winrm-elevated 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bb58d85b030cf0a126747be05fa9719d880b04d
-  data.tar.gz: d58290dbaa6567a26bc4881af45867149a17f233
+  metadata.gz: c4572eca7fef32bcc8a6ca9176a7bdf6c9e2363d
+  data.tar.gz: 64379eea77854e78f5693d2837f84366e985e667
 SHA512:
-  metadata.gz: 0ffc606d3525a1d64c99f3bb2f15b218756ef9bf8d5d2e76ee4697be496f5daa544e5efc8744bd531fe21275530135cd2f091f205fb12ba98542cbae4894ed21
-  data.tar.gz: a2bfbf4099222105321c8d708fe8d81b021f38b9cbdc3b904392aeeeb64aa73016f9b7f5f8f9808fc2dab65e7aebfe0090dcb1f86152ef2e1a3d043942e2d93b
+  metadata.gz: c46c73909c7cc83ed7b4290e57ad7ff7082d8673986dee063c31e5437f22460b136b26023a0d797afd201a5903dc7d257a609ba6a3ae12f9aa8745a08ac282fe
+  data.tar.gz: 03c883e1fe01ecb29bb161c2cb8a09d5863ca3ec38a236f706a51b754d0f74935067c420f6b445a1ffa977bbfb0e64467aca7f5f2770f8fd1958e92abdc72d76

data/.rubocop.yml

@@ -1,17 +1,17 @@
-Style/FileName:
-  Enabled: false
-
-Style/Encoding:
-  Enabled: true
-
-Metrics/LineLength:
-  Max: 120
-
-Metrics/MethodLength:
-  Max: 20
-
-ClassLength:
-  Max: 250
-
-Metrics/AbcSize:
-  Max: 25
+Style/FileName:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+ClassLength:
+  Max: 250
+
+Metrics/AbcSize:
+  Max: 25

data/.travis.yml

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

data/README.md

@@ -1,86 +1,86 @@
-# Runs PowerShell commands as elevated over Windows Remote Management (WinRM) via a scheduled task
-[![Gem Version](https://badge.fury.io/rb/winrm-elevated.svg)](http://badge.fury.io/rb/winrm-elevated)
-
-This gem allows you to break out of the magical WinRM constraints thus allowing to reach out to network shares and even install Windows updates, .NET, SQL Server etc.
-
-## Running commands elevated
-```ruby
-require 'winrm'
-require 'winrm-elevated'
-
-conn = WinRM::Connection.new(...
-conn.shell(:elevated) do |shell|
-  shell.run('$PSVersionTable') do |stdout, stderr|
-    STDOUT.print stdout
-    STDERR.print stderr
-  end
-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'
-
-conn = WinRM::Connection.new(...
-conn.shell(:elevated) do |shell|
-  shell.username = 'System'
-  shell.password = nil
-  shell.run('$PSVersionTable') do |stdout, stderr|
-    STDOUT.print stdout
-    STDERR.print stderr
-  end
-end
-```
-
-## How does it work?
-
-The gem works by creating a new logon session local to the Windows box by using a scheduled task. After this point WinRM is just used to read output from the scheduled task via a log file.
-
-1. The command you'd like to run outside the WinRM context is saved to a temporary file.
-2. This file is uploaded to the machine over WinRM.
-3. A script is executed over WinRM and does the following:
-  1. Scheduled task is created which will execute your command and redirect stdout and stderr to a location known by elevated_shell.ps1.
-  2. The scheduled task is executed.
-  3. elevated_shell.ps1 polls the stdout and stderr log files and writes them back to WinRM. The script continues in this loop until the scheduled task is complete.
-
-## Troubleshooting
-
-If you're having trouble, first of all its most likely a network or WinRM configuration
-issue. Take a look at the [WinRM gem troubleshooting](https://github.com/WinRb/WinRM#troubleshooting)
-first.
-
-## Contributing
-
-1. Fork it.
-2. Create a branch (git checkout -b my_feature_branch)
-3. Run the unit and integration tests (bundle exec rake integration)
-4. Commit your changes (git commit -am "Added a sweet feature")
-5. Push to the branch (git push origin my_feature_branch)
-6. Create a pull requst from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
-
-### Running the tests
-
-We use Bundler to manage dependencies during development.
-
-```
-$ bundle install
-```
-
-Once you have the dependencies, you can run the unit tests with `rake`:
-
-```
-$ bundle exec rake spec
-```
-
-To run the integration tests you will need a Windows box with the WinRM service properly configured. Its easiest to use the Vagrant Windows box in the Vagrantilfe of this repo.
-
-1. Create a Windows VM with WinRM configured (see above).
-2. Copy the config-example.yml to config.yml - edit this file with your WinRM connection details.
-3. Run `bundle exec rake integration`
-
-## WinRM-elevated Authors
-* Shawn Neal (https://github.com/sneal)
-
-[Contributors](https://github.com/WinRb/winrm-elevated/graphs/contributors)
+# Runs PowerShell commands as elevated over Windows Remote Management (WinRM) via a scheduled task
+[![Gem Version](https://badge.fury.io/rb/winrm-elevated.svg)](http://badge.fury.io/rb/winrm-elevated)
+
+This gem allows you to break out of the magical WinRM constraints thus allowing to reach out to network shares and even install Windows updates, .NET, SQL Server etc.
+
+## Running commands elevated
+```ruby
+require 'winrm'
+require 'winrm-elevated'
+
+conn = WinRM::Connection.new(...
+conn.shell(:elevated) do |shell|
+  shell.run('$PSVersionTable') do |stdout, stderr|
+    STDOUT.print stdout
+    STDERR.print stderr
+  end
+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'
+
+conn = WinRM::Connection.new(...
+conn.shell(:elevated) do |shell|
+  shell.username = 'System'
+  shell.password = nil
+  shell.run('$PSVersionTable') do |stdout, stderr|
+    STDOUT.print stdout
+    STDERR.print stderr
+  end
+end
+```
+
+## How does it work?
+
+The gem works by creating a new logon session local to the Windows box by using a scheduled task. After this point WinRM is just used to read output from the scheduled task via a log file.
+
+1. The command you'd like to run outside the WinRM context is saved to a temporary file.
+2. This file is uploaded to the machine over WinRM.
+3. A script is executed over WinRM and does the following:
+  1. Scheduled task is created which will execute your command and redirect stdout and stderr to a location known by elevated_shell.ps1.
+  2. The scheduled task is executed.
+  3. elevated_shell.ps1 polls the stdout and stderr log files and writes them back to WinRM. The script continues in this loop until the scheduled task is complete.
+
+## Troubleshooting
+
+If you're having trouble, first of all its most likely a network or WinRM configuration
+issue. Take a look at the [WinRM gem troubleshooting](https://github.com/WinRb/WinRM#troubleshooting)
+first.
+
+## Contributing
+
+1. Fork it.
+2. Create a branch (git checkout -b my_feature_branch)
+3. Run the unit and integration tests (bundle exec rake integration)
+4. Commit your changes (git commit -am "Added a sweet feature")
+5. Push to the branch (git push origin my_feature_branch)
+6. Create a pull requst from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
+
+### Running the tests
+
+We use Bundler to manage dependencies during development.
+
+```
+$ bundle install
+```
+
+Once you have the dependencies, you can run the unit tests with `rake`:
+
+```
+$ bundle exec rake spec
+```
+
+To run the integration tests you will need a Windows box with the WinRM service properly configured. Its easiest to use the Vagrant Windows box in the Vagrantilfe of this repo.
+
+1. Create a Windows VM with WinRM configured (see above).
+2. Copy the config-example.yml to config.yml - edit this file with your WinRM connection details.
+3. Run `bundle exec rake integration`
+
+## WinRM-elevated Authors
+* Shawn Neal (https://github.com/sneal)
+
+[Contributors](https://github.com/WinRb/winrm-elevated/graphs/contributors)

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/appveyor.yml

@@ -1,39 +1,39 @@
-version: "master-{build}"
-
-os: Windows Server 2012 R2
-platform:
-  - x64
-
-environment:
-  winrm_user: test_user
-  winrm_password: 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_password
-  - 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
+version: "master-{build}"
+
+os: Windows Server 2012 R2
+platform:
+  - x64
+
+environment:
+  winrm_user: test_user
+  winrm_password: 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_password
+  - 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,18 +1,26 @@
-# 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)
-
-# 0.2.0
-- [Only upload the elevated runner script once per winrm session](https://github.com/WinRb/winrm-elevated/pull/3)
-- Bump WinRM (1.5) and WinRM-fs (0.3.0) gem constraints
-
-# 0.1.0
-- Initial Release
+# WinRM-Elevated Gem Changelog
+
+# 1.0.1
+- Fix to avoid profile conflicts
+- Fix inadequate Execution Policy errors
+
+# 1.0.0
+- Adjust to comply with winrm v2 APIs
+- Expose implementation as a class of `WinRM::Shells`
+
+# 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)
+
+# 0.2.0
+- [Only upload the elevated runner script once per winrm session](https://github.com/WinRb/winrm-elevated/pull/3)
+- Bump WinRM (1.5) and WinRM-fs (0.3.0) gem constraints
+
+# 0.1.0
+- Initial Release

data/lib/winrm-elevated.rb

@@ -1,18 +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/shells/elevated'
+# 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/lib/winrm-elevated/scripts/elevated_shell.ps1

@@ -1,108 +1,108 @@
-$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
+$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 -executionpolicy bypass -NoProfile -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