winrm-elevated 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b63f3710673e9e412c7110b790d0faa0d31acb81
-  data.tar.gz: 6345755c43570c6850cc6f2ead751a223e78c3df
+  metadata.gz: d34dd03c88011d2bcfd6b93b401b56d90e53475a
+  data.tar.gz: 6ba1a65c66c8cdaa2fad628881b096bcbd104e67
 SHA512:
-  metadata.gz: 761a06ccc981cf532c8b6985d6a7536c54412d9f98e63fbd10f3f0b4974a53552074f2e25f70e60911776793b65fb476be821e991d5cec90f9e96f2e89c0ab6d
-  data.tar.gz: 78176a4a5d945b910854129b99e5934ecf7c141642b5317f01560addc40d55e6b047648fd657796af57532f22048a4e4159497416c4685c734a8ee471bb44d45
+  metadata.gz: 5231b2d898cdf659afde87840a813a1857686c062023b45f0d1ee3887552992e3d69222ba5b7fb475491b6613794f7f7eba32212b59dcdd31815e844bd9f9343
+  data.tar.gz: 6ed0aeb89b9b9210da6137e2a82551e6ece6ff2b5e752542ce4d8d037a707fc24fc4f16ea9bacc60d4dff3511af0546d8a7a7f147625303de251b00d65b0ffe0

data/.rubocop.yml

@@ -6,3 +6,12 @@ Style/Encoding:
 
 Metrics/LineLength:
   Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+ClassLength:
+  Max: 250
+
+Metrics/AbcSize:
+  Max: 25

data/.travis.yml

@@ -2,4 +2,9 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.0
+
+# This prevents testing branches that are created just for PRs
+branches:
+  only:
+  - master

data/README.md

@@ -9,9 +9,25 @@ require 'winrm'
 require 'winrm-elevated'
 
 service = WinRM::WinRMWebService.new(...
-elevated_runner = WinRM::Elevated::Runner.new(service)
-result = elevated_runner.powershell_elevated('dir', 'Administrator', 'password')
-puts "Std out: #{result.output}"
+service.create_executor do |executor|
+  elevated_runner = WinRM::Elevated::Runner.new(executor)
+  result = elevated_runner.powershell_elevated('dir', 'Administrator', 'password')
+  puts "Std out: #{result.output}"
+end
+```
+
+### Impersonating a service account
+By passing a `nil` password, winrm-elevated will assume that the command should run as a service account:
+```ruby
+require 'winrm'
+require 'winrm-elevated'
+
+service = WinRM::WinRMWebService.new(...
+service.create_executor do |executor|
+  elevated_runner = WinRM::Elevated::Runner.new(service)
+  result = elevated_runner.powershell_elevated('dir', 'System', nil)
+  puts "Std out: #{result.output}"
+end
 ```
 
 ## How does it work?

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/appveyor.yml

@@ -0,0 +1,39 @@
+version: "master-{build}"
+
+os: Windows Server 2012 R2
+platform:
+  - x64
+
+environment:
+  winrm_user: test_user
+  winrm_pass: Pass@word1
+
+  matrix:
+    - ruby_version: "21"
+      winrm_endpoint: http://localhost:5985/wsman
+
+clone_folder: c:\projects\winrm-elevated
+clone_depth: 1
+branches:
+  only:
+    - master
+
+install:
+  - ps: net user /add $env:winrm_user $env:winrm_pass
+  - ps: net localgroup administrators $env:winrm_user /add
+  - ps: winrm set winrm/config/client/auth '@{Basic="true"}'
+  - ps: winrm set winrm/config/service/auth '@{Basic="true"}'
+  - ps: winrm set winrm/config/service '@{AllowUnencrypted="true"}'
+  - ps: $env:PATH="C:\Ruby$env:ruby_version\bin;$env:PATH"
+  - ps: Write-Host $env:PATH
+  - ps: ruby --version
+  - ps: gem --version
+  - ps: gem install bundler --quiet --no-ri --no-rdoc
+  - ps: bundler --version
+
+build_script:
+  - bundle install || bundle install || bundle install
+
+test_script:
+  - SET SPEC_OPTS=--format progress
+  - bundle exec rake integration

data/changelog.md

@@ -1,5 +1,12 @@
 # WinRM-Elevated Gem Changelog
 
+# 0.4.0
+- Initialize `Elevated::Runner` with a `CommandExecutor` instead of a `WinrmService` client
+- Run commands from newer winrm executor
+- Use latest winrm-fs 0.4.2
+- Allow task to run as a service account
+- Provide an artificially long timeout to the task to keep the task from dying after 60 seconds
+
 # 0.3.0
 - [Name Powershell Script and Log Files Uniquely](https://github.com/WinRb/winrm-elevated/pull/6)
 

data/lib/winrm-elevated/runner.rb

@@ -23,10 +23,10 @@ module WinRM
     # Runs PowerShell commands elevated via a scheduled task
     class Runner
       # Creates a new Elevated Runner instance
-      # @param [WinRMWebService] WinRM web service client
-      def initialize(winrm_service)
-        @winrm_service = winrm_service
-        @winrm_file_manager = WinRM::FS::FileManager.new(winrm_service)
+      # @param [CommandExecutor] a winrm CommandExecutor
+      def initialize(executor)
+        @executor = executor
+        @winrm_file_transporter = WinRM::FS::Core::FileTransporter.new(executor)
         @elevated_shell_path = 'c:/windows/temp/winrm-elevated-shell-' + SecureRandom.uuid + '.ps1'
         @uploaded            = nil
       end
@@ -45,7 +45,7 @@ module WinRM
 
         upload_elevated_shell_wrapper_script
         wrapped_script = wrap_in_scheduled_task(script_text, username, password)
-        @winrm_service.run_cmd(wrapped_script, &block)
+        @executor.run_cmd(wrapped_script, &block)
       end
 
       private
@@ -53,7 +53,7 @@ module WinRM
       def upload_elevated_shell_wrapper_script
         return if @uploaded
         with_temp_file do |temp_file|
-          @winrm_file_manager.upload(temp_file, @elevated_shell_path)
+          @winrm_file_transporter.upload(temp_file, @elevated_shell_path)
           @uploaded = true
         end
       end
@@ -76,8 +76,7 @@ module WinRM
       def wrap_in_scheduled_task(script_text, username, password)
         ps_script = WinRM::PowershellScript.new(script_text)
         "powershell -executionpolicy bypass -file \"#{@elevated_shell_path}\" " \
-          "-username \"#{username}\" -password \"#{password}\" -timeout \"#{@winrm_service.timeout}\" " \
-          "-encoded_command \"#{ps_script.encoded}\""
+          "-username \"#{username}\" -password \"#{password}\" -encoded_command \"#{ps_script.encoded}\""
       end
     end
   end

data/lib/winrm-elevated/scripts/elevated_shell.ps1

@@ -1,4 +1,13 @@
-param([String]$username, [String]$password, [String]$encoded_command, [String]$timeout)
+param([String]$username, [String]$password, [String]$encoded_command)
+
+$pass_to_use = $password
+$logon_type = 1
+$logon_type_xml = "<LogonType>Password</LogonType>"
+if($pass_to_use.length -eq 0) {
+  $pass_to_use = $null
+  $logon_type = 5
+  $logon_type_xml = ""
+}
 
 $task_name = "WinRM_Elevated_Shell"
 $out_file = [System.IO.Path]::GetTempFileName()
@@ -10,7 +19,7 @@ $task_xml = @'
   <Principals>
     <Principal id="Author">
       <UserId>{username}</UserId>
-      <LogonType>Password</LogonType>
+      {logon_type}
       <RunLevel>HighestAvailable</RunLevel>
     </Principal>
   </Principals>
@@ -30,7 +39,7 @@ $task_xml = @'
     <Hidden>false</Hidden>
     <RunOnlyIfIdle>false</RunOnlyIfIdle>
     <WakeToRun>false</WakeToRun>
-    <ExecutionTimeLimit>{timeout}</ExecutionTimeLimit>
+    <ExecutionTimeLimit>PT24H</ExecutionTimeLimit>
     <Priority>4</Priority>
   </Settings>
   <Actions Context="Author">
@@ -46,14 +55,14 @@ $arguments = "/c powershell.exe -EncodedCommand $encoded_command &gt; $out_file
 
 $task_xml = $task_xml.Replace("{arguments}", $arguments)
 $task_xml = $task_xml.Replace("{username}", $username)
-$task_xml = $task_xml.Replace("{timeout}", $timeout)
+$task_xml = $task_xml.Replace("{logon_type}", $logon_type_xml)
 
 $schedule = New-Object -ComObject "Schedule.Service"
 $schedule.Connect()
 $task = $schedule.NewTask($null)
 $task.XmlText = $task_xml
 $folder = $schedule.GetFolder("\")
-$folder.RegisterTaskDefinition($task_name, $task, 6, $username, $password, 1, $null) | Out-Null
+$folder.RegisterTaskDefinition($task_name, $task, 6, $username, $pass_to_use, $logon_type, $null) | Out-Null
 
 $registered_task = $folder.GetTask("\$task_name")
 $registered_task.Run($null) | Out-Null

data/spec/powershell_elevated_spec.rb

@@ -7,6 +7,13 @@ describe 'powershell elevated runner', integration: true do
     it { should have_no_stderr }
   end
 
+  describe 'ipconfig as Service' do
+    subject(:output) { elevated_runner.powershell_elevated('ipconfig', 'System', nil) }
+    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) { elevated_runner.powershell_elevated("echo 'hello world'", username, password) }
     it { should have_exit_code 0 }

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@ module ConnectionHelper
   end
 
   def elevated_runner
-    @elevated_runner ||= WinRM::Elevated::Runner.new(winrm_connection)
+    @elevated_runner ||= WinRM::Elevated::Runner.new(winrm_connection.create_executor)
   end
 
   def winrm_config
@@ -25,6 +25,9 @@ module ConnectionHelper
         path = File.expand_path("#{File.dirname(__FILE__)}/config-example.yml")
       end
       @winrm_config = YAML.load(File.read(path))
+      @winrm_config['endpoint'] = ENV['winrm_endpoint'] if ENV['winrm_endpoint']
+      @winrm_config['options']['user'] = ENV['winrm_user'] if ENV['winrm_user']
+      @winrm_config['options']['pass'] = ENV['winrm_pass'] if ENV['winrm_pass']
     end
     @winrm_config
   end

data/winrm-elevated.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 1.9.0'
   s.add_runtime_dependency 'winrm', '~> 1.5'
-  s.add_runtime_dependency 'winrm-fs', '~> 0.3.0'
+  s.add_runtime_dependency 'winrm-fs', '~> 0.4.2'
   s.add_development_dependency 'rspec', '~> 3.2'
   s.add_development_dependency 'rake', '~> 10.3'
   s.add_development_dependency 'rubocop', '~> 0.28'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: winrm-elevated
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Shawn Neal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: winrm
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +99,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- appveyor.yml
 - changelog.md
 - lib/winrm-elevated.rb
 - lib/winrm-elevated/runner.rb