winrm-elevated 0.4.0 → 1.0.0

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

@@ -1,105 +1,108 @@
-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()
-$err_file = [System.IO.Path]::GetTempFileName()
-
-$task_xml = @'
-<?xml version="1.0" encoding="UTF-16"?>
-<Task version="1.2" xmlns="http://schemas.microsoft.com/windows/2004/02/mit/task">
-  <Principals>
-    <Principal id="Author">
-      <UserId>{username}</UserId>
-      {logon_type}
-      <RunLevel>HighestAvailable</RunLevel>
-    </Principal>
-  </Principals>
-  <Settings>
-    <MultipleInstancesPolicy>IgnoreNew</MultipleInstancesPolicy>
-    <DisallowStartIfOnBatteries>false</DisallowStartIfOnBatteries>
-    <StopIfGoingOnBatteries>false</StopIfGoingOnBatteries>
-    <AllowHardTerminate>true</AllowHardTerminate>
-    <StartWhenAvailable>false</StartWhenAvailable>
-    <RunOnlyIfNetworkAvailable>false</RunOnlyIfNetworkAvailable>
-    <IdleSettings>
-      <StopOnIdleEnd>false</StopOnIdleEnd>
-      <RestartOnIdle>false</RestartOnIdle>
-    </IdleSettings>
-    <AllowStartOnDemand>true</AllowStartOnDemand>
-    <Enabled>true</Enabled>
-    <Hidden>false</Hidden>
-    <RunOnlyIfIdle>false</RunOnlyIfIdle>
-    <WakeToRun>false</WakeToRun>
-    <ExecutionTimeLimit>PT24H</ExecutionTimeLimit>
-    <Priority>4</Priority>
-  </Settings>
-  <Actions Context="Author">
-    <Exec>
-      <Command>cmd</Command>
-      <Arguments>{arguments}</Arguments>
-    </Exec>
-  </Actions>
-</Task>
-'@
-
-$arguments = "/c powershell.exe -EncodedCommand $encoded_command &gt; $out_file 2&gt;$err_file"
-
-$task_xml = $task_xml.Replace("{arguments}", $arguments)
-$task_xml = $task_xml.Replace("{username}", $username)
-$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, $pass_to_use, $logon_type, $null) | Out-Null
-
-$registered_task = $folder.GetTask("\$task_name")
-$registered_task.Run($null) | Out-Null
-
-$timeout = 10
-$sec = 0
-while ( (!($registered_task.state -eq 4)) -and ($sec -lt $timeout) ) {
-  Start-Sleep -s 1
-  $sec++
-}
-
-function SlurpOutput($file, $cur_line, $out_type) {
-  if (Test-Path $file) {
-    get-content $file | select -skip $cur_line | ForEach {
-      $cur_line += 1
-      if ($out_type -eq 'err') {
-        $host.ui.WriteErrorLine("$_")
-      } else {
-        $host.ui.WriteLine("$_")
-      }
-    }
-  }
-  return $cur_line
-}
-
-$err_cur_line = 0
-$out_cur_line = 0
-do {
-  Start-Sleep -m 100
-  $out_cur_line = SlurpOutput $out_file $out_cur_line 'out'
-  $err_cur_line = SlurpOutput $err_file $err_cur_line 'err'
-} while (!($registered_task.state -eq 3))
-
-del $out_file
-del $err_file
-
-$exit_code = $registered_task.LastTaskResult
-[System.Runtime.Interopservices.Marshal]::ReleaseComObject($schedule) | Out-Null
-
-exit $exit_code
+$username = "<%= username %>"
+$password = "<%= password %>"
+$script_file = "<%= script_path %>"
+
+$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()
+$err_file = [System.IO.Path]::GetTempFileName()
+
+$task_xml = @'
+<?xml version="1.0" encoding="UTF-16"?>
+<Task version="1.2" xmlns="http://schemas.microsoft.com/windows/2004/02/mit/task">
+  <Principals>
+    <Principal id="Author">
+      <UserId>{username}</UserId>
+      {logon_type}
+      <RunLevel>HighestAvailable</RunLevel>
+    </Principal>
+  </Principals>
+  <Settings>
+    <MultipleInstancesPolicy>IgnoreNew</MultipleInstancesPolicy>
+    <DisallowStartIfOnBatteries>false</DisallowStartIfOnBatteries>
+    <StopIfGoingOnBatteries>false</StopIfGoingOnBatteries>
+    <AllowHardTerminate>true</AllowHardTerminate>
+    <StartWhenAvailable>false</StartWhenAvailable>
+    <RunOnlyIfNetworkAvailable>false</RunOnlyIfNetworkAvailable>
+    <IdleSettings>
+      <StopOnIdleEnd>false</StopOnIdleEnd>
+      <RestartOnIdle>false</RestartOnIdle>
+    </IdleSettings>
+    <AllowStartOnDemand>true</AllowStartOnDemand>
+    <Enabled>true</Enabled>
+    <Hidden>false</Hidden>
+    <RunOnlyIfIdle>false</RunOnlyIfIdle>
+    <WakeToRun>false</WakeToRun>
+    <ExecutionTimeLimit>PT24H</ExecutionTimeLimit>
+    <Priority>4</Priority>
+  </Settings>
+  <Actions Context="Author">
+    <Exec>
+      <Command>cmd</Command>
+      <Arguments>{arguments}</Arguments>
+    </Exec>
+  </Actions>
+</Task>
+'@
+
+$arguments = "/c powershell.exe -File $script_file &gt; $out_file 2&gt;$err_file"
+
+$task_xml = $task_xml.Replace("{arguments}", $arguments)
+$task_xml = $task_xml.Replace("{username}", $username)
+$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, $pass_to_use, $logon_type, $null) | Out-Null
+
+$registered_task = $folder.GetTask("\$task_name")
+$registered_task.Run($null) | Out-Null
+
+$timeout = 10
+$sec = 0
+while ( (!($registered_task.state -eq 4)) -and ($sec -lt $timeout) ) {
+  Start-Sleep -s 1
+  $sec++
+}
+
+function SlurpOutput($file, $cur_line, $out_type) {
+  if (Test-Path $file) {
+    get-content $file | select -skip $cur_line | ForEach {
+      $cur_line += 1
+      if ($out_type -eq 'err') {
+        $host.ui.WriteErrorLine("$_")
+      } else {
+        $host.ui.WriteLine("$_")
+      }
+    }
+  }
+  return $cur_line
+}
+
+$err_cur_line = 0
+$out_cur_line = 0
+do {
+  Start-Sleep -m 100
+  $out_cur_line = SlurpOutput $out_file $out_cur_line 'out'
+  $err_cur_line = SlurpOutput $err_file $err_cur_line 'err'
+} while (!($registered_task.state -eq 3))
+
+del $out_file
+del $err_file
+del $script_file
+
+$exit_code = $registered_task.LastTaskResult
+[System.Runtime.Interopservices.Marshal]::ReleaseComObject($schedule) | Out-Null
+
+exit $exit_code

data/lib/winrm-elevated.rb

@@ -1,25 +1,18 @@
-# encoding: UTF-8
-#
-# Copyright 2015 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 'winrm'
-require_relative 'winrm-elevated/runner'
-
-module WinRM
-  # WinRM File System
-  module Elevated
-    # Top level module code
-  end
-end
+# encoding: UTF-8
+#
+# Copyright 2015 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 'winrm'
+require_relative 'winrm/shells/elevated'

data/spec/config-example.yml

@@ -1,5 +1,3 @@
-auth_type: plaintext
-endpoint: "http://localhost:55985/wsman"
-options:
-  user: vagrant
-  pass: vagrant
+endpoint: "http://localhost:55985/wsman"
+user: vagrant
+password: vagrant

data/spec/matchers.rb

@@ -1,64 +1,50 @@
-# encoding: UTF-8
-require 'rspec/expectations'
-
-# rspec matchers
-module WinRMSpecs
-  def self.stdout(output)
-    output[:data].collect do |i|
-      i[:stdout]
-    end.join('\r\n').gsub(/(\\r\\n)+$/, '')
-  end
-
-  def self.stderr(output)
-    output[:data].collect do |i|
-      i[:stderr]
-    end.join('\r\n').gsub(/(\\r\\n)+$/, '')
-  end
-end
-
-RSpec::Matchers.define :have_stdout_match do |expected_stdout|
-  match do |actual_output|
-    !expected_stdout.match(WinRMSpecs.stdout(actual_output)).nil?
-  end
-  failure_message do |actual_output|
-    "expected that '#{WinRMSpecs.stdout(actual_output)}' would match #{expected_stdout}"
-  end
-end
-
-RSpec::Matchers.define :have_stderr_match do |expected_stderr|
-  match do |actual_output|
-    !expected_stderr.match(WinRMSpecs.stderr(actual_output)).nil?
-  end
-  failure_message do |actual_output|
-    "expected that '#{WinRMSpecs.stderr(actual_output)}' would match #{expected_stderr}"
-  end
-end
-
-RSpec::Matchers.define :have_no_stdout do
-  match do |actual_output|
-    stdout = WinRMSpecs.stdout(actual_output)
-    stdout == '\r\n' || stdout == ''
-  end
-  failure_message do |actual_output|
-    "expected that '#{WinRMSpecs.stdout(actual_output)}' would have no stdout"
-  end
-end
-
-RSpec::Matchers.define :have_no_stderr do
-  match do |actual_output|
-    stderr = WinRMSpecs.stderr(actual_output)
-    stderr == '\r\n' || stderr == ''
-  end
-  failure_message do |actual_output|
-    "expected that '#{WinRMSpecs.stderr(actual_output)}' would have no stderr"
-  end
-end
-
-RSpec::Matchers.define :have_exit_code do |expected_exit_code|
-  match do |actual_output|
-    expected_exit_code == actual_output[:exitcode]
-  end
-  failure_message do |actual_output|
-    "expected exit code #{expected_exit_code}, but got #{actual_output[:exitcode]}"
-  end
-end
+# encoding: UTF-8
+require 'rspec/expectations'
+
+# rspec matchers
+RSpec::Matchers.define :have_stdout_match do |expected_stdout|
+  match do |actual_output|
+    !expected_stdout.match(actual_output.stdout).nil?
+  end
+  failure_message do |actual_output|
+    "expected that '#{actual_output.stdout}' would match #{expected_stdout}"
+  end
+end
+
+RSpec::Matchers.define :have_stderr_match do |expected_stderr|
+  match do |actual_output|
+    !expected_stderr.match(actual_output.stderr).nil?
+  end
+  failure_message do |actual_output|
+    "expected that '#{actual_output.stderr}' would match #{expected_stderr}"
+  end
+end
+
+RSpec::Matchers.define :have_no_stdout do
+  match do |actual_output|
+    stdout = actual_output.stdout
+    stdout == '\r\n' || stdout == ''
+  end
+  failure_message do |actual_output|
+    "expected that '#{actual_output.stdout}' would have no stdout"
+  end
+end
+
+RSpec::Matchers.define :have_no_stderr do
+  match do |actual_output|
+    stderr = actual_output.stderr
+    stderr == '\r\n' || stderr == ''
+  end
+  failure_message do |actual_output|
+    "expected that '#{actual_output.stderr}' would have no stderr"
+  end
+end
+
+RSpec::Matchers.define :have_exit_code do |expected_exit_code|
+  match do |actual_output|
+    expected_exit_code == actual_output.exitcode
+  end
+  failure_message do |actual_output|
+    "expected exit code #{expected_exit_code}, but got #{actual_output.exitcode}"
+  end
+end

data/spec/powershell_elevated_spec.rb

@@ -1,93 +1,87 @@
-# encoding: UTF-8
-describe 'powershell elevated runner', integration: true do
-  describe 'ipconfig' do
-    subject(:output) { elevated_runner.powershell_elevated('ipconfig', username, password) }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/Windows IP Configuration/) }
-    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 }
-    it { should have_stdout_match(/hello world/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'ipconfig with incorrect argument -z' do
-    subject(:output) { elevated_runner.powershell_elevated('ipconfig 127.0.0.1 -z', username, password) }
-    it { should have_exit_code 1 }
-  end
-
-  describe 'Math area calculation' do
-    subject(:output) do
-      cmd = <<-EOH
-        $diameter = 4.5
-        $area = [Math]::pow([Math]::PI * ($diameter/2), 2)
-        Write-Host $area
-      EOH
-      elevated_runner.powershell_elevated(cmd, username, password)
-    end
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/49.9648722805149/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'ipconfig with a block' do
-    subject(:stdout) do
-      outvar = ''
-      elevated_runner.powershell_elevated('ipconfig', username, password) do |stdout, _stderr|
-        outvar << stdout
-      end
-      outvar
-    end
-    it { should match(/Windows IP Configuration/) }
-  end
-
-  describe 'capturing output from Write-Host and Write-Error' do
-    subject(:output) do
-      script = <<-eos
-      Write-Host 'Hello'
-      $host.ui.WriteErrorLine(', world!')
-      eos
-
-      @captured_stdout = ''
-      @captured_stderr = ''
-      elevated_runner.powershell_elevated(script, username, password) 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
-      # TODO: Option to parse CLIXML
-      # expect(output.output).to eq("Hello\n, world!")
-      # expect(output.stderr).to eq(", world!")
-      expect(output.stderr).to eq(
-        "#< CLIXML\r\n<Objs Version=\"1.1.0.1\" " \
-        "xmlns=\"http://schemas.microsoft.com/powershell/2004/04\">" \
-        "<S S=\"Error\">, world!_x000D__x000A_</S></Objs>\r\n")
-      expect(output.stderr).to eq(@captured_stderr)
-    end
-
-    it 'should have output' do
-      # TODO: Option to parse CLIXML
-      # expect(output.output).to eq("Hello\n, world!")
-      expect(output.output).to eq("Hello\r\n#< CLIXML\r\n<Objs Version=\"1.1.0.1\" " \
-        "xmlns=\"http://schemas.microsoft.com/powershell/2004/04\">" \
-        "<S S=\"Error\">, world!_x000D__x000A_</S></Objs>\r\n")
-    end
-  end
-end
+# encoding: UTF-8
+describe 'powershell elevated runner', integration: true do
+  describe 'ipconfig' do
+    subject(:output) { elevated_shell.run('ipconfig') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/Windows IP Configuration/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'ipconfig as Service' do
+    subject(:output) do
+      elevated_shell.username = 'System'
+      elevated_shell.password = nil
+      elevated_shell.run('ipconfig')
+    end
+    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_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 'ipconfig with incorrect argument -z' do
+    subject(:output) { elevated_shell.run('ipconfig 127.0.0.1 -z') }
+    it { should have_exit_code 1 }
+  end
+
+  describe 'Math area calculation' do
+    subject(:output) do
+      cmd = <<-EOH
+        $diameter = 4.5
+        $area = [Math]::pow([Math]::PI * ($diameter/2), 2)
+        Write-Host $area
+      EOH
+      elevated_shell.run(cmd)
+    end
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/49.9648722805149/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'ipconfig with a block' do
+    subject(:stdout) do
+      outvar = ''
+      elevated_shell.run('ipconfig') do |stdout, _stderr|
+        outvar << stdout
+      end
+      outvar
+    end
+    it { should match(/Windows IP Configuration/) }
+  end
+
+  describe 'capturing output from Write-Host and Write-Error' do
+    subject(:output) do
+      script = <<-eos
+      Write-Host 'Hello'
+      $host.ui.WriteErrorLine(', world!')
+      eos
+
+      @captured_stdout = ''
+      @captured_stderr = ''
+      elevated_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
+end