winrm 1.8.1 → 2.0.0

data/lib/winrm/wsmv/wql_query.rb

@@ -0,0 +1,79 @@
+# -*- 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 'nori'
+require_relative 'base'
+
+module WinRM
+  module WSMV
+    # WSMV message to query Windows via WQL
+    class WqlQuery < Base
+      def initialize(session_opts, wql)
+        @session_opts = session_opts
+        @wql = wql
+      end
+
+      def process_response(response)
+        parser = Nori.new(
+          parser: :rexml,
+          advanced_typecasting: false,
+          convert_tags_to: ->(tag) { tag.snakecase.to_sym },
+          strip_namespaces: true
+        )
+        hresp = parser.parse(response.to_s)[:envelope][:body]
+
+        # Normalize items so the type always has an array even if it's just a single item.
+        items = {}
+        if hresp[:enumerate_response][:items]
+          hresp[:enumerate_response][:items].each_pair do |k, v|
+            items[k] = v.is_a?(Array) ? v : [v]
+          end
+        end
+        items
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(wql_header)
+      end
+
+      def create_body(body)
+        body.tag!("#{NS_ENUM}:Enumerate") { |en| en << Gyoku.xml(wql_body) }
+      end
+
+      private
+
+      def wql_header
+        merge_headers(shared_headers(@session_opts), resource_uri_wmi, action_enumerate)
+      end
+
+      def wql_body
+        {
+          "#{NS_WSMAN_DMTF}:OptimizeEnumeration" => nil,
+          "#{NS_WSMAN_DMTF}:MaxElements" => '32000',
+          "#{NS_WSMAN_DMTF}:Filter" => @wql,
+          "#{NS_WSMAN_MSFT}:SessionId" => "uuid:#{@session_opts[:session_id]}",
+          :attributes! => {
+            "#{NS_WSMAN_DMTF}:Filter" => {
+              'Dialect' => 'http://schemas.microsoft.com/wbem/wsman/1/WQL'
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/write_stdin.rb

@@ -0,0 +1,88 @@
+# -*- 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_relative 'base'
+
+module WinRM
+  module WSMV
+    # WSMV message to send stdin to a remote shell
+    class WriteStdin < Base
+      def initialize(session_opts, stdin_opts)
+        validate_opts(session_opts, stdin_opts)
+        init_ops(session_opts, stdin_opts)
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(stdin_headers)
+      end
+
+      def create_body(body)
+        body << Gyoku.xml(stdin_body)
+      end
+
+      private
+
+      def init_ops(session_opts, stdin_opts)
+        @session_opts = session_opts
+        @shell_id = stdin_opts[:shell_id]
+        @command_id = stdin_opts[:command_id]
+        @stdin = stdin_opts[:stdin]
+        @shell_uri = stdin_opts[:shell_uri] || RESOURCE_URI_CMD
+      end
+
+      def validate_opts(session_opts, stdin_opts)
+        raise 'session_opts is required' unless session_opts
+        raise 'stdin_opts[:shell_id] is required' unless stdin_opts[:shell_id]
+        raise 'stdin_opts[:command_id] is required' unless stdin_opts[:command_id]
+        raise 'stdin_opts[:stdin] is required' unless stdin_opts[:stdin]
+      end
+
+      def stdin_headers
+        merge_headers(shared_headers(@session_opts),
+                      resource_uri_shell(@shell_uri),
+                      action_send,
+                      selector_shell_id(@shell_id))
+      end
+
+      def action_send
+        {
+          "#{NS_ADDRESSING}:Action" =>
+          'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/Send',
+          :attributes! => {
+            "#{NS_ADDRESSING}:Action" => {
+              'mustUnderstand' => true
+            }
+          }
+        }
+      end
+
+      def stdin_body
+        {
+          "#{NS_WIN_SHELL}:Send" => {
+            "#{NS_WIN_SHELL}:Stream" => {
+              '@Name' => 'stdin',
+              '@CommandId' => @command_id,
+              :content! => Base64.encode64(@stdin)
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/preamble

@@ -1,17 +1,17 @@
-=begin
-  This file is part of WinRM; the Ruby library for Microsoft WinRM.
-
-  Copyright © 2010 Dan Wanek <dan.wanek@gmail.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.
-=end
+=begin
+  This file is part of WinRM; the Ruby library for Microsoft WinRM.
+
+  Copyright © 2010 Dan Wanek <dan.wanek@gmail.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.
+=end

data/{spec → tests/integration}/auth_timeout_spec.rb

@@ -1,16 +1,18 @@
-# encoding: UTF-8
-# This test may only be meaningful with kerberos auth
-# Against server 2012, a kerberos connection will require reauth (get a 401)
-# if there are no requests for >= 15 seconds
-
-describe 'Verify kerberos will reauth when necessary', kerberos: true do
-  before(:all) do
-    @winrm = winrm_connection
-  end
-
-  it 'work with a 18 second sleep' do
-    ps_command = 'Start-Sleep -s 18'
-    output = @winrm.run_powershell_script(ps_command)
-    output[:exitcode].should == 0
-  end
-end
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+# This test may only be meaningful with kerberos auth
+# Against server 2012, a kerberos connection will require reauth (get a 401)
+# if there are no requests for >= 15 seconds
+
+describe 'Verify kerberos will reauth when necessary', kerberos: true do
+  before(:all) do
+    @powershell = winrm_connection.shell(:powershell)
+  end
+
+  it 'work with a 18 second sleep' do
+    ps_command = 'Start-Sleep -s 18'
+    output = @powershell.run(ps_command)
+    expect(output.exitcode).to eq(0)
+  end
+end

data/{spec → tests/integration}/cmd_spec.rb

@@ -1,102 +1,104 @@
-# encoding: UTF-8
-describe 'winrm client cmd', integration: true do
-  before(:all) do
-    @winrm = winrm_connection
-  end
-
-  describe 'empty string' do
-    subject(:output) { @winrm.cmd('') }
-    it { should have_exit_code 0 }
-    it { should have_no_stdout }
-    it { should have_no_stderr }
-  end
-
-  describe 'ipconfig' do
-    subject(:output) { @winrm.cmd('ipconfig') }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/Windows IP Configuration/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'echo \'hello world\' using apostrophes' do
-    subject(:output) { @winrm.cmd("echo 'hello world'") }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/'hello world'/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'echo "string with trailing \\" using double quotes' do
-    # This is a regression test for #131.  " is converted to " when serializing
-    # the command to SOAP/XML.  Any naive substitution performed on such a serialized
-    # string can result in any \& sequence being interpreted as a back-substitution.
-    subject(:output) { @winrm.cmd('echo "string with trailing \\"') }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/string with trailing \\/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'capturing output from stdout and stderr' do
-    subject(:output) do
-      # Note: Multiple lines doesn't work:
-      # script = <<-eos
-      # echo Hello
-      # echo , world! 1>&2
-      # eos
-
-      script = 'echo Hello & echo , world! 1>&2'
-
-      @captured_stdout = ''
-      @captured_stderr = ''
-      @winrm.cmd(script) do |stdout, stderr|
-        @captured_stdout << stdout if stdout
-        @captured_stderr << stderr if stderr
-      end
-    end
-
-    it 'should have stdout' do
-      expect(output.stdout).to eq("Hello \r\n")
-      expect(output.stdout).to eq(@captured_stdout)
-    end
-
-    it 'should have stderr' do
-      expect(output.stderr).to eq(", world! \r\n")
-      expect(output.stderr).to eq(@captured_stderr)
-    end
-
-    it 'should have output' do
-      expect(output.output).to eq("Hello \r\n, world! \r\n")
-    end
-  end
-
-  describe 'ipconfig with /all argument' do
-    subject(:output) { @winrm.cmd('ipconfig', %w(/all)) }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/Windows IP Configuration/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'dir with incorrect argument /z' do
-    subject(:output) { @winrm.cmd('dir /z') }
-    it { should have_exit_code 1 }
-    it { should have_no_stdout }
-    it { should have_stderr_match(/Invalid switch/) }
-  end
-
-  describe 'ipconfig && echo error 1>&2' do
-    subject(:output) { @winrm.cmd('ipconfig && echo error 1>&2') }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/Windows IP Configuration/) }
-    it { should have_stderr_match(/error/) }
-  end
-
-  describe 'ipconfig with a block' do
-    subject(:stdout) do
-      outvar = ''
-      @winrm.cmd('ipconfig') do |stdout, _stderr|
-        outvar << stdout
-      end
-      outvar
-    end
-    it { should match(/Windows IP Configuration/) }
-  end
-end
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe 'winrm client cmd' do
+  before(:all) do
+    @cmd_shell = winrm_connection.shell(:cmd)
+  end
+
+  describe 'empty string' do
+    subject(:output) { @cmd_shell.run('') }
+    it { should have_exit_code 0 }
+    it { should have_no_stdout }
+    it { should have_no_stderr }
+  end
+
+  describe 'ipconfig' do
+    subject(:output) { @cmd_shell.run('ipconfig') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/Windows IP Configuration/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'echo \'hello world\' using apostrophes' do
+    subject(:output) { @cmd_shell.run("echo 'hello world'") }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/'hello world'/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'echo "string with trailing \\" using double quotes' do
+    # This is a regression test for #131.  " is converted to &quot; when serializing
+    # the command to SOAP/XML.  Any naive substitution performed on such a serialized
+    # string can result in any \& sequence being interpreted as a back-substitution.
+    subject(:output) { @cmd_shell.run('echo "string with trailing \\"') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/string with trailing \\/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'capturing output from stdout and stderr' do
+    subject(:output) do
+      # Note: Multiple lines doesn't work:
+      # script = <<-eos
+      # echo Hello
+      # echo , world! 1>&2
+      # eos
+
+      script = 'echo Hello & echo , world! 1>&2'
+
+      @captured_stdout = ''
+      @captured_stderr = ''
+      @cmd_shell.run(script) do |stdout, stderr|
+        @captured_stdout << stdout if stdout
+        @captured_stderr << stderr if stderr
+      end
+    end
+
+    it 'should have stdout' do
+      expect(output.stdout).to eq("Hello \r\n")
+      expect(output.stdout).to eq(@captured_stdout)
+    end
+
+    it 'should have stderr' do
+      expect(output.stderr).to eq(", world! \r\n")
+      expect(output.stderr).to eq(@captured_stderr)
+    end
+
+    it 'should have output' do
+      expect(output.output).to eq("Hello \r\n, world! \r\n")
+    end
+  end
+
+  describe 'ipconfig with /all argument' do
+    subject(:output) { @cmd_shell.run('ipconfig', %w(/all)) }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/Windows IP Configuration/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'dir with incorrect argument /z' do
+    subject(:output) { @cmd_shell.run('dir /z') }
+    it { should have_exit_code 1 }
+    it { should have_no_stdout }
+    it { should have_stderr_match(/Invalid switch/) }
+  end
+
+  describe 'ipconfig && echo error 1>&2' do
+    subject(:output) { @cmd_shell.run('ipconfig && echo error 1>&2') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/Windows IP Configuration/) }
+    it { should have_stderr_match(/error/) }
+  end
+
+  describe 'ipconfig with a block' do
+    subject(:stdout) do
+      outvar = ''
+      @cmd_shell.run('ipconfig') do |stdout, _stderr|
+        outvar << stdout
+      end
+      outvar
+    end
+    it { should match(/Windows IP Configuration/) }
+  end
+end

data/{spec → tests/integration}/config-example.yml

@@ -1,19 +1,16 @@
-# Copy this file to config.yml and edit the settings below.
-# This should work out of the box for vagrant provisioned boxes.
-
-## Kerberos
-#auth_type: kerberos
-#endpoint: "http://<yourserver>:5985/wsman"
-#options:
-#  realm: "your.realm"
-
-## Plain Text
-auth_type: plaintext
-# If you are running this in a vagrant provisioned box using NAT,
-# this will be the forwarded WinRM HTTP port to your VM.
-# If you are running this on the VM, the default HTTP port is 5985.
-# See README.md#Troubleshooting.
-endpoint: "http://localhost:55985/wsman"
-options:
-  user: vagrant
-  pass: vagrant
+# Copy this file to config.yml and edit the settings below.
+# This should work out of the box for vagrant provisioned boxes.
+
+## Kerberos
+#  auth_type: kerberos
+#  realm: "your.realm"
+#  endpoint: "http://<yourserver>:5985/wsman"
+
+# If you are running this in a vagrant provisioned box using NAT,
+# this will be the forwarded WinRM HTTP port to your VM.
+# If you are running this on the VM, the default HTTP port is 5985.
+# See README.md#Troubleshooting.
+
+endpoint: "http://localhost:55985/wsman"
+user: vagrant
+password: vagrant