winrm 1.3.0 → 1.3.1

data/README.md

@@ -132,7 +132,8 @@ To run the integration tests you will need a Windows box with the WinRM service
 
 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. Run `bundle exec rake integration`
+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)

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.3.1

data/bin/rwinrm

@@ -32,7 +32,7 @@ def parse_options
   options = {}
   fail 'Missing required options' unless ARGV.length == 1
 
-  m = /^(?<user>\w+)@{1}(?<host>[a-zA-Z0-9\.]+)(?<port>:[0-9]+)?/.match(ARGV[0])
+  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"

data/changelog.md

@@ -1,5 +1,10 @@
 # WinRM Gem Changelog
 
+# 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

data/lib/winrm/winrm_service.rb

@@ -164,7 +164,7 @@ module WinRM
       # Grab the command element and unescape any single quotes - issue 69
       xml = builder.target!
       escaped_cmd = /<#{NS_WIN_SHELL}:Command>(.+)<\/#{NS_WIN_SHELL}:Command>/m.match(xml)[1]
-      xml.sub!(escaped_cmd, escaped_cmd.gsub(/&#39;/, "'"))
+      xml[escaped_cmd] = escaped_cmd.gsub(/&#39;/, "'")
 
       resp_doc = send_message(xml)
       command_id = REXML::XPath.first(resp_doc, "//#{NS_WIN_SHELL}:CommandId").text
@@ -222,41 +222,35 @@ module WinRM
         end
       end
 
-      resp_doc = send_message(builder.target!)
+      resp_doc = nil
+      request_msg = builder.target!
+      done_elems = []
       output = Output.new
-      REXML::XPath.match(resp_doc, "//#{NS_WIN_SHELL}:Stream").each do |n|
-        next if n.text.nil? || n.text.empty?
-        stream = { n.attributes['Name'].to_sym => Base64.decode64(n.text) }
-        output[:data] << stream
-        yield stream[:stdout], stream[:stderr] if block_given?
-      end
 
-      # We may need to get additional output if the stream has not finished.
-      # The CommandState will change from Running to Done like so:
-      # @example
-      #   from...
-      #   <rsp:CommandState CommandId="..." State="http://schemas.microsoft.com/wbem/wsman/1/windows/shell/CommandState/Running"/>
-      #   to...
-      #   <rsp:CommandState CommandId="..." State="http://schemas.microsoft.com/wbem/wsman/1/windows/shell/CommandState/Done">
-      #     <rsp:ExitCode>0</rsp:ExitCode>
-      #   </rsp:CommandState>
-      #if ((resp/"//*[@State='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/CommandState/Done']").empty?)
-      done_elems = REXML::XPath.match(resp_doc, "//*[@State='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/CommandState/Done']")
-      if done_elems.empty?
-        output.merge!(get_command_output(shell_id, command_id, &block)) do |key, old_data, new_data|
-          old_data += new_data
+      while done_elems.empty?
+        resp_doc = send_get_output_message(request_msg)
+
+        REXML::XPath.match(resp_doc, "//#{NS_WIN_SHELL}:Stream").each do |n|
+          next if n.text.nil? || n.text.empty?
+          stream = { n.attributes['Name'].to_sym => Base64.decode64(n.text) }
+          output[:data] << stream
+          yield stream[:stdout], stream[:stderr] if block_given?
         end
-      else
-        output[:exitcode] = REXML::XPath.first(resp_doc, "//#{NS_WIN_SHELL}:ExitCode").text.to_i
+
+        # We may need to get additional output if the stream has not finished.
+        # The CommandState will change from Running to Done like so:
+        # @example
+        #   from...
+        #   <rsp:CommandState CommandId="..." State="http://schemas.microsoft.com/wbem/wsman/1/windows/shell/CommandState/Running"/>
+        #   to...
+        #   <rsp:CommandState CommandId="..." State="http://schemas.microsoft.com/wbem/wsman/1/windows/shell/CommandState/Done">
+        #     <rsp:ExitCode>0</rsp:ExitCode>
+        #   </rsp:CommandState>
+        done_elems = REXML::XPath.match(resp_doc, "//*[@State='http://schemas.microsoft.com/wbem/wsman/1/windows/shell/CommandState/Done']")
       end
+
+      output[:exitcode] = REXML::XPath.first(resp_doc, "//#{NS_WIN_SHELL}:ExitCode").text.to_i
       output
-    rescue WinRMWSManFault => e
-      # If no output is available before the wsman:OperationTimeout expires,
-      # the server MUST return a WSManFault with the Code attribute equal to
-      # 2150858793. When the client receives this fault, it SHOULD issue 
-      # another Receive request.
-      # http://msdn.microsoft.com/en-us/library/cc251676.aspx
-      retry if e.fault_code == '2150858793'
     end
 
     # Clean-up after a command.
@@ -417,6 +411,21 @@ module WinRM
       hdr
     end
 
+    def send_get_output_message(message)
+      send_message(message)
+    rescue WinRMWSManFault => e
+      # If no output is available before the wsman:OperationTimeout expires,
+      # the server MUST return a WSManFault with the Code attribute equal to
+      # 2150858793. When the client receives this fault, it SHOULD issue 
+      # another Receive request.
+      # http://msdn.microsoft.com/en-us/library/cc251676.aspx
+      if e.fault_code == '2150858793'
+        retry
+      else
+        raise
+      end
+    end
+
     def send_message(message)
       @xfer.send_request(message)
     end

data/spec/cmd_spec.rb

@@ -25,6 +25,16 @@ describe 'winrm client cmd', integration: true do
     it { should have_no_stderr }
   end
 
+  describe 'echo "string with trailing \\" using double quotes' do
+    # This is a regression test for #131.  " is converted to " when serializing
+    # the command to SOAP/XML.  Any naive substitution performed on such a serialized
+    # string can result in any \& sequence being interpreted as a back-substitution.
+    subject(:output) { @winrm.cmd('echo "string with trailing \\"') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/string with trailing \\/) }
+    it { should have_no_stderr }
+  end
+
   describe 'capturing output from stdout and stderr' do
     subject(:output) do
       # Note: Multiple lines doesn't work:

data/spec/config-example.yml

@@ -1,12 +1,19 @@
+# Copy this file to config.yml and edit the settings below.
+# This should work out of the box for vagrant provisioned boxes.
+
 ## Kerberos
-#auth_type: plaintest
+#auth_type: kerberos
 #endpoint: "http://<yourserver>:5985/wsman"
 #options:
 #  realm: "your.realm"
 
 ## Plain Text
 auth_type: plaintext
+# If you are running this in a vagrant provisioned box using NAT,
+# this will be the forwarded WinRM HTTP port to your VM.
+# If you are running this on the VM, the default HTTP port is 5985.
+# See README.md#Troubleshooting.
 endpoint: "http://localhost:55985/wsman"
 options:
   user: vagrant
-  pass: vagrant
+  pass: vagrant

data/spec/matchers.rb

@@ -66,7 +66,7 @@ end
 RSpec::Matchers.define :be_a_uid do
   match do |actual|
     # WinRM1.1 returns uuid's prefixed with 'uuid:' where as later versions do not
-    !actual.nil? && actual.match(/^(uuid:)*\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$/)
+    actual && actual.to_s.match(/^(uuid:)*\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$/)
   end
   failure_message do |actual|
     "expected a uid, but got '#{actual}'"

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: winrm
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
+  prerelease: 
 platform: ruby
 authors:
 - Dan Wanek
@@ -9,11 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gssapi
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -21,6 +23,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -28,26 +31,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.2'
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.2.0.2
 - !ruby/object:Gem::Dependency
   name: rubyntlm
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +61,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +69,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +77,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,26 +85,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -103,6 +115,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,6 +123,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: gyoku
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -117,6 +131,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -124,20 +139,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -145,6 +163,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -152,6 +171,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -159,6 +179,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -166,6 +187,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -173,12 +195,14 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.28.0
-description: |2
-      Ruby library for Windows Remote Management
+description: ! '    Ruby library for Windows Remote Management
+
+'
 email:
 - dan.wanek@gmail.com
 - paul@themortonsonline.com
@@ -232,7 +256,6 @@ files:
 - winrm.gemspec
 homepage: http://github.com/WinRb/WinRM
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options:
 - -x
@@ -242,19 +265,24 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1450055644460961921
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby library for Windows Remote Management
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: f3608a4fcc34f3bcad9cee57c3fada4a67a4ccb0
-  data.tar.gz: 89f128800437d974194dedafb9ef3d56300c33e5
-SHA512:
-  metadata.gz: b041e877f6b11c9b11acff78c714da8d2bb6e3cd80f87a8788deb62177edb8f2e1483e9f9aa7d36966fd8cccc2d57c0f69c601498f782b96535b397ec22486c3
-  data.tar.gz: e10dd4724ec11e483fa652ba49cf93a41f8999256ef3b5564235856b46b340dd120d7602b9da63901b356f986deecf6f54edbe0a81a8cd39ea2703b3abbcb661