Class: Bolt::Transport::WinRM::Connection

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

Constant Summary collapse

DEFAULT_EXTENSIONS = 
['.ps1', '.rb', '.pp'].freeze
HTTP_PORT = 
5985
HTTPS_PORT = 
5986

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target, transport_logger) ⇒ Connection

Returns a new instance of Connection.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/bolt/transport/winrm/connection.rb', line 14

def initialize(target, transport_logger)
  @target = target

  default_port = target.options['ssl'] ? HTTPS_PORT : HTTP_PORT
  @port = @target.port || default_port
  @user = @target.user

  # Accept a single entry or a list, ensure each is prefixed with '.'
  extensions = [target.options['extensions'] || []].flatten.map { |ext| ext[0] != '.' ? '.' + ext : ext }
  @extensions = DEFAULT_EXTENSIONS.to_set.merge(extensions)

  @logger = Logging.logger[@target.host]
  @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 



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

def connect
  if target.options['ssl']
    scheme = 'https'
    transport = :ssl
  else
    scheme = 'http'
    transport = :negotiate
  end
  endpoint = "#{scheme}://#{target.host}:#{@port}/wsman"
  options = { endpoint: endpoint,
              user: @user,
              password: target.password,
              retry_limit: 1,
              transport: transport,
              ca_trust_path: target.options['cacert'],
              no_ssl_peer_verification: !target.options['ssl-verify'] }

  Timeout.timeout(target.options['connect-timeout']) do
    @connection = ::WinRM::Connection.new(options)
    @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.options['ssl'] && @port == HTTPS_PORT
    the_problem = "\nUse --no-ssl if this host isn't configured to use SSL for WinRM"
  end
  raise Bolt::Node::ConnectError.new(
    "Timeout after #{target.options['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.options['ssl'] && @port == HTTP_PORT
    theres_your_problem = "\nAre you using SSL to connect to a non-SSL port?"
  end
  if target.options['ssl-verify'] && e.message.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.message}#{theres_your_problem}",
    "CONNECT_ERROR"
  )
rescue StandardError => e
  raise Bolt::Node::ConnectError.new(
    "Failed to connect to #{endpoint}: #{e.message}",
    'CONNECT_ERROR'
  )
end

#disconnect ⇒ Object 



93
94
95
96
 
# File 'lib/bolt/transport/winrm/connection.rb', line 93

def disconnect
  @session&.close
  @logger.debug { "Closed session" }
end

#execute(command) ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/bolt/transport/winrm/connection.rb', line 295

def execute(command)
  result_output = Bolt::Node::Output.new

  @logger.debug { "Executing command: #{command}" }

  output = @session.run(command) do |stdout, stderr|
    result_output.stdout << stdout
    @logger.debug { "stdout: #{stdout}" }
    result_output.stderr << stderr
    @logger.debug { "stderr: #{stderr}" }
  end
  result_output.exit_code = output.exitcode
  if output.exitcode.zero?
    @logger.debug { "Command returned successfully" }
  else
    @logger.info { "Command failed with exit code #{output.exitcode}" }
  end
  result_output
rescue StandardError
  @logger.debug { "Command aborted" }
  raise
end

#execute_process(path = '', arguments = [], stdin = nil) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/bolt/transport/winrm/connection.rb', line 318

def execute_process(path = '', arguments = [], stdin = nil)
  quoted_args = arguments.map do |arg|
    "'" + arg.gsub("'", "''") + "'"
  end.join(' ')

  exec_cmd =
    if stdin.nil?
      "& #{path} #{quoted_args}"
    else
      "@'\n#{stdin}\n'@ | & #{path} #{quoted_args}"
    end
  execute(<<-PS)
$OutputEncoding = [Console]::OutputEncoding
#{exec_cmd}
if (-not $? -and ($LASTEXITCODE -eq $null)) { exit 1 }
exit $LASTEXITCODE
PS
end

#make_tempdir ⇒ Object 



344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/bolt/transport/winrm/connection.rb', line 344

def make_tempdir
  find_parent = target.options['tmpdir'] ? "\"#{target.options['tmpdir']}\"" : '[System.IO.Path]::GetTempPath()'
  result = execute(<<-PS)
$parent = #{find_parent}
$name = [System.IO.Path]::GetRandomFileName()
$path = Join-Path $parent $name
New-Item -ItemType Directory -Path $path | Out-Null
$path
PS
  if result.exit_code != 0
    raise Bolt::Node::FileError.new("Could not make tempdir: #{result.stderr}", 'TEMPDIR_ERROR')
  end
  result.stdout.string.chomp
end

#shell_init ⇒ Object 



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
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
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
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/bolt/transport/winrm/connection.rb', line 98

def shell_init
  return nil if @shell_initialized
  result = execute(<<-PS)
$ENV:PATH += ";${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\bin\\;" +
"${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\puppet\\bin;" +
"${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\sys\\ruby\\bin\\"
$ENV:RUBYLIB = "${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\puppet\\lib;" +
"${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\facter\\lib;" +
"${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\hiera\\lib;" +
$ENV:RUBYLIB

Add-Type -AssemblyName System.ServiceModel.Web, System.Runtime.Serialization
$utf8 = [System.Text.Encoding]::UTF8

function Write-Stream {
PARAM(
  [Parameter(Position=0)] $stream,
  [Parameter(ValueFromPipeline=$true)] $string
)
PROCESS {
  $bytes = $utf8.GetBytes($string)
  $stream.Write( $bytes, 0, $bytes.Length )
}
}

function Convert-JsonToXml {
PARAM([Parameter(ValueFromPipeline=$true)] [string[]] $json)
BEGIN {
  $mStream = New-Object System.IO.MemoryStream
}
PROCESS {
  $json | Write-Stream -Stream $mStream
}
END {
  $mStream.Position = 0
  try {
    $jsonReader = [System.Runtime.Serialization.Json.JsonReaderWriterFactory]::CreateJsonReader($mStream,[System.Xml.XmlDictionaryReaderQuotas]::Max)
    $xml = New-Object Xml.XmlDocument
    $xml.Load($jsonReader)
    $xml
  } finally {
    $jsonReader.Close()
    $mStream.Dispose()
  }
}
}

Function ConvertFrom-Xml {
[CmdletBinding(DefaultParameterSetName="AutoType")]
PARAM(
  [Parameter(ValueFromPipeline=$true,Mandatory=$true,Position=1)] [Xml.XmlNode] $xml,
  [Parameter(Mandatory=$true,ParameterSetName="ManualType")] [Type] $Type,
  [Switch] $ForceType
)
PROCESS{
  if (Get-Member -InputObject $xml -Name root) {
    return $xml.root.Objects | ConvertFrom-Xml
  } elseif (Get-Member -InputObject $xml -Name Objects) {
    return $xml.Objects | ConvertFrom-Xml
  }
  $propbag = @{}
  foreach ($name in Get-Member -InputObject $xml -MemberType Properties | Where-Object{$_.Name -notmatch "^__|type"} | Select-Object -ExpandProperty name) {
    Write-Debug "$Name Type: $($xml.$Name.type)" -Debug:$false
    $propbag."$Name" = Convert-Properties $xml."$name"
  }
  if (!$Type -and $xml.HasAttribute("__type")) { $Type = $xml.__Type }
  if ($ForceType -and $Type) {
    try {
      $output = New-Object $Type -Property $propbag
    } catch {
      $output = New-Object PSObject -Property $propbag
      $output.PsTypeNames.Insert(0, $xml.__type)
    }
  } elseif ($propbag.Count -ne 0) {
    $output = New-Object PSObject -Property $propbag
    if ($Type) {
      $output.PsTypeNames.Insert(0, $Type)
    }
  }
  return $output
}
}

Function Convert-Properties {
PARAM($InputObject)
switch ($InputObject.type) {
  "object" {
    return (ConvertFrom-Xml -Xml $InputObject)
  }
  "string" {
    $MightBeADate = $InputObject.get_InnerText() -as [DateTime]
    ## Strings that are actually dates (*grumble* JSON is crap)
    if ($MightBeADate -and $propbag."$Name" -eq $MightBeADate.ToString("G")) {
      return $MightBeADate
    } else {
      return $InputObject.get_InnerText()
    }
  }
  "number" {
    $number = $InputObject.get_InnerText()
    if ($number -eq ($number -as [int])) {
      return $number -as [int]
    } elseif ($number -eq ($number -as [double])) {
      return $number -as [double]
    } else {
      return $number -as [decimal]
    }
  }
  "boolean" {
    return [bool]::parse($InputObject.get_InnerText())
  }
  "null" {
    return $null
  }
  "array" {
    [object[]]$Items = $(foreach( $item in $InputObject.GetEnumerator() ) {
      Convert-Properties $item
    })
    return $Items
  }
  default {
    return $InputObject
  }
}
}

Function ConvertFrom-Json2 {
[CmdletBinding()]
PARAM(
  [Parameter(ValueFromPipeline=$true,Mandatory=$true,Position=1)] [string] $InputObject,
  [Parameter(Mandatory=$true)] [Type] $Type,
  [Switch] $ForceType
)
PROCESS {
  $null = $PSBoundParameters.Remove("InputObject")
  [Xml.XmlElement]$xml = (Convert-JsonToXml $InputObject).Root
  if ($xml) {
    if ($xml.Objects) {
      $xml.Objects.Item.GetEnumerator() | ConvertFrom-Xml @PSBoundParameters
    } elseif ($xml.Item -and $xml.Item -isnot [System.Management.Automation.PSParameterizedProperty]) {
      $xml.Item | ConvertFrom-Xml @PSBoundParameters
    } else {
      $xml | ConvertFrom-Xml @PSBoundParameters
    }
  } else {
    Write-Error "Failed to parse JSON with JsonReader" -Debug:$false
  }
}
}

function ConvertFrom-PSCustomObject
{
PARAM([Parameter(ValueFromPipeline = $true)] $InputObject)
PROCESS {
  if ($null -eq $InputObject) { return $null }

  if ($InputObject -is [System.Collections.IEnumerable] -and $InputObject -isnot [string]) {
    $collection = @(
      foreach ($object in $InputObject) { ConvertFrom-PSCustomObject $object }
    )

    $collection
  } elseif ($InputObject -is [System.Management.Automation.PSCustomObject]) {
    $hash = @{}
    foreach ($property in $InputObject.PSObject.Properties) {
      $hash[$property.Name] = ConvertFrom-PSCustomObject $property.Value
    }

    $hash
  } else {
    $InputObject
  }
}
}

function Get-ContentAsJson
{
[CmdletBinding()]
PARAM(
  [Parameter(Mandatory = $true)] $Text,
  [Parameter(Mandatory = $false)] [Text.Encoding] $Encoding = [Text.Encoding]::UTF8
)

# using polyfill cmdlet on PS2, so pass type info
if ($PSVersionTable.PSVersion -lt [Version]'3.0') {
  $Text | ConvertFrom-Json2 -Type PSObject | ConvertFrom-PSCustomObject
} else {
  $Text | ConvertFrom-Json | ConvertFrom-PSCustomObject
}
}
PS
  if result.exit_code != 0
    raise BaseError.new("Could not initialize shell: #{result.stderr.string}", "SHELL_INIT_ERROR")
  end
  @shell_initialized = true
end

#validate_extensions(ext) ⇒ Object 



368
369
370
371
372
373
 
# File 'lib/bolt/transport/winrm/connection.rb', line 368

def validate_extensions(ext)
  unless @extensions.include?(ext)
    raise Bolt::Node::FileError.new("File extension #{ext} is not enabled, "\
                        "to run it please add to 'winrm: extensions'", 'FILETYPE_ERROR')
  end
end

#with_remote_tempdir ⇒ Object 



359
360
361
362
363
364
365
366
 
# File 'lib/bolt/transport/winrm/connection.rb', line 359

def with_remote_tempdir
  dir = make_tempdir
  yield dir
ensure
  execute(<<-PS)
Remove-Item -Force -Recurse -Path "#{dir}"
PS
end

#write_executable_from_content(dir, content, filename) ⇒ Object 



383
384
385
386
387
388
 
# File 'lib/bolt/transport/winrm/connection.rb', line 383

def write_executable_from_content(dir, content, filename)
  validate_extensions(File.extname(filename))
  remote_path = "#{dir}\\#{filename}"
  write_remote_file(content, remote_path)
  remote_path
end

#write_remote_executable(dir, file, filename = nil) ⇒ Object 



375
376
377
378
379
380
381
 
# File 'lib/bolt/transport/winrm/connection.rb', line 375

def write_remote_executable(dir, file, filename = nil)
  filename ||= File.basename(file)
  validate_extensions(File.extname(filename))
  remote_path = "#{dir}\\#{filename}"
  write_remote_file(file, remote_path)
  remote_path
end

#write_remote_file(source, destination) ⇒ Object 



337
338
339
340
341
342
 
# File 'lib/bolt/transport/winrm/connection.rb', line 337

def write_remote_file(source, destination)
  fs = ::WinRM::FS::FileManager.new(@connection)
  fs.upload(source, destination)
rescue StandardError => e
  raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')
end