winrm-elevated 1.0.1 → 1.1.0

data/lib/winrm/shells/elevated.rb

@@ -1,99 +1,104 @@
-# 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 'erubis'
-require 'winrm'
-require 'winrm-fs'
-require 'securerandom'
-
-module WinRM
-  module Shells
-    # Runs PowerShell commands elevated via a scheduled task
-    class Elevated
-      # Create a new elevated shell
-      # @param connection_opts [ConnectionOpts] The WinRM connection options
-      # @param transport [HttpTransport] The WinRM SOAP transport
-      # @param logger [Logger] The logger to log diagnostic messages to
-      def initialize(connection_opts, transport, logger)
-        @logger = logger
-        @username = connection_opts[:user]
-        @password = connection_opts[:password]
-        @shell = Powershell.new(connection_opts, transport, logger)
-        @winrm_file_transporter = WinRM::FS::Core::FileTransporter.new(@shell)
-      end
-
-      # @return [String] The admin user name to execute the scheduled task as
-      attr_accessor :username
-
-      # @return [String] The admin user password
-      attr_accessor :password
-
-      # Run a command or PowerShell script elevated without any of the
-      # restrictions that WinRM puts in place.
-      #
-      # @param [String] The command or PS script to wrap in a scheduled task
-      #
-      # @return [WinRM::Output] :stdout and :stderr
-      def run(command, &block)
-        # if an IO object is passed read it, otherwise assume the contents of the file were passed
-        script_text = command.respond_to?(:read) ? command.read : command
-
-        script_path = upload_elevated_shell_script(script_text)
-        wrapped_script = wrap_in_scheduled_task(script_path, username, password)
-        @shell.run(wrapped_script, &block)
-      end
-
-      # Closes the shell if one is open
-      def close
-        @shell.close
-      end
-
-      private
-
-      def upload_elevated_shell_script(script_text)
-        elevated_shell_path = 'c:/windows/temp/winrm-elevated-shell-' + SecureRandom.uuid + '.ps1'
-        with_temp_file(script_text) do |temp_file|
-          @winrm_file_transporter.upload(temp_file, elevated_shell_path)
-        end
-        elevated_shell_path
-      end
-
-      def with_temp_file(script_text)
-        file = Tempfile.new(['winrm-elevated-shell', 'ps1'])
-        file.write(script_text)
-        file.write("\r\n$Host.SetShouldExit($LASTEXITCODE)")
-        file.fsync
-        file.close
-        yield file.path
-      ensure
-        file.close
-        file.unlink
-      end
-
-      def elevated_shell_script_content
-        IO.read(File.expand_path('../../../winrm-elevated/scripts/elevated_shell.ps1', __FILE__))
-      end
-
-      def wrap_in_scheduled_task(script_path, username, password)
-        Erubis::Eruby.new(elevated_shell_script_content).result(
-          username: username,
-          password: password,
-          script_path: script_path
-        )
-      end
-    end
-  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 'erubis'
+require 'winrm'
+require 'winrm-fs'
+require 'securerandom'
+
+module WinRM
+  module Shells
+    # Runs PowerShell commands elevated via a scheduled task
+    class Elevated
+      # Create a new elevated shell
+      # @param connection_opts [ConnectionOpts] The WinRM connection options
+      # @param transport [HttpTransport] The WinRM SOAP transport
+      # @param logger [Logger] The logger to log diagnostic messages to
+      def initialize(connection_opts, transport, logger)
+        @logger = logger
+        @username = connection_opts[:user]
+        @password = connection_opts[:password]
+        @interactive_logon = false
+        @shell = Powershell.new(connection_opts, transport, logger)
+        @winrm_file_transporter = WinRM::FS::Core::FileTransporter.new(@shell)
+      end
+
+      # @return [String] The admin user name to execute the scheduled task as
+      attr_accessor :username
+
+      # @return [String] The admin user password
+      attr_accessor :password
+
+      # @return [Bool] Using an interactive logon
+      attr_accessor :interactive_logon
+
+      # Run a command or PowerShell script elevated without any of the
+      # restrictions that WinRM puts in place.
+      #
+      # @param [String] The command or PS script to wrap in a scheduled task
+      #
+      # @return [WinRM::Output] :stdout and :stderr
+      def run(command, &block)
+        # if an IO object is passed read it, otherwise assume the contents of the file were passed
+        script_text = command.respond_to?(:read) ? command.read : command
+
+        script_path = upload_elevated_shell_script(script_text)
+        wrapped_script = wrap_in_scheduled_task(script_path, username, password)
+        @shell.run(wrapped_script, &block)
+      end
+
+      # Closes the shell if one is open
+      def close
+        @shell.close
+      end
+
+      private
+
+      def upload_elevated_shell_script(script_text)
+        elevated_shell_path = 'c:/windows/temp/winrm-elevated-shell-' + SecureRandom.uuid + '.ps1'
+        with_temp_file(script_text) do |temp_file|
+          @winrm_file_transporter.upload(temp_file, elevated_shell_path)
+        end
+        elevated_shell_path
+      end
+
+      def with_temp_file(script_text)
+        file = Tempfile.new(['winrm-elevated-shell', 'ps1'])
+        file.write(script_text)
+        file.write("\r\n$Host.SetShouldExit($LASTEXITCODE)")
+        file.fsync
+        file.close
+        yield file.path
+      ensure
+        file.close
+        file.unlink
+      end
+
+      def elevated_shell_script_content
+        IO.read(File.expand_path('../../../winrm-elevated/scripts/elevated_shell.ps1', __FILE__))
+      end
+
+      def wrap_in_scheduled_task(script_path, username, password)
+        Erubis::Eruby.new(elevated_shell_script_content).result(
+          username: username,
+          password: password,
+          script_path: script_path,
+          interactive_logon: interactive_logon
+        )
+      end
+    end
+  end
+end

data/spec/config-example.yml

@@ -1,3 +1,3 @@
-endpoint: "http://localhost:55985/wsman"
-user: vagrant
-password: vagrant
+endpoint: "http://localhost:55985/wsman"
+user: vagrant
+password: vagrant

data/spec/matchers.rb

@@ -1,50 +1,50 @@
-# 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
+# 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,87 +1,87 @@
-# 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
+# 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