winrm 1.3.5 → 1.3.6

data/README.md

@@ -1,148 +1,148 @@
-# Windows Remote Management (WinRM) for Ruby
-[![Build Status](https://travis-ci.org/WinRb/WinRM.svg?branch=master)](https://travis-ci.org/WinRb/WinRM)
-[![Gem Version](https://badge.fury.io/rb/winrm.svg)](http://badge.fury.io/rb/winrm)
-
-This is a SOAP library that uses the functionality in Windows Remote
-Management(WinRM) to call native object in Windows.  This includes, but is
-not limitted to, running batch scripts, powershell scripts and fetching WMI
-variables.  For more information on WinRM, please visit Microsoft's WinRM
-site: http://msdn.microsoft.com/en-us/library/aa384426(v=VS.85).aspx
-
-## Supported WinRM Versions
-WinRM 1.1 is supported, however 2.0 and higher is recommended. [See MSDN](http://technet.microsoft.com/en-us/library/ff520073(v=ws.10).aspx) for information about WinRM versions and supported operating systems.
-
-## Install
-`gem install -r winrm` then on the server `winrm quickconfig` as admin
-
-## Example
-```ruby
-require 'winrm'
-endpoint = 'http://mywinrmhost:5985/wsman'
-krb5_realm = 'EXAMPLE.COM'
-winrm = WinRM::WinRMWebService.new(endpoint, :kerberos, :realm => krb5_realm)
-winrm.cmd('ipconfig /all') do |stdout, stderr|
-  STDOUT.print stdout
-  STDERR.print stderr
-end
-```
-
-There are various connection types you can specify upon initialization:
-
-It is recommended that you <code>:disable_sspi => true</code> if you are using the plaintext or ssl transport.
-
-#### Plaintext
-```ruby
-WinRM::WinRMWebService.new(endpoint, :plaintext, :user => myuser, :pass => mypass, :disable_sspi => true)
-
-## Same but force basic authentication:
-WinRM::WinRMWebService.new(endpoint, :plaintext, :user => myuser, :pass => mypass, :basic_auth_only => true)
-```
-
-#### SSL
-```ruby
-WinRM::WinRMWebService.new(endpoint, :ssl, :user => myuser, :pass => mypass, :disable_sspi => true)
-
-# Specifying CA path
-WinRM::WinRMWebService.new(endpoint, :ssl, :user => myuser, :pass => mypass, :ca_trust_path => '/etc/ssl/certs/cert.pem', :basic_auth_only => true)
-
-# Same but force basic authentication:
-WinRM::WinRMWebService.new(endpoint, :ssl, :user => myuser, :pass => mypass, :basic_auth_only => true)
-
-# Basic auth over SSL w/self signed cert
-# Enabling no_ssl_peer_verification is not recommended. HTTPS connections are still encrypted,
-# but the WinRM gem is not able to detect forged replies or man in the middle attacks.
-WinRM::WinRMWebService.new(endpoint, :ssl, :user => myuser, :pass => mypass, :basic_auth_only => true, :no_ssl_peer_verification => true)
-```
-
-##### Create a self signed cert for WinRM
-You may want to create a self signed certificate for servicing https WinRM connections. First you must install makecert.exe from the Windows SDK, then you can use the following PowerShell script to create a cert and enable the WinRM HTTPS listener.
-
-```powershell
-$hostname = $Env:ComputerName
- 
-C:\"Program Files"\"Microsoft SDKs"\Windows\v7.1\Bin\makecert.exe -r -pe -n "CN=$hostname,O=vagrant" -eku 1.3.6.1.5.5.7.3.1 -ss my -sr localMachine -sky exchange -sp "Microsoft RSA SChannel Cryptographic Provider" -sy 12 "$hostname.cer"
- 
-$thumbprint = (& ls cert:LocalMachine/my).Thumbprint
-$cmd = "winrm create winrm/config/Listener?Address=*+Transport=HTTPS '@{Hostname=`"$hostname`";CertificateThumbprint=`"$thumbprint`"}'"
-iex $cmd
-```
-
-#### Kerberos
-```ruby
-WinRM::WinRMWebService.new(endpoint, :kerberos, :realm => 'MYREALM.COM')
-```
-
-## Troubleshooting
-You may have some errors like ```WinRM::WinRMAuthorizationError```.
-You can run the following commands on the server to try to solve the problem:
-```
-winrm set winrm/config/client/auth @{Basic="true"}
-winrm set winrm/config/service/auth @{Basic="true"}
-winrm set winrm/config/service @{AllowUnencrypted="true"}
-```
-You can read more about that on issue [#29](https://github.com/WinRb/WinRM/issues/29)
-
-
-## Current features
-
-1. GSSAPI support:  This is the default way that Windows authenticates and
-   secures WinRM messages. In order for this to work the computer you are
-   connecting to must be a part of an Active Directory domain and you must
-   have local credentials via kinit. GSSAPI support is dependent on the
-   gssapi gem which only supports the MIT Kerberos libraries at this time.
-
-   If you are using this method there is no longer a need to change the
-   WinRM service authentication settings. You can simply do a
-   'winrm quickconfig' on your server or enable WinRM via group policy and
-   everything should be working.
-
-2. Multi-Instance support:  Moving away from Handsoap allows multiple
-   instances to be created because the SOAP backend is no longer a Singleton
-   type class.
-
-3. 100% Ruby: Nokogiri while faster can present additional frustration for
-   users above and beyond what is already required to get WinRM working.
-   The goal of this gem is make using WinRM easy. In V2 we plan on making
-   the parser swappable in case you really do need the performance.
-
-## Contributing
-
-1. Fork it.
-2. Create a branch (git checkout -b my_feature_branch)
-3. Run the unit and integration tests (bundle exec rake integration)
-4. Commit your changes (git commit -am "Added a sweet feature")
-5. Push to the branch (git push origin my_feature_branch)
-6. Create a pull requst from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
-
-### Running the tests
-
-We use Bundler to manage dependencies during development.
-
-```
-$ bundle install
-```
-
-Once you have the dependencies, you can run the unit tests with `rake`:
-
-```
-$ bundle exec rake spec
-```
-
-To run the integration tests you will need a Windows box with the WinRM service properly configured. Its easiest to use a Vagrant Windows box.
-
-1. Create a Windows VM with WinRM configured (see above).
-2. Copy the config-example.yml to config.yml - edit this file with your WinRM connection details.
-3. Ensure that the box you are running the test against has a default shell profile (check ~\Documents\WindowsPowerShell).  If any of your shell profiles generate stdout or stderr output, the test validators may get thrown off.
-4. Run `bundle exec rake integration`
-
-## WinRM Author
-* Twitter: [@zentourist](https://twitter.com/zentourist)
-* BLOG:  [http://distributed-frostbite.blogspot.com/](http://distributed-frostbite.blogspot.com/)
-* Add me in LinkedIn:  [http://www.linkedin.com/in/danwanek](http://www.linkedin.com/in/danwanek)
-* Find me on irc.freenode.net in #ruby-lang (zenChild)
-
-## Maintainers
-* Paul Morton (https://github.com/pmorton)
-* Shawn Neal (https://github.com/sneal)
-
-[Contributors](https://github.com/WinRb/WinRM/graphs/contributors)
+# Windows Remote Management (WinRM) for Ruby
+[![Build Status](https://travis-ci.org/WinRb/WinRM.svg?branch=master)](https://travis-ci.org/WinRb/WinRM)
+[![Gem Version](https://badge.fury.io/rb/winrm.svg)](http://badge.fury.io/rb/winrm)
+
+This is a SOAP library that uses the functionality in Windows Remote
+Management(WinRM) to call native object in Windows.  This includes, but is
+not limitted to, running batch scripts, powershell scripts and fetching WMI
+variables.  For more information on WinRM, please visit Microsoft's WinRM
+site: http://msdn.microsoft.com/en-us/library/aa384426(v=VS.85).aspx
+
+## Supported WinRM Versions
+WinRM 1.1 is supported, however 2.0 and higher is recommended. [See MSDN](http://technet.microsoft.com/en-us/library/ff520073(v=ws.10).aspx) for information about WinRM versions and supported operating systems.
+
+## Install
+`gem install -r winrm` then on the server `winrm quickconfig` as admin
+
+## Example
+```ruby
+require 'winrm'
+endpoint = 'http://mywinrmhost:5985/wsman'
+krb5_realm = 'EXAMPLE.COM'
+winrm = WinRM::WinRMWebService.new(endpoint, :kerberos, :realm => krb5_realm)
+winrm.cmd('ipconfig /all') do |stdout, stderr|
+  STDOUT.print stdout
+  STDERR.print stderr
+end
+```
+
+There are various connection types you can specify upon initialization:
+
+It is recommended that you <code>:disable_sspi => true</code> if you are using the plaintext or ssl transport.
+
+#### Plaintext
+```ruby
+WinRM::WinRMWebService.new(endpoint, :plaintext, :user => myuser, :pass => mypass, :disable_sspi => true)
+
+## Same but force basic authentication:
+WinRM::WinRMWebService.new(endpoint, :plaintext, :user => myuser, :pass => mypass, :basic_auth_only => true)
+```
+
+#### SSL
+```ruby
+WinRM::WinRMWebService.new(endpoint, :ssl, :user => myuser, :pass => mypass, :disable_sspi => true)
+
+# Specifying CA path
+WinRM::WinRMWebService.new(endpoint, :ssl, :user => myuser, :pass => mypass, :ca_trust_path => '/etc/ssl/certs/cert.pem', :basic_auth_only => true)
+
+# Same but force basic authentication:
+WinRM::WinRMWebService.new(endpoint, :ssl, :user => myuser, :pass => mypass, :basic_auth_only => true)
+
+# Basic auth over SSL w/self signed cert
+# Enabling no_ssl_peer_verification is not recommended. HTTPS connections are still encrypted,
+# but the WinRM gem is not able to detect forged replies or man in the middle attacks.
+WinRM::WinRMWebService.new(endpoint, :ssl, :user => myuser, :pass => mypass, :basic_auth_only => true, :no_ssl_peer_verification => true)
+```
+
+##### Create a self signed cert for WinRM
+You may want to create a self signed certificate for servicing https WinRM connections. First you must install makecert.exe from the Windows SDK, then you can use the following PowerShell script to create a cert and enable the WinRM HTTPS listener.
+
+```powershell
+$hostname = $Env:ComputerName
+ 
+C:\"Program Files"\"Microsoft SDKs"\Windows\v7.1\Bin\makecert.exe -r -pe -n "CN=$hostname,O=vagrant" -eku 1.3.6.1.5.5.7.3.1 -ss my -sr localMachine -sky exchange -sp "Microsoft RSA SChannel Cryptographic Provider" -sy 12 "$hostname.cer"
+ 
+$thumbprint = (& ls cert:LocalMachine/my).Thumbprint
+$cmd = "winrm create winrm/config/Listener?Address=*+Transport=HTTPS '@{Hostname=`"$hostname`";CertificateThumbprint=`"$thumbprint`"}'"
+iex $cmd
+```
+
+#### Kerberos
+```ruby
+WinRM::WinRMWebService.new(endpoint, :kerberos, :realm => 'MYREALM.COM')
+```
+
+## Troubleshooting
+You may have some errors like ```WinRM::WinRMAuthorizationError```.
+You can run the following commands on the server to try to solve the problem:
+```
+winrm set winrm/config/client/auth @{Basic="true"}
+winrm set winrm/config/service/auth @{Basic="true"}
+winrm set winrm/config/service @{AllowUnencrypted="true"}
+```
+You can read more about that on issue [#29](https://github.com/WinRb/WinRM/issues/29)
+
+
+## Current features
+
+1. GSSAPI support:  This is the default way that Windows authenticates and
+   secures WinRM messages. In order for this to work the computer you are
+   connecting to must be a part of an Active Directory domain and you must
+   have local credentials via kinit. GSSAPI support is dependent on the
+   gssapi gem which only supports the MIT Kerberos libraries at this time.
+
+   If you are using this method there is no longer a need to change the
+   WinRM service authentication settings. You can simply do a
+   'winrm quickconfig' on your server or enable WinRM via group policy and
+   everything should be working.
+
+2. Multi-Instance support:  Moving away from Handsoap allows multiple
+   instances to be created because the SOAP backend is no longer a Singleton
+   type class.
+
+3. 100% Ruby: Nokogiri while faster can present additional frustration for
+   users above and beyond what is already required to get WinRM working.
+   The goal of this gem is make using WinRM easy. In V2 we plan on making
+   the parser swappable in case you really do need the performance.
+
+## Contributing
+
+1. Fork it.
+2. Create a branch (git checkout -b my_feature_branch)
+3. Run the unit and integration tests (bundle exec rake integration)
+4. Commit your changes (git commit -am "Added a sweet feature")
+5. Push to the branch (git push origin my_feature_branch)
+6. Create a pull requst from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
+
+### Running the tests
+
+We use Bundler to manage dependencies during development.
+
+```
+$ bundle install
+```
+
+Once you have the dependencies, you can run the unit tests with `rake`:
+
+```
+$ bundle exec rake spec
+```
+
+To run the integration tests you will need a Windows box with the WinRM service properly configured. Its easiest to use a Vagrant Windows box.
+
+1. Create a Windows VM with WinRM configured (see above).
+2. Copy the config-example.yml to config.yml - edit this file with your WinRM connection details.
+3. Ensure that the box you are running the test against has a default shell profile (check ~\Documents\WindowsPowerShell).  If any of your shell profiles generate stdout or stderr output, the test validators may get thrown off.
+4. Run `bundle exec rake integration`
+
+## WinRM Author
+* Twitter: [@zentourist](https://twitter.com/zentourist)
+* BLOG:  [http://distributed-frostbite.blogspot.com/](http://distributed-frostbite.blogspot.com/)
+* Add me in LinkedIn:  [http://www.linkedin.com/in/danwanek](http://www.linkedin.com/in/danwanek)
+* Find me on irc.freenode.net in #ruby-lang (zenChild)
+
+## Maintainers
+* Paul Morton (https://github.com/pmorton)
+* Shawn Neal (https://github.com/sneal)
+
+[Contributors](https://github.com/WinRb/WinRM/graphs/contributors)

data/Rakefile

@@ -1,28 +1,28 @@
-# encoding: UTF-8
-require 'rubygems'
-require 'bundler/setup'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'bundler/gem_tasks'
-
-# Change to the directory of this file.
-Dir.chdir(File.expand_path('../', __FILE__))
-
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.pattern = 'spec/*_spec.rb'
-  task.rspec_opts = ['--color', '-f documentation']
-  task.rspec_opts << '-tunit'
-end
-
-# Run the integration test suite
-RSpec::Core::RakeTask.new(:integration) do |task|
-  task.pattern = 'spec/*_spec.rb'
-  task.rspec_opts = ['--color', '-f documentation']
-  task.rspec_opts << '-tintegration'
-end
-
-RuboCop::RakeTask.new
-
-task default: [:spec, :rubocop]
-
-task all: [:default, :integration]
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path('../', __FILE__))
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/*_spec.rb'
+  task.rspec_opts = ['--color', '-f documentation']
+  task.rspec_opts << '-tunit'
+end
+
+# Run the integration test suite
+RSpec::Core::RakeTask.new(:integration) do |task|
+  task.pattern = 'spec/*_spec.rb'
+  task.rspec_opts = ['--color', '-f documentation']
+  task.rspec_opts << '-tintegration'
+end
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]
+
+task all: [:default, :integration]

data/VERSION

@@ -1 +1 @@
-1.3.5
+1.3.6

data/Vagrantfile

@@ -1,9 +1,9 @@
-# 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
+# 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

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