ConvertFrom-Sid.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# Windows Security Identifier (SID) to account conversion script for PowerShell
# GNU Affero GPL v3 (ɔ) 2020 almaceleste
# https://github.com/almaceleste

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
# https://www.gnu.org/licenses/agpl-3.0.html
# https://www.gnu.org/licenses/agpl-3.0.txt

<#
    .SYNOPSIS
    ConvertFrom-Sid converts the SID of the user or group account to the name of this account
    .DESCRIPTION
    ConvertFrom-Sid converts the SID of the user or group account to the name of this account. you could convert both local and domain accounts SIDs.
    .PARAMETER sid
    SID of the user or group account whose name we want to get
    .EXAMPLE
    ConvertFrom-Sid -sid S-1-1-0 # output: Everyone
    this example returns Everyone user group account name
    .EXAMPLE
    ConvertFrom-Sid -sid S-1-5-21-<example.com part>-501 # output: Guest
    this example returns default guest domain account name
    .INPUTS
    string
    .OUTPUTS
    string
    .LINK
    https://github.com/almaceleste/sidconversion#ConvertFrom-Sid
    .COMPONENT
    System.Security.Principal
    .NOTES
    Version: 0.1.1
    Author: almaceleste
    Creation Date: 2020
    Purpose/Change: fixed help link
#>

param (
    [Parameter(
        HelpMessage='enter SID (security identifier, looks like S-1-1-...)',
        Mandatory=$true,
        ValueFromPipeline=$true,
        ValueFromPipelineByPropertyName=$true)]
    [ValidateLength(5,256)]
    [ValidatePattern('^S-[0-9]{1}-[0-9]{1}[\-0-9]{0,251}', Options='IgnoreCase')]
    [System.String]
    $SID
)
try {
    $account = (New-Object System.Security.Principal.SecurityIdentifier($SID)).Translate([System.Security.Principal.NTAccount])
    return $account.Value
}
catch {
    return "SID $SID not found"
}