winrm 1.2.0 → 1.3.0.dev.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c3acfe714f1a55013dc15af581c52eb75c1ae0e
-  data.tar.gz: df2ca6f9c29b249058aebb111f1c42631a033294
+  metadata.gz: 6e51474e140d25ef1680a4c431b1bcdee6185fd0
+  data.tar.gz: 6c1cb088c144cf90125121f25727f277d0f7a3f2
 SHA512:
-  metadata.gz: 76440fae9da8a3b989afee26d092e6cf1ae7c2cc9824ae87c3b4aa6d4826f5b88193af75ba29610fcb819e0447278cd108218b0d96d3b35f5db0a8799e597345
-  data.tar.gz: 314d60dd2cecd17d2f306b90c4ec30be04a2bd7957cbb09e057082fa7376c22296e35056baf6c7f8dbfeb3ab9c78f48f477aa5a4547a3a5ab65275e05de6192c
+  metadata.gz: 7dc6b9dfa831f92c35488bef5cdf25e54e44289b20b1c61fcd7bafffea6cb361f98bb05fa8a7022ba74f9b1c903fa7e0ec95cf54ad053017ea9f80b27824e769
+  data.tar.gz: 00000ad60eaf4ea00f4c55814c74af0270dc80840e7eaf3c2b3e89c9e70005678121895a4274d4acd51552ca4b2fdeeb27b88aa4dc8beee0f9e207b36f463890

data/README.md

@@ -8,6 +8,9 @@ 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
 
@@ -128,18 +131,14 @@ To run the integration tests you will need a Windows box with the WinRM service
 2. Copy the config-example.yml to config.yml - edit this file with your WinRM connection details.
 3. Run `bundle exec rake integration`
 
-## My Info
+## 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)
 
-## Contributors
-Many thanks to the following for their many patches....
-* Seth Chisamore (https://github.com/schisamo)
+## Maintainers
 * Paul Morton (https://github.com/pmorton)
+* Shawn Neal (https://github.com/sneal)
 
-## Disclaimer
-If you see something that could be done better or would like to help out in the development of this code please feel free to clone the repository and send me patches.
-
-`git clone git://github.com/WinRb/WinRM.git` or add an [issue](https://github.com/WinRb/WinRM/issues) on GitHub
+[Contributors](https://github.com/WinRb/WinRM/graphs/contributors)

data/Rakefile

@@ -18,6 +18,7 @@ end
 RSpec::Core::RakeTask.new(:integration) do |task|
   task.pattern = "test/spec/*_spec.rb"
   task.rspec_opts = [ '--color', '-f documentation' ]
+  task.rspec_opts << '-tintegration'
 end
 
-task :default => "spec"
+task :default => "spec"

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0.dev.1

data/bin/rwinrm

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+# 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.
+
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'readline'
+require 'optparse'
+require 'winrm'
+
+def parse_options
+  options = {}
+  optparse = OptionParser.new do |opts|
+    opts.banner = "Usage: rwinrm endpoint [options]"
+
+    options[:auth_type] = :plaintext
+    options[:basic_auth_only] = true
+    options[:endpoint] = ARGV[0]
+
+    opts.on('-u', '--user username', String, 'WinRM user name') do |v|
+      options[:user] = v
+    end
+
+    opts.on('-p', '--pass password', String, 'WinRM user password') do |v|
+      options[:pass] = v
+    end
+
+    opts.on('-h', '--help', 'Display this screen') do
+      puts opts
+      exit
+    end
+  end
+
+  optparse.parse!
+  raise OptionParser::MissingArgument.new(:endpoint) if options[:endpoint].nil?
+
+  options
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+  puts $!.message
+  puts optparse
+  exit 1
+end
+
+def repl(options)
+  client = WinRM::WinRMWebService.new(
+    options[:endpoint],
+    options[:auth_type].to_sym,
+    options)
+
+  shell_id = client.open_shell()
+  command_id = client.run_command(shell_id, 'cmd')
+
+  read_thread = Thread.new do
+    client.get_command_output(shell_id, command_id) do |stdout, stderr|
+      STDOUT.write stdout
+      STDERR.write stderr
+    end
+  end
+
+  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
+  # ctrl-c
+rescue StandardError => e
+  puts e.message
+  exit 1
+end
+
+repl(parse_options())

data/lib/winrm/exceptions/exceptions.rb

@@ -1,34 +1,44 @@
-=begin
-  This file is part of WinRM; the Ruby library for Microsoft WinRM.
-
-  Copyright © 2010 Dan Wanek <dan.wanek@gmail.com>
-
-  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.
-=end
+# Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
+# 
+# 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.
 
 module WinRM
-  # Generic WinRM SOAP Error
-  class WinRMWebServiceError < StandardError
-  end
+
+  # WinRM base class for errors
+  class WinRMError < StandardError; end
 
   # Authorization Error
-  class WinRMAuthorizationError < StandardError
-  end
+  class WinRMAuthorizationError < WinRMError; end
 
   # A Fault returned in the SOAP response. The XML node is a WSManFault
-  class WinRMWSManFault < StandardError; end
+  class WinRMWSManFault < WinRMError
+    attr_reader :fault_code
+    attr_reader :fault_description
+
+    def initialize(fault_description, fault_code)
+      @fault_description = fault_description
+      @fault_code = fault_code
+      super("[WSMAN ERROR CODE: #{fault_code}]: #{fault_description}")
+    end
+  end
 
-  # Bad HTTP Transport
-  class WinRMHTTPTransportError < StandardError; end
-end # WinRM
+  # non-200 response without a SOAP fault
+  class WinRMHTTPTransportError < WinRMError
+    attr_reader :status_code
 
+    def initialize(msg, status_code)
+      @status_code = status_code
+      super(msg + " (#{status_code}).")
+    end
+  end
+end

data/lib/winrm/helpers/iso8601_duration.rb

@@ -1,20 +1,16 @@
-=begin
-  This file is part of WinRM; the Ruby library for Microsoft WinRM.
-
-  Copyright © 2010 Dan Wanek <dan.wanek@gmail.com>
-
-  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.
-=end
+# Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
+# 
+# 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.
 
 # Format an ISO8601 Duration
 module Iso8601Duration

data/lib/winrm/http/response_handler.rb

@@ -0,0 +1,70 @@
+# 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.
+
+require 'rexml/document'
+
+module WinRM
+  # Handles the raw WinRM HTTP response. Returns the body as an XML doc
+  # or raises the appropriate WinRM error if the response is an error.
+  class ResponseHandler
+
+    # @param [String] The raw unparsed response body, if any
+    # @param [Integer] The HTTP response status code
+    def initialize(response_body, status_code)
+      @response_body = response_body
+      @status_code = status_code
+    end
+
+    # Processes the response from the WinRM service and either returns an XML
+    # doc or raises an appropriate error.
+    #
+    # @returns [REXML::Document] The parsed response body
+    def parse_to_xml()
+      raise_if_error()
+      response_xml
+    end
+
+    private
+
+    def response_xml()
+      @response_xml ||= REXML::Document.new(@response_body)
+    rescue REXML::ParseException => e
+      raise WinRMHTTPTransportError.new("Unable to parse WinRM response: #{e.message}", @status_code)
+    end
+
+    def raise_if_error()
+      return if @status_code == 200 
+      raise_if_auth_error()
+      raise_if_soap_fault()
+      raise_transport_error()
+    end
+
+    def raise_if_auth_error()
+      raise WinRMAuthorizationError.new if @status_code == 401 
+    end
+
+    def raise_if_soap_fault()
+      soap_errors = REXML::XPath.match(response_xml, "//#{NS_SOAP_ENV}:Body/#{NS_SOAP_ENV}:Fault/*")
+      if !soap_errors.empty?
+        fault = REXML::XPath.first(soap_errors, "//#{NS_WSMAN_FAULT}:WSManFault")
+        raise WinRMWSManFault.new(fault.to_s, fault.attributes['Code'])
+      end
+    end
+
+    def raise_transport_error()
+      raise WinRMHTTPTransportError.new('Bad HTTP response returned from server', @status_code)
+    end
+
+  end
+end

data/lib/winrm/http/transport.rb

@@ -1,20 +1,18 @@
-=begin
-  This file is part of WinRM; the Ruby library for Microsoft WinRM.
-
-  Copyright © 2010 Dan Wanek <dan.wanek@gmail.com>
-
-  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.
-=end
+# Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
+# 
+# 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.
+
+require_relative 'response_handler'
 
 module WinRM
   module HTTP
@@ -33,20 +31,18 @@ module WinRM
         @logger = Logging.logger[self]
       end
 
+      # Sends the SOAP payload to the WinRM service and returns the service's
+      # SOAP response. If an error occurrs an appropriate error is raised.
+      #
+      # @param [String] The XML SOAP message
+      # @returns [REXML::Document] The parsed response body
       def send_request(message)
+        log_soap_message(message)
         hdr = {'Content-Type' => 'application/soap+xml;charset=UTF-8', 'Content-Length' => message.length}
         resp = @httpcli.post(@endpoint, message, hdr)
-        if(resp.status == 200)
-          # Version 1.1 of WinRM adds the namespaces in the document instead of the envelope so we have to
-          # add them ourselves here. This should have no affect version 2.
-          doc = Nokogiri::XML(resp.http_body.content)
-          doc.collect_namespaces.each_pair do |k,v|
-            doc.root.add_namespace((k.split(/:/).last),v) unless doc.namespaces.has_key?(k)
-          end
-          return doc
-        else
-          raise WinRMHTTPTransportError, "Bad HTTP response returned from server (#{resp.status})."
-        end
+        log_soap_message(resp.http_body.content)
+        handler = WinRM::ResponseHandler.new(resp.http_body.content, resp.status)
+        handler.parse_to_xml()
       end
 
       # We'll need this to force basic authentication if desired
@@ -66,6 +62,19 @@ module WinRM
         @httpcli.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
 
+      protected
+
+      def log_soap_message(message)
+        return unless @logger.debug?
+        
+        xml_msg = REXML::Document.new(message)
+        formatter = REXML::Formatters::Pretty.new(2)
+        formatter.compact = true
+        formatter.write(xml_msg, @logger)
+        @logger.debug("\n")
+      rescue StandardError => e
+        @logger.debug("Couldn't log SOAP request/response: #{e.message} - #{message}")
+      end
     end
 
 
@@ -100,20 +109,42 @@ module WinRM
       def initialize(endpoint, realm, service = nil, keytab = nil, opts)
         super(endpoint)
         # Remove the GSSAPI auth from HTTPClient because we are doing our own thing
-        auths = @httpcli.www_auth.instance_variable_get('@authenticator')
-        auths.delete_if {|i| i.is_a?(HTTPClient::SSPINegotiateAuth)}
+        no_sspi_auth!
         service ||= 'HTTP'
         @service = "#{service}/#{@endpoint.host}@#{realm}"
         init_krb
       end
 
-      def set_auth(user,pass)
-        # raise Error
+      # Sends the SOAP payload to the WinRM service and returns the service's
+      # SOAP response. If an error occurrs an appropriate error is raised.
+      #
+      # @param [String] The XML SOAP message
+      # @returns [REXML::Document] The parsed response body
+      def send_request(message)
+        resp = send_kerberos_request(message)
+
+        if resp.status == 401
+          @logger.debug "Got 401 - reinitializing Kerberos and retrying one more time"
+          init_krb
+          resp = send_kerberos_request(message)
+        end
+
+        handler = WinRM::ResponseHandler.new(winrm_decrypt(resp.http_body.content), resp.status)
+        handler.parse_to_xml()
       end
 
-      def send_request(msg)
-        original_length = msg.length
-        pad_len, emsg = winrm_encrypt(msg)
+
+      private
+
+      # Sends the SOAP payload to the WinRM service and returns the service's
+      # HTTP response.
+      #
+      # @param [String] The XML SOAP message
+      # @returns [Object] The HTTP response object
+      def send_kerberos_request(message)
+        log_soap_message(message)
+        original_length = message.length
+        pad_len, emsg = winrm_encrypt(message)
         hdr = {
           "Connection" => "Keep-Alive",
           "Content-Type" => "multipart/encrypted;protocol=\"application/HTTP-Kerberos-session-encrypted\";boundary=\"Encrypted Boundary\""
@@ -128,15 +159,11 @@ Content-Type: application/octet-stream\r
 #{emsg}--Encrypted Boundary\r
         EOF
 
-        r = @httpcli.post(@endpoint, body, hdr)
-
-        winrm_decrypt(r.http_body.content)
+        resp = @httpcli.post(@endpoint, body, hdr)
+        log_soap_message(resp.http_body.content)
+        resp
       end
 
-
-      private 
-
-
       def init_krb
         @logger.debug "Initializing Kerberos for #{@service}"
         @gsscli = GSSAPI::Simple.new(@endpoint.host, @service)
@@ -218,7 +245,7 @@ Content-Type: application/octet-stream\r
 
         @logger.debug "SOAP message decrypted (MAJ: #{maj_stat}, MIN: #{min_stat.read_int}):\n#{iov1[:buffer].value}"
 
-        Nokogiri::XML(iov1[:buffer].value)
+        iov1[:buffer].value
       end
 
     end

data/lib/winrm/soap_provider.rb

@@ -1,26 +1,22 @@
-=begin
-  This file is part of WinRM; the Ruby library for Microsoft WinRM.
-
-  Copyright © 2010 Dan Wanek <dan.wanek@gmail.com>
-
-  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.
-=end
+# Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
+# 
+# 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.
 
 require 'httpclient'
-require 'savon'
+require 'builder'
+require 'gyoku'
 require 'uuidtools'
 require 'base64'
-require 'nokogiri'
 
 module WinRM
   NS_SOAP_ENV    ='s'   # http://www.w3.org/2003/05/soap-envelope