winrm 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b23f30eeef61764dafa663e77588acda56160b5
-  data.tar.gz: cfbde1991563fd9b6d9dc9bc08171c5404cd330c
+  metadata.gz: 8513f8bd7975beaf571799996f1a2a799d5f9703
+  data.tar.gz: 18d6d880eb43e8038048e587ce4530472a09798f
 SHA512:
-  metadata.gz: 2b28caeef7b43e428caafd1bd1406e9a1c9bf7a7e889683e1f7aad4ec6519b5f9831cad6f4014970d2be6fc3f12c01f1e321b0cf6622863f714637050c55b60b
-  data.tar.gz: 0c0c4ab172e632e70c9baf09bc58217f9a0e9b8c9412c12f3fbefc9a083b8a4e93cd197c185b65a530d680e55ed2169aaf7ba9d66f9d1d8c4f608baba558b3b2
+  metadata.gz: d71061fcb4154162b517fead0f4392d0e012494e5fe506aa7c712beab933a45ac8f90e154e028f2f50166bcec9cf19245422f30f66c8081adc923455595db4d6
+  data.tar.gz: 15ea773970783c2fdcf4cd1220d057c4cbee4a66d998e00ff444b2c9002cceb38aeff61b3f442b2a2ad753fed169559547592a382a1f89e0096b37ec2829d0d0

data/README.md

@@ -27,10 +27,11 @@ opts = {
 }
 conn = WinRM::Connection.new(opts)
 conn.shell(:powershell) do |shell|
-  shell.run('$PSVersionTable') do |stdout, stderr|
+  output = shell.run('$PSVersionTable') do |stdout, stderr|
     STDOUT.print stdout
     STDERR.print stderr
   end
+  puts "The script exited with exit code #{output.exitcode}"
 end
 ```
 

data/changelog.md

@@ -1,5 +1,10 @@
 # WinRM Gem Changelog
 
+# 2.0.2
+- Constrain to rubyntlm `>= 0.6.1` to avoid mutating frozen strings
+- When using certificate authentication, do not validate presense of user and password
+- Handle failed `PIPELINE_STATE` messages so that `throw` errors are not swallowed
+
 # 2.0.1
 - Fixed Powershell shell leakage when not explicitly closed
 - Fixed cmd commands with responses that extend beyond one stream

data/lib/winrm/connection_opts.rb

@@ -66,8 +66,12 @@ module WinRM
 
     def validate_required_fields
       raise 'endpoint is a required option' unless self[:endpoint]
-      raise 'user is a required option' unless self[:user]
-      raise 'password is a required option' unless self[:password]
+      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

data/lib/winrm/psrp/message_data.rb

@@ -18,6 +18,7 @@ require_relative 'message_data/base'
 require_relative 'message_data/error_record'
 require_relative 'message_data/pipeline_output'
 require_relative 'message_data/pipeline_host_call'
+require_relative 'message_data/pipeline_state'
 require_relative 'message_data/runspacepool_host_call'
 require_relative 'message_data/runspacepool_state'
 require_relative 'message_data/session_capability'

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

@@ -17,7 +17,7 @@
 module WinRM
   module PSRP
     module MessageData
-      # pipeline host call message type
+      # error record message type
       class ErrorRecord < Base
         def exception
           @exception ||= property_hash('Exception')

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

@@ -0,0 +1,40 @@
+# -*- 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.
+
+module WinRM
+  module PSRP
+    module MessageData
+      # pipeline state message type
+      class PipelineState < Base
+        NOT_STARTED = 0
+        RUNNING = 1
+        STOPPING = 2
+        STOPPED = 3
+        COMPLETED = 4
+        FAILED = 5
+        DISCONNECTED = 6
+
+        def pipeline_state
+          clixml[:i32].to_i
+        end
+
+        def exception_as_error_record
+          @exception_as_error_record ||= ErrorRecord.new(raw) if pipeline_state == FAILED
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/powershell_output_decoder.rb

@@ -16,11 +16,13 @@
 
 require 'base64'
 require_relative 'message'
+require_relative 'message_data/pipeline_state'
 
 module WinRM
   module PSRP
     # Handles decoding a raw powershell output response
     class PowershellOutputDecoder
+      # rubocop:disable Metrics/CyclomaticComplexity
       # Decode the raw SOAP output into decoded PSRP message,
       # Removes BOM and replaces encoded line endings
       # @param raw_output [String] The raw encoded output
@@ -35,8 +37,13 @@ module WinRM
           decode_host_call(message)
         when WinRM::PSRP::Message::MESSAGE_TYPES[:error_record]
           decode_error_record(message)
+        when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
+          if message.parsed_data.pipeline_state == WinRM::PSRP::MessageData::PipelineState::FAILED
+            decode_error_record(message)
+          end
         end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       protected
 
@@ -66,15 +73,19 @@ module WinRM
       def decode_error_record(message)
         parsed = message.parsed_data
         text = begin
-          case parsed.fully_qualified_error_id
-          when 'Microsoft.PowerShell.Commands.WriteErrorException'
-            render_write_error_exception(parsed)
-          when 'NativeCommandError'
-            render_native_command_error(parsed)
-          when 'NativeCommandErrorMessage'
-            parsed.exception[:message]
+          if message.type == WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
+            render_exception_as_error_record(parsed.exception_as_error_record)
           else
-            render_exception(parsed)
+            case parsed.fully_qualified_error_id
+            when 'Microsoft.PowerShell.Commands.WriteErrorException'
+              render_write_error_exception(parsed)
+            when 'NativeCommandError'
+              render_native_command_error(parsed)
+            when 'NativeCommandErrorMessage'
+              parsed.exception[:message]
+            else
+              render_exception(parsed)
+            end
           end
         end
 
@@ -106,6 +117,14 @@ EOH
 EOH
       end
 
+      def render_exception_as_error_record(parsed)
+        <<EOH
+#{parsed.exception[:message]}
+    + CategoryInfo          : #{parsed.error_category_message}
+    + FullyQualifiedErrorId : #{parsed.fully_qualified_error_id}
+EOH
+      end
+
       private
 
       def hex_decode(text)

data/lib/winrm/psrp/receive_response_reader.rb

@@ -78,6 +78,10 @@ module WinRM
           type = :stderr
         when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_host_call]
           type = :stderr if message.data.include?('WriteError')
+        when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
+          if message.parsed_data.pipeline_state == WinRM::PSRP::MessageData::PipelineState::FAILED
+            type = :stderr
+          end
         end
         type
       end

data/lib/winrm/version.rb

@@ -3,5 +3,5 @@
 # WinRM module
 module WinRM
   # The version of the WinRM library
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.0.2'.freeze
 end

data/tests/integration/powershell_spec.rb

@@ -13,6 +13,12 @@ describe 'winrm client powershell' do
     it { should have_no_stderr }
   end
 
+  describe 'throw' do
+    subject(:output) { @powershell.run("throw 'an error occured'") }
+    it { should have_exit_code 0 }
+    it { should have_stderr_match(/an error occured/) }
+  end
+
   describe 'exit' do
     subject(:output) { @powershell.run('exit 5') }
     it { should have_exit_code 5 }

data/tests/spec/configuration_spec.rb

@@ -2,13 +2,82 @@
 require 'winrm/connection_opts'
 
 describe WinRM::ConnectionOpts do
+  shared_examples 'invalid options' do
+    it 'throws a validation error' do
+      expect { WinRM::ConnectionOpts.create_with_defaults(overrides) }.to raise_error
+    end
+  end
+
   context 'when there are no overrides' do
-    describe '#create_with_defaults' do
-      it 'throws a validation error' do
-        expect { WinRM::ConnectionOpts.create_with_defaults({}) }.to raise_error
-      end
+    it_behaves_like 'invalid options'
+  end
+
+  context 'when there are only username and password' do
+    let(:overrides) do
+      {
+        user: 'Administrator',
+        password: 'password'
+      }
+    end
+
+    it_behaves_like 'invalid options'
+  end
+
+  context 'when there are only username and endpoint' do
+    let(:overrides) do
+      {
+        user: 'Administrator',
+        endpoint: 'http://localhost:5985/wsman'
+      }
+    end
+
+    it_behaves_like 'invalid options'
+  end
+
+  context 'when there are only password and endpoint' do
+    let(:overrides) do
+      {
+        password: 'password',
+        endpoint: 'http://localhost:5985/wsman'
+      }
     end
+
+    it_behaves_like 'invalid options'
   end
+
+  context 'when there are only certificate and key' do
+    let(:overrides) do
+      {
+        client_cert: 'path/to/cert',
+        client_key: 'path/to/key'
+      }
+    end
+
+    it_behaves_like 'invalid options'
+  end
+
+  context 'when there are only certificate and endpoint' do
+    let(:overrides) do
+      {
+        client_cert: 'path/to/cert',
+        endpoint: 'http://localhost:5985/wsman'
+      }
+    end
+
+    it_behaves_like 'invalid options'
+  end
+
+  context 'when there are only key and endpoint' do
+    let(:overrides) do
+      {
+        client_key: 'path/to/key',
+        endpoint: 'http://localhost:5985/wsman'
+      }
+    end
+
+    it_behaves_like 'invalid options'
+  end
+
   context 'when username, password, and endpoint are given' do
     let(:overrides) do
       {
@@ -26,6 +95,25 @@ describe WinRM::ConnectionOpts do
       end
     end
   end
+
+  context 'when certificate, key and endpoint are given' do
+    let(:overrides) do
+      {
+        client_cert: 'path/to/cert',
+        client_key: 'path/to/key',
+        endpoint: 'http://localhost:5985/wsman'
+      }
+    end
+    describe '#create_with_defaults' do
+      it 'creates a ConnectionOpts object' do
+        config = WinRM::ConnectionOpts.create_with_defaults(overrides)
+        expect(config[:client_cert]).to eq(overrides[:client_cert])
+        expect(config[:client_key]).to eq(overrides[:client_key])
+        expect(config[:endpoint]).to eq(overrides[:endpoint])
+      end
+    end
+  end
+
   context 'when overrides are provided' do
     let(:overrides) do
       {
@@ -42,6 +130,7 @@ describe WinRM::ConnectionOpts do
       end
     end
   end
+
   context 'when receive_timeout is specified' do
     let(:overrides) do
       {
@@ -58,6 +147,7 @@ describe WinRM::ConnectionOpts do
       end
     end
   end
+
   context 'when operation_timeout is specified' do
     let(:overrides) do
       {
@@ -75,6 +165,7 @@ describe WinRM::ConnectionOpts do
       end
     end
   end
+
   context 'when invalid data types are given' do
     let(:overrides) do
       {

data/tests/spec/psrp/message_data/pipeline_state_spec.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+
+require 'winrm/psrp/message_data/base'
+require 'winrm/psrp/message_data/pipeline_state'
+
+describe WinRM::PSRP::MessageData::PipelineState do
+  let(:test_data_xml_template) do
+    ERB.new(stubbed_clixml('pipeline_state.xml.erb'))
+  end
+  let(:pipeline_state) { WinRM::PSRP::MessageData::PipelineState::FAILED }
+  let(:error_message) { 'an error occured' }
+  let(:category_message) { 'category message' }
+  let(:error_id) { 'an error occured' }
+  let(:raw_data) { test_data_xml_template.result(binding) }
+  subject { described_class.new(raw_data) }
+
+  it 'returns the state' do
+    expect(subject.pipeline_state).to eq(pipeline_state)
+  end
+
+  it 'returns the exception' do
+    expect(subject.exception_as_error_record.exception[:message]).to eq(error_message)
+  end
+
+  it 'returns the FullyQualifiedErrorId' do
+    expect(subject.exception_as_error_record.fully_qualified_error_id).to eq(error_id)
+  end
+
+  it 'returns the error category message' do
+    expect(subject.exception_as_error_record.error_category_message).to eq(category_message)
+  end
+
+  context 'state is not failed' do
+    let(:pipeline_state) { WinRM::PSRP::MessageData::PipelineState::COMPLETED }
+
+    it 'has a nil exception' do
+      expect(subject.exception_as_error_record).to be(nil)
+    end
+  end
+end

data/tests/spec/psrp/powershell_output_decoder_spec.rb

@@ -17,7 +17,7 @@ describe WinRM::PSRP::PowershellOutputDecoder do
   subject { described_class.new.decode(message) }
 
   context 'undecodable message type' do
-    let(:message_type) { WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state] }
+    let(:message_type) { WinRM::PSRP::Message::MESSAGE_TYPES[:public_key] }
 
     it 'ignores message' do
       expect(subject).to be nil
@@ -81,4 +81,20 @@ describe WinRM::PSRP::PowershellOutputDecoder do
       expect(subject).to match(/#{error_message}/)
     end
   end
+
+  context 'receiving error record in pipeline state' do
+    let(:message_type) { WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state] }
+    let(:test_data_error_xml_template) do
+      ERB.new(stubbed_clixml('pipeline_state.xml.erb'))
+    end
+    let(:pipeline_state) { WinRM::PSRP::MessageData::PipelineState::FAILED }
+    let(:error_message) { 'an error' }
+    let(:category_message) { 'category message' }
+    let(:error_id) { 'an error' }
+    let(:data) { test_data_error_xml_template.result(binding) }
+
+    it 'decodes error record' do
+      expect(subject).to match(/#{error_message}/)
+    end
+  end
 end

data/tests/spec/psrp/recieve_response_reader_spec.rb

@@ -69,6 +69,24 @@ describe WinRM::PSRP::ReceiveResponseReader do
       end
     end
 
+    context 'response doc failed pipeline state' do
+      let(:message_type) { WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state] }
+      let(:test_data_error_xml_template) do
+        ERB.new(stubbed_clixml('pipeline_state.xml.erb'))
+      end
+      let(:pipeline_state) { WinRM::PSRP::MessageData::PipelineState::FAILED }
+      let(:error_message) { 'an error' }
+      let(:category_message) { 'category message' }
+      let(:error_id) { 'Microsoft.PowerShell.Commands.WriteErrorException' }
+      let(:test_data) { test_data_error_xml_template.result(binding) }
+
+      it 'outputs to stderr' do
+        expect(
+          subject.read_output(output_message).stderr
+        ).to match(/#{error_message}/)
+      end
+    end
+
     context 'response doc writing error to host' do
       let(:message_type) { WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_host_call] }
       let(:test_data) do

data/tests/spec/stubs/clixml/pipeline_state.xml.erb

@@ -0,0 +1,88 @@
+<?xml version="1.0"?>
+<Obj RefId="0">
+	<MS>
+		<I32 N="PipelineState"><%= pipeline_state %></I32>
+		<Obj N="ExceptionAsErrorRecord" RefId="1">
+			<TN RefId="0">
+				<T>System.Management.Automation.ErrorRecord</T>
+				<T>System.Object</T>
+			</TN>
+			<ToString><%= error_message %></ToString>
+			<MS>
+				<Obj N="Exception" RefId="2">
+					<TN RefId="1">
+						<T>System.Management.Automation.RuntimeException</T>
+						<T>Microsoft.PowerShell.CoreClr.Stubs.SystemException</T>
+						<T>System.Exception</T>
+						<T>System.Object</T>
+					</TN>
+					<ToString>System.Management.Automation.RuntimeException: <%= error_message %></ToString>
+					<Props>
+						<S N="ErrorRecord"><%= error_message %></S>
+						<B N="WasThrownFromThrowStatement">true</B>
+						<S N="Message"><%= error_message %></S>
+						<Obj N="Data" RefId="3">
+							<TN RefId="2">
+								<T>System.Collections.ListDictionaryInternal</T>
+								<T>System.Object</T>
+							</TN>
+							<DCT />
+						</Obj>
+						<Nil N="InnerException" />
+						<Nil N="StackTrace" />
+						<Nil N="HelpLink" />
+						<Nil N="Source" />
+						<I32 N="HResult">-2146233088</I32>
+					</Props>
+				</Obj>
+				<S N="TargetObject"><%= error_message %></S>
+				<S N="FullyQualifiedErrorId"><%= error_id %></S>
+				<Obj N="InvocationInfo" RefId="4">
+					<TN RefId="3">
+						<T>System.Management.Automation.InvocationInfo</T>
+						<T>System.Object</T>
+					</TN>
+					<ToString>System.Management.Automation.InvocationInfo</ToString>
+					<Props>
+						<Nil N="MyCommand" />
+						<Obj N="BoundParameters" RefId="5">
+							<TN RefId="4">
+								<T>System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</T>
+								<T>System.Object</T>
+							</TN>
+							<DCT />
+						</Obj>
+						<Obj N="UnboundArguments" RefId="6">
+							<TN RefId="5">
+								<T>System.Collections.Generic.List`1[[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</T>
+								<T>System.Object</T>
+							</TN>
+							<LST />
+						</Obj>
+						<I32 N="ScriptLineNumber">1</I32>
+						<I32 N="OffsetInLine">1</I32>
+						<I64 N="HistoryId">-1</I64>
+						<S N="ScriptName"></S>
+						<S N="Line">throw '<%= error_message %>'</S>
+						<S N="PositionMessage">At line:1 char:1_x000D__x000A_+ throw '<%= error_message %>'_x000D__x000A_+ ~~~~~~~~~~~~~~~~~~~~~~~~</S>
+						<S N="PSScriptRoot"></S>
+						<Nil N="PSCommandPath" />
+						<S N="InvocationName"></S>
+						<I32 N="PipelineLength">0</I32>
+						<I32 N="PipelinePosition">0</I32>
+						<B N="ExpectingInput">false</B>
+						<S N="CommandOrigin">Internal</S>
+						<Nil N="DisplayScriptPosition" />
+					</Props>
+				</Obj>
+				<I32 N="ErrorCategory_Category">14</I32>
+				<S N="ErrorCategory_Activity"></S>
+				<S N="ErrorCategory_Reason">RuntimeException</S>
+				<S N="ErrorCategory_TargetName"><%= error_message %></S><S N="ErrorCategory_TargetType">String</S>
+				<S N="ErrorCategory_Message"><%= category_message %></S>
+				<B N="SerializeExtendedInfo">false</B>
+				<S N="ErrorDetails_ScriptStackTrace">at &lt;ScriptBlock&gt;, &lt;No file&gt;: line 1</S>
+			</MS>
+		</Obj>
+	</MS>
+</Obj>

data/winrm.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.0'
   s.add_runtime_dependency 'gssapi', '~> 1.2'
   s.add_runtime_dependency 'httpclient', '~> 2.2', '>= 2.2.0.2'
-  s.add_runtime_dependency 'rubyntlm', '~> 0.6.0'
+  s.add_runtime_dependency 'rubyntlm', '~> 0.6.0', '>= 0.6.1'
   s.add_runtime_dependency 'logging', ['>= 1.6.1', '< 3.0']
   s.add_runtime_dependency 'nori', '~> 2.0'
   s.add_runtime_dependency 'gyoku', '~> 1.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winrm
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Dan Wanek
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gssapi
@@ -52,6 +52,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,6 +62,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
@@ -245,6 +251,7 @@ files:
 - lib/winrm/psrp/message_data/error_record.rb
 - lib/winrm/psrp/message_data/pipeline_host_call.rb
 - lib/winrm/psrp/message_data/pipeline_output.rb
+- lib/winrm/psrp/message_data/pipeline_state.rb
 - lib/winrm/psrp/message_data/runspacepool_host_call.rb
 - lib/winrm/psrp/message_data/runspacepool_state.rb
 - lib/winrm/psrp/message_data/session_capability.rb
@@ -300,6 +307,7 @@ files:
 - tests/spec/psrp/message_data/error_record_spec.rb
 - tests/spec/psrp/message_data/pipeline_host_call_spec.rb
 - tests/spec/psrp/message_data/pipeline_output_spec.rb
+- tests/spec/psrp/message_data/pipeline_state_spec.rb
 - tests/spec/psrp/message_data/runspace_pool_host_call_spec.rb
 - tests/spec/psrp/message_data/runspacepool_state_spec.rb
 - tests/spec/psrp/message_data/session_capability_spec.rb
@@ -316,6 +324,7 @@ files:
 - tests/spec/shells/powershell_spec.rb
 - tests/spec/spec_helper.rb
 - tests/spec/stubs/clixml/error_record.xml.erb
+- tests/spec/stubs/clixml/pipeline_state.xml.erb
 - tests/spec/stubs/responses/get_command_output_response.xml.erb
 - tests/spec/stubs/responses/get_command_output_response_not_done.xml.erb
 - tests/spec/stubs/responses/get_powershell_keepalive_response.xml.erb