winrm 1.7.1 → 1.7.2

data/lib/winrm/command_output_decoder.rb

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+#
+# 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 'base64'
+
+module WinRM
+  # Handles decoding a raw output response
+  class CommandOutputDecoder
+    # Decode the raw SOAP output into decoded and human consumable text,
+    # Decodes and replaces invalid unicode characters.
+    # @param raw_output [String] The raw encoded output
+    # @return [String] The decoded output
+    def decode(raw_output)
+      decoded_text = decode_raw_output(raw_output)
+      decoded_text = handle_invalid_encoding(decoded_text)
+      decoded_text = remove_bom(decoded_text)
+      decoded_text
+    end
+
+    private
+
+    def decode_raw_output(raw_output)
+      Base64.decode64(raw_output).force_encoding('utf-8')
+    end
+
+    def handle_invalid_encoding(decoded_text)
+      return decoded_text if decoded_text.valid_encoding?
+      if decoded_text.respond_to?(:scrub)
+        decoded_text.scrub
+      else
+        decoded_text.encode('utf-16', invalid: :replace, undef: :replace).encode('utf-8')
+      end
+    end
+
+    def remove_bom(decoded_text)
+      # remove BOM which 2008R2 applies
+      decoded_text.sub("\xEF\xBB\xBF", '')
+    end
+  end
+end

data/lib/winrm/exceptions/exceptions.rb

@@ -1,57 +1,57 @@
-# encoding: UTF-8
-#
-# 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
-
-  # 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 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)
-      @status_code = status_code
-      super(msg + " (#{status_code}).")
-    end
-  end
-end
+# encoding: UTF-8
+#
+# 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
+
+  # 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 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)
+      @status_code = status_code
+      super(msg + " (#{status_code}).")
+    end
+  end
+end

data/lib/winrm/helpers/iso8601_duration.rb

@@ -1,58 +1,58 @@
-# encoding: UTF-8
-#
-# 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.
-
-# rubocop:disable Metrics/MethodLength
-# rubocop:disable Metrics/AbcSize
-
-# Format an ISO8601 Duration
-module Iso8601Duration
-  # Convert the number of seconds to an ISO8601 duration format
-  # @see http://tools.ietf.org/html/rfc2445#section-4.3.6
-  # @param [Fixnum] seconds The amount of seconds for this duration
-  def self.sec_to_dur(seconds)
-    seconds = seconds.to_i
-    iso_str = 'P'
-    if seconds > 604_800 # more than a week
-      weeks = seconds / 604_800
-      seconds -= (604_800 * weeks)
-      iso_str << "#{weeks}W"
-    end
-    if seconds > 86_400 # more than a day
-      days = seconds / 86_400
-      seconds -= (86_400 * days)
-      iso_str << "#{days}D"
-    end
-    if seconds > 0
-      iso_str << 'T'
-      if seconds > 3600 # more than an hour
-        hours = seconds / 3600
-        seconds -= (3600 * hours)
-        iso_str << "#{hours}H"
-      end
-      if seconds > 60 # more than a minute
-        minutes = seconds / 60
-        seconds -= (60 * minutes)
-        iso_str << "#{minutes}M"
-      end
-      iso_str << "#{seconds}S"
-    end
-
-    iso_str
-  end
-end
-
-# rubocop:enable Metrics/MethodLength
-# rubocop:enable Metrics/AbcSize
+# encoding: UTF-8
+#
+# 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.
+
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/AbcSize
+
+# Format an ISO8601 Duration
+module Iso8601Duration
+  # Convert the number of seconds to an ISO8601 duration format
+  # @see http://tools.ietf.org/html/rfc2445#section-4.3.6
+  # @param [Fixnum] seconds The amount of seconds for this duration
+  def self.sec_to_dur(seconds)
+    seconds = seconds.to_i
+    iso_str = 'P'
+    if seconds > 604_800 # more than a week
+      weeks = seconds / 604_800
+      seconds -= (604_800 * weeks)
+      iso_str << "#{weeks}W"
+    end
+    if seconds > 86_400 # more than a day
+      days = seconds / 86_400
+      seconds -= (86_400 * days)
+      iso_str << "#{days}D"
+    end
+    if seconds > 0
+      iso_str << 'T'
+      if seconds > 3600 # more than an hour
+        hours = seconds / 3600
+        seconds -= (3600 * hours)
+        iso_str << "#{hours}H"
+      end
+      if seconds > 60 # more than a minute
+        minutes = seconds / 60
+        seconds -= (60 * minutes)
+        iso_str << "#{minutes}M"
+      end
+      iso_str << "#{seconds}S"
+    end
+
+    iso_str
+  end
+end
+
+# rubocop:enable Metrics/MethodLength
+# rubocop:enable Metrics/AbcSize

data/lib/winrm/helpers/powershell_script.rb

@@ -1,42 +1,42 @@
-# 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.
-
-module WinRM
-  # Wraps a PowerShell script to make it easy to Base64 encode for transport
-  class PowershellScript
-    attr_reader :text
-
-    # Creates a new PowershellScript object which can be used to encode
-    # PS scripts for safe transport over WinRM.
-    # @param [String] The PS script text content
-    def initialize(script)
-      @text = script
-    end
-
-    # Encodes the script so that it can be passed to the PowerShell
-    # --EncodedCommand argument.
-    # @return [String] The UTF-16LE base64 encoded script
-    def encoded
-      encoded_script = safe_script(text).encode('UTF-16LE', 'UTF-8')
-      Base64.strict_encode64(encoded_script)
-    end
-
-    # suppress the progress stream from leaking to stderr
-    def safe_script(script)
-      "$ProgressPreference='SilentlyContinue';" + script
-    end
-  end
-end
+# 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.
+
+module WinRM
+  # Wraps a PowerShell script to make it easy to Base64 encode for transport
+  class PowershellScript
+    attr_reader :text
+
+    # Creates a new PowershellScript object which can be used to encode
+    # PS scripts for safe transport over WinRM.
+    # @param [String] The PS script text content
+    def initialize(script)
+      @text = script
+    end
+
+    # Encodes the script so that it can be passed to the PowerShell
+    # --EncodedCommand argument.
+    # @return [String] The UTF-16LE base64 encoded script
+    def encoded
+      encoded_script = safe_script(text).encode('UTF-16LE', 'UTF-8')
+      Base64.strict_encode64(encoded_script)
+    end
+
+    # suppress the progress stream from leaking to stderr
+    def safe_script(script)
+      "$ProgressPreference='SilentlyContinue';" + script
+    end
+  end
+end

data/lib/winrm/http/response_handler.rb

@@ -1,82 +1,82 @@
-# 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.
-
-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_wsman_fault
-      raise_if_wmi_error
-      raise_transport_error
-    end
-
-    def raise_if_auth_error
-      fail WinRMAuthorizationError if @status_code == 401
-    end
-
-    def raise_if_wsman_fault
-      soap_errors = REXML::XPath.match(response_xml, "//#{NS_SOAP_ENV}:Body/#{NS_SOAP_ENV}:Fault/*")
-      return if soap_errors.empty?
-      fault = REXML::XPath.first(soap_errors, "//#{NS_WSMAN_FAULT}:WSManFault")
-      fail WinRMWSManFault.new(fault.to_s, fault.attributes['Code']) unless fault.nil?
-    end
-
-    def raise_if_wmi_error
-      soap_errors = REXML::XPath.match(response_xml, "//#{NS_SOAP_ENV}:Body/#{NS_SOAP_ENV}:Fault/*")
-      return if soap_errors.empty?
-
-      error = REXML::XPath.first(soap_errors, "//#{NS_WSMAN_MSFT}:MSFT_WmiError")
-      return if error.nil?
-
-      error_code = REXML::XPath.first(error, "//#{NS_WSMAN_MSFT}:error_Code").text
-      fail WinRMWMIError.new(error.to_s, error_code)
-    end
-
-    def raise_transport_error
-      fail WinRMHTTPTransportError.new('Bad HTTP response returned from server', @status_code)
-    end
-  end
-end
+# 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.
+
+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_wsman_fault
+      raise_if_wmi_error
+      raise_transport_error
+    end
+
+    def raise_if_auth_error
+      fail WinRMAuthorizationError if @status_code == 401
+    end
+
+    def raise_if_wsman_fault
+      soap_errors = REXML::XPath.match(response_xml, "//#{NS_SOAP_ENV}:Body/#{NS_SOAP_ENV}:Fault/*")
+      return if soap_errors.empty?
+      fault = REXML::XPath.first(soap_errors, "//#{NS_WSMAN_FAULT}:WSManFault")
+      fail WinRMWSManFault.new(fault.to_s, fault.attributes['Code']) unless fault.nil?
+    end
+
+    def raise_if_wmi_error
+      soap_errors = REXML::XPath.match(response_xml, "//#{NS_SOAP_ENV}:Body/#{NS_SOAP_ENV}:Fault/*")
+      return if soap_errors.empty?
+
+      error = REXML::XPath.first(soap_errors, "//#{NS_WSMAN_MSFT}:MSFT_WmiError")
+      return if error.nil?
+
+      error_code = REXML::XPath.first(error, "//#{NS_WSMAN_MSFT}:error_Code").text
+      fail WinRMWMIError.new(error.to_s, error_code)
+    end
+
+    def raise_transport_error
+      fail WinRMHTTPTransportError.new('Bad HTTP response returned from server', @status_code)
+    end
+  end
+end