Make sudo.ps1 support multi-line commands #39
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,87 +1,94 @@ | ||||||
| <# | ||||||
| .SYNOPSIS | ||||||
| Runs a scriptblock, command or application as an elevated process using sudo.exe | ||||||
| .DESCRIPTION | ||||||
| Wraps sudo.exe to add functionality for running PowerShell scripts or commands in an elevated process. | ||||||
|
|
||||||
| When running a scriptblock or PowerShell command, a new copy of PowerShell is run with sudo and an EncodedCommand. | ||||||
| When running a native application, the command itself is run with sudo. | ||||||
|
|
||||||
| This script DOES NOT (currently) support piping input to the elevated command. | ||||||
| #> | ||||||
|
|
||||||
| # Copyright (c) Microsoft Corporation. | ||||||
| # Licensed under the MIT License. | ||||||
| [CmdletBinding(DefaultParameterSetName = "Script")] | ||||||
| param( | ||||||
| # A scriptblock to run in an elevated process | ||||||
| [Parameter(Mandatory, Position = 0, ParameterSetName = "Script")] | ||||||
| [scriptblock]$ScriptBlock, | ||||||
|
|
||||||
| # Run PowerShell with the -NoProfile switch | ||||||
| [switch]$NoProfile, | ||||||
|
|
||||||
| # A command or application to run in an elevated process | ||||||
| [Parameter(Mandatory, Position = 0, ParameterSetName = "Command")] | ||||||
| [string]$Command, | ||||||
|
|
||||||
| # Arguments to pass to the command or application | ||||||
| [Parameter(Position = 1, ParameterSetName = "Command", ValueFromRemainingArguments)] | ||||||
| [Alias("Args")] | ||||||
| [PSObject[]]$ArgumentList | ||||||
| ) | ||||||
| begin { | ||||||
| if ($IsLinux -or $IsMacOS) { | ||||||
| throw "This script works only on Microsoft Windows" | ||||||
| } | ||||||
|
|
||||||
| if ($__SUDO_TEST -ne $true) { | ||||||
| $Env:SUDOEXE = "sudo.exe" | ||||||
| } elseif (!$Env:SUDOEXE) { | ||||||
| throw "Environment variable SUDOEXE has not been set for testing" | ||||||
| } | ||||||
|
|
||||||
| if (!(Get-Command -Type Application -Name $Env:SUDOEXE -ErrorAction Ignore)) { | ||||||
| throw "Env:SUDOEXE is set to '$Env:SUDOEXE' but it cannot be found." | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. maybe "that cannot be found." or keep "it" There was a problem hiding this comment. Yeah, I think this: Is better than: |
||||||
| } | ||||||
|
|
||||||
| $thisPowerShell = (Get-Process -Id $PID).MainModule.FileName | ||||||
|
There was a problem hiding this comment. I want to point out that I dramatically simplified this, just because there isn't really any way this can go wrong. $PID is a constant in PowerShell and can't changed, so this is always going to return the full path to the executable. |
||||||
| if (!$thisPowerShell) { | ||||||
| throw "Cannot determine PowerShell executable path." | ||||||
| } | ||||||
|
|
||||||
| function ConvertToBase64EncodedString([string]$InputObject) { | ||||||
| $bytes = [System.Text.Encoding]::Unicode.GetBytes($InputObject) | ||||||
| [Convert]::ToBase64String($bytes) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| end { | ||||||
| # If the first parameter is the name of an executable, just run that without PowerShell | ||||||
| if ($PSCmdlet.ParameterSetName -eq "Command") { | ||||||
| if (@(Get-Command $Command -ErrorAction Ignore)[0].CommandType -eq "Application") { | ||||||
| # NOTE: this assumes that all the parameters can be just strings | ||||||
| if ($PSBoundParameters.Contains("Debug")) { | ||||||
|
|
||||||
| Trace-Command -PSHost -Name param* -Expression { & $Env:SUDOEXE $Command @ArgumentList } | ||||||
| } else { | ||||||
| & $Env:SUDOEXE $Command $ArgumentList | ||||||
| } | ||||||
| return | ||||||
| } else { | ||||||
| # In this case, we're going to need to _make_ a scriptblock out of $MyInvocation.Statement | ||||||
| # NOT $MyInvocation.Line because there might be more than one line in the statement | ||||||
| # IISReset and Jaykul apologize for the reflection, but we need to support old versions of PowerShell | ||||||
| $Statement = [System.Management.Automation.InvocationInfo].GetMember( | ||||||
| '_scriptPosition', | ||||||
| [System.Reflection.BindingFlags]'NonPublic,Instance' | ||||||
| )[0].GetValue($MyInvocation).Text. | ||||||
|
Comment on lines
+74
to
+77
There was a problem hiding this comment. the trailing |
||||||
| # Strip the 'sudo' or 'sudo.ps1` or whatever off the front of the statement | ||||||
| $Statement = $Statement.SubString($MyInvocation.InvocationName.Length).Trim() | ||||||
| $EncodedCommand = ConvertToBase64EncodedString $Statement | ||||||
| } | ||||||
| } else { | ||||||
| $EncodedCommand = ConvertToBase64EncodedString $scriptBlock | ||||||
| } | ||||||
|
|
||||||
| $switches = @("-NoLogo", "-NonInteractive") | ||||||
| if ($NoProfile) { $switches += "-NoProfile" } | ||||||
|
|
||||||
| if ($PSBoundParameters.Contains("Debug")) { | ||||||
|
|
||||||
| Trace-Command -PSHost -Name param* -Expression { & $Env:SUDOEXE $ThisPowerShell @switches -EncodedCommand $encodedCommand } | ||||||
| } else { | ||||||
| & $Env:SUDOEXE $ThisPowerShell @switches -EncodedCommand $encodedCommand | ||||||
| } | ||||||
| } | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems overly complicated. One must set two variables: SUDOEXE and __SUDO_TEST, to actually be able to use an alternate executable for testing? I'm not sure why this was here...
I would prefer to just have a parameter
SudoPaththat you can set to whatever you want for testing purposes, but that defaults to justsudo.exeand assumes that sudo.exe is in the PATH.NOTE: I changed
SUDOEXEto an environment variable. I feel like if we're using a mock sudo, you need to be able to set the environment stuff once (i.e. in your pipeline, or in your machine scope), instead of needing to set multiple flags for different wrapper scripts.I'd rather remove these, but if we want to keep them, should
__SUDO_TESTalso be an environment variable?