winrm 1.8.1 → 2.0.0

data/lib/winrm/shells/retryable.rb

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright 2016 Shawn Neal <sneal@sneal.net>
+# Copyright 2015 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 '../exceptions'
+
+module WinRM
+  module Shells
+    # Shell mixin for retrying an operation
+    module Retryable
+      RETRYABLE_EXCEPTIONS = lambda do
+        [
+          Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
+          Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH, ::WinRM::WinRMWSManFault,
+          ::WinRM::WinRMHTTPTransportError, ::WinRM::WinRMAuthorizationError,
+          HTTPClient::KeepAliveDisconnected, HTTPClient::ConnectTimeoutError
+        ].freeze
+      end
+
+      # Retries the operation a specified number of times with a delay between
+      # @param retries [Fixnum] The number of times to retry
+      # @param delay [Fixnum] The number of seconds to wait between retry attempts
+      def retryable(retries, delay)
+        yield
+      rescue *RETRYABLE_EXCEPTIONS.call
+        raise unless (retries -= 1) > 0
+        sleep(delay)
+        retry
+      end
+    end
+  end
+end

data/lib/winrm/shells/shell_factory.rb

@@ -0,0 +1,50 @@
+# -*- 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 'cmd'
+require_relative 'power_shell'
+
+module WinRM
+  module Shells
+    # Factory for creating concrete shell instances
+    class ShellFactory
+      # Creates a new ShellFactory instance
+      # @param connection_opts [ConnectionOpts] The WinRM connection options
+      # @param transport [HttpTransport] The WinRM SOAP transport for sending messages
+      # @param logger [Logger] The logger to log messages to
+      def initialize(connection_opts, transport, logger)
+        @connection_opts = connection_opts
+        @transport = transport
+        @logger = logger
+      end
+
+      # Creates a new shell instance based off the shell_type
+      # @param shell_type [Symbol] The shell type :cmd or :powershell
+      # @return The ready to use shell instance
+      def create_shell(shell_type)
+        type = shell_type.to_s.capitalize.to_sym
+        if Shells.constants.include?(type)
+          WinRM::Shells.const_get(type).new(@connection_opts, @transport, @logger)
+        else
+          message = "#{type} is not a valid WinRM shell type. " \
+            'Expected either :cmd, :powershell or pluggable shell.'
+          raise WinRM::InvalidShellError, message
+        end
+      end
+    end
+  end
+end

data/lib/winrm/version.rb

@@ -1,7 +1,7 @@
-# encoding: UTF-8
-
-# WinRM module
-module WinRM
-  # The version of the WinRM library
-  VERSION = '1.8.1'
-end
+# encoding: UTF-8
+
+# WinRM module
+module WinRM
+  # The version of the WinRM library
+  VERSION = '2.0.0'.freeze
+end

data/lib/winrm/wsmv/base.rb

@@ -0,0 +1,59 @@
+# -*- 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'
+require 'builder'
+require 'gyoku'
+require_relative 'soap'
+require_relative 'header'
+
+module WinRM
+  module WSMV
+    # Base class for all WSMV message classes
+    class Base
+      include WinRM::WSMV::SOAP
+      include WinRM::WSMV::Header
+
+      # Builds the WSMV message XML payload
+      def build
+        builder = Builder::XmlMarkup.new
+        builder.instruct!(:xml, encoding: 'UTF-8')
+        builder.tag! :env, :Envelope, namespaces do |env|
+          env.tag!(:env, :Header) do |env_header|
+            create_header(env_header)
+          end
+          env.tag!(:env, :Body) do |env_body|
+            create_body(env_body)
+          end
+        end
+      end
+
+      protected
+
+      def create_header
+        raise NotImplementedError
+      end
+
+      def create_body
+        raise NotImplementedError
+      end
+
+      def encode_bytes(bytes)
+        Base64.strict_encode64(bytes.pack('C*'))
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/cleanup_command.rb

@@ -0,0 +1,61 @@
+# -*- 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'
+
+module WinRM
+  module WSMV
+    # WSMV message to execute a command inside a remote shell
+    class CleanupCommand < Base
+      def initialize(session_opts, opts)
+        raise 'opts[:shell_id] is required' unless opts[:shell_id]
+        raise 'opts[:command_id] is required' unless opts[:command_id]
+        @session_opts = session_opts
+        @shell_id = opts[:shell_id]
+        @command_id = opts[:command_id]
+        @shell_uri = opts[:shell_uri] || RESOURCE_URI_CMD
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(cleanup_header)
+      end
+
+      def create_body(body)
+        body.tag!("#{NS_WIN_SHELL}:Signal", 'CommandId' => @command_id) do |cl|
+          cl << Gyoku.xml(cleanup_body)
+        end
+      end
+
+      private
+
+      def cleanup_header
+        merge_headers(shared_headers(@session_opts),
+                      resource_uri_shell(@shell_uri),
+                      action_signal,
+                      selector_shell_id(@shell_id))
+      end
+
+      def cleanup_body
+        {
+          "#{NS_WIN_SHELL}:Code" =>
+            'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/signal/terminate'
+        }
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/close_shell.rb

@@ -0,0 +1,50 @@
+# -*- 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'
+
+module WinRM
+  module WSMV
+    # WSMV message to close a remote shell
+    class CloseShell < Base
+      def initialize(session_opts, shell_opts)
+        raise 'shell_opts[:shell_id] is required' unless shell_opts[:shell_id]
+        @session_opts = session_opts
+        @shell_id = shell_opts[:shell_id]
+        @shell_uri = shell_opts[:shell_uri] || RESOURCE_URI_CMD
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(close_header)
+      end
+
+      def create_body(_body)
+        # no body
+      end
+
+      private
+
+      def close_header
+        merge_headers(shared_headers(@session_opts),
+                      resource_uri_shell(@shell_uri),
+                      action_delete,
+                      selector_shell_id(@shell_id))
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/command.rb

@@ -0,0 +1,101 @@
+# -*- 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'
+
+module WinRM
+  module WSMV
+    # WSMV message to execute a command inside a remote shell
+    class Command < Base
+      attr_reader :command_id
+
+      def initialize(session_opts, cmd_opts)
+        @command_id = SecureRandom.uuid.to_s.upcase
+        validate_opts(session_opts, cmd_opts)
+        init_ops(session_opts, cmd_opts)
+      end
+
+      def build
+        xml = super
+        issue69_unescape_single_quotes(xml)
+      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 init_ops(session_opts, cmd_opts)
+        @session_opts = session_opts
+        @shell_id = cmd_opts[:shell_id]
+        @command = cmd_opts[:command]
+        @arguments = cmd_opts[:arguments] || []
+        @shell_uri = cmd_opts[:shell_uri] || RESOURCE_URI_CMD
+        @consolemode = cmd_opts.key?(:console_mode_stdin) ? cmd_opts[:console_mode_stdin] : 'TRUE'
+        @skipcmd = cmd_opts.key?(:skip_cmd_shell) ? cmd_opts[:skip_cmd_shell] : 'FALSE'
+      end
+
+      def validate_opts(session_opts, cmd_opts)
+        raise 'session_opts is required' unless session_opts
+        raise 'cmd_opts[:shell_id] is required' unless cmd_opts[:shell_id]
+        raise 'cmd_opts[:command] is required' unless cmd_opts[:command]
+      end
+
+      def issue69_unescape_single_quotes(xml)
+        escaped_cmd = %r{<#{NS_WIN_SHELL}:Command>(.+)<\/#{NS_WIN_SHELL}:Command>}m.match(xml)[1]
+        xml[escaped_cmd] = escaped_cmd.gsub(/&#39;/, "'")
+        xml
+      end
+
+      def command_body
+        {
+          "#{NS_WIN_SHELL}:Command" => "\"#{@command}\"", "#{NS_WIN_SHELL}:Arguments" => @arguments
+        }
+      end
+
+      def command_headers
+        merge_headers(shared_headers(@session_opts),
+                      resource_uri_shell(@shell_uri),
+                      action_command,
+                      command_header_opts,
+                      selector_shell_id(@shell_id))
+      end
+
+      def command_header_opts
+        return {} if @shell_uri != RESOURCE_URI_CMD
+        # this is only needed for the regular Windows shell
+        {
+          "#{NS_WSMAN_DMTF}:OptionSet" => {
+            "#{NS_WSMAN_DMTF}:Option" => [@consolemode, @skipcmd], :attributes! => {
+              "#{NS_WSMAN_DMTF}:Option" => {
+                'Name' => %w(WINRS_CONSOLEMODE_STDIN WINRS_SKIP_CMD_SHELL)
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/command_output.rb

@@ -0,0 +1,76 @@
+# -*- 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'
+
+module WinRM
+  module WSMV
+    # WSMV message to get output from a remote shell
+    class CommandOutput < Base
+      def initialize(session_opts, command_out_opts)
+        raise 'command_out_opts[:shell_id] is required' unless command_out_opts[:shell_id]
+        raise 'command_out_opts[:command_id] is required' unless command_out_opts[:command_id]
+        @session_opts = session_opts
+        @shell_id = command_out_opts[:shell_id]
+        @command_id = command_out_opts[:command_id]
+        @shell_uri = command_out_opts[:shell_uri] || RESOURCE_URI_CMD
+        @out_streams = command_out_opts[:out_streams] || %w(stdout stderr)
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(output_header)
+      end
+
+      def create_body(body)
+        body.tag!("#{NS_WIN_SHELL}:Receive") { |cl| cl << Gyoku.xml(output_body) }
+      end
+
+      private
+
+      def output_header
+        merge_headers(shared_headers(@session_opts),
+                      resource_uri_shell(@shell_uri),
+                      action_receive,
+                      header_opts,
+                      selector_shell_id(@shell_id))
+      end
+
+      def header_opts
+        {
+          "#{NS_WSMAN_DMTF}:OptionSet" => {
+            "#{NS_WSMAN_DMTF}:Option" => 'TRUE', :attributes! => {
+              "#{NS_WSMAN_DMTF}:Option" => {
+                'Name' => 'WSMAN_CMDSHELL_OPTION_KEEPALIVE'
+              }
+            }
+          }
+        }
+      end
+
+      def output_body
+        {
+          "#{NS_WIN_SHELL}:DesiredStream" => @out_streams.join(' '), :attributes! => {
+            "#{NS_WIN_SHELL}:DesiredStream" => {
+              'CommandId' => @command_id
+            }
+          }
+        }
+      end
+    end
+  end
+end