Class: Bolt::Transport::SSH

Inherits:
Base
  • Object
show all
Defined in:
lib/bolt/transport/ssh.rb,
lib/bolt/transport/ssh/connection.rb

Defined Under Namespace

Classes: Connection

Constant Summary collapse

PROVIDED_FEATURES = 
['shell'].freeze

Constants inherited from Base

Base::ENVIRONMENT_METHODS, Base::STDIN_METHODS

Instance Attribute Summary

Attributes inherited from Base

#logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#assert_batch_size_one, #batch_command, #batch_script, #batch_task, #batch_upload, #batches, #filter_options, #with_events

Constructor Details

#initialize ⇒ SSH

Returns a new instance of SSH.



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/bolt/transport/ssh.rb', line 49

def initialize
  super

  require 'net/ssh'
  require 'net/scp'
  begin
    require 'net/ssh/krb'
  rescue LoadError
    logger.debug {
      "Authentication method 'gssapi-with-mic' is not available"
    }
  end
end

Class Method Details

.options ⇒ Object 



11
12
13
 
# File 'lib/bolt/transport/ssh.rb', line 11

def self.options
  %w[port user password sudo-password private-key host-key-check connect-timeout tmpdir run-as tty run-as-command]
end

.validate(options) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/bolt/transport/ssh.rb', line 17

def self.validate(options)
  logger = Logging.logger[self]

  if options['sudo-password'] && options['run-as'].nil?
    logger.warn("--sudo-password will not be used without specifying a " \
                 "user to escalate to with --run-as")
  end

  host_key = options['host-key-check']
  unless !!host_key == host_key
    raise Bolt::ValidationError, 'host-key-check option must be a Boolean true or false'
  end

  if (key_opt = options['private-key'])
    unless key_opt.instance_of?(String) || (key_opt.instance_of?(Hash) && key_opt.include?('key-data'))
      raise Bolt::ValidationError,
            "private-key option must be the path to a private key file or a hash containing the 'key-data'"
    end
  end

  timeout_value = options['connect-timeout']
  unless timeout_value.is_a?(Integer) || timeout_value.nil?
    error_msg = "connect-timeout value must be an Integer, received #{timeout_value}:#{timeout_value.class}"
    raise Bolt::ValidationError, error_msg
  end

  run_as_cmd = options['run-as-command']
  if run_as_cmd && (!run_as_cmd.is_a?(Array) || run_as_cmd.any? { |n| !n.is_a?(String) })
    raise Bolt::ValidationError, "run-as-command must be an Array of Strings, received #{run_as_cmd}"
  end
end

Instance Method Details

#make_wrapper_stringio(task_path, stdin) ⇒ Object 



163
164
165
166
167
168
169
170
 
# File 'lib/bolt/transport/ssh.rb', line 163

def make_wrapper_stringio(task_path, stdin)
  StringIO.new(<<-SCRIPT)
#!/bin/sh
'#{task_path}' <<EOF
#{stdin}
EOF
SCRIPT
end

#run_command(target, command, options = {}) ⇒ Object 



95
96
97
98
99
100
101
102
 
# File 'lib/bolt/transport/ssh.rb', line 95

def run_command(target, command, options = {})
  with_connection(target) do |conn|
    conn.running_as(options['_run_as']) do
      output = conn.execute(command, sudoable: true)
      Bolt::Result.for_command(target, output.stdout.string, output.stderr.string, output.exit_code)
    end
  end
end

#run_script(target, script, arguments, options = {}) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/bolt/transport/ssh.rb', line 104

def run_script(target, script, arguments, options = {})
  with_connection(target) do |conn|
    conn.running_as(options['_run_as']) do
      conn.with_remote_tempdir do |dir|
        remote_path = conn.write_remote_executable(dir, script)
        dir.chown(conn.run_as)
        output = conn.execute([remote_path, *arguments], sudoable: true)
        Bolt::Result.for_command(target, output.stdout.string, output.stderr.string, output.exit_code)
      end
    end
  end
end

#run_task(target, task, arguments, options = {}) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/bolt/transport/ssh.rb', line 117

def run_task(target, task, arguments, options = {})
  executable = target.select_impl(task, PROVIDED_FEATURES)
  raise "No suitable implementation of #{task.name} for #{target.name}" unless executable

  input_method = task.input_method || "both"
  with_connection(target) do |conn|
    conn.running_as(options['_run_as']) do
      stdin, output = nil

      command = []
      execute_options = {}

      if STDIN_METHODS.include?(input_method)
        stdin = JSON.dump(arguments)
      end

      if ENVIRONMENT_METHODS.include?(input_method)
        environment = arguments.inject({}) do |env, (param, val)|
          val = val.to_json unless val.is_a?(String)
          env.merge("PT_#{param}" => val)
        end
        execute_options[:environment] = environment
      end

      conn.with_remote_tempdir do |dir|
        remote_task_path = conn.write_remote_executable(dir, executable)
        if conn.run_as && stdin
          wrapper = make_wrapper_stringio(remote_task_path, stdin)
          remote_wrapper_path = conn.write_remote_executable(dir, wrapper, 'wrapper.sh')
          command << remote_wrapper_path
        else
          command << remote_task_path
          execute_options[:stdin] = stdin
        end
        dir.chown(conn.run_as)

        execute_options[:sudoable] = true if conn.run_as
        output = conn.execute(command, execute_options)
      end
      Bolt::Result.for_task(target, output.stdout.string,
                            output.stderr.string,
                            output.exit_code)
    end
  end
end

#upload(target, source, destination, options = {}) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/bolt/transport/ssh.rb', line 75

def upload(target, source, destination, options = {})
  with_connection(target) do |conn|
    conn.running_as(options['_run_as']) do
      conn.with_remote_tempdir do |dir|
        basename = File.basename(destination)
        tmpfile = "#{dir}/#{basename}"
        conn.write_remote_file(source, tmpfile)
        # pass over file ownership if we're using run-as to be a different user
        dir.chown(conn.run_as)
        result = conn.execute(['mv', tmpfile, destination], sudoable: true)
        if result.exit_code != 0
          message = "Could not move temporary file '#{tmpfile}' to #{destination}: #{result.stderr.string}"
          raise Bolt::Node::FileError.new(message, 'MV_ERROR')
        end
      end
      Bolt::Result.for_upload(target, source, destination)
    end
  end
end

#with_connection(target) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/bolt/transport/ssh.rb', line 63

def with_connection(target)
  conn = Connection.new(target)
  conn.connect
  yield conn
ensure
  begin
    conn&.disconnect
  rescue StandardError => ex
    logger.info("Failed to close connection to #{target.uri} : #{ex.message}")
  end
end