ConvertTo-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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# Windows Security Identifier (SID) conversion module 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
    ConvertTo-Sid converts a Windows user or group account name to the SID of this account
    .DESCRIPTION
    ConvertTo-Sid converts a Windows user or group account name to the SID of this account. you could convert both local and domain accounts (for local accounts use local machine name (or .) as parameter -domain)
    .PARAMETER accountName
    account name of user or group for which we want to get SID
    .PARAMETER domain
    domain name of user or group for which we want to get SID
    .EXAMPLE
    ConvertTo-Sid -name everyone # output: S-1-1-0
    this example returns SID for the Everyone user group
    .EXAMPLE
    ConvertTo-Sid -name guest -domain example.com # output: S-1-5-21-<example.com part>-501
    this example returns SID for the Guest domain user
    .INPUTS
    string
    .OUTPUTS
    string
    .LINK
    https://github.com/almaceleste/sidconversion#ConvertTo-Sid
    .COMPONENT
    System.Security.Principal
    .NOTES
    Version: 0.1.1
    Author: almaceleste
    Creation Date: 2020
    Purpose/Change: fixed help link
#>

param
(
    [Alias('samAccountName')]
    [Parameter(
        HelpMessage='input user of group account name (exclude "/ \ [ ] : ; | = , + * ? < > and space)',
        Mandatory=$true,
        ValueFromPipeline=$true,
        ValueFromPipelineByPropertyName=$true)]
    [ValidateLength(1,104)]
    [ValidatePattern('[^\"/\\\[\]:;\|=\,\+\*\?<>\s]', Options='IgnoreCase')]
    [System.String]
    $accountName, 

    [Alias('NTDomain')]
    [Parameter(
        HelpMessage="input NT domain name or FQDN (exclude `" , ~ : ! @ # $ % ^ & ' ( ) { } _ and space)",
        Mandatory=$false,
        ValueFromPipeline=$true,
        ValueFromPipelineByPropertyName=$true)]
    [ValidateLength(1,64)]
    [ValidatePattern("^[a-z0-9][^,~:!@#\$%\^\&\'\(\)\{\}_\s]+[^\-]$|\.", Options='IgnoreCase')]
    [System.String]
    $domain
)
try {
    if ([string]::IsNullOrEmpty($domain)) {
        $account = New-Object System.Security.Principal.NTAccount($accountName)
    }
    else {
        if ($domain -eq ".") {$domain=$env:computername}
        $account = New-Object System.Security.Principal.NTAccount($domain,$accountName)
    }
    $sid = $account.Translate([System.Security.Principal.SecurityIdentifier])
    return $sid.Value
}
catch {
    return "Account $accountName does not exist"
}