internal/functions/Resolve-ADPrincipal.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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
function Resolve-ADPrincipal
{
<#
    .SYNOPSIS
        Resolves an AD Principal into a common format.
     
    .DESCRIPTION
        Resolves an AD Principal into a common format.
        Optimized for use with cross-domain migration procedures.
     
        Caches successful results.
        Returns empty values on unresolved users.
     
    .PARAMETER Name
        Name of the principal to resolve.
     
    .PARAMETER Domain
        Domain to resolve it for.
        Read access is required.
     
    .EXAMPLE
        PS C:\> Resolve-ADPrincipal -Name 'contoso\max' -Domain 'contoso.com'
     
        Resolves the user max from contoso.com
#>

    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingEmptyCatchBlock', '')]
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
        [string[]]
        $Name,
        
        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
        [string]
        $Domain
    )
    
    begin
    {
        if (-not $script:principals) { $script:principals = @{ } }
        
        $principalsToIgnore = @(
            # .NET Account sids, that are shared across all domains and need no translation
            'S-1-5-82-3876422241-1344743610-1729199087-774402673-2621913236'
            'S-1-5-82-271721585-897601226-2024613209-625570482-296978595'
            
            # Everyone, as it is 100% generic and has no domain-prefix
            'S-1-1-0'
            
            # NT Authority SIDs, as SID-to-SID need no translation, localization can be an issue
            'S-1-5-18'
            'S-1-5-19'
            'S-1-5-20'
        )
        
        $defaultDomainData = Get-DomainData -Domain $Domain
        $defaultDomainFQDN = $defaultDomainData.Fqdn
        $defaultDomainName = $defaultDomainData.Name
    }
    process
    {
        foreach ($identity in $Name)
        {
            if ($identity -in $principalsToIgnore) { continue }

            Write-Verbose "[Resolve-ADPrincipal] Resolving $identity"
            
            #region Resolve Principal Domain
            $domainFQDN = $defaultDomainFQDN
            $domainName = $defaultDomainName
            if ($identity -like "*@*")
            {
                $domainObject = Get-DomainData -Domain $identity.Split("@")[1]
                if ($domainObject)
                {
                    $domainFQDN = $domainObject.Fqdn
                    $domainName = $domainObject.Name
                }
            }
            elseif ($identity -as [System.Security.Principal.SecurityIdentifier])
            {
                if (([System.Security.Principal.SecurityIdentifier]$identity).AccountDomainSid)
                {
                    $domainObject = Get-DomainData -Domain ([System.Security.Principal.SecurityIdentifier]$identity).AccountDomainSid
                    if ($domainObject)
                    {
                        $domainFQDN = $domainObject.Fqdn
                        $domainName = $domainObject.Name
                    }
                }
            }
            elseif ($identity -like "*\*")
            {
                try { $domainObject = Get-DomainData -Domain $identity.Split("\")[0] -ErrorAction Stop }
                catch { }
                if ($domainObject)
                {
                    $domainFQDN = $domainObject.Fqdn
                    $domainName = $domainObject.Name
                }
            }
            $rootDomain = (Get-ADForest -Server $domainFQDN).RootDomain
            #endregion Resolve Principal Domain
            
            if (-not $script:principals[$domainFQDN]) { $script:principals[$domainFQDN] = @{ } }
            
            # Return form Cache if available
            if ($script:principals[$domainFQDN][$identity])
            {
                return $script:principals[$domainFQDN][$identity]
            }
            
            #region Resolve User in AD
            if ($identity -as [System.Security.Principal.SecurityIdentifier])
            {
                $adObject = Get-ADObject -Server $domainFQDN -LDAPFilter "(objectSID=$identity)" -Properties ObjectSID, SamAccountName
                # Handle Builtin SIDs that only exist in the root domain
                if (-not $adObject) { $adObject = Get-ADObject -Server $rootDomain -LDAPFilter "(objectSID=$identity)" -Properties ObjectSID, SamAccountName }
            }
            elseif (Test-IsDistinguishedName -Name $identity)
            {
                $adObject = Get-ADObject -Server ($identity | ConvertTo-DnsDomainName) -Identity $identity -Properties ObjectSID, SamAccountName
            }
            elseif ($identity -like "*\*")
            {
                try { $sidName = ([System.Security.Principal.NTAccount]$identity).Translate([System.Security.Principal.SecurityIdentifier]) }
                catch
                {
                    Write-Warning "Failed to translate identity: $identity"
                    continue
                }
                try { $adObject = Get-ADObject -Server $domainFQDN -LDAPFilter "(objectSID=$sidName)" -Properties ObjectSID, SamAccountName -ErrorAction Stop }
                catch { }
                if (-not $adObject)
                {
                    $script:principals[$domainFQDN][$identity] = [pscustomobject]@{
                        DistinguishedName = $null
                        Name              = $identity
                        SID                  = $sidName.Value
                        RID                  = $sidName.Value.ToString().Split("-")[-1]
                        Type              = 'Local BuiltIn'
                        IsBuiltin          = $true
                        DomainName          = $domainName
                        DomainFqdn          = $domainFQDN
                    }
                    $script:principals[$domainFQDN][$identity]
                    continue
                }
            }
            else
            {
                try
                {
                    $sidName = ([System.Security.Principal.NTAccount]$identity).Translate([System.Security.Principal.SecurityIdentifier])
                    if ($sidName.Value -like 'S-1-3-*')
                    {
                        $script:principals[$domainFQDN][$identity] = [pscustomobject]@{
                            DistinguishedName = $null
                            Name              = $identity
                            SID                  = $sidName.Value
                            RID                  = $sidName.Value.ToString().Split("-")[-1]
                            Type              = 'Local BuiltIn'
                            IsBuiltin          = $true
                            DomainName          = $domainName
                            DomainFqdn          = $domainFQDN
                        }
                        $script:principals[$domainFQDN][$identity]
                        continue
                    }
                    $adObject = Get-ADObject -Server $domainFQDN -LDAPFilter "(objectSID=$sidName)" -Properties ObjectSID, SamAccountName
                }
                catch
                {
                    $adObject = Get-ADObject -Server $domainFQDN -LDAPFilter "(SamAccountName=$identity)" -Properties ObjectSID, SamAccountName
                }
            }
            if (-not $adObject -or -not $adObject.ObjectSID)
            {
                Write-Warning "Failed to resolve principal: $identity"
                continue
            }
            #endregion Resolve User in AD
            
            $script:principals[$domainFQDN][$identity] = [pscustomobject]@{
                DistinguishedName = $adObject.DistinguishedName
                Name              = $adObject.SamAccountName
                SID                  = $adObject.ObjectSID.Value
                RID                  = $adObject.ObjectSID.Value.ToString().Split("-")[-1]
                Type              = $adObject.ObjectClass
                IsBuiltin          = ((($adObject.ObjectSID.Value.Split("-")[-1] -as [int]) -lt 1000) -or ($adObject.ObjectSID.Value -like 'S-1-5-32-*'))
                DomainName          = $domainName
                DomainFqdn          = $domainFQDN
            }
            $script:principals[$domainFQDN][$identity]
        }
    }
}