Class: Bolt::Transport::WinRM::Connection
- Inherits:
-
Object
- Object
- Bolt::Transport::WinRM::Connection
- Defined in:
- lib/bolt/transport/winrm/connection.rb
Constant Summary collapse
- HTTP_PORT =
5985
- HTTPS_PORT =
5986
Instance Attribute Summary collapse
-
#logger ⇒ Object
readonly
Returns the value of attribute logger.
-
#target ⇒ Object
readonly
Returns the value of attribute target.
Instance Method Summary collapse
- #connect ⇒ Object
- #copy_file(source, destination) ⇒ Object
- #copy_file_smb(source, destination) ⇒ Object
- #copy_file_winrm(source, destination) ⇒ Object
- #disconnect ⇒ Object
- #execute(command) ⇒ Object
-
#initialize(target, transport_logger) ⇒ Connection
constructor
A new instance of Connection.
- #max_command_length ⇒ Object
- #shell ⇒ Object
Constructor Details
#initialize(target, transport_logger) ⇒ Connection
Returns a new instance of Connection.
12 13 14 15 16 17 18 19 20 21 22 23 24 |
# File 'lib/bolt/transport/winrm/connection.rb', line 12 def initialize(target, transport_logger) raise Bolt::ValidationError, "Target #{target.safe_name} does not have a host" unless target.host @target = target default_port = target.['ssl'] ? HTTPS_PORT : HTTP_PORT @port = @target.port || default_port @user = @target.user # Build set of extensions from extensions config as well as interpreters @logger = Logging.logger[@target.safe_name] logger.debug("Initializing winrm connection to #{@target.safe_name}") @transport_logger = transport_logger end |
Instance Attribute Details
#logger ⇒ Object (readonly)
Returns the value of attribute logger.
10 11 12 |
# File 'lib/bolt/transport/winrm/connection.rb', line 10 def logger @logger end |
#target ⇒ Object (readonly)
Returns the value of attribute target.
10 11 12 |
# File 'lib/bolt/transport/winrm/connection.rb', line 10 def target @target end |
Instance Method Details
#connect ⇒ Object
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/bolt/transport/winrm/connection.rb', line 29 def connect if target.['ssl'] scheme = 'https' transport = :ssl else scheme = 'http' transport = :negotiate end transport = :kerberos if target.['realm'] endpoint = "#{scheme}://#{target.host}:#{@port}/wsman" cacert = target.['cacert'] && target.['ssl'] ? File.(target.['cacert']) : nil = { endpoint: endpoint, # https://github.com/WinRb/WinRM/issues/270 user: target.['realm'] ? 'dummy' : @user, password: target.['realm'] ? 'dummy' : target.password, retry_limit: 1, transport: transport, basic_auth_only: target.['basic-auth-only'], ca_trust_path: cacert, realm: target.['realm'], no_ssl_peer_verification: !target.['ssl-verify'] } Timeout.timeout(target.['connect-timeout']) do @connection = ::WinRM::Connection.new() @connection.logger = @transport_logger @session = @connection.shell(:powershell) @session.run('$PSVersionTable.PSVersion') @logger.debug { "Opened session" } end rescue Timeout::Error # If we're using the default port with SSL, a timeout probably means the # host doesn't support SSL. if target.['ssl'] && @port == HTTPS_PORT the_problem = "\nVerify that required WinRM ports are open, " \ "or use --no-ssl if this host isn't configured to use SSL for WinRM." end raise Bolt::Node::ConnectError.new( "Timeout after #{target.['connect-timeout']} seconds connecting to #{endpoint}#{the_problem}", 'CONNECT_ERROR' ) rescue ::WinRM::WinRMAuthorizationError raise Bolt::Node::ConnectError.new( "Authentication failed for #{endpoint}", 'AUTH_ERROR' ) rescue OpenSSL::SSL::SSLError => e # If we're using SSL with the default non-SSL port, mention that as a likely problem if target.['ssl'] && @port == HTTP_PORT theres_your_problem = "\nAre you using SSL to connect to a non-SSL port?" end if target.['ssl-verify'] && e..include?('certificate verify failed') theres_your_problem = "\nIs the remote host using a self-signed SSL "\ "certificate? Use --no-ssl-verify to disable "\ "remote host SSL verification." end raise Bolt::Node::ConnectError.new( "Failed to connect to #{endpoint}: #{e.}#{theres_your_problem}", "CONNECT_ERROR" ) rescue StandardError => e raise Bolt::Node::ConnectError.new( "Failed to connect to #{endpoint}: #{e.}", 'CONNECT_ERROR' ) end |
#copy_file(source, destination) ⇒ Object
132 133 134 135 136 137 138 139 |
# File 'lib/bolt/transport/winrm/connection.rb', line 132 def copy_file(source, destination) @logger.debug { "Uploading #{source}, to #{destination}" } if target.['file-protocol'] == 'smb' copy_file_smb(source, destination) else copy_file_winrm(source, destination) end end |
#copy_file_smb(source, destination) ⇒ Object
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/bolt/transport/winrm/connection.rb', line 148 def copy_file_smb(source, destination) # lazy-load expensive gem code require 'ruby_smb' win_dest = destination.tr('/', '\\') if (md = win_dest.match(/^([a-z]):\\(.*)/i)) # if drive, use admin share for that drive, so path is '\\host\C$' path = "\\\\#{@target.host}\\#{md[1]}$" dest = md[2] elsif (md = win_dest.match(/^(\\\\[^\\]+\\[^\\]+)\\(.*)/)) # if unc, path is '\\host\share' path = md[1] dest = md[2] else raise ArgumentError, "Unknown destination '#{destination}'" end client = smb_client_login tree = client.tree_connect(path) begin copy_file_smb_recursive(tree, source, dest) ensure tree.disconnect! end rescue ::RubySMB::Error::UnexpectedStatusCode => e raise Bolt::Node::FileError.new("SMB Error: #{e.}", 'WRITE_ERROR') rescue StandardError => e raise Bolt::Node::FileError.new(e., 'WRITE_ERROR') end |
#copy_file_winrm(source, destination) ⇒ Object
141 142 143 144 145 146 |
# File 'lib/bolt/transport/winrm/connection.rb', line 141 def copy_file_winrm(source, destination) fs = ::WinRM::FS::FileManager.new(@connection) fs.upload(source, destination) rescue StandardError => e raise Bolt::Node::FileError.new(e., 'WRITE_ERROR') end |
#disconnect ⇒ Object
97 98 99 100 101 |
# File 'lib/bolt/transport/winrm/connection.rb', line 97 def disconnect @session&.close @client&.disconnect! @logger.debug { "Closed session" } end |
#execute(command) ⇒ Object
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 |
# File 'lib/bolt/transport/winrm/connection.rb', line 103 def execute(command) @logger.debug { "Executing command: #{command}" } inp = StringIO.new # This transport doesn't accept stdin, so close the stream to ensure # it will fail if the shell attempts to provide stdin inp.close out_rd, out_wr = IO.pipe('UTF-8') err_rd, err_wr = IO.pipe('UTF-8') th = Thread.new do result = @session.run(command) out_wr << result.stdout err_wr << result.stderr out_wr.close err_wr.close result.exitcode end [inp, out_rd, err_rd, th] rescue Errno::EMFILE => e msg = "#{e.}. This may be resolved by increasing your user limit "\ "with 'ulimit -n 1024'. See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details." raise Bolt::Error.new(msg, 'bolt/too-many-files') rescue StandardError @logger.debug { "Command aborted" } raise end |
#max_command_length ⇒ Object
182 183 184 |
# File 'lib/bolt/transport/winrm/connection.rb', line 182 def max_command_length nil end |
#shell ⇒ Object
178 179 180 |
# File 'lib/bolt/transport/winrm/connection.rb', line 178 def shell @shell ||= Bolt::Shell::Powershell.new(target, self) end |