winrm 1.8.1 → 2.0.0

data/lib/winrm/wsmv/command_output_decoder.rb

@@ -0,0 +1,55 @@
+# -*- 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
+  module WSMV
+    # 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
+end

data/lib/winrm/wsmv/configuration.rb

@@ -0,0 +1,46 @@
+# -*- 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_relative 'base'
+
+module WinRM
+  module WSMV
+    # WSMV keep alive message
+    class Configuration < Base
+      def initialize(session_opts)
+        @session_opts = session_opts
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(configuration_headers)
+      end
+
+      def create_body(_body)
+        # no body
+      end
+
+      private
+
+      def configuration_headers
+        merge_headers(shared_headers(@session_opts),
+                      resource_uri_shell('http://schemas.microsoft.com/wbem/wsman/1/config'),
+                      action_get)
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/create_pipeline.rb

@@ -0,0 +1,66 @@
+# -*- 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_relative 'base'
+require_relative '../psrp/message_factory'
+
+module WinRM
+  module WSMV
+    # WSMV message to execute a command via psrp
+    class CreatePipeline < Base
+      attr_accessor :shell_id, :command_id, :fragment
+
+      def initialize(session_opts, shell_id, command_id, fragment = nil)
+        @command_id = command_id
+        @session_opts = session_opts
+        @shell_id = shell_id
+        @fragment = fragment
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(command_headers)
+      end
+
+      def create_body(body)
+        body.tag!("#{NS_WIN_SHELL}:CommandLine", 'CommandId' => command_id) do |cl|
+          cl << Gyoku.xml(command_body)
+        end
+      end
+
+      private
+
+      def command_body
+        {
+          "#{NS_WIN_SHELL}:Command" => 'Invoke-Expression',
+          "#{NS_WIN_SHELL}:Arguments" => arguments
+        }
+      end
+
+      def command_headers
+        merge_headers(shared_headers(@session_opts),
+                      resource_uri_shell(RESOURCE_URI_POWERSHELL),
+                      action_command,
+                      selector_shell_id(shell_id))
+      end
+
+      def arguments
+        encode_bytes(fragment.bytes) if fragment
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/create_shell.rb

@@ -0,0 +1,119 @@
+# -*- 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_relative 'base'
+require_relative 'iso8601_duration'
+
+module WinRM
+  module WSMV
+    # WSMV message to create a remote shell
+    class CreateShell < Base
+      # utf8 as default codepage
+      # https://msdn.microsoft.com/en-us/library/dd317756(VS.85).aspx
+      UTF8_CODE_PAGE = 65001
+
+      attr_accessor :i_stream, :o_stream, :codepage, :noprofile
+      attr_accessor :working_directory, :idle_timeout, :env_vars
+
+      def initialize(session_opts, shell_opts = {})
+        @session_opts = session_opts
+        @shell_uri = opt_or_default(shell_opts, :shell_uri, RESOURCE_URI_CMD)
+        @i_stream = opt_or_default(shell_opts, :i_stream, 'stdin')
+        @o_stream = opt_or_default(shell_opts, :o_stream, 'stdout stderr')
+        @codepage = opt_or_default(shell_opts, :codepage, UTF8_CODE_PAGE)
+        @noprofile = opt_or_default(shell_opts, :noprofile, 'FALSE')
+        @working_directory = opt_or_default(shell_opts, :working_directory)
+        @idle_timeout = opt_or_default(shell_opts, :idle_timeout)
+        @env_vars = opt_or_default(shell_opts, :env_vars)
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(shell_headers)
+      end
+
+      def create_body(body)
+        body.tag!("#{NS_WIN_SHELL}:Shell") { |s| s << Gyoku.xml(shell_body) }
+      end
+
+      private
+
+      def opt_or_default(shell_opts, key, default_value = nil)
+        shell_opts.key?(key) ? shell_opts[key] : default_value
+      end
+
+      def shell_body
+        body = {
+          "#{NS_WIN_SHELL}:InputStreams" => @i_stream,
+          "#{NS_WIN_SHELL}:OutputStreams" => @o_stream
+        }
+        body["#{NS_WIN_SHELL}:WorkingDirectory"] = @working_directory if @working_directory
+        if @idle_timeout
+          body["#{NS_WIN_SHELL}:IdleTimeOut"] = format_idle_timeout(@idle_timeout)
+        end
+        body["#{NS_WIN_SHELL}:Environment"] = environment_vars_body if @env_vars
+        body
+      end
+
+      # backwards compat - idle_timeout as an Iso8601Duration string
+      def format_idle_timeout(timeout)
+        timeout.is_a?(String) ? timeout : Iso8601Duration.sec_to_dur(timeout)
+      end
+
+      def environment_vars_body
+        {
+          "#{NS_WIN_SHELL}:Variable" => @env_vars.values,
+          :attributes! => {
+            "#{NS_WIN_SHELL}:Variable" => {
+              'Name' => @env_vars.keys
+            }
+          }
+        }
+      end
+
+      def shell_headers
+        merge_headers(shared_headers(@session_opts),
+                      resource_uri_shell(@shell_uri),
+                      action_create,
+                      header_opts)
+      end
+
+      def action_create
+        {
+          "#{NS_ADDRESSING}:Action" => 'http://schemas.xmlsoap.org/ws/2004/09/transfer/Create',
+          :attributes! => {
+            "#{NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def header_opts
+        {
+          "#{NS_WSMAN_DMTF}:OptionSet" => {
+            "#{NS_WSMAN_DMTF}:Option" => [@noprofile, @codepage], :attributes! => {
+              "#{NS_WSMAN_DMTF}:Option" => {
+                'Name' => %w(WINRS_NOPROFILE WINRS_CODEPAGE)
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/header.rb

@@ -0,0 +1,203 @@
+# -*- 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.
+
+# rubocop:disable Metrics/MethodLength
+
+require_relative 'soap'
+require_relative 'iso8601_duration'
+
+module WinRM
+  module WSMV
+    # SOAP header utility mixin
+    module Header
+      # WSMan URI of the regular Windows cmd shell
+      RESOURCE_URI_CMD = 'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/cmd'.freeze
+
+      # WSMan URI for PowerShell
+      RESOURCE_URI_POWERSHELL = 'http://schemas.microsoft.com/powershell/Microsoft.PowerShell'.freeze
+
+      # Merge the various header hashes and make sure we carry all of the attributes
+      # through instead of overwriting them.
+      def merge_headers(*headers)
+        hdr = {}
+        headers.each do |h|
+          hdr.merge!(h) do |k, v1, v2|
+            v1.merge!(v2) if k == :attributes!
+          end
+        end
+        hdr
+      end
+
+      def shared_headers(session_opts)
+        {
+          "#{SOAP::NS_ADDRESSING}:To" => session_opts[:endpoint],
+          "#{SOAP::NS_ADDRESSING}:ReplyTo" => {
+            "#{SOAP::NS_ADDRESSING}:Address" =>
+              'http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous',
+            :attributes! => {
+              "#{SOAP::NS_ADDRESSING}:Address" => {
+                'mustUnderstand' => true
+              }
+            }
+          },
+          "#{SOAP::NS_WSMAN_DMTF}:MaxEnvelopeSize" => session_opts[:max_envelope_size],
+          "#{SOAP::NS_ADDRESSING}:MessageID" => "uuid:#{SecureRandom.uuid.to_s.upcase}",
+          "#{SOAP::NS_WSMAN_MSFT}:SessionId" => "uuid:#{session_opts[:session_id]}",
+          "#{SOAP::NS_WSMAN_DMTF}:Locale/" => '',
+          "#{SOAP::NS_WSMAN_MSFT}:DataLocale/" => '',
+          "#{SOAP::NS_WSMAN_DMTF}:OperationTimeout" =>
+            Iso8601Duration.sec_to_dur(session_opts[:operation_timeout]),
+          :attributes! => {
+            "#{SOAP::NS_WSMAN_DMTF}:MaxEnvelopeSize" => { 'mustUnderstand' => true },
+            "#{SOAP::NS_WSMAN_DMTF}:Locale/" => {
+              'xml:lang' => session_opts[:locale], 'mustUnderstand' => false
+            },
+            "#{SOAP::NS_WSMAN_MSFT}:DataLocale/" => {
+              'xml:lang' => session_opts[:locale], 'mustUnderstand' => false
+            },
+            "#{SOAP::NS_WSMAN_MSFT}:SessionId" => { 'mustUnderstand' => false }
+          }
+        }
+      end
+
+      # Helper methods for SOAP Headers
+
+      def resource_uri_shell(shell_uri)
+        {
+          "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" => shell_uri, :attributes! => {
+            "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def resource_uri_cmd
+        resource_uri_shell(RESOURCE_URI_CMD)
+      end
+
+      def resource_uri_wmi(namespace = 'root/cimv2/*')
+        {
+          "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" =>
+          "http://schemas.microsoft.com/wbem/wsman/1/wmi/#{namespace}",
+          :attributes! => {
+            "#{SOAP::NS_WSMAN_DMTF}:ResourceURI" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_get
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.xmlsoap.org/ws/2004/09/transfer/Get',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_delete
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.xmlsoap.org/ws/2004/09/transfer/Delete',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_command
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Command',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_receive
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Receive',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_send
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Send',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_signal
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Signal',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def action_enumerate
+        {
+          "#{SOAP::NS_ADDRESSING}:Action" =>
+          'http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerate',
+          :attributes! => {
+            "#{SOAP::NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def selector_shell_id(shell_id)
+        {
+          "#{SOAP::NS_WSMAN_DMTF}:SelectorSet" => {
+            "#{SOAP::NS_WSMAN_DMTF}:Selector" => shell_id, :attributes! => {
+              "#{SOAP::NS_WSMAN_DMTF}:Selector" => {
+                'Name' => 'ShellId'
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end
+
+# rubocop:enable Metrics/MethodLength