winrm 2.2.3 → 2.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 46a0806843f652f3d0b8d8858eb87cf0365d8e4d
-  data.tar.gz: 76f409feeda643970222972be8c571e2905a6fb9
+SHA256:
+  metadata.gz: d70e24f7a32d8dac9c3d3a7c1675c40af3431df4e5c9a1b202cd87de21bb0a1f
+  data.tar.gz: 839b983ad19d3172c56cac95955efd20191a5f80880a53197366d2ef44b7dd4a
 SHA512:
-  metadata.gz: cd17e956aa071c63ab65c0a9db69bada2a256b735ee4c9e2b63b32a16920357749bc814b32b15dd3ad61e777d77144fa73eea1e851c23347e0486ded69ffd47b
-  data.tar.gz: 119346b0543a18a8715f90b2c318df0bf98cbdeeae16d8afd7ffd70f73c6690b620e8c94d541e4a0798dc490c395f5e4feee7d12c8e83fddf64970560781602d
+  metadata.gz: 20d3f20e5ddf0dc50519145c6bb13b40c1e5da21770510a50fd529bb2afb4b87ea3f55cde0a6653ccffdd1368a041c98992957800a9b45a016e8f6fd113eac61
+  data.tar.gz: 01ad60c5c78598ebf17434a02b0b4848eaeb605d2f5871edd11dc16be8c627d1bb8bf4390a282f80ebaaced51564858b5d2a82c552c608115054b78e4ad0e4dc

data/README.md

@@ -72,7 +72,7 @@ The `:negotiate` transport uses the [rubyntlm gem](https://github.com/WinRb/ruby
 ### `:ssl`
 ```ruby
 WinRM::Connection.new( 
-  endpoint: 'https://myhost:59856/wsman',
+  endpoint: 'https://myhost:5986/wsman',
   transport: :ssl,
   user: 'administrator',
   password: 'Pass@word1'

data/bin/rwinrm

@@ -1,97 +1,90 @@
-#!/usr/bin/env ruby
-# 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.
-
-# rubocop:disable all
-
-$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
-
-require 'readline'
-require 'io/console'
-require 'winrm'
-
-def help_msg
-  puts 'Usage: rwinrm user@host'
-  puts ''
-end
-
-def parse_options
-  options = {}
-  fail 'Missing required options' unless ARGV.length == 1
-
-  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?/i.match(ARGV[0])
-  fail "#{ARGV[0]} is an invalid host" unless m
-  options[:user] = m[:user]
-  options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
-
-  # Get the password
-  print 'Password: '
-  options[:pass] = STDIN.noecho(&:gets).chomp
-  puts
-
-  # Set some defaults required by WinRM WS
-  options[:auth_type] = :plaintext
-  options[:basic_auth_only] = true
-
-  options
-rescue StandardError => e
-  puts e.message
-  help_msg
-  exit 1
-end
-
-def repl(options)
-  client = WinRM::WinRMWebService.new(
-    options[:endpoint],
-    options[:auth_type].to_sym,
-    options)
-
-  client.set_timeout(3600)
-  shell_id = client.open_shell
-  command_id = client.run_command(shell_id, 'cmd', "/K prompt [#{ARGV[0]}]$P$G")
-
-  read_thread = Thread.new do
-    client.get_command_output(shell_id, command_id) do |stdout, stderr|
-      STDOUT.write stdout
-      STDERR.write stderr
-    end
-  end
-  read_thread.abort_on_exception = true
-
-  while (buf = Readline.readline('', true))
-    if buf =~ /^exit/
-      read_thread.exit
-      client.cleanup_command(shell_id, command_id)
-      client.close_shell(shell_id)
-      exit 0
-    else
-      client.write_stdin(shell_id, command_id, "#{buf}\r\n")
-    end
-  end
-rescue Interrupt
-  puts 'exiting'
-  # ctrl-c
-rescue WinRM::WinRMAuthorizationError
-  puts 'Authentication failed, bad user name or password'
-  exit 1
-rescue StandardError => e
-  puts e.message
-  exit 1
-end
-
-repl(parse_options)
-
-# rubocop:enable all
+#!/usr/bin/env ruby
+
+# 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.
+
+# rubocop:disable all
+
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'readline'
+require 'io/console'
+require 'winrm'
+
+def help_msg
+  puts 'Usage: rwinrm user@host'
+  puts ''
+end
+
+def parse_options
+  options = {}
+  fail 'Missing required options' unless ARGV.length == 1
+
+  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?/i.match(ARGV[0])
+  fail "#{ARGV[0]} is an invalid host" unless m
+  options[:user] = m[:user]
+  options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
+
+  # Get the password
+  print 'Password: '
+  options[:password] = STDIN.noecho(&:gets).chomp
+  puts
+
+  # Set some defaults required by WinRM WS
+  options[:transport] = :plaintext
+  options[:basic_auth_only] = true
+  options[:operation_timeout] = 3600
+
+  options
+rescue StandardError => e
+  puts e.message
+  help_msg
+  exit 1
+end
+
+def repl(options)
+  shell = nil
+
+  client = WinRM::Connection.new(options)
+  shell = client.shell(:powershell)
+  prompt = "PS #{ARGV[0]}> "
+
+  while (buf = Readline.readline(prompt, true))
+    if buf =~ /^exit/
+      shell.close
+      shell = nil
+      exit 0
+    else
+      shell.run(buf) do |stdout, stderr|
+        $stdout.write stdout
+        $stderr.write stderr
+      end
+    end
+  end
+rescue Interrupt
+  puts 'exiting'
+  # ctrl-c
+rescue WinRM::WinRMAuthorizationError
+  puts 'Authentication failed, bad user name or password'
+  exit 1
+rescue StandardError => e
+  puts e.message
+  exit 1
+ensure
+  shell.close unless shell.nil?
+end
+
+repl(parse_options)
+
+# rubocop:enable all

data/lib/winrm/connection.rb

@@ -1,86 +1,84 @@
-# -*- 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 'connection_opts'
-require_relative 'http/transport_factory'
-require_relative 'shells/shell_factory'
-require_relative 'wsmv/wql_query'
-require_relative 'wsmv/wql_pull'
-
-module WinRM
-  # WinRM connection used to establish a session with the remote WinRM service.
-  class Connection
-    # Creates a new WinRM connection
-    # See the ConnectionOpts class for connection options.
-    def initialize(connection_opts)
-      configure_connection_opts(connection_opts)
-      configure_logger
-    end
-
-    attr_accessor :logger
-
-    # Creates a new shell on the remote Windows server associated with
-    # this connection.
-    # @param shell_type [Symbol] The shell type :cmd or :powershell
-    # @param shell_opts [Hash] Options targeted for the created shell
-    # @return [Shell] PowerShell or Cmd shell instance.
-    def shell(shell_type, shell_opts = {})
-      shell = shell_factory.create_shell(shell_type, shell_opts)
-      if block_given?
-        begin
-          yield shell
-        ensure
-          shell.close
-        end
-      else
-        shell
-      end
-    end
-
-    # Executes a WQL query against the WinRM connection
-    # @param wql [String] The wql query
-    # @param namespace [String] namespace for query - default is root/cimv2/*
-    # @return [Hash] Hash representation of wql query response (Hash is empty if a block is given)
-    # @yeild [type, item] Yields the time name and item for every item
-    def run_wql(wql, namespace = 'root/cimv2/*', &block)
-      query = WinRM::WSMV::WqlQuery.new(transport, @connection_opts, wql, namespace)
-      query.process_response(transport.send_request(query.build), &block)
-    end
-
-    private
-
-    def configure_connection_opts(connection_opts)
-      @connection_opts = ConnectionOpts.create_with_defaults(connection_opts)
-    end
-
-    def configure_logger
-      @logger = Logging.logger[self]
-      logger.level = :warn
-      logger.add_appenders(Logging.appenders.stdout)
-    end
-
-    def shell_factory
-      @shell_factory ||= WinRM::Shells::ShellFactory.new(@connection_opts, transport, logger)
-    end
-
-    def transport
-      @transport ||= begin
-        transport_factory = WinRM::HTTP::TransportFactory.new
-        transport_factory.create_transport(@connection_opts)
-      end
-    end
-  end
-end
+# 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 'connection_opts'
+require_relative 'http/transport_factory'
+require_relative 'shells/shell_factory'
+require_relative 'wsmv/wql_query'
+require_relative 'wsmv/wql_pull'
+
+module WinRM
+  # WinRM connection used to establish a session with the remote WinRM service.
+  class Connection
+    # Creates a new WinRM connection
+    # See the ConnectionOpts class for connection options.
+    def initialize(connection_opts)
+      configure_connection_opts(connection_opts)
+      configure_logger
+    end
+
+    attr_accessor :logger
+
+    # Creates a new shell on the remote Windows server associated with
+    # this connection.
+    # @param shell_type [Symbol] The shell type :cmd or :powershell
+    # @param shell_opts [Hash] Options targeted for the created shell
+    # @return [Shell] PowerShell or Cmd shell instance.
+    def shell(shell_type, shell_opts = {})
+      shell = shell_factory.create_shell(shell_type, shell_opts)
+      if block_given?
+        begin
+          yield shell
+        ensure
+          shell.close
+        end
+      else
+        shell
+      end
+    end
+
+    # Executes a WQL query against the WinRM connection
+    # @param wql [String] The wql query
+    # @param namespace [String] namespace for query - default is root/cimv2/*
+    # @return [Hash] Hash representation of wql query response (Hash is empty if a block is given)
+    # @yeild [type, item] Yields the time name and item for every item
+    def run_wql(wql, namespace = 'root/cimv2/*', &block)
+      query = WinRM::WSMV::WqlQuery.new(transport, @connection_opts, wql, namespace)
+      query.process_response(transport.send_request(query.build), &block)
+    end
+
+    private
+
+    def configure_connection_opts(connection_opts)
+      @connection_opts = ConnectionOpts.create_with_defaults(connection_opts)
+    end
+
+    def configure_logger
+      @logger = Logging.logger[self]
+      logger.level = :warn
+      logger.add_appenders(Logging.appenders.stdout)
+    end
+
+    def shell_factory
+      @shell_factory ||= WinRM::Shells::ShellFactory.new(@connection_opts, transport, logger)
+    end
+
+    def transport
+      @transport ||= begin
+        transport_factory = WinRM::HTTP::TransportFactory.new
+        transport_factory.create_transport(@connection_opts)
+      end
+    end
+  end
+end

data/lib/winrm/connection_opts.rb

@@ -1,91 +1,90 @@
-# -*- 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 '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
-
-    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
-      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
+# 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
+
+    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
+      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

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -52,6 +50,20 @@ module WinRM
     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