Class: Bolt::Transport::WinRM

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

Defined Under Namespace

Classes: Connection

Constant Summary

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_connected?, #batch_script, #batch_task, #batch_upload, #batches, #envify_params, filter_options, #select_implementation, #select_interpreter, #unwrap_sensitive_args, #with_events

Constructor Details

#initialize ⇒ WinRM

Returns a new instance of WinRM.



61
62
63
64
65
66
67
68
 
# File 'lib/bolt/transport/winrm.rb', line 61

def initialize
  super
  require 'winrm'
  require 'winrm-fs'

  @transport_logger = Logging.logger[::WinRM]
  @transport_logger.level = :warn
end

Class Method Details

.default_options ⇒ Object 



17
18
19
20
21
22
23
24
 
# File 'lib/bolt/transport/winrm.rb', line 17

def self.default_options
  {
    'connect-timeout' => 10,
    'ssl' => true,
    'ssl-verify' => true,
    'file-protocol' => 'winrm'
  }
end

.options ⇒ Object 



10
11
12
13
14
15
 
# File 'lib/bolt/transport/winrm.rb', line 10

def self.options
  %w[
    host port user password connect-timeout ssl ssl-verify tmpdir
    cacert extensions interpreters file-protocol smb-port realm
  ]
end

.validate(options) ⇒ Object 



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
 
# File 'lib/bolt/transport/winrm.rb', line 35

def self.validate(options)
  ssl_flag = options['ssl']
  unless !!ssl_flag == ssl_flag
    raise Bolt::ValidationError, 'ssl option must be a Boolean true or false'
  end

  if ssl_flag && (options['file-protocol'] == 'smb')
    raise Bolt::ValidationError, 'SMB file transfers are not allowed with SSL enabled'
  end

  if ssl_flag && (ca_path = options['cacert'])
    Bolt::Util.validate_file('cacert', ca_path)
  end

  ssl_verify_flag = options['ssl-verify']
  unless !!ssl_verify_flag == ssl_verify_flag
    raise Bolt::ValidationError, 'ssl-verify option must be a Boolean true or false'
  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
end

Instance Method Details

#connected?(target) ⇒ Boolean

Returns:

  • (Boolean) 


183
184
185
186
187
 
# File 'lib/bolt/transport/winrm.rb', line 183

def connected?(target)
  with_connection(target) { true }
rescue Bolt::Node::ConnectError
  false
end

#default_input_method(executable) ⇒ Object 



30
31
32
33
 
# File 'lib/bolt/transport/winrm.rb', line 30

def default_input_method(executable)
  input_method ||= Powershell.powershell_file?(executable) ? 'powershell' : 'both'
  input_method
end

#provided_features ⇒ Object 



26
27
28
 
# File 'lib/bolt/transport/winrm.rb', line 26

def provided_features
  ['powershell']
end

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



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/bolt/transport/winrm.rb', line 89

def run_command(target, command, _options = {})
  with_connection(target) do |conn|
    output = conn.execute(command)
    Bolt::Result.for_command(target,
                             output.stdout.string,
                             output.stderr.string,
                             output.exit_code,
                             'command', command)
  end
end

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/bolt/transport/winrm.rb', line 100

def run_script(target, script, arguments, _options = {})
  # unpack any Sensitive data
  arguments = unwrap_sensitive_args(arguments)
  with_connection(target) do |conn|
    conn.with_remote_tempdir do |dir|
      remote_path = conn.write_remote_executable(dir, script)
      if Powershell.powershell_file?(remote_path)
        output = conn.execute(Powershell.run_script(arguments, remote_path))
      else
        path, args = *Powershell.process_from_extension(remote_path)
        args += Powershell.escape_arguments(arguments)
        output = conn.execute_process(path, args)
      end
      Bolt::Result.for_command(target,
                               output.stdout.string,
                               output.stderr.string,
                               output.exit_code,
                               'script', script)
    end
  end
end

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



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/bolt/transport/winrm.rb', line 122

def run_task(target, task, arguments, _options = {})
  implementation = select_implementation(target, task)
  executable = implementation['path']
  input_method = implementation['input_method']
  extra_files = implementation['files']
  input_method ||= Powershell.powershell_file?(executable) ? 'powershell' : 'both'

  # unpack any Sensitive data
  arguments = unwrap_sensitive_args(arguments)
  with_connection(target) do |conn|
    conn.with_remote_tempdir do |dir|
      if extra_files.empty?
        task_dir = dir
      else
        # TODO: optimize upload of directories
        arguments['_installdir'] = dir
        task_dir = File.join(dir, task.tasks_dir)
        conn.mkdirs([task_dir] + extra_files.map { |file| File.join(dir, File.dirname(file['name'])) })
        extra_files.each do |file|
          conn.write_remote_file(file['path'], File.join(dir, file['name']))
        end
      end

      remote_task_path = conn.write_remote_executable(task_dir, executable)

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

      if ENVIRONMENT_METHODS.include?(input_method)
        envify_params(arguments).each do |(arg, val)|
          cmd = Powershell.set_env(arg, val)
          result = conn.execute(cmd)
          if result.exit_code != 0
            raise Bolt::Node::EnvironmentVarError.new(arg, val)
          end
        end
      end

      conn.shell_init
      output =
        if Powershell.powershell_file?(remote_task_path) && stdin.nil?
          conn.execute(Powershell.run_ps_task(arguments, remote_task_path, input_method))
        else
          if (interpreter = select_interpreter(remote_task_path, target.options['interpreters']))
            path = interpreter
            args = [remote_task_path]
          else
            path, args = *Powershell.process_from_extension(remote_task_path)
          end
          conn.execute_process(path, args, stdin)
        end

      Bolt::Result.for_task(target, output.stdout.string,
                            output.stderr.string,
                            output.exit_code,
                            task.name)
    end
  end
end

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



82
83
84
85
86
87
 
# File 'lib/bolt/transport/winrm.rb', line 82

def upload(target, source, destination, _options = {})
  with_connection(target) do |conn|
    conn.write_remote_file(source, destination)
    Bolt::Result.for_upload(target, source, destination)
  end
end

#with_connection(target) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/bolt/transport/winrm.rb', line 70

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