winrm 2.1.3 → 2.2.0

data/lib/winrm/wsmv/wql_pull.rb

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+
+require 'nori'
+require_relative 'base'
+
+module WinRM
+  module WSMV
+    # WSMV message to 'pull' rest of enumeration results from Windows via WQL
+    class WqlPull < Base
+      def initialize(session_opts, namespace, enumeration_context)
+        @session_opts = session_opts
+        @namespace = namespace
+        @enumeration_context = enumeration_context
+      end
+
+      def process_response(response)
+        parser = Nori.new(
+          parser: :rexml,
+          advanced_typecasting: false,
+          convert_tags_to: ->(tag) { tag.snakecase.to_sym },
+          strip_namespaces: true
+        )
+        parser.parse(response.to_s)[:envelope][:body]
+      end
+
+      protected
+
+      def create_header(header)
+        header << Gyoku.xml(wql_header)
+      end
+
+      def create_body(body)
+        body.tag!("#{NS_ENUM}:Pull") { |en| en << Gyoku.xml(wql_body) }
+      end
+
+      private
+
+      def wql_header
+        merge_headers(
+          shared_headers(@session_opts),
+          resource_uri_wmi(@namespace),
+          action_enumerate_pull
+        )
+      end
+
+      def wql_body
+        {
+          "#{NS_ENUM}:EnumerationContext" => @enumeration_context,
+          "#{NS_WSMAN_DMTF}:OptimizeEnumeration" => nil,
+          "#{NS_ENUM}:MaxElements" => '32000',
+          "#{NS_WSMAN_MSFT}:SessionId" => "uuid:#{@session_opts[:session_id]}"
+        }
+      end
+    end
+  end
+end

data/lib/winrm/wsmv/wql_query.rb

@@ -1,79 +1,99 @@
-# -*- 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
+# -*- 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(transport, session_opts, wql, namespace = nil)
+        @session_opts = session_opts
+        @wql = wql
+        @namespace = namespace
+        @transport = transport
+      end
+
+      def process_response(response, &block)
+        parser = Nori.new(
+          parser: :rexml,
+          advanced_typecasting: false,
+          convert_tags_to: ->(tag) { tag.snakecase.to_sym },
+          strip_namespaces: true
+        )
+        @items = Hash.new { |h, k| h[k] = [] }
+
+        hresp = parser.parse(response.to_s)[:envelope][:body][:enumerate_response]
+        process_items hresp[:items], &block
+
+        # Perform WS-Enum PULL's until we have all the elements
+        enumeration_context = hresp[:enumeration_context]
+        until enumeration_context.nil?
+          query = WqlPull.new(@session_opts, @namespace, enumeration_context)
+          hresp = query.process_response(@transport.send_request(query.build))[:pull_response]
+          process_items hresp[:items], &block
+          enumeration_context = hresp[:enumeration_context]
+        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 process_items(items, &block)
+        return if items.nil?
+        items.each_pair do |k, v|
+          # Normalize items so the type always has an array even if it's just a single item.
+          v_ary = v.is_a?(Array) ? v : [v]
+          if block
+            v_ary.each { |val| yield k, val }
+          else
+            @items[k] += v_ary
+          end
+        end
+      end
+
+      def wql_header
+        merge_headers(shared_headers(@session_opts), resource_uri_wmi(@namespace), 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/tests/integration/wql_spec.rb

@@ -1,16 +1,34 @@
-# encoding: UTF-8
-require_relative 'spec_helper'
-
-describe 'winrm client wql' do
-  before(:all) do
-    @winrm = winrm_connection
-  end
-
-  it 'should query Win32_OperatingSystem' do
-    output = @winrm.run_wql('select * from Win32_OperatingSystem')
-    expect(output).to_not be_empty
-    output_caption = output[:win32_operating_system][0][:caption]
-    expect(output_caption).to include('Microsoft')
-    expect(output_caption).to include('Windows')
-  end
-end
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe 'winrm client wql' do
+  before(:all) do
+    @winrm = winrm_connection
+  end
+
+  it 'should query Win32_OperatingSystem' do
+    output = @winrm.run_wql('select * from Win32_OperatingSystem')
+    expect(output).to_not be_empty
+    output_caption = output[:win32_operating_system][0][:caption]
+    expect(output_caption).to include('Microsoft')
+    expect(output_caption).to include('Windows')
+  end
+
+  it 'should query Win32_Process' do
+    output = @winrm.run_wql('select * from Win32_Process')
+    expect(output).to_not be_empty
+    process_count = output[:win32_process].count
+    expect(process_count).to be > 1
+    expect(output[:win32_process]).to all(include(:command_line))
+  end
+
+  it 'should query Win32_Process with block' do
+    count = 0
+    @winrm.run_wql('select * from Win32_Process') do |type, item|
+      expect(type).to eq(:win32_process)
+      expect(item).to include(:command_line)
+      count += 1
+    end
+    expect(count).to be > 1
+  end
+end

data/tests/spec/wsmv/wql_query_spec.rb

@@ -1,13 +1,13 @@
-# encoding: UTF-8
-
-require 'winrm/wsmv/wql_query'
-
-describe WinRM::WSMV::WqlQuery do
-  context 'default session options' do
-    subject { described_class.new(default_connection_opts, 'SELECT * FROM Win32') }
-    let(:xml) { subject.build }
-    it 'creates a well formed message' do
-      expect(xml).to include('<w:OperationTimeout>PT60S</w:OperationTimeout>')
-    end
-  end
-end
+# encoding: UTF-8
+
+require 'winrm/wsmv/wql_query'
+
+describe WinRM::WSMV::WqlQuery do
+  context 'default session options' do
+    subject { described_class.new(nil, default_connection_opts, 'SELECT * FROM Win32') }
+    let(:xml) { subject.build }
+    it 'creates a well formed message' do
+      expect(xml).to include('<w:OperationTimeout>PT60S</w:OperationTimeout>')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winrm
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Dan Wanek
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gssapi
@@ -288,6 +288,7 @@ files:
 - lib/winrm/wsmv/receive_response_reader.rb
 - lib/winrm/wsmv/send_data.rb
 - lib/winrm/wsmv/soap.rb
+- lib/winrm/wsmv/wql_pull.rb
 - lib/winrm/wsmv/wql_query.rb
 - lib/winrm/wsmv/write_stdin.rb
 - preamble
@@ -378,7 +379,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Ruby library for Windows Remote Management