winrm 2.2.3 → 2.3.6

data/lib/winrm/http/transport_factory.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Shawn Neal <sneal@sneal.net>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -59,9 +57,7 @@ module WinRM
                 .select { |m| m.to_s.start_with?('init_') && m.to_s.end_with?('_transport') }
                 .map { |tm| tm.to_s.split('_')[1] }
 
-        unless valid.include?(transport.to_s)
-          raise WinRM::InvalidTransportError.new(transport, valid)
-        end
+        raise WinRM::InvalidTransportError.new(transport, valid) unless valid.include?(transport.to_s)
       end
     end
   end

data/lib/winrm/output.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2014 Max Lincoln <max@devopsy.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -48,6 +46,7 @@ module WinRM
     # Sets the exitcode
     def exitcode=(code)
       raise WinRM::InvalidExitCode unless code.is_a? Integer
+
       @exitcode = code
     end
 

data/lib/winrm/psrp/fragment.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 # Copyright 2016 Shawn Neal <sneal@sneal.net>
 #

data/lib/winrm/psrp/message.rb

@@ -1,130 +1,128 @@
-# encoding: UTF-8
-#
-# Copyright 2015 Matt Wrock <matt@mattwrock.com>
-# 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_relative 'uuid'
-require_relative 'message_data'
-
-module WinRM
-  # PowerShell Remoting Protcol module
-  module PSRP
-    # PowerShell Remoting Protocol base message.
-    # http://download.microsoft.com/download/9/5/E/95EF66AF-9026-4BB0-A41D-A4F81802D92C/%5BMS-PSRP%5D.pdf
-    class Message
-      include UUID
-
-      # Value of message destination when sent to a client
-      CLIENT_DESTINATION = 1
-
-      # Value of message destination when sent to a server
-      SERVER_DESTINATION = 2
-
-      # All known PSRP message types
-      MESSAGE_TYPES = {
-        session_capability:         0x00010002,
-        init_runspacepool:          0x00010004,
-        public_key:                 0x00010005,
-        encrypted_session_key:      0x00010006,
-        public_key_request:         0x00010007,
-        connect_runspacepool:       0x00010008,
-        runspace_init_data:         0x0002100b,
-        reset_runspace_state:       0x0002100c,
-        set_max_runspaces:          0x00021002,
-        set_min_runspaces:          0x00021003,
-        runspace_availability:      0x00021004,
-        runspacepool_state:         0x00021005,
-        create_pipeline:            0x00021006,
-        get_available_runspaces:    0x00021007,
-        user_event:                 0x00021008,
-        application_private_data:   0x00021009,
-        get_command_metadata:       0x0002100a,
-        runspacepool_host_call:     0x00021100,
-        runspacepool_host_response: 0x00021101,
-        pipeline_input:             0x00041002,
-        end_of_pipeline_input:      0x00041003,
-        pipeline_output:            0x00041004,
-        error_record:               0x00041005,
-        pipeline_state:             0x00041006,
-        debug_record:               0x00041007,
-        verbose_record:             0x00041008,
-        warning_record:             0x00041009,
-        progress_record:            0x00041010,
-        information_record:         0x00041011,
-        pipeline_host_call:         0x00041100,
-        pipeline_host_response:     0x00041101
-      }.freeze
-
-      # Creates a new PSRP message instance
-      # @param runspace_pool_id [String] The UUID of the remote shell/runspace pool.
-      # @param pipeline_id [String] The UUID to correlate the command/pipeline response
-      # @param type [Integer] The PSRP MessageType. This is most commonly
-      # specified in hex, e.g. 0x00010002.
-      # @param data [String] The PSRP payload as serialized XML
-      # @param destination [Integer] The destination for this message - client or server
-      def initialize(
-        runspace_pool_id,
-        type,
-        data,
-        pipeline_id = nil,
-        destination = SERVER_DESTINATION
-      )
-        raise 'invalid message type' unless MESSAGE_TYPES.values.include?(type)
-
-        @data = data
-        @destination = destination
-        @type = type
-        @pipeline_id = pipeline_id
-        @runspace_pool_id = runspace_pool_id
-      end
-
-      attr_reader :destination, :type, :runspace_pool_id, :pipeline_id, :data
-
-      # Returns the raw PSRP message bytes ready for transfer to Windows inside a
-      # WinRM message.
-      # @return [Array<Byte>] Unencoded raw byte array of the PSRP message.
-      def bytes
-        [
-          int16le(destination),
-          int16le(type),
-          uuid_to_windows_guid_bytes(runspace_pool_id),
-          uuid_to_windows_guid_bytes(pipeline_id),
-          byte_order_mark,
-          data_bytes
-        ].flatten
-      end
-
-      # Parses the raw data to a MessageData class
-      # @return [MessageData::Base] MessageData corresponding to this message type
-      def parsed_data
-        @parsed_data ||= MessageData.parse(self)
-      end
-
-      private
-
-      def byte_order_mark
-        [239, 187, 191]
-      end
-
-      def data_bytes
-        @data_bytes ||= data.force_encoding('utf-8').bytes
-      end
-
-      def int16le(int16)
-        [int16].pack('N').unpack('C4').reverse
-      end
-    end
-  end
-end
+# Copyright 2015 Matt Wrock <matt@mattwrock.com>
+# 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_relative 'uuid'
+require_relative 'message_data'
+
+module WinRM
+  # PowerShell Remoting Protcol module
+  module PSRP
+    # PowerShell Remoting Protocol base message.
+    # http://download.microsoft.com/download/9/5/E/95EF66AF-9026-4BB0-A41D-A4F81802D92C/%5BMS-PSRP%5D.pdf
+    class Message
+      include UUID
+
+      # Value of message destination when sent to a client
+      CLIENT_DESTINATION = 1
+
+      # Value of message destination when sent to a server
+      SERVER_DESTINATION = 2
+
+      # All known PSRP message types
+      MESSAGE_TYPES = {
+        session_capability: 0x00010002,
+        init_runspacepool: 0x00010004,
+        public_key: 0x00010005,
+        encrypted_session_key: 0x00010006,
+        public_key_request: 0x00010007,
+        connect_runspacepool: 0x00010008,
+        runspace_init_data: 0x0002100b,
+        reset_runspace_state: 0x0002100c,
+        set_max_runspaces: 0x00021002,
+        set_min_runspaces: 0x00021003,
+        runspace_availability: 0x00021004,
+        runspacepool_state: 0x00021005,
+        create_pipeline: 0x00021006,
+        get_available_runspaces: 0x00021007,
+        user_event: 0x00021008,
+        application_private_data: 0x00021009,
+        get_command_metadata: 0x0002100a,
+        runspacepool_host_call: 0x00021100,
+        runspacepool_host_response: 0x00021101,
+        pipeline_input: 0x00041002,
+        end_of_pipeline_input: 0x00041003,
+        pipeline_output: 0x00041004,
+        error_record: 0x00041005,
+        pipeline_state: 0x00041006,
+        debug_record: 0x00041007,
+        verbose_record: 0x00041008,
+        warning_record: 0x00041009,
+        progress_record: 0x00041010,
+        information_record: 0x00041011,
+        pipeline_host_call: 0x00041100,
+        pipeline_host_response: 0x00041101
+      }.freeze
+
+      # Creates a new PSRP message instance
+      # @param runspace_pool_id [String] The UUID of the remote shell/runspace pool.
+      # @param pipeline_id [String] The UUID to correlate the command/pipeline response
+      # @param type [Integer] The PSRP MessageType. This is most commonly
+      # specified in hex, e.g. 0x00010002.
+      # @param data [String] The PSRP payload as serialized XML
+      # @param destination [Integer] The destination for this message - client or server
+      def initialize(
+        runspace_pool_id,
+        type,
+        data,
+        pipeline_id = nil,
+        destination = SERVER_DESTINATION
+      )
+        raise 'invalid message type' unless MESSAGE_TYPES.value?(type)
+
+        @data = data
+        @destination = destination
+        @type = type
+        @pipeline_id = pipeline_id
+        @runspace_pool_id = runspace_pool_id
+      end
+
+      attr_reader :destination, :type, :runspace_pool_id, :pipeline_id, :data
+
+      # Returns the raw PSRP message bytes ready for transfer to Windows inside a
+      # WinRM message.
+      # @return [Array<Byte>] Unencoded raw byte array of the PSRP message.
+      def bytes
+        [
+          int16le(destination),
+          int16le(type),
+          uuid_to_windows_guid_bytes(runspace_pool_id),
+          uuid_to_windows_guid_bytes(pipeline_id),
+          byte_order_mark,
+          data_bytes
+        ].flatten
+      end
+
+      # Parses the raw data to a MessageData class
+      # @return [MessageData::Base] MessageData corresponding to this message type
+      def parsed_data
+        @parsed_data ||= MessageData.parse(self)
+      end
+
+      private
+
+      def byte_order_mark
+        [239, 187, 191]
+      end
+
+      def data_bytes
+        @data_bytes ||= data.force_encoding('utf-8').bytes
+      end
+
+      def int16le(int16)
+        [int16].pack('N').unpack('C4').reverse
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data/base.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/winrm/psrp/message_data/error_record.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -50,6 +48,8 @@ module WinRM
 
         def property_hash(prop_name)
           prop_nodes = REXML::XPath.first(doc, "//*[@N='#{prop_name}']/Props")
+          return {} if prop_nodes.nil?
+
           prop_nodes.elements.each_with_object({}) do |node, props|
             name = node.attributes['N']
             props[underscore(name).to_sym] = node.text if node.text

data/lib/winrm/psrp/message_data/pipeline_host_call.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/winrm/psrp/message_data/pipeline_output.rb

@@ -1,54 +1,48 @@
-# -*- encoding: utf-8 -*-
-#
-# Copyright 2016 Matt Wrock <matt@mattwrock.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 'rexml/document'
-
-module WinRM
-  module PSRP
-    module MessageData
-      # Handles decoding a raw powershell output response
-      class PipelineOutput < Base
-        def output
-          extract_out_string(remove_bom(raw.force_encoding('utf-8')))
-        end
-
-        private
-
-        def extract_out_string(text)
-          doc = REXML::Document.new(text)
-          doc.root.get_elements('//S').map do |node|
-            text = ''
-            if node.text
-              text << node.text.gsub(/_x(\h\h\h\h)_/) do
-                decoded_text = Regexp.last_match[1].hex.chr.force_encoding('utf-8')
-                if decoded_text.respond_to?(:scrub)
-                  decoded_text.scrub
-                else
-                  decoded_text.encode('utf-16', invalid: :replace, undef: :replace).encode('utf-8')
-                end
-              end.chomp
-            end
-            text << "\r\n"
-          end.join
-        end
-
-        def remove_bom(text)
-          text.sub("\xEF\xBB\xBF", '')
-        end
-      end
-    end
-  end
-end
+# Copyright 2016 Matt Wrock <matt@mattwrock.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 'rexml/document' unless defined?(REXML::Document)
+
+module WinRM
+  module PSRP
+    module MessageData
+      # Handles decoding a raw powershell output response
+      class PipelineOutput < Base
+        def output
+          extract_out_string(remove_bom(raw.force_encoding('utf-8')))
+        end
+
+        private
+
+        def extract_out_string(text)
+          doc = REXML::Document.new(text)
+          doc.root.get_elements('//S').map do |node|
+            text = ''
+            if node.text
+              text << node.text.gsub(/(_x\h\h\h\h_)+/) do |match|
+                match.scan(/_x(\h\h\h\h)_/).flatten.map(&:hex)
+                     .pack('S*').force_encoding('utf-16le').encode('utf-8')
+              end.chomp
+            end
+            text << "\r\n"
+          end.join
+        end
+
+        def remove_bom(text)
+          text.sub("\xEF\xBB\xBF", '')
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data/pipeline_state.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/winrm/psrp/message_data/runspacepool_host_call.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/winrm/psrp/message_data/runspacepool_state.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/winrm/psrp/message_data/session_capability.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/winrm/psrp/message_data.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/winrm/psrp/message_defragmenter.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -31,11 +29,13 @@ module WinRM
         @messages[fragment.object_id] ||= []
         @messages[fragment.object_id].push fragment
 
+        # rubocop:disable Style/GuardClause
         if fragment.end_fragment
           blob = []
           @messages.delete(fragment.object_id).each { |frag| blob += frag.blob }
           return message_from(blob.pack('C*'))
         end
+        # rubocop:enable Style/GuardClause
       end
 
       def fragment_from(byte_string)

data/lib/winrm/psrp/message_factory.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2016 Shawn Neal <sneal@sneal.net>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'erubis'
+require 'erubi'
 require_relative 'message'
 
 module WinRM
@@ -65,9 +63,22 @@ module WinRM
         # @api private
         def render(template, context = nil)
           template_path = File.expand_path(
-            "#{File.dirname(__FILE__)}/#{template}.xml.erb")
+            "#{File.dirname(__FILE__)}/#{template}.xml.erb"
+          )
           template = File.read(template_path)
-          Erubis::Eruby.new(template).result(context)
+          case context
+          when Hash
+            b = binding
+            locals = context.collect { |k, _| "#{k} = context[#{k.inspect}]; " }
+            b.eval(locals.join)
+          when Binding
+            b = context
+          when NilClass
+            b = binding
+          else
+            raise ArgumentError
+          end
+          b.eval(Erubi::Engine.new(template).src)
         end
       end
     end

data/lib/winrm/psrp/message_fragmenter.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -45,7 +43,7 @@ module WinRM
             object_id,
             message.bytes[bytes_fragmented..last_byte - 1],
             fragment_id,
-            bytes_fragmented == 0,
+            bytes_fragmented.zero?,
             last_byte == message_bytes.length
           )
           fragment_id += 1