Sudo

2.1.0

Public/Remove-SudoSession.ps1

                                <#

    .SYNOPSIS

        Removes a Sudo Session (i.e. elevated PSSession) for the current user in the current PowerShell Session and

        and reverts any changes to WSMAN/CredSSP made by the New-SudoSession function.

        IMPORTANT NOTE: This function should only be necessary if the New-SudoSession function was used with the -KeepOpen switch!

        It is meant to be used in the same PowerShell Session that the New-SudoSession function was used in.

    .DESCRIPTION

        See .SYNOPSIS

    .PARAMETER SessionToRemove

        This parameter is MANDATORY.

        This parameter takes a System.Management.Automation.Runspaces.PSSession object that you would like to remove.

        NOTE: The Name property of the PSSession object provided to this paramter should be "Sudo<UserName>". This

        function is not meant to be used to close any other kind of PSSession.

    .PARAMETER OriginalConfigInfo

        This parameter is MANDATORY.

        This parameter defaults to the 'WSManAndRegistryChanges' property of the global variable created via the New-SudoSession

        function called $global:NewSessionAndOriginalStatus, which is a PSCustomObject with the following properties:

            [bool]WinRMStateChange

            [bool]WSMANServerCredSSPStateChange

            [bool]WSMANClientCredSSPStateChange

            [System.Collections.ArrayList]RegistryKeyCreated

            [System.Collections.ArrayList]RegistryKeyPropertiesCreated

    .PARAMETER UserName

        This is a string that represents a UserName with Administrator privileges. Defaults to current user.

        This parameter is mandatory if you do NOT use the -Credentials parameter.

    .PARAMETER Password

        This can be either a plaintext string or a secure string that represents the password for the -UserName.

        This parameter is mandatory if you do NOT use the -Credentials parameter.

    .PARAMETER Credentials

        This is a System.Management.Automation.PSCredential object used to create an elevated PSSession.

    .EXAMPLE

        PS C:\Users\zeroadmin> $SudoSessionInfo = New-SudoSession -Credentials $MyCreds

        PS C:\Users\zeroadmin> Remove-SudoSession -Credentials $MyCreds -OriginalConfigInfo $SudoSessionInfo.WSManAndRegistryChanges -SessionToRemove $SudoSessionInfo.ElevatedPSSession

#>

function Remove-SudoSession {

    [CmdletBinding(DefaultParameterSetName='Supply UserName and Password')]

    Param(

        [Parameter(

            Mandatory=$True,

            ValueFromPipeline=$True,

            Position=0

        )]

        [System.Management.Automation.Runspaces.PSSession]$SessionToRemove,

        [Parameter(Mandatory=$False)]

        $OriginalConfigInfo = $global:NewSessionAndOriginalStatus.WSManAndRegistryChanges,

        [Parameter(

            Mandatory=$False,

            ParameterSetName='Supply UserName and Password'

        )]

        [string]$UserName = $([System.Security.Principal.WindowsIdentity]::GetCurrent().Name -split "\\")[-1],

        [Parameter(

            Mandatory=$False,

            ParameterSetName='Supply UserName and Password'

        )]

        [securestring]$Password,

        [Parameter(

            Mandatory=$False,

            ParameterSetName='Supply Credentials'

        )]

        [System.Management.Automation.PSCredential]$Credentials

    )

    ##### BEGIN Variable/Parameter Transforms and PreRun Prep #####

    if (GetElevation) {

        Write-Error "The current PowerShell Session is already being run with elevated permissions. There is no reason to use the Start-SudoSession function. Halting!"

        $global:FunctionResult = "1"

        return

    }

    if ($OriginalConfigInfo -eq $null) {

        Write-Warning "Unable to determine the original configuration of WinRM/WSMan and AllowFreshCredentials Registry prior to using New-SudoSession. No configuration changes will be made/reverted."

        Write-Warning "The only action will be removing the Elevated PSSession specified by the -SessionToRemove parameter."

    }

    ##### END Variable/Parameter Transforms and PreRunPrep #####

    ##### BEGIN Main Body #####

    if ($OriginalConfigInfo -ne $null) {

        $RestoreOriginalSystemConfigSplatParams = @{

            ExistingSudoSession     = $SessionToRemove

            OriginalConfigInfo      = $OriginalConfigInfo

            ErrorAction             = "Stop"

        }

        if ($SessionToRemove.State -ne "Opened") {

            if ($global:SudoCredentials) {

                if (!$Credentials) {

                    if ($Username -match "\\") {

                        $UserName = $($UserName -split "\\")[-1]

                    }

                    if ($global:SudoCredentials.UserName -match "\\") {

                        $SudoUserName = $($global:SudoCredentials.UserName -split "\\")[-1]

                    }

                    else {

                        $SudoUserName = $global:SudoCredentials.UserName

                    }

                    if ($SudoUserName -match $UserName) {

                        $Credentials = $global:SudoCredentials

                    }

                }

                else {

                    if ($global:SudoCredentials.UserName -ne $Credentials.UserName) {

                        $global:SudoCredentials = $Credentials

                    }

                }

            }

            if (!$Credentials) {

                if (!$Password) {

                    $Password = Read-Host -Prompt "Please enter the password for $UserName" -AsSecureString

                }

                $Credentials = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $UserName, $Password

            }

            if ($Credentials.UserName -match "\\") {

                $UserName = $($Credentials.UserName -split "\\")[-1]

            }

            if ($Username -match "\\") {

                $UserName = $($UserName -split "\\")[-1]

            }

            $global:SudoCredentials = $null

        }

        if ($Credentials) {

            $RestoreOriginalSystemConfigSplatParams.Add("Credentials",$Credentials)

        }

        try {

            Restore-OriginalSystemConfig @RestoreOriginalSystemConfigSplatParams

        }

        catch {

            Write-Error $_

            $global:FunctionResult = "1"

            return

        }

    }

    try {

        Remove-PSSession $SessionToRemove -ErrorAction Stop

    }

    catch {

        Write-Error $_

        $global:FunctionResult = "1"

        return

    }

    ##### END Main Body #####

}

# SIG # Begin signature block

# MIIMiAYJKoZIhvcNAQcCoIIMeTCCDHUCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB

# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR

# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUXX3ljZzU6Xt00YHsFfHbHemS

# 24Ggggn9MIIEJjCCAw6gAwIBAgITawAAAB/Nnq77QGja+wAAAAAAHzANBgkqhkiG

# 9w0BAQsFADAwMQwwCgYDVQQGEwNMQUIxDTALBgNVBAoTBFpFUk8xETAPBgNVBAMT

# CFplcm9EQzAxMB4XDTE3MDkyMDIxMDM1OFoXDTE5MDkyMDIxMTM1OFowPTETMBEG

# CgmSJomT8ixkARkWA0xBQjEUMBIGCgmSJomT8ixkARkWBFpFUk8xEDAOBgNVBAMT

# B1plcm9TQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDCwqv+ROc1

# bpJmKx+8rPUUfT3kPSUYeDxY8GXU2RrWcL5TSZ6AVJsvNpj+7d94OEmPZate7h4d

# gJnhCSyh2/3v0BHBdgPzLcveLpxPiSWpTnqSWlLUW2NMFRRojZRscdA+e+9QotOB

# aZmnLDrlePQe5W7S1CxbVu+W0H5/ukte5h6gsKa0ktNJ6X9nOPiGBMn1LcZV/Ksl

# lUyuTc7KKYydYjbSSv2rQ4qmZCQHqxyNWVub1IiEP7ClqCYqeCdsTtfw4Y3WKxDI

# JaPmWzlHNs0nkEjvnAJhsRdLFbvY5C2KJIenxR0gA79U8Xd6+cZanrBUNbUC8GCN

# wYkYp4A4Jx+9AgMBAAGjggEqMIIBJjASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsG

# AQQBgjcVAgQWBBQ/0jsn2LS8aZiDw0omqt9+KWpj3DAdBgNVHQ4EFgQUicLX4r2C

# Kn0Zf5NYut8n7bkyhf4wGQYJKwYBBAGCNxQCBAweCgBTAHUAYgBDAEEwDgYDVR0P

# AQH/BAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUdpW6phL2RQNF

# 7AZBgQV4tgr7OE0wMQYDVR0fBCowKDAmoCSgIoYgaHR0cDovL3BraS9jZXJ0ZGF0

# YS9aZXJvREMwMS5jcmwwPAYIKwYBBQUHAQEEMDAuMCwGCCsGAQUFBzAChiBodHRw

# Oi8vcGtpL2NlcnRkYXRhL1plcm9EQzAxLmNydDANBgkqhkiG9w0BAQsFAAOCAQEA

# tyX7aHk8vUM2WTQKINtrHKJJi29HaxhPaHrNZ0c32H70YZoFFaryM0GMowEaDbj0

# a3ShBuQWfW7bD7Z4DmNc5Q6cp7JeDKSZHwe5JWFGrl7DlSFSab/+a0GQgtG05dXW

# YVQsrwgfTDRXkmpLQxvSxAbxKiGrnuS+kaYmzRVDYWSZHwHFNgxeZ/La9/8FdCir

# MXdJEAGzG+9TwO9JvJSyoGTzu7n93IQp6QteRlaYVemd5/fYqBhtskk1zDiv9edk

# mHHpRWf9Xo94ZPEy7BqmDuixm4LdmmzIcFWqGGMo51hvzz0EaE8K5HuNvNaUB/hq

# MTOIB5145K8bFOoKHO4LkTCCBc8wggS3oAMCAQICE1gAAAH5oOvjAv3166MAAQAA

# AfkwDQYJKoZIhvcNAQELBQAwPTETMBEGCgmSJomT8ixkARkWA0xBQjEUMBIGCgmS

# JomT8ixkARkWBFpFUk8xEDAOBgNVBAMTB1plcm9TQ0EwHhcNMTcwOTIwMjE0MTIy

# WhcNMTkwOTIwMjExMzU4WjBpMQswCQYDVQQGEwJVUzELMAkGA1UECBMCUEExFTAT

# BgNVBAcTDFBoaWxhZGVscGhpYTEVMBMGA1UEChMMRGlNYWdnaW8gSW5jMQswCQYD

# VQQLEwJJVDESMBAGA1UEAxMJWmVyb0NvZGUyMIIBIjANBgkqhkiG9w0BAQEFAAOC

# AQ8AMIIBCgKCAQEAxX0+4yas6xfiaNVVVZJB2aRK+gS3iEMLx8wMF3kLJYLJyR+l

# rcGF/x3gMxcvkKJQouLuChjh2+i7Ra1aO37ch3X3KDMZIoWrSzbbvqdBlwax7Gsm

# BdLH9HZimSMCVgux0IfkClvnOlrc7Wpv1jqgvseRku5YKnNm1JD+91JDp/hBWRxR

# 3Qg2OR667FJd1Q/5FWwAdrzoQbFUuvAyeVl7TNW0n1XUHRgq9+ZYawb+fxl1ruTj

# 3MoktaLVzFKWqeHPKvgUTTnXvEbLh9RzX1eApZfTJmnUjBcl1tCQbSzLYkfJlJO6

# eRUHZwojUK+TkidfklU2SpgvyJm2DhCtssFWiQIDAQABo4ICmjCCApYwDgYDVR0P

# AQH/BAQDAgeAMBMGA1UdJQQMMAoGCCsGAQUFBwMDMB0GA1UdDgQWBBS5d2bhatXq

# eUDFo9KltQWHthbPKzAfBgNVHSMEGDAWgBSJwtfivYIqfRl/k1i63yftuTKF/jCB

# 6QYDVR0fBIHhMIHeMIHboIHYoIHVhoGubGRhcDovLy9DTj1aZXJvU0NBKDEpLENO

# PVplcm9TQ0EsQ049Q0RQLENOPVB1YmxpYyUyMEtleSUyMFNlcnZpY2VzLENOPVNl

# cnZpY2VzLENOPUNvbmZpZ3VyYXRpb24sREM9emVybyxEQz1sYWI/Y2VydGlmaWNh

# dGVSZXZvY2F0aW9uTGlzdD9iYXNlP29iamVjdENsYXNzPWNSTERpc3RyaWJ1dGlv

# blBvaW50hiJodHRwOi8vcGtpL2NlcnRkYXRhL1plcm9TQ0EoMSkuY3JsMIHmBggr

# BgEFBQcBAQSB2TCB1jCBowYIKwYBBQUHMAKGgZZsZGFwOi8vL0NOPVplcm9TQ0Es

# Q049QUlBLENOPVB1YmxpYyUyMEtleSUyMFNlcnZpY2VzLENOPVNlcnZpY2VzLENO

# PUNvbmZpZ3VyYXRpb24sREM9emVybyxEQz1sYWI/Y0FDZXJ0aWZpY2F0ZT9iYXNl

# P29iamVjdENsYXNzPWNlcnRpZmljYXRpb25BdXRob3JpdHkwLgYIKwYBBQUHMAKG

# Imh0dHA6Ly9wa2kvY2VydGRhdGEvWmVyb1NDQSgxKS5jcnQwPQYJKwYBBAGCNxUH

# BDAwLgYmKwYBBAGCNxUIg7j0P4Sb8nmD8Y84g7C3MobRzXiBJ6HzzB+P2VUCAWQC

# AQUwGwYJKwYBBAGCNxUKBA4wDDAKBggrBgEFBQcDAzANBgkqhkiG9w0BAQsFAAOC

# AQEAszRRF+YTPhd9UbkJZy/pZQIqTjpXLpbhxWzs1ECTwtIbJPiI4dhAVAjrzkGj

# DyXYWmpnNsyk19qE82AX75G9FLESfHbtesUXnrhbnsov4/D/qmXk/1KD9CE0lQHF

# Lu2DvOsdf2mp2pjdeBgKMRuy4cZ0VCc/myO7uy7dq0CvVdXRsQC6Fqtr7yob9NbE

# OdUYDBAGrt5ZAkw5YeL8H9E3JLGXtE7ir3ksT6Ki1mont2epJfHkO5JkmOI6XVtg

# anuOGbo62885BOiXLu5+H2Fg+8ueTP40zFhfLh3e3Kj6Lm/NdovqqTBAsk04tFW9

# Hp4gWfVc0gTDwok3rHOrfIY35TGCAfUwggHxAgEBMFQwPTETMBEGCgmSJomT8ixk

# ARkWA0xBQjEUMBIGCgmSJomT8ixkARkWBFpFUk8xEDAOBgNVBAMTB1plcm9TQ0EC

# E1gAAAH5oOvjAv3166MAAQAAAfkwCQYFKw4DAhoFAKB4MBgGCisGAQQBgjcCAQwx

# CjAIoAKAAKECgAAwGQYJKoZIhvcNAQkDMQwGCisGAQQBgjcCAQQwHAYKKwYBBAGC

# NwIBCzEOMAwGCisGAQQBgjcCARUwIwYJKoZIhvcNAQkEMRYEFEv69m3xhQ7r0yEz

# NQHefc55h6z+MA0GCSqGSIb3DQEBAQUABIIBABw+rMk+xGyDRFLssHMv2H6MAzb0

# RUtCqeVlJqgGzK0VSPNoSaqkxH5t7Yv71HpRJRgLb+I+pT8DPdAghYH4nNPSTp4o

# fGXc6oMzQcT/IaabzjnZdOKtLSaeMzN5DL+ReM7Lt4IpUkOOtrmVX9bluFBa1vvD

# 9wRRjsOtZ6F9rym/XCHIhdXpOsP+dP4nifJREylJWeZNFk49zhL6WJBdvffIB6TY

# KTaroaluCu3FZ95n5RpJhKOkLWrGkIe/38zJdld12O8b6QUrYTvs6QSXXPiZmoTw

# iIYVmmwq7t3X3vnih0H/3VBf/gKrYXUfDJLcd55YLtAlWY7pWFWJvbhTj1I=

# SIG # End signature block