Class: Bolt::Transport::SSH::Connection
- Inherits:
-
Object
- Object
- Bolt::Transport::SSH::Connection
- Defined in:
- lib/bolt/transport/ssh/connection.rb
Defined Under Namespace
Modules: Win Classes: RemoteTempdir
Instance Attribute Summary collapse
-
#logger ⇒ Object
readonly
Returns the value of attribute logger.
-
#run_as ⇒ Object
This method allows the @run_as variable to be used as a per-operation override for the user to run as.
-
#target ⇒ Object
readonly
Returns the value of attribute target.
-
#user ⇒ Object
readonly
Returns the value of attribute user.
Instance Method Summary collapse
- #connect ⇒ Object
- #disconnect ⇒ Object
- #execute(command, sudoable: false, **options) ⇒ Object
- #handled_sudo(channel, data) ⇒ Object
-
#initialize(target, transport_logger, load_config = true) ⇒ Connection
constructor
A new instance of Connection.
- #make_executable(path) ⇒ Object
- #make_tempdir ⇒ Object
-
#running_as(user) ⇒ Object
Run as the specified user for the duration of the block.
- #sudo_prompt ⇒ Object
-
#with_remote_tempdir ⇒ Object
A helper to create and delete a tempdir on the remote system.
- #write_executable_from_content(dest, content, filename) ⇒ Object
- #write_remote_executable(dir, file, filename = nil) ⇒ Object
- #write_remote_file(source, destination) ⇒ Object
Constructor Details
#initialize(target, transport_logger, load_config = true) ⇒ Connection
Returns a new instance of Connection.
57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/bolt/transport/ssh/connection.rb', line 57 def initialize(target, transport_logger, load_config = true) @target = target @load_config = load_config ssh_user = load_config ? Net::SSH::Config.for(target.host)[:user] : nil @user = @target.user || ssh_user || Etc.getlogin @run_as = nil @logger = Logging.logger[@target.host] @transport_logger = transport_logger end |
Instance Attribute Details
#logger ⇒ Object (readonly)
Returns the value of attribute logger.
54 55 56 |
# File 'lib/bolt/transport/ssh/connection.rb', line 54 def logger @logger end |
#run_as ⇒ Object
This method allows the @run_as variable to be used as a per-operation override for the user to run as. When @run_as is unset, the user specified on the target will be used.
158 159 160 |
# File 'lib/bolt/transport/ssh/connection.rb', line 158 def run_as @run_as || target.['run-as'] end |
#target ⇒ Object (readonly)
Returns the value of attribute target.
54 55 56 |
# File 'lib/bolt/transport/ssh/connection.rb', line 54 def target @target end |
#user ⇒ Object (readonly)
Returns the value of attribute user.
54 55 56 |
# File 'lib/bolt/transport/ssh/connection.rb', line 54 def user @user end |
Instance Method Details
#connect ⇒ Object
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 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 |
# File 'lib/bolt/transport/ssh/connection.rb', line 79 def connect = { logger: @transport_logger, non_interactive: true } if (key = target.['private-key']) if key.instance_of?(String) [:keys] = key else [:key_data] = [key['key-data']] end end [:port] = target.port if target.port [:password] = target.password if target.password [:verify_host_key] = if target.['host-key-check'] Net::SSH::Verifiers::Secure.new else Net::SSH::Verifiers::Null.new end [:timeout] = target.['connect-timeout'] if target.['connect-timeout'] if @load_config # Mirroring: # https://github.com/net-ssh/net-ssh/blob/master/lib/net/ssh/authentication/agent.rb#L80 # https://github.com/net-ssh/net-ssh/blob/master/lib/net/ssh/authentication/pageant.rb#L403 if defined?(UNIXSocket) && UNIXSocket if ENV['SSH_AUTH_SOCK'].to_s.empty? @logger.debug { "Disabling use_agent in net-ssh: ssh-agent is not available" } [:use_agent] = false end elsif Bolt::Util.windows? pageant_wide = 'Pageant'.encode('UTF-16LE') if Win.FindWindow(pageant_wide, pageant_wide).to_i == 0 @logger.debug { "Disabling use_agent in net-ssh: pageant process not running" } [:use_agent] = false end end else # Disable ssh config and ssh-agent if requested via load_config [:config] = false [:use_agent] = false end @session = Net::SSH.start(target.host, @user, ) @logger.debug { "Opened session" } rescue Net::SSH::AuthenticationFailed => e raise Bolt::Node::ConnectError.new( e., 'AUTH_ERROR' ) rescue Net::SSH::HostKeyError => e raise Bolt::Node::ConnectError.new( "Host key verification failed for #{target.uri}: #{e.}", 'HOST_KEY_ERROR' ) rescue Net::SSH::ConnectionTimeout raise Bolt::Node::ConnectError.new( "Timeout after #{target.['connect-timeout']} seconds connecting to #{target.uri}", 'CONNECT_ERROR' ) rescue StandardError => e raise Bolt::Node::ConnectError.new( "Failed to connect to #{target.uri}: #{e.}", 'CONNECT_ERROR' ) end |
#disconnect ⇒ Object
148 149 150 151 152 153 |
# File 'lib/bolt/transport/ssh/connection.rb', line 148 def disconnect if @session && !@session.closed? @session.close @logger.debug { "Closed session" } end end |
#execute(command, sudoable: false, **options) ⇒ Object
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/bolt/transport/ssh/connection.rb', line 204 def execute(command, sudoable: false, **) result_output = Bolt::Node::Output.new run_as = [:run_as] || self.run_as escalate = sudoable && run_as && @user != run_as use_sudo = escalate && @target.['run-as-command'].nil? command_str = command.is_a?(String) ? command : Shellwords.shelljoin(command) if escalate if use_sudo sudo_flags = ["sudo", "-S", "-u", run_as, "-p", sudo_prompt] sudo_flags += ["-E"] if [:environment] sudo_str = Shellwords.shelljoin(sudo_flags) command_str = "#{sudo_str} #{command_str}" else run_as_str = Shellwords.shelljoin(@target.['run-as-command'] + [run_as]) command_str = "#{run_as_str} #{command_str}" end end # Including the environment declarations in the shelljoin will escape # the = sign, so we have to handle them separately. if [:environment] env_decls = [:environment].map do |env, val| "#{env}=#{Shellwords.shellescape(val)}" end command_str = "#{env_decls.join(' ')} #{command_str}" end @logger.debug { "Executing: #{command_str}" } session_channel = @session.open_channel do |channel| # Request a pseudo tty channel.request_pty if target.['tty'] channel.exec(command_str) do |_, success| unless success raise Bolt::Node::ConnectError.new( "Could not execute command: #{command_str.inspect}", 'EXEC_ERROR' ) end channel.on_data do |_, data| unless use_sudo && handled_sudo(channel, data) result_output.stdout << data end @logger.debug { "stdout: #{data.strip}" } end channel.on_extended_data do |_, _, data| unless use_sudo && handled_sudo(channel, data) result_output.stderr << data end @logger.debug { "stderr: #{data.strip}" } end channel.on_request("exit-status") do |_, data| result_output.exit_code = data.read_long end if [:stdin] channel.send_data([:stdin]) channel.eof! end end end session_channel.wait if result_output.exit_code == 0 @logger.debug { "Command returned successfully" } else @logger.info { "Command failed with exit code #{result_output.exit_code}" } end result_output rescue StandardError @logger.debug { "Command aborted" } raise end |
#handled_sudo(channel, data) ⇒ Object
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/bolt/transport/ssh/connection.rb', line 174 def handled_sudo(channel, data) if data.lines.include?(sudo_prompt) if target.['sudo-password'] channel.send_data "#{target.['sudo-password']}\n" channel.wait return true else # Cancel the sudo prompt to prevent later commands getting stuck channel.close raise Bolt::Node::EscalateError.new( "Sudo password for user #{@user} was not provided for #{target.uri}", 'NO_PASSWORD' ) end elsif data =~ /^#{@user} is not in the sudoers file\./ @logger.debug { data } raise Bolt::Node::EscalateError.new( "User #{@user} does not have sudo permission on #{target.uri}", 'SUDO_DENIED' ) elsif data =~ /^Sorry, try again\./ @logger.debug { data } raise Bolt::Node::EscalateError.new( "Sudo password for user #{@user} not recognized on #{target.uri}", 'BAD_PASSWORD' ) end false end |
#make_executable(path) ⇒ Object
326 327 328 329 330 331 332 |
# File 'lib/bolt/transport/ssh/connection.rb', line 326 def make_executable(path) result = execute(['chmod', 'u+x', path]) if result.exit_code != 0 = "Could not make file '#{path}' executable: #{result.stderr.string}" raise Bolt::Node::FileError.new(, 'CHMOD_ERROR') end end |
#make_tempdir ⇒ Object
289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/bolt/transport/ssh/connection.rb', line 289 def make_tempdir tmpdir = target..fetch('tmpdir', '/tmp') tmppath = "#{tmpdir}/#{SecureRandom.uuid}" command = ['mkdir', '-m', 700, tmppath] result = execute(command) if result.exit_code != 0 raise Bolt::Node::FileError.new("Could not make tempdir: #{result.stderr.string}", 'TEMPDIR_ERROR') end path = tmppath || result.stdout.string.chomp RemoteTempdir.new(self, path) end |
#running_as(user) ⇒ Object
Run as the specified user for the duration of the block.
163 164 165 166 167 168 |
# File 'lib/bolt/transport/ssh/connection.rb', line 163 def running_as(user) @run_as = user yield ensure @run_as = nil end |
#sudo_prompt ⇒ Object
170 171 172 |
# File 'lib/bolt/transport/ssh/connection.rb', line 170 def sudo_prompt '[sudo] Bolt needs to run as another user, password: ' end |
#with_remote_tempdir ⇒ Object
A helper to create and delete a tempdir on the remote system. Yields the directory name.
304 305 306 307 308 309 |
# File 'lib/bolt/transport/ssh/connection.rb', line 304 def with_remote_tempdir dir = make_tempdir yield dir ensure dir&.delete end |
#write_executable_from_content(dest, content, filename) ⇒ Object
319 320 321 322 323 324 |
# File 'lib/bolt/transport/ssh/connection.rb', line 319 def write_executable_from_content(dest, content, filename) remote_path = File.join(dest.to_s, filename) @session.scp.upload!(StringIO.new(content), remote_path) make_executable(remote_path) remote_path end |
#write_remote_executable(dir, file, filename = nil) ⇒ Object
311 312 313 314 315 316 317 |
# File 'lib/bolt/transport/ssh/connection.rb', line 311 def write_remote_executable(dir, file, filename = nil) filename ||= File.basename(file) remote_path = File.join(dir.to_s, filename) write_remote_file(file, remote_path) make_executable(remote_path) remote_path end |