chef-winrm 2.3.10

data/lib/winrm/connection_opts.rb

@@ -0,0 +1,92 @@
+# Copyright 2016 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 'securerandom'
+
+module WinRM
+  # WinRM connection options, provides defaults and validation.
+  class ConnectionOpts < Hash
+    DEFAULT_OPERATION_TIMEOUT = 60
+    DEFAULT_RECEIVE_TIMEOUT = DEFAULT_OPERATION_TIMEOUT + 10
+    DEFAULT_MAX_ENV_SIZE = 153600
+    DEFAULT_LOCALE = 'en-US'.freeze
+    DEFAULT_RETRY_DELAY = 10
+    DEFAULT_RETRY_LIMIT = 3
+    DEFAULT_USER_AGENT = 'Ruby WinRM Client'.freeze
+
+    class << self
+      def create_with_defaults(overrides)
+        config = default.merge(overrides)
+        config = ensure_receive_timeout_is_greater_than_operation_timeout(config)
+        config.validate
+        config
+      end
+
+      private
+
+      def ensure_receive_timeout_is_greater_than_operation_timeout(config)
+        if config[:receive_timeout] < config[:operation_timeout]
+          config[:receive_timeout] = config[:operation_timeout] + 10
+        end
+        config
+      end
+
+      def default
+        config = ConnectionOpts.new
+        config[:session_id] = SecureRandom.uuid.to_s.upcase
+        config[:transport] = :negotiate
+        config[:locale] = DEFAULT_LOCALE
+        config[:max_envelope_size] = DEFAULT_MAX_ENV_SIZE
+        config[:operation_timeout] = DEFAULT_OPERATION_TIMEOUT
+        config[:receive_timeout] = DEFAULT_RECEIVE_TIMEOUT
+        config[:retry_delay] = DEFAULT_RETRY_DELAY
+        config[:retry_limit] = DEFAULT_RETRY_LIMIT
+        config[:user_agent] = DEFAULT_USER_AGENT
+        config
+      end
+    end
+
+    def validate
+      validate_required_fields
+      validate_data_types
+    end
+
+    private
+
+    def validate_required_fields
+      raise 'endpoint is a required option' unless self[:endpoint]
+
+      if self[:client_cert]
+        raise 'path to client key is required' unless self[:client_key]
+      else
+        raise 'user is a required option' unless self[:user]
+        raise 'password is a required option' unless self[:password]
+      end
+    end
+
+    def validate_data_types
+      validate_integer(:retry_limit)
+      validate_integer(:retry_delay)
+      validate_integer(:max_envelope_size)
+      validate_integer(:operation_timeout)
+      validate_integer(:receive_timeout, self[:operation_timeout])
+    end
+
+    def validate_integer(key, min = 0)
+      value = self[key]
+      raise "#{key} must be a Integer" unless value && value.is_a?(Integer)
+      raise "#{key} must be greater than #{min}" unless value > min
+    end
+  end
+end

data/lib/winrm/exceptions.rb

@@ -0,0 +1,88 @@
+# 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
+  # WinRM base class for errors
+  class WinRMError < StandardError; end
+
+  # Authorization Error
+  class WinRMAuthorizationError < WinRMError; end
+
+  # Shell creation error
+  class InvalidShellError < WinRMError; end
+
+  # Exitcode error
+  class InvalidExitCode < WinRMError; end
+
+  # Shell creation error
+  class InvalidTransportError < WinRMError
+    attr_reader :invalid_transport
+
+    def initialize(invalid_transport, valid_transports)
+      @invalid_transport = invalid_transport
+      super(
+        "Invalid transport '#{invalid_transport}' specified" \
+        ", expected: #{valid_transports.join(', ')}."
+      )
+    end
+  end
+
+  # A Fault returned in the SOAP response. The XML node is a WSManFault
+  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
+
+  # A Fault returned in the SOAP response. The XML node contains Code, SubCode and Reason
+  class WinRMSoapFault < WinRMError
+    attr_reader :code
+    attr_reader :subcode
+    attr_reader :reason
+
+    def initialize(code, subcode, reason)
+      @code = code
+      @subcode = subcode
+      @reason = reason
+      super("[SOAP ERROR CODE: #{code} (#{subcode})]: #{reason}")
+    end
+  end
+
+  # A Fault returned in the SOAP response. The XML node is a MSFT_WmiError
+  class WinRMWMIError < WinRMError
+    attr_reader :error_code
+    attr_reader :error
+
+    def initialize(error, error_code)
+      @error = error
+      @error_code = error_code
+      super("[WMI ERROR CODE: #{error_code}]: #{error}")
+    end
+  end
+
+  # non-200 response without a SOAP fault
+  class WinRMHTTPTransportError < WinRMError
+    attr_reader :status_code
+
+    def initialize(msg, status_code = nil)
+      @status_code = status_code
+      super(msg + " (#{status_code}).")
+    end
+  end
+end

data/lib/winrm/http/response_handler.rb

@@ -0,0 +1,127 @@
+# 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' unless defined?(REXML::Document)
+require_relative '../wsmv/soap'
+
+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_wsman_fault
+      raise_if_wmi_error
+      raise_if_soap_fault
+      raise_transport_error
+    end
+
+    def raise_if_auth_error
+      raise WinRMAuthorizationError if @status_code == 401
+    end
+
+    def raise_if_wsman_fault
+      soap_errors = REXML::XPath.match(
+        response_xml,
+        "//*[local-name() = 'Envelope']/*[local-name() = 'Body']/*[local-name() = 'Fault']/*"
+      )
+      return if soap_errors.empty?
+
+      fault = REXML::XPath.first(
+        soap_errors,
+        "//*[local-name() = 'WSManFault']"
+      )
+      raise WinRMWSManFault.new(fault.to_s, fault.attributes['Code']) unless fault.nil?
+    end
+
+    def raise_if_wmi_error
+      soap_errors = REXML::XPath.match(
+        response_xml,
+        "//*[local-name() = 'Envelope']/*[local-name() = 'Body']/*[local-name() = 'Fault']/*"
+      )
+      return if soap_errors.empty?
+
+      error = REXML::XPath.first(
+        soap_errors,
+        "//*[local-name() = 'MSFT_WmiError']"
+      )
+      return if error.nil?
+
+      error_code = REXML::XPath.first(
+        error,
+        "//*[local-name() = 'error_Code']"
+      ).text
+      raise WinRMWMIError.new(error.to_s, error_code)
+    end
+
+    def raise_if_soap_fault
+      soap_errors = REXML::XPath.match(
+        response_xml,
+        "//*[local-name() = 'Envelope']/*[local-name() = 'Body']/*[local-name() = 'Fault']/*"
+      )
+      return if soap_errors.empty?
+
+      code = REXML::XPath.first(
+        soap_errors,
+        "//*[local-name() = 'Code']/*[local-name() = 'Value']/text()"
+      )
+      subcode = REXML::XPath.first(
+        soap_errors,
+        "//*[local-name() = 'Subcode']/*[local-name() = 'Value']/text()"
+      )
+      reason = REXML::XPath.first(
+        soap_errors,
+        "//*[local-name() = 'Reason']/*[local-name() = 'Text']/text()"
+      )
+
+      raise WinRMSoapFault.new(code, subcode, reason) unless
+        code.nil? && subcode.nil? && reason.nil?
+    end
+
+    def raise_transport_error
+      raise WinRMHTTPTransportError.new(
+        "Bad HTTP response returned from server. Body(if present):#{@response_body}",
+        @status_code
+      )
+    end
+  end
+end