remotus 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d07fd3936fbe26fea5629acc43238c698f735f3d6814f0733c3b5b81d638f340
-  data.tar.gz: fd028ed4fe407c5f4b9dc82ecdc7ec3371c4605cc19997227287df08badcaa9b
+  metadata.gz: 34953ce4b1c254e31a40b7b3ff3795124fe98b712722862a35813cceba686759
+  data.tar.gz: 3d342087b707b3078cedf38038b3ba21c1a1db6ed7c7d189f5912d9cd5adf4e7
 SHA512:
-  metadata.gz: 143e87065eb71702504a6773c74e68bc4a6efff6f08cbc8b812ed0c84db7a994719b578e4eb6a345a0f2369a11c1f4b05e1a9531a015cee345f958186ee06860
-  data.tar.gz: 54ce478b43f70a989d8103f659da7ae61723794da6ef1918eee33ff73ee1d363dfb772da8297a4b8428712f639291d481c1df3112d5d09ba1bbbb3c2fd58883b
+  metadata.gz: c884fbb30a585899e840ab9e3dddd3b3d6ac052d4b10745bc9c582f9e67ca445aa9ef98af7ac8cbba551cc6594f23a9583d3f54cfba6202f3b8595804bd60641
+  data.tar.gz: 166f8cb4e3e633a79f1f28ddba9a3ff8793cc2927873bdd349e035870273c81ad6a9688f37d2f871413f43451604f64a06631e0813f8e111f7d36c701a168b05

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.4.0] - 2022-06-02
+* Added winrm-elevated gem to solve wirnrm AuthenticationError
+
 ## [0.3.0] - 2022-02-18
 * Add retries to SSH SCP transactions
 

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    remotus (0.3.0)
+    remotus (0.4.0)
       connection_pool (~> 2.2)
       net-scp (~> 3.0)
       net-ssh (~> 6.1)
       winrm (~> 2.3)
+      winrm-elevated (~> 1.2)
       winrm-fs (~> 1.3)
 
 GEM
@@ -19,11 +20,12 @@ GEM
     ffi (1.15.5)
     gssapi (1.3.1)
       ffi (>= 1.0.1)
-    gyoku (1.3.1)
+    gyoku (1.4.0)
       builder (>= 2.1.2)
+      rexml (~> 3.0)
     httpclient (2.8.3)
     little-plugger (1.1.4)
-    logging (2.3.0)
+    logging (2.3.1)
       little-plugger (~> 1.1)
       multi_json (~> 1.14)
     multi_json (1.15.0)
@@ -80,6 +82,10 @@ GEM
       logging (>= 1.6.1, < 3.0)
       nori (~> 2.0)
       rubyntlm (~> 0.6.0, >= 0.6.3)
+    winrm-elevated (1.2.3)
+      erubi (~> 1.8)
+      winrm (~> 2.0)
+      winrm-fs (~> 1.0)
     winrm-fs (1.3.5)
       erubi (~> 1.8)
       logging (>= 1.6.1, < 3.0)

data/README.md

@@ -54,6 +54,9 @@ result.exit_code
 # Run a command on the remote host with sudo (Linux only, requires password to be specified)
 result = connection.run("ls /root", sudo: true)
 
+# Run a command on the remote host with elevated shell privilege
+result = connection.run("ipconfig", shell: :elevated)
+
 # Run a script on the remote host
 connection.run_script("/local/script.sh", "/remote/path/script.sh")
 

data/lib/remotus/core_ext/elevated.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "winrm-elevated"
+
+module Remotus
+  # Core Ruby extensions
+  module CoreExt
+    # WinRM Elevated extension module
+    module Elevated
+      unless method_defined?(:connection_opts)
+        #
+        # Returns a hash for the connection options from the interal
+        # WinRM::Shells::Powershell object
+        #
+        # @return [Hash] internal WinRM::Shells::Powershell connection options
+        #
+        def connection_opts
+          @shell.connection_opts
+        end
+      end
+    end
+  end
+end
+
+# @api private
+# Main WinRM module
+module WinRM
+  # Shells module (contains PowerShell, Elevated, etc.)
+  module Shells
+    # Elevated PowerShell class from winrm-elevated
+    class Elevated
+      include Remotus::CoreExt::Elevated
+    end
+  end
+end

data/lib/remotus/core_ext/string.rb

@@ -24,4 +24,8 @@ module Remotus
   end
 end
 
-String.include(Remotus::CoreExt::String)
+# @api private
+# Core ruby string class
+class String
+  include Remotus::CoreExt::String
+end

data/lib/remotus/version.rb

@@ -2,5 +2,5 @@
 
 module Remotus
   # Remotus gem version
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/remotus/winrm_connection.rb

@@ -4,7 +4,9 @@ require "forwardable"
 require "remotus"
 require "remotus/result"
 require "remotus/auth"
+require "remotus/core_ext/elevated"
 require "winrm"
+require "winrm-elevated"
 require "winrm-fs"
 
 module Remotus
@@ -21,6 +23,9 @@ module Remotus
     # @return [String] host hostname
     attr_reader :host
 
+    # @return [String] shell type
+    attr_reader :shell
+
     # @return [Remotus::HostPool] host_pool associated host pool
     attr_reader :host_pool
 
@@ -38,6 +43,7 @@ module Remotus
       @host = host
       @port = port
       @host_pool = host_pool
+      @shell = :powershell
     end
 
     #
@@ -69,14 +75,17 @@ module Remotus
 
     #
     # Retrieves/creates the WinRM shell connection for the host
+    #
+    # @param [symbol] shell connection shell type, defaults to :powershell
     # If the connection already exists, the existing connection will be retrieved
     #
-    # @return [WinRM::Shells::Powershell] remote connection
+    # @return [WinRM::Shells::Powershell, WinRM::Shells::Elevated] remote connection
     #
-    def connection
-      return @connection unless restart_connection?
+    def connection(shell = :powershell)
+      return @connection unless restart_connection?(shell: shell)
 
-      @connection = base_connection(reload: true).shell(:powershell)
+      @shell = shell
+      @connection = base_connection(reload: true).shell(@shell)
     end
 
     #
@@ -93,13 +102,14 @@ module Remotus
     #
     # @param [String] command command to run
     # @param [Array] args command arguments
-    # @param [Hash] _options unused command options
+    # @param [Hash] options command options
+    # @option options [Symbol] :shell shell type to use for the connection
     #
     # @return [Remotus::Result] result describing the stdout, stderr, and exit status of the command
     #
-    def run(command, *args, **_options)
+    def run(command, *args, **options)
       command = "#{command}#{args.empty? ? "" : " "}#{args.join(" ")}"
-      run_result = connection.run(command)
+      run_result = options[:shell].nil? ? connection.run(command) : connection(options[:shell]).run(command)
       Remotus::Result.new(command, run_result.stdout, run_result.stderr, run_result.output, run_result.exitcode)
     rescue WinRM::WinRMAuthorizationError => e
       raise Remotus::AuthenticationError, e.to_s
@@ -171,7 +181,7 @@ module Remotus
     # @return [Boolean] whether to restart the current base connection
     #
     def restart_base_connection?
-      return restart_connection? if @connection
+      return restart_connection?(shell: @shell) if @connection
       return true unless @base_connection
       return true if @host != @base_connection.instance_values["connection_opts"][:endpoint].scan(%r{//(.*):}).flatten.first
       return true if Remotus::Auth.credential(self).user != @base_connection.instance_values["connection_opts"][:user]
@@ -183,10 +193,14 @@ module Remotus
     #
     # Whether to restart the current WinRM connection
     #
+    # @param [Hash] options restart connection options
+    # @option options [Symbol] :shell shell type to use for the connection
+    #
     # @return [Boolean] whether to restart the current connection
     #
-    def restart_connection?
+    def restart_connection?(**options)
       return true unless @connection
+      return true if shell && !options[:shell].casecmp?(@shell)
       return true if @host != @connection.connection_opts[:endpoint].scan(%r{//(.*):}).flatten.first
       return true if Remotus::Auth.credential(self).user != @connection.connection_opts[:user]
       return true if Remotus::Auth.credential(self).password != @connection.connection_opts[:password]

data/remotus.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "net-scp", "~> 3.0"
   spec.add_dependency "net-ssh", "~> 6.1"
   spec.add_dependency "winrm", "~> 2.3"
+  spec.add_dependency "winrm-elevated", "~> 1.2"
   spec.add_dependency "winrm-fs", "~> 1.3"
 
   # Development dependencies

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remotus
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Matthew Newell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: winrm-elevated
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: winrm-fs
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +202,7 @@ files:
 - lib/remotus/auth/credential.rb
 - lib/remotus/auth/hash_store.rb
 - lib/remotus/auth/store.rb
+- lib/remotus/core_ext/elevated.rb
 - lib/remotus/core_ext/string.rb
 - lib/remotus/host_pool.rb
 - lib/remotus/logger.rb