winrm 1.8.1 → 2.0.0

data/Vagrantfile

@@ -1,9 +1,6 @@
-# encoding: UTF-8
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
-
-VAGRANTFILE_API_VERSION = '2'
-
-Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  config.vm.box = 'mwrock/Windows2012R2'
-end
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "mwrock/WindowsNano"
+end

data/WinrmAppveyor.psm1

@@ -1,32 +1,32 @@
-function New-ClientCertificate {
-  param([String]$username, [String]$basePath = ((Resolve-Parh .).Path))
-
-  $env:OPENSSL_CONF=[System.IO.Path]::GetTempFileName()
-
-  Set-Content -Path $env:OPENSSL_CONF -Value @"
-  distinguished_name = req_distinguished_name
-  [req_distinguished_name]
-  [v3_req_client]
-  extendedKeyUsage = clientAuth
-  subjectAltName = otherName:1.3.6.1.4.1.311.20.2.3;UTF8:$username@localhost
-"@
-
-  $user_path = Join-Path $basePath user.pem
-  $key_path = Join-Path $basePath key.pem
-  $pfx_path = Join-Path $basePath user.pfx
-
-  openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -out $user_path -outform PEM -keyout $key_path -subj "/CN=$username" -extensions v3_req_client 2>&1
-
-  openssl pkcs12 -export -in $user_path -inkey $key_path -out $pfx_path -passout pass: 2>&1
-
-  del $env:OPENSSL_CONF
-}
-
-function New-WinrmUserCertificateMapping {
-  param([String]$issuer)
-  $secure_pass = ConvertTo-SecureString $env:winrm_pass -AsPlainText -Force
-  $cred = New-Object System.Management.Automation.PSCredential ($env:winrm_user, $secure_pass)
-  New-Item -Path WSMan:\localhost\ClientCertificate -Subject "$env:winrm_user@localhost" -URI * -Issuer $issuer -Credential $cred -Force
-}
-
+function New-ClientCertificate {
+  param([String]$username, [String]$basePath = ((Resolve-Path .).Path))
+
+  $env:OPENSSL_CONF=[System.IO.Path]::GetTempFileName()
+
+  Set-Content -Path $env:OPENSSL_CONF -Value @"
+  distinguished_name = req_distinguished_name
+  [req_distinguished_name]
+  [v3_req_client]
+  extendedKeyUsage = clientAuth
+  subjectAltName = otherName:1.3.6.1.4.1.311.20.2.3;UTF8:$username@localhost
+"@
+
+  $user_path = Join-Path $basePath user.pem
+  $key_path = Join-Path $basePath key.pem
+  $pfx_path = Join-Path $basePath user.pfx
+
+  openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -out $user_path -outform PEM -keyout $key_path -subj "/CN=$username" -extensions v3_req_client 2>&1
+
+  openssl pkcs12 -export -in $user_path -inkey $key_path -out $pfx_path -passout pass: 2>&1
+
+  del $env:OPENSSL_CONF
+}
+
+function New-WinrmUserCertificateMapping {
+  param([String]$issuer)
+  $secure_pass = ConvertTo-SecureString $env:winrm_password -AsPlainText -Force
+  $cred = New-Object System.Management.Automation.PSCredential ($env:winrm_user, $secure_pass)
+  New-Item -Path WSMan:\localhost\ClientCertificate -Subject "$env:winrm_user@localhost" -URI * -Issuer $issuer -Credential $cred -Force
+}
+
 Export-ModuleMember New-ClientCertificate, New-WinrmUserCertificateMapping

data/appveyor.yml

@@ -1,51 +1,51 @@
-version: "master-{build}"
-
-os: Windows Server 2012 R2
-platform:
-  - x64
-
-environment:
-  winrm_user: test_user
-  winrm_pass: Pass@word1
-  user_cert: c:\projects\winrm\user.pem
-  user_key: c:\projects\winrm\key.pem
-
-  matrix:
-    - ruby_version: "21"
-      winrm_endpoint: http://localhost:5985/wsman
-
-clone_folder: c:\projects\winrm
-clone_depth: 1
-branches:
-  only:
-    - master
-
-install:
-  - ps: net user /add $env:winrm_user $env:winrm_pass
-  - ps: net localgroup administrators $env:winrm_user /add
-  - ps: $env:PATH="C:\OpenSSL-Win64\bin;$env:PATH"
-  - ps: Import-Module c:\projects\winrm\WinrmAppveyor.psm1
-  - ps: New-ClientCertificate $env:winrm_user c:\projects\winrm
-  - ps: $env:user_cert_thumb = (Import-pfxCertificate -FilePath c:\projects\winrm\user.pfx -CertStoreLocation Cert:\LocalMachine\root).Thumbprint
-  - ps: Import-pfxCertificate -FilePath c:\projects\winrm\user.pfx -CertStoreLocation Cert:\LocalMachine\TrustedPeople
-  - ps: $env:winrm_cert = (New-SelfSignedCertificate -DnsName localhost -CertStoreLocation cert:\localmachine\my).Thumbprint
-  - ps: winrm create winrm/config/Listener?Address=*+Transport=HTTPS "@{Hostname=`"localhost`";CertificateThumbprint=`"$($env:winrm_cert)`"}"
-  - ps: winrm set winrm/config/client/auth '@{Basic="true"}'
-  - ps: winrm set winrm/config/service/auth '@{Basic="true"}'
-  - ps: winrm set winrm/config/service/auth '@{Certificate="true"}'
-  - ps: winrm set winrm/config/service/auth '@{CbtHardeningLevel="Strict"}'
-  - ps: winrm set winrm/config/service '@{AllowUnencrypted="true"}'
-  - ps: New-WinrmUserCertificateMapping $env:user_cert_thumb
-  - ps: $env:PATH="C:\Ruby$env:ruby_version\bin;$env:PATH"
-  - ps: Write-Host $env:PATH
-  - ps: ruby --version
-  - ps: gem --version
-  - ps: gem install bundler --quiet --no-ri --no-rdoc
-  - ps: bundler --version
-
-build_script:
-  - bundle install || bundle install || bundle install
-
-test_script:
-  - SET SPEC_OPTS=--format progress
-  - bundle exec rake integration
+version: "master-{build}"
+
+os: Windows Server 2012 R2
+platform:
+  - x64
+
+environment:
+  winrm_user: test_user
+  winrm_password: Pass@word1
+  user_cert: c:\projects\winrm\user.pem
+  user_key: c:\projects\winrm\key.pem
+
+  matrix:
+    - ruby_version: "21"
+      winrm_endpoint: http://localhost:5985/wsman
+
+clone_folder: c:\projects\winrm
+clone_depth: 1
+branches:
+  only:
+    - master
+
+install:
+  - ps: net user /add $env:winrm_user $env:winrm_password
+  - ps: net localgroup administrators $env:winrm_user /add
+  - ps: $env:PATH="C:\OpenSSL-Win64\bin;$env:PATH"
+  - ps: Import-Module c:\projects\winrm\WinrmAppveyor.psm1
+  - ps: New-ClientCertificate $env:winrm_user c:\projects\winrm
+  - ps: $env:user_cert_thumb = (Import-pfxCertificate -FilePath c:\projects\winrm\user.pfx -CertStoreLocation Cert:\LocalMachine\root).Thumbprint
+  - ps: Import-pfxCertificate -FilePath c:\projects\winrm\user.pfx -CertStoreLocation Cert:\LocalMachine\TrustedPeople
+  - ps: $env:winrm_cert = (New-SelfSignedCertificate -DnsName localhost -CertStoreLocation cert:\localmachine\my).Thumbprint
+  - ps: winrm create winrm/config/Listener?Address=*+Transport=HTTPS "@{Hostname=`"localhost`";CertificateThumbprint=`"$($env:winrm_cert)`"}"
+  - ps: winrm set winrm/config/client/auth '@{Basic="true"}'
+  - ps: winrm set winrm/config/service/auth '@{Basic="true"}'
+  - ps: winrm set winrm/config/service/auth '@{Certificate="true"}'
+  - ps: winrm set winrm/config/service/auth '@{CbtHardeningLevel="Strict"}'
+  - ps: winrm set winrm/config/service '@{AllowUnencrypted="true"}'
+  - ps: New-WinrmUserCertificateMapping $env:user_cert_thumb
+  - ps: $env:PATH="C:\Ruby$env:ruby_version\bin;$env:PATH"
+  - ps: Write-Host $env:PATH
+  - ps: ruby --version
+  - ps: gem --version
+  - ps: gem install bundler --quiet --no-ri --no-rdoc
+  - ps: bundler --version
+
+build_script:
+  - bundle install || bundle install || bundle install
+
+test_script:
+  - SET SPEC_OPTS=--format progress
+  - bundle exec rake integration

data/bin/rwinrm

@@ -1,97 +1,97 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-# Copyright 2014 Shawn Neal <sneal@sneal.net>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# rubocop:disable all
-
-$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
-
-require 'readline'
-require 'io/console'
-require 'winrm'
-
-def help_msg
-  puts 'Usage: rwinrm user@host'
-  puts ''
-end
-
-def parse_options
-  options = {}
-  fail 'Missing required options' unless ARGV.length == 1
-
-  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?/i.match(ARGV[0])
-  fail "#{ARGV[0]} is an invalid host" unless m
-  options[:user] = m[:user]
-  options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
-
-  # Get the password
-  print 'Password: '
-  options[:pass] = STDIN.noecho(&:gets).chomp
-  puts
-
-  # Set some defaults required by WinRM WS
-  options[:auth_type] = :plaintext
-  options[:basic_auth_only] = true
-
-  options
-rescue StandardError => e
-  puts e.message
-  help_msg
-  exit 1
-end
-
-def repl(options)
-  client = WinRM::WinRMWebService.new(
-    options[:endpoint],
-    options[:auth_type].to_sym,
-    options)
-
-  client.set_timeout(3600)
-  shell_id = client.open_shell
-  command_id = client.run_command(shell_id, 'cmd', "/K prompt [#{ARGV[0]}]$P$G")
-
-  read_thread = Thread.new do
-    client.get_command_output(shell_id, command_id) do |stdout, stderr|
-      STDOUT.write stdout
-      STDERR.write stderr
-    end
-  end
-  read_thread.abort_on_exception = true
-
-  while (buf = Readline.readline('', true))
-    if buf =~ /^exit/
-      read_thread.exit
-      client.cleanup_command(shell_id, command_id)
-      client.close_shell(shell_id)
-      exit 0
-    else
-      client.write_stdin(shell_id, command_id, "#{buf}\r\n")
-    end
-  end
-rescue Interrupt
-  puts 'exiting'
-  # ctrl-c
-rescue WinRM::WinRMAuthorizationError
-  puts 'Authentication failed, bad user name or password'
-  exit 1
-rescue StandardError => e
-  puts e.message
-  exit 1
-end
-
-repl(parse_options)
-
-# rubocop:enable all
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# Copyright 2014 Shawn Neal <sneal@sneal.net>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# rubocop:disable all
+
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'readline'
+require 'io/console'
+require 'winrm'
+
+def help_msg
+  puts 'Usage: rwinrm user@host'
+  puts ''
+end
+
+def parse_options
+  options = {}
+  fail 'Missing required options' unless ARGV.length == 1
+
+  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?/i.match(ARGV[0])
+  fail "#{ARGV[0]} is an invalid host" unless m
+  options[:user] = m[:user]
+  options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
+
+  # Get the password
+  print 'Password: '
+  options[:pass] = STDIN.noecho(&:gets).chomp
+  puts
+
+  # Set some defaults required by WinRM WS
+  options[:auth_type] = :plaintext
+  options[:basic_auth_only] = true
+
+  options
+rescue StandardError => e
+  puts e.message
+  help_msg
+  exit 1
+end
+
+def repl(options)
+  client = WinRM::WinRMWebService.new(
+    options[:endpoint],
+    options[:auth_type].to_sym,
+    options)
+
+  client.set_timeout(3600)
+  shell_id = client.open_shell
+  command_id = client.run_command(shell_id, 'cmd', "/K prompt [#{ARGV[0]}]$P$G")
+
+  read_thread = Thread.new do
+    client.get_command_output(shell_id, command_id) do |stdout, stderr|
+      STDOUT.write stdout
+      STDERR.write stderr
+    end
+  end
+  read_thread.abort_on_exception = true
+
+  while (buf = Readline.readline('', true))
+    if buf =~ /^exit/
+      read_thread.exit
+      client.cleanup_command(shell_id, command_id)
+      client.close_shell(shell_id)
+      exit 0
+    else
+      client.write_stdin(shell_id, command_id, "#{buf}\r\n")
+    end
+  end
+rescue Interrupt
+  puts 'exiting'
+  # ctrl-c
+rescue WinRM::WinRMAuthorizationError
+  puts 'Authentication failed, bad user name or password'
+  exit 1
+rescue StandardError => e
+  puts e.message
+  exit 1
+end
+
+repl(parse_options)
+
+# rubocop:enable all

data/changelog.md

@@ -1,86 +1,86 @@
-# WinRM Gem Changelog
-
-# 1.8.1
-- Http receive timeout should always be equal to 10 seconds greater than the winrm operation timeout and not default to one hour
-
-# 1.8.0
-- Add certificate authentication
-
-# 1.7.3
-- Open a new shell if the current shell has been deleted
-
-# 1.7.2
-- Fix regression where BOM appears in 2008R2 output and is not stripped
-
-# 1.7.1
-- Fix OS version comparisons for Windows 10 using `Gem::Version` instead of strings
-
-# 1.7.0
-- Bump rubyntlm gem to 0.6.0 to get channel binding support for HTTPS fixing connections to endoints with `CbtHardeningLevel` set to `Strict`
-- Fix for parsing binary data in command output
-
-# 1.6.1
-- Use codepage 437 by default on os versions older than Windows 7 and Windows Server 2008 R2
-
-# 1.6.0
-- Adding `:negotiate` transport providing NTLM/Negotiate encryption of WinRM requests and responses
-- Removed dependency on UUIDTools gem
-- Extending accepted error codes for retry behavior to include `Errno::ETIMEDOUT`
-- Correct deprecation warning for WinRMWebService.run_powershell_script
-
-# 1.5.0
-- Deprecating `WinRM::WinRMWebService` methods `cmd`, `run_cmd`, `powershell`, and `run_powershell_script` in favor of the `run_cmd` and `run_powershell_script` methods of the `WinRM::CommandExecutor` class. The `CommandExecutor` allows multiple commands to be run from the same WinRM shell providing a significant performance improvement when issuing multiple calls.
-- Added an `:ssl_peer_fingerprint` option to be used instead of `:no_ssl_peer_verification` and allows a specific certificate to be verified.
-- Opening a winrm shell is retriable with configurable delay and retry limit.
-- Logging apends to `stdout` by default and can be replaced with a logger from a consuming application.
-
-# 1.4.0
-- Added WinRM::Version so the gem version is available at runtime for consumers.
-
-# 1.3.6
-- Remove BOM from response (Issue #159) added by Windows 2008R2
-
-# 1.3.5
-- Widen logging version constraints to include 2.0
-- Use codepage 65001 (UTF-8)
-
-# 1.3.4
-- Relaxed version pins on dev dependencies
-
-# 1.3.3
-- Fixed issue 133, rwinrm allow hostnames with dashes
-- Use duck typing for powershell script read
-
-# 1.3.2
-- Add spec.license attribute to gemspec
-- Bump RSpec dependency 3.0 to 3.2
-
-# 1.3.1
-- Fixed issue 129, long running commands could cause a stackoverflow exception
-- Fixed use of sub! in run_command results in spurious capture/replacement of \& sequences
-- Fixed issue 124 rwinrm won't take '.' characters in username
-
-# 1.3.0
-- Fixed multiple issues with WinRMHTTPTransportError incorrectly being raised
-- Refactored and added more unit and integration tests
-- Added ability to write to stdin
-- Added rwinrm binary to launch remote shell
-- Added WINRM_LOG env var to set log level
-- Retry Kerberos auth once if 401 response is received
-- Remove Savon dependency and use newer versions of underlying dependencies
-- Remove Nokogiri dependency and replace with native Ruby XML
-- Fixed issue 85, ensure WQL response is not nil
-- All WinRM library errors inherit from base class WinRMError
-- Integrations tests should now pass on Windows Server 2008+
-- Bump Ruby NTLM gem version dependency
-- HTTP client receive timeout is now configurable via set_timeout
-- Added backwards compatible Output class to make it easier to collect output
-- Bumped gssapi dependency from 1.0 to 1.2 and fixed issue 54
-- Added Rubocop to build
-- Fixed error when commands contain a newline character
-
-# 1.2.0
-- Allow user to disable SSL peer ceritifcate validation #44
-- Allow commands with "'" chars on Ruby 2.x, fixes #69
-- Fixed uninitialized constant Module::Kconv in Ruby 2.x, fixes #65
-- Commands with non-ASCII chars should work, #70
+# WinRM Gem Changelog
+
+# 1.8.1
+- Http receive timeout should always be equal to 10 seconds greater than the winrm operation timeout and not default to one hour
+
+# 1.8.0
+- Add certificate authentication
+
+# 1.7.3
+- Open a new shell if the current shell has been deleted
+
+# 1.7.2
+- Fix regression where BOM appears in 2008R2 output and is not stripped
+
+# 1.7.1
+- Fix OS version comparisons for Windows 10 using `Gem::Version` instead of strings
+
+# 1.7.0
+- Bump rubyntlm gem to 0.6.0 to get channel binding support for HTTPS fixing connections to endoints with `CbtHardeningLevel` set to `Strict`
+- Fix for parsing binary data in command output
+
+# 1.6.1
+- Use codepage 437 by default on os versions older than Windows 7 and Windows Server 2008 R2
+
+# 1.6.0
+- Adding `:negotiate` transport providing NTLM/Negotiate encryption of WinRM requests and responses
+- Removed dependency on UUIDTools gem
+- Extending accepted error codes for retry behavior to include `Errno::ETIMEDOUT`
+- Correct deprecation warning for WinRMWebService.run_powershell_script
+
+# 1.5.0
+- Deprecating `WinRM::WinRMWebService` methods `cmd`, `run_cmd`, `powershell`, and `run_powershell_script` in favor of the `run_cmd` and `run_powershell_script` methods of the `WinRM::CommandExecutor` class. The `CommandExecutor` allows multiple commands to be run from the same WinRM shell providing a significant performance improvement when issuing multiple calls.
+- Added an `:ssl_peer_fingerprint` option to be used instead of `:no_ssl_peer_verification` and allows a specific certificate to be verified.
+- Opening a winrm shell is retriable with configurable delay and retry limit.
+- Logging apends to `stdout` by default and can be replaced with a logger from a consuming application.
+
+# 1.4.0
+- Added WinRM::Version so the gem version is available at runtime for consumers.
+
+# 1.3.6
+- Remove BOM from response (Issue #159) added by Windows 2008R2
+
+# 1.3.5
+- Widen logging version constraints to include 2.0
+- Use codepage 65001 (UTF-8)
+
+# 1.3.4
+- Relaxed version pins on dev dependencies
+
+# 1.3.3
+- Fixed issue 133, rwinrm allow hostnames with dashes
+- Use duck typing for powershell script read
+
+# 1.3.2
+- Add spec.license attribute to gemspec
+- Bump RSpec dependency 3.0 to 3.2
+
+# 1.3.1
+- Fixed issue 129, long running commands could cause a stackoverflow exception
+- Fixed use of sub! in run_command results in spurious capture/replacement of \& sequences
+- Fixed issue 124 rwinrm won't take '.' characters in username
+
+# 1.3.0
+- Fixed multiple issues with WinRMHTTPTransportError incorrectly being raised
+- Refactored and added more unit and integration tests
+- Added ability to write to stdin
+- Added rwinrm binary to launch remote shell
+- Added WINRM_LOG env var to set log level
+- Retry Kerberos auth once if 401 response is received
+- Remove Savon dependency and use newer versions of underlying dependencies
+- Remove Nokogiri dependency and replace with native Ruby XML
+- Fixed issue 85, ensure WQL response is not nil
+- All WinRM library errors inherit from base class WinRMError
+- Integrations tests should now pass on Windows Server 2008+
+- Bump Ruby NTLM gem version dependency
+- HTTP client receive timeout is now configurable via set_timeout
+- Added backwards compatible Output class to make it easier to collect output
+- Bumped gssapi dependency from 1.0 to 1.2 and fixed issue 54
+- Added Rubocop to build
+- Fixed error when commands contain a newline character
+
+# 1.2.0
+- Allow user to disable SSL peer ceritifcate validation #44
+- Allow commands with "'" chars on Ruby 2.x, fixes #69
+- Fixed uninitialized constant Module::Kconv in Ruby 2.x, fixes #65
+- Commands with non-ASCII chars should work, #70