Adsi.psm1
#[NoRunspaceAffinity()] # Make this class thread-safe (requires PS 7+) class FakeDirectoryEntry { <# Used in place of a DirectoryEntry for certain WinNT security principals that do not have objects in the directory The WinNT provider only throws an error if you try to retrieve certain accounts/identities #> [string]$Name [string]$Parent [string]$Path [type]$SchemaEntry [byte[]]$objectSid [string]$Description [hashtable]$Properties [string]$SchemaClassName FakeDirectoryEntry ( [string]$DirectoryPath ) { $LastSlashIndex = $DirectoryPath.LastIndexOf('/') $StartIndex = $LastSlashIndex + 1 $This.Name = $DirectoryPath.Substring($StartIndex, $DirectoryPath.Length - $StartIndex) $This.Parent = $DirectoryPath.Substring(0, $LastSlashIndex) $This.Path = $DirectoryPath $This.SchemaEntry = [System.DirectoryServices.DirectoryEntry] switch -regex ($DirectoryPath) { 'CREATOR OWNER$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-3-0' $This.Description = 'A SID to be replaced by the SID of the user who creates a new object. This SID is used in inheritable ACEs.' $This.SchemaClassName = 'user' } 'SYSTEM$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-18' $This.Description = 'By default, the SYSTEM account is granted Full Control permissions to all files on an NTFS volume' $This.SchemaClassName = 'user' } 'INTERACTIVE$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-4' $This.Description = 'Users who log on for interactive operation. This is a group identifier added to the token of a process when it was logged on interactively.' $This.SchemaClassName = 'group' } 'Authenticated Users$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-11' $This.Description = 'Any user who accesses the system through a sign-in process has the Authenticated Users identity.' $This.SchemaClassName = 'group' } 'TrustedInstaller$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-80-956008885-3418522649-1831038044-1853292631-2271478464' $This.Description = 'Most of the operating system files are owned by the TrustedInstaller security identifier (SID)' $This.SchemaClassName = 'user' } 'ALL APPLICATION PACKAGES$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-15-2-1' $This.Description = 'All applications running in an app package context. SECURITY_BUILTIN_PACKAGE_ANY_PACKAGE' $This.SchemaClassName = 'group' } 'ALL RESTRICTED APPLICATION PACKAGES$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-15-2-2' $This.Description = 'SECURITY_BUILTIN_PACKAGE_ANY_RESTRICTED_PACKAGE' $This.SchemaClassName = 'group' } 'Everyone$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-1-0' $This.Description = "A group that includes all users; aka 'World'." $This.SchemaClassName = 'group' } 'LOCAL SERVICE$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-19' $This.Description = 'A local service account' $This.SchemaClassName = 'user' } 'NETWORK SERVICE$' { $This.objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-20' $This.Description = 'A network service account' $This.SchemaClassName = 'user' } } $This.Properties = @{ Name = $This.Name Description = $This.Description objectSid = $This.objectSid SchemaClassName = $This.SchemaClassName } } [void]RefreshCache([string[]]$Nonsense) {} [void]Invoke([string]$Nonsense) {} } function Add-DomainFqdnToLdapPath { <# .SYNOPSIS Add a domain FQDN to an LDAP directory path as the server address so the new path can be used for remote queries .DESCRIPTION Uses RegEx to: - Match the Domain Components from the Distinguished Name in the LDAP directory path - Convert the Domain Components to an FQDN - Insert them into the directory path as the server address .INPUTS [System.String]$DirectoryPath .OUTPUTS [System.String] Complete LDAP directory path including server address .EXAMPLE Add-DomainFqdnToLdapPath -DirectoryPath 'LDAP://CN=user1,OU=UsersOU,DC=ad,DC=contoso,DC=com' LDAP://ad.contoso.com/CN=user1,OU=UsersOU,DC=ad,DC=contoso,DC=com Add the domain FQDN to a single LDAP directory path #> [OutputType([System.String])] param ( # Incomplete LDAP directory path containing a distinguishedName but lacking a server address [Parameter(ValueFromPipeline)] [string[]]$DirectoryPath, <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) begin { <# $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream LogBuffer = $LogBuffer WhoAmI = $WhoAmI } #> $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } $PathRegEx = '(?<Path>LDAP:\/\/[^\/]*)' $DomainRegEx = '(?i)DC=\w{1,}?\b' } process { ForEach ($ThisPath in $DirectoryPath) { if ($ThisPath -match $PathRegEx) { $RegExMatches = $null $RegExMatches = [regex]::Matches($ThisPath, $DomainRegEx) if ($RegExMatches) { $DomainDN = $null $DomainFqdn = $null $RegExMatches = $RegExMatches | ForEach-Object { $_.Value } $DomainDN = $RegExMatches -join ',' $DomainFqdn = ConvertTo-Fqdn -DistinguishedName $DomainDN -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams if ($ThisPath -match "LDAP:\/\/$DomainFqdn\/") { #Write-LogMsg @LogParams -Text " # Domain FQDN already found in the directory path: '$ThisPath'" $ThisPath } else { $ThisPath -replace 'LDAP:\/\/', "LDAP://$DomainFqdn/" } } else { #Write-LogMsg @LogParams -Text " # Domain DN not found in the directory path: '$ThisPath'" $ThisPath } } else { #Write-LogMsg @LogParams -Text " # Not an expected directory path: '$ThisPath'" $ThisPath } } } } function Add-SidInfo { <# .SYNOPSIS Add some useful properties to a DirectoryEntry object for easier access .DESCRIPTION Add SidString, Domain, and SamAccountName NoteProperties to a DirectoryEntry .INPUTS [System.DirectoryServices.DirectoryEntry] or a [PSCustomObject] imitation. InputObject parameter. Must contain the objectSid property. .OUTPUTS [System.DirectoryServices.DirectoryEntry] or a [PSCustomObject] imitation. Whatever was input, but with three extra properties added now. .EXAMPLE [System.DirectoryServices.DirectoryEntry]::new('WinNT://localhost/Administrator') | Add-SidInfo distinguishedName : Path : WinNT://localhost/Administrator The output object's default format is not modified so with default formatting it appears identical to the original. Upon closer inspection it now has SidString, Domain, and SamAccountName properties. #> [OutputType([System.DirectoryServices.DirectoryEntry[]], [PSCustomObject[]])] param ( # Expecting a [System.DirectoryServices.DirectoryEntry] from the LDAP or WinNT providers, or a [PSCustomObject] imitation from Get-DirectoryEntry. # Must contain the objectSid property [Parameter(ValueFromPipeline)] $InputObject, # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) begin { $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } } process { ForEach ($Object in $InputObject) { $SID = $null $SamAccountName = $null $DomainObject = $null if ($null -eq $Object) { continue } elseif ($Object.objectSid.Value ) { # With WinNT directory entries for the root (WinNT://localhost), objectSid is a method rather than a property # So we need to filter out those instances here to avoid this error: # The following exception occurred while retrieving the string representation for method "objectSid": # "Object reference not set to an instance of an object." if ( $Object.objectSid.Value.GetType().FullName -ne 'System.Management.Automation.PSMethod' ) { [string]$SID = [System.Security.Principal.SecurityIdentifier]::new([byte[]]$Object.objectSid.Value, 0) } } elseif ($Object.objectSid) { # With WinNT directory entries for the root (WinNT://localhost), objectSid is a method rather than a property # So we need to filter out those instances here to avoid this error: # The following exception occurred while retrieving the string representation for method "objectSid": # "Object reference not set to an instance of an object." if ($Object.objectSid.GetType().FullName -ne 'System.Management.Automation.PSMethod') { [string]$SID = [System.Security.Principal.SecurityIdentifier]::new([byte[]]$Object.objectSid, 0) } } elseif ($Object.Properties) { if ($Object.Properties['objectSid'].Value) { [string]$SID = [System.Security.Principal.SecurityIdentifier]::new([byte[]]$Object.Properties['objectSid'].Value, 0) } elseif ($Object.Properties['objectSid']) { [string]$SID = [System.Security.Principal.SecurityIdentifier]::new([byte[]]($Object.Properties['objectSid'] | ForEach-Object { $_ }), 0) } if ($Object.Properties['samaccountname']) { $SamAccountName = $Object.Properties['samaccountname'] } else { #DirectoryEntries from the WinNT provider for local accounts do not have a samaccountname attribute so we use name instead $SamAccountName = $Object.Properties['name'] } } elseif ($Object.objectSid) { [string]$SID = [System.Security.Principal.SecurityIdentifier]::new([byte[]]$Object.objectSid, 0) } if ($Object.Domain.Sid) { #if ($Object.Domain.GetType().FullName -ne 'System.Management.Automation.PSMethod') { # This would only have come from Add-SidInfo in the first place # This means it was added with Add-Member in Get-DirectoryEntry for the root of the computer's directory if ($null -eq $SID) { [string]$SID = $Object.Domain.Sid } $DomainObject = $Object.Domain #} } if (-not $DomainObject) { # The SID of the domain is the SID of the user minus the last block of numbers $DomainSid = $SID.Substring(0, $Sid.LastIndexOf("-")) # Lookup other information about the domain using its SID as the key $DomainObject = $DomainsBySid[$DomainSid] } #Write-LogMsg @LogParams -Text "$SamAccountName`t$SID" Add-Member -InputObject $Object -PassThru -Force @{ SidString = $SID Domain = $DomainObject SamAccountName = $SamAccountName } } } } function ConvertFrom-DirectoryEntry { <# .SYNOPSIS Convert a DirectoryEntry to a PSCustomObject .DESCRIPTION Recursively convert every property into a string, or a PSCustomObject (whose properties are all strings, or more PSCustomObjects) This obfuscates the troublesome PropertyCollection and PropertyValueCollection and Hashtable aspects of working with ADSI #> param ( [Parameter( Position = 0 )] [System.DirectoryServices.DirectoryEntry[]]$DirectoryEntry ) ForEach ($ThisDirectoryEntry in $DirectoryEntry) { $OutputObject = @{} ForEach ($Prop in ($ThisDirectoryEntry | Get-Member -View All -MemberType Property, NoteProperty).Name) { $null = ConvertTo-SimpleProperty -InputObject $ThisDirectoryEntry -Property $Prop -PropertyDictionary $OutputObject } [PSCustomObject]$OutputObject } } function ConvertFrom-IdentityReferenceResolved { <# .SYNOPSIS Use ADSI to collect more information about the IdentityReference in NTFS Access Control Entries .DESCRIPTION Recursively retrieves group members and detailed information about them Use caching to reduce duplicate directory queries .INPUTS [System.Object]$IdentityReference .OUTPUTS [System.Object] The input object is returned with additional properties added: DirectoryEntry DomainDn DomainNetBIOS ObjectType Members (if the DirectoryEntry is a group). .EXAMPLE (Get-Acl).Access | Resolve-IdentityReference | Group-Object -Property IdentityReferenceResolved | ConvertFrom-IdentityReferenceResolved Incomplete example but it shows the chain of functions to generate the expected input for this #> [OutputType([void])] param ( # The NTFS AccessControlEntry object(s), grouped by their IdentityReference property # TODO: Use System.Security.Principal.NTAccount instead [Parameter(ValueFromPipeline)] [string]$IdentityReference, # Do not get group members [switch]$NoGroupMembers, # Cache of access control entries keyed by their resolved identities [hashtable]$ACEsByResolvedID = ([hashtable]::Synchronized(@{})), # Thread-safe hashtable to use for caching directory entries and avoiding duplicate directory queries [hashtable]$PrincipalById = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug', # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Dictionary to cache directory entries to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # The current domain # Can be passed as a parameter to reduce calls to Get-CurrentDomain [string]$CurrentDomain = (Get-CurrentDomain) ) $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } $AccessControlEntries = $ACEsByResolvedID[$IdentityReference] if ($null -eq $PrincipalById[$IdentityReference]) { Write-LogMsg @LogParams -Text " # ADSI Principal cache miss for '$IdentityReference'" $GetDirectoryEntryParams = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios ThisFqdn = $ThisFqdn CimCache = $CimCache DebugOutputStream = $DebugOutputStream } $SearchDirectoryParams = @{ CimCache = $CimCache DebugOutputStream = $DebugOutputStream DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios ThisFqdn = $ThisFqdn } $split = $IdentityReference.Split('\') $DomainNetBIOS = $split[0] $SamaccountnameOrSid = $split[1] if ( $null -ne $SamaccountnameOrSid -and @($AccessControlEntries.AdsiProvider)[0] -eq 'LDAP' ) { Write-LogMsg @LogParams -Text " # '$IdentityReference' is a domain security principal" $DomainNetbiosCacheResult = $DomainsByNetbios[$DomainNetBIOS] if ($DomainNetbiosCacheResult) { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache hit for '$DomainNetBIOS' for '$IdentityReference'" $DomainDn = $DomainNetbiosCacheResult.DistinguishedName $SearchDirectoryParams['DirectoryPath'] = "LDAP://$($DomainNetbiosCacheResult.Dns)/$DomainDn" } else { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache miss for '$DomainNetBIOS' for '$IdentityReference'" if ( -not [string]::IsNullOrEmpty($DomainNetBIOS) ) { $DomainDn = ConvertTo-DistinguishedName -Domain $DomainNetBIOS -DomainsByNetbios $DomainsByNetbios @LoggingParams } $SearchDirectoryParams['DirectoryPath'] = Add-DomainFqdnToLdapPath -DirectoryPath "LDAP://$DomainNetBIOS" -ThisFqdn $ThisFqdn -CimCache $CimCache @LogParams } # Search the domain for the principal $SearchDirectoryParams['Filter'] = "(samaccountname=$SamaccountnameOrSid)" $SearchDirectoryParams['PropertiesToLoad'] = @( 'objectClass', 'objectSid', 'samAccountName', 'distinguishedName', 'name', 'grouptype', 'description', 'managedby', 'member', 'Department', 'Title', 'primaryGroupToken' ) $Params = ForEach ($ParamName in $SearchDirectoryParams.Keys) { $ParamValue = ConvertTo-PSCodeString -InputObject $SearchDirectoryParams[$ParamName] "-$ParamName $ParamValue" } Write-LogMsg @LogParams -Text "Search-Directory $($Params -join ' ')" try { $DirectoryEntry = Search-Directory @SearchDirectoryParams @LoggingParams } catch { $LogParams['Type'] = 'Warning' # PS 5.1 will not allow you to override the Splat by manually calling the param, so we must update the splat Write-LogMsg @LogParams -Text " # '$IdentityReference' could not be resolved against its directory: $($_.Exception.Message)" $LogParams['Type'] = $DebugOutputStream } } elseif ( $IdentityReference.Substring(0, $IdentityReference.LastIndexOf('-') + 1) -eq $CurrentDomain.SIDString ) { Write-LogMsg @LogParams -Text " # '$IdentityReference' is an unresolved SID from the current domain" # Get the distinguishedName and netBIOSName of the current domain. This also determines whether the domain is online. $DomainDN = $CurrentDomain.distinguishedName.Value $DomainFQDN = ConvertTo-Fqdn -DistinguishedName $DomainDN -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams $SearchDirectoryParams['DirectoryPath'] = "LDAP://$DomainFQDN/cn=partitions,cn=configuration,$DomainDn" $SearchDirectoryParams['Filter'] = "(&(objectcategory=crossref)(dnsroot=$DomainFQDN)(netbiosname=*))" $SearchDirectoryParams['PropertiesToLoad'] = 'netbiosname' $Params = ForEach ($ParamName in $SearchDirectoryParams.Keys) { $ParamValue = ConvertTo-PSCodeString -InputObject $SearchDirectoryParams[$ParamName] "-$ParamName $ParamValue" } Write-LogMsg @LogParams -Text "Search-Directory $($Params -join ' ')" $DomainCrossReference = Search-Directory @SearchDirectoryParams @LoggingParams if ($DomainCrossReference.Properties ) { Write-LogMsg @LogParams -Text " # The domain '$DomainFQDN' is online for '$IdentityReference'" [string]$DomainNetBIOS = $DomainCrossReference.Properties['netbiosname'] # TODO: The domain is online, so let's see if any domain trusts have issues? Determine if SID is foreign security principal? # TODO: What if the foreign security principal exists but the corresponding domain trust is down? Don't want to recommend deletion of the ACE in that case. } $SidObject = [System.Security.Principal.SecurityIdentifier]::new($IdentityReference) $SidBytes = [byte[]]::new($SidObject.BinaryLength) $null = $SidObject.GetBinaryForm($SidBytes, 0) $ObjectSid = ConvertTo-HexStringRepresentationForLDAPFilterString -SIDByteArray $SidBytes $SearchDirectoryParams['DirectoryPath'] = "LDAP://$DomainFQDN/$DomainDn" $SearchDirectoryParams['Filter'] = "(objectsid=$ObjectSid)" $SearchDirectoryParams['PropertiesToLoad'] = @( 'objectClass', 'objectSid', 'samAccountName', 'distinguishedName', 'name', 'grouptype', 'description', 'managedby', 'member', 'Department', 'Title', 'primaryGroupToken' ) $Params = ForEach ($ParamName in $SearchDirectoryParams.Keys) { $ParamValue = ConvertTo-PSCodeString -InputObject $SearchDirectoryParams[$ParamName] "-$ParamName $ParamValue" } Write-LogMsg @LogParams -Text "Search-Directory $($Params -join ' ')" try { $DirectoryEntry = Search-Directory @SearchDirectoryParams @LoggingParams } catch { $LogParams['Type'] = 'Warning' # PS 5.1 will not allow you to override the Splat by manually calling the param, so we must update the splat Write-LogMsg @LogParams -Text " # '$IdentityReference' could not be resolved against its directory. Error: $($_.Exception.Message.Trim())" $LogParams['Type'] = $DebugOutputStream } } else { Write-LogMsg @LogParams -Text " # '$IdentityReference' is a local security principal or unresolved SID" if ($null -eq $SamaccountnameOrSid) { $SamaccountnameOrSid = $IdentityReference } if ($SamaccountnameOrSid -like "S-1-*") { Write-LogMsg @LogParams -Text "$($IdentityReference) is an unresolved SID" # The SID of the domain is the SID of the user minus the last block of numbers $DomainSid = $SamaccountnameOrSid.Substring(0, $SamaccountnameOrSid.LastIndexOf("-")) # Determine if SID belongs to current domain if ($DomainSid -eq $CurrentDomain.SIDString) { Write-LogMsg @LogParams -Text "$($IdentityReference) belongs to the current domain. Could be a deleted user. ?possibly a foreign security principal corresponding to an offline trusted domain or deleted user in the trusted domain?" } else { Write-LogMsg @LogParams -Text "$($IdentityReference) does not belong to the current domain. Could be a local security principal or belong to an unresolvable domain." } # Lookup other information about the domain using its SID as the key $DomainObject = $DomainsBySID[$DomainSid] if ($DomainObject) { $GetDirectoryEntryParams['DirectoryPath'] = "WinNT://$($DomainObject.Dns)/Users,group" $DomainNetBIOS = $DomainObject.Netbios $DomainDN = $DomainObject.DistinguishedName } else { $GetDirectoryEntryParams['DirectoryPath'] = "WinNT://$DomainNetBIOS/Users,group" $DomainDn = ConvertTo-DistinguishedName -Domain $DomainNetBIOS -DomainsByNetbios $DomainsByNetbios @LoggingParams } $Params = ForEach ($ParamName in $GetDirectoryEntryParams.Keys) { $ParamValue = ConvertTo-PSCodeString -InputObject $GetDirectoryEntryParams[$ParamName] "-$ParamName $ParamValue" } Write-LogMsg @LogParams -Text "Get-DirectoryEntry $($Params -join ' ')" try { $UsersGroup = Get-DirectoryEntry @GetDirectoryEntryParams @LoggingParams } catch { $LogParams['Type'] = 'Warning' # PS 5.1 will not allow you to override the Splat by manually calling the param, so we must update the splat Write-LogMsg @LogParams -Text "Could not get '$($GetDirectoryEntryParams['DirectoryPath'])' using PSRemoting. Error: $_" $LogParams['Type'] = $DebugOutputStream } $MembersOfUsersGroup = Get-WinNTGroupMember -DirectoryEntry $UsersGroup -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams $DirectoryEntry = $MembersOfUsersGroup | Where-Object -FilterScript { ($SamaccountnameOrSid -eq [System.Security.Principal.SecurityIdentifier]::new([byte[]]$_.Properties['objectSid'].Value, 0)) } } else { Write-LogMsg @LogParams -Text " # '$IdentityReference' is a local security principal" $CimCacheResult = $CimCache[$DomainNetBIOS]['Win32_AccountsByCaption'][$IdentityReference] if ($CimCacheResult) { $DirectoryEntry = $CimCacheResult } else { Write-LogMsg @LogParams -Text " # Win32_AccountsByCaption CIM instance cache miss for '$IdentityReference' on '$DomainNetBIOS'" $DomainNetbiosCacheResult = $DomainsByNetbios[$DomainNetBIOS] if ($DomainNetbiosCacheResult) { $GetDirectoryEntryParams['DirectoryPath'] = "WinNT://$($DomainNetbiosCacheResult.Dns)/$SamaccountnameOrSid" } else { $GetDirectoryEntryParams['DirectoryPath'] = "WinNT://$DomainNetBIOS/$SamaccountnameOrSid" } $GetDirectoryEntryParams['PropertiesToLoad'] = @( 'members', 'objectClass', 'objectSid', 'samAccountName', 'distinguishedName', 'name', 'grouptype', 'description', 'managedby', 'member', 'Department', 'Title', 'primaryGroupToken' ) $Params = ForEach ($ParamName in $GetDirectoryEntryParams.Keys) { $ParamValue = ConvertTo-PSCodeString -InputObject $GetDirectoryEntryParams[$ParamName] "-$ParamName $ParamValue" } Write-LogMsg @LogParams -Text "Get-DirectoryEntry $($Params -join ' ')" try { $DirectoryEntry = Get-DirectoryEntry @GetDirectoryEntryParams @LoggingParams } catch { $LogParams['Type'] = 'Warning' # PS 5.1 will not allow you to override the Splat by manually calling the param, so we must update the splat Write-LogMsg @LogParams -Text " # '$($GetDirectoryEntryParams['DirectoryPath'])' could not be resolved for '$IdentityReference'. Error: $($_.Exception.Message.Trim())" $LogParams['Type'] = $DebugOutputStream } } } } $PropertiesToAdd = @{ DomainDn = $DomainDn DomainNetbios = $DomainNetBIOS } if ($null -ne $DirectoryEntry) { ForEach ($Prop in ($DirectoryEntry | Get-Member -View All -MemberType Property, NoteProperty).Name) { $null = ConvertTo-SimpleProperty -InputObject $DirectoryEntry -Property $Prop -PropertyDictionary $PropertiesToAdd } if ($DirectoryEntry.Name) { $AccountName = $DirectoryEntry.Name } else { if ($DirectoryEntry.Properties) { if ($DirectoryEntry.Properties['name'].Value) { $AccountName = $DirectoryEntry.Properties['name'].Value } else { $AccountName = $DirectoryEntry.Properties['name'] } } } $PropertiesToAdd['ResolvedAccountName'] = "$DomainNetBIOS\$AccountName" # WinNT objects have a SchemaClassName property which is a string # LDAP objects have an objectClass property which is an ordered list of strings, the last being the class name of the object instance # ToDo: LDAP objects may have SchemaClassName too. When/why? Should I just request it always in the list of properties? # ToDo: Actually I should create an AdsiObjectType property of my own or something...don't expose the dependency if (-not $DirectoryEntry.SchemaClassName) { $PropertiesToAdd['SchemaClassName'] = @($DirectoryEntry.Properties['objectClass'])[-1] #untested but should work, last value should be the correct one https://learn.microsoft.com/en-us/windows/win32/ad/retrieving-the-objectclass-property } if ($NoGroupMembers -eq $false) { if ( # WinNT DirectoryEntries do not contain an objectClass property # If this property exists it is an LDAP DirectoryEntry rather than WinNT $PropertiesToAdd.ContainsKey('objectClass') ) { # Retrieve the members of groups from the LDAP provider Write-LogMsg @LogParams -Text " # '$($DirectoryEntry.Path)' is an LDAP security principal for '$IdentityReference'" $Members = (Get-AdsiGroupMember -Group $DirectoryEntry -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams).FullMembers } else { Write-LogMsg @LogParams -Text " # '$($DirectoryEntry.Path)' is a WinNT security principal for '$IdentityReference'" if ( $DirectoryEntry.SchemaClassName -eq 'group') { Write-LogMsg @LogParams -Text " # '$($DirectoryEntry.Path)' is a WinNT group for '$IdentityReference'" $Members = Get-WinNTGroupMember -DirectoryEntry $DirectoryEntry -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams } } # (Get-AdsiGroupMember).FullMembers or Get-WinNTGroupMember could return an array with null members so we must verify that is not true if ($Members) { $GroupMembers = ForEach ($ThisMember in $Members) { if ($ThisMember.Domain) { # Include specific desired properties $OutputProperties = @{} } else { # Include specific desired properties $OutputProperties = @{ Domain = [pscustomobject]@{ Dns = $DomainNetBIOS Netbios = $DomainNetBIOS Sid = @($SamaccountnameOrSid -split '-')[-1] } } } # Get any existing properties for inclusion later $InputProperties = (Get-Member -InputObject $ThisMember -MemberType Property, CodeProperty, ScriptProperty, NoteProperty).Name # Include any existing properties found earlier ForEach ($ThisProperty in $InputProperties) { #$OutputProperties[$ThisProperty] = $ThisMember.$ThisProperty $null = ConvertTo-SimpleProperty -InputObject $ThisMember -Property $ThisProperty -PropertyDictionary $OutputProperties } if ($ThisMember.sAmAccountName) { $ResolvedAccountName = "$($OutputProperties['Domain'].Netbios)\$($ThisMember.sAmAccountName)" } else { $ResolvedAccountName = "$($OutputProperties['Domain'].Netbios)\$($ThisMember.Name)" } $OutputProperties['ResolvedAccountName'] = $ResolvedAccountName $PrincipalById[$ResolvedAccountName] = [PSCustomObject]$OutputProperties $ACEsByResolvedID[$ResolvedAccountName] = $AccessControlEntries $ResolvedAccountName } } } $PropertiesToAdd['Members'] = $GroupMembers Write-LogMsg @LogParams -Text " # '$($DirectoryEntry.Path)' has $(($Members | Measure-Object).Count) members for '$IdentityReference'" } else { $LogParams['Type'] = 'Warning' # PS 5.1 will not allow you to override the Splat by manually calling the param, so we must update the splat Write-LogMsg @LogParams -Text " # '$IdentityReference' could not be matched to a DirectoryEntry" $LogParams['Type'] = $DebugOutputStream } $PrincipalById[$IdentityReference] = [PSCustomObject]$PropertiesToAdd } } function ConvertFrom-PropertyValueCollectionToString { <# .SYNOPSIS Convert a PropertyValueCollection to a string .DESCRIPTION Useful when working with System.DirectoryServices and some other namespaces .INPUTS None. Pipeline input is not accepted. .OUTPUTS [System.String] .EXAMPLE $DirectoryEntry = [adsi]("WinNT://$(hostname)") $DirectoryEntry.Properties.Keys | ForEach-Object { ConvertFrom-PropertyValueCollectionToString -PropertyValueCollection $DirectoryEntry.Properties[$_] } For each property in a DirectoryEntry, convert its corresponding PropertyValueCollection to a string #> param ( [System.DirectoryServices.PropertyValueCollection]$PropertyValueCollection ) $SubType = & { $PropertyValueCollection.Value.GetType().FullName } 2>$null switch ($SubType) { 'System.Byte[]' { ConvertTo-DecStringRepresentation -ByteArray $PropertyValueCollection.Value } default { "$($PropertyValueCollection.Value)" } } } function ConvertFrom-ResultPropertyValueCollectionToString { <# .SYNOPSIS Convert a ResultPropertyValueCollection to a string .DESCRIPTION Useful when working with System.DirectoryServices and some other namespaces .INPUTS None. Pipeline input is not accepted. .OUTPUTS [System.String] .EXAMPLE $DirectoryEntry = [adsi]("WinNT://$(hostname)") $DirectoryEntry.Properties.Keys | ForEach-Object { ConvertFrom-PropertyValueCollectionToString -PropertyValueCollection $DirectoryEntry.Properties[$_] } For each property in a DirectoryEntry, convert its corresponding PropertyValueCollection to a string #> param ( [System.DirectoryServices.ResultPropertyValueCollection]$ResultPropertyValueCollection ) $SubType = & { $ResultPropertyValueCollection.Value.GetType().FullName } 2>$null switch ($SubType) { 'System.Byte[]' { ConvertTo-DecStringRepresentation -ByteArray $ResultPropertyValueCollection.Value } default { "$($ResultPropertyValueCollection.Value)" } } } function ConvertFrom-SearchResult { <# .SYNOPSIS Convert a SearchResult to a PSCustomObject .DESCRIPTION Recursively convert every property into a string, or a PSCustomObject (whose properties are all strings, or more PSCustomObjects) This obfuscates the troublesome ResultPropertyCollection and ResultPropertyValueCollection and Hashtable aspects of working with ADSI searches .NOTES # TODO: There is a faster way than Select-Object, just need to dig into the default formatting of SearchResult to see how to get those properties #> param ( [Parameter( Position = 0, ValueFromPipeline )] [System.DirectoryServices.SearchResult[]]$SearchResult ) process { ForEach ($ThisSearchResult in $SearchResult) { #$ObjectWithProperties = $ThisSearchResult | #Select-Object -Property * # #$ObjectNoteProperties = $ObjectWithProperties | #Get-Member -MemberType Property, CodeProperty, ScriptProperty, NoteProperty # #$ThisObject = @{} # ## Enumerate the keys of the ResultPropertyCollection #ForEach ($ThisProperty in $ThisSearchResult.Properties.Keys) { # $ThisObject = ConvertTo-SimpleProperty -InputObject $ThisSearchResult.Properties -Property $ThisProperty -PropertyDictionary $ThisObject #} # ## We will allow any existing properties to override members of the ResultPropertyCollection #ForEach ($ThisObjProperty in $ObjectNoteProperties) { # $ThisObject = ConvertTo-SimpleProperty -InputObject $ObjectWithProperties -Property $ThisObjProperty.Name -PropertyDictionary $ThisObject #} # #[PSCustomObject]$ThisObject $OutputObject = @{} # Enumerate the keys of the ResultPropertyCollection ForEach ($ThisProperty in $ThisSearchResult.Properties.Keys) { $null = ConvertTo-SimpleProperty -InputObject $ThisSearchResult.Properties -Property $ThisProperty -PropertyDictionary $ThisObject } # We will allow any existing properties to override members of the ResultPropertyCollection ForEach ($ThisProperty in ($ThisSearchResult | Get-Member -View All -MemberType Property, NoteProperty).Name) { $null = ConvertTo-SimpleProperty -InputObject $ThisSearchResult -Property $ThisProperty -PropertyDictionary $OutputObject } [PSCustomObject]$OutputObject } } } # This function is not currently in use by Export-Permission function ConvertFrom-SidString { #[OutputType([System.Security.Principal.NTAccount])] param ( [string]$SID, # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug', # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Dictionary to cache directory entries to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})) ) $GetDirectoryEntryParams = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios ThisFqdn = $ThisFqdn ThisHostname = $ThisHostname CimCache = $CimCache LogBuffer = $LogBuffer WhoAmI = $WhoAmI DebugOutputStream = $DebugOutputStream } #[System.Security.Principal.SecurityIdentifier]::new($SID) # Only works if SID is in the current domain...otherwise SID not found Get-DirectoryEntry -DirectoryPath "LDAP://<SID=$SID>" @GetDirectoryEntryParams } function ConvertTo-DecStringRepresentation { <# .SYNOPSIS Convert a byte array to a string representation of its decimal format .DESCRIPTION Uses the custom format operator -f to format each byte as a string decimal representation .INPUTS [System.Byte[]]$ByteArray .OUTPUTS [System.String] Array of strings representing the byte array's decimal values .EXAMPLE ConvertTo-DecStringRepresentation -ByteArray $Bytes Convert the binary SID $Bytes to a decimal string representation #> [OutputType([System.String])] param ( # Byte array. Often the binary format of an objectSid or LoginHours [byte[]]$ByteArray ) $ByteArray | ForEach-Object { '{0}' -f $_ } } function ConvertTo-DistinguishedName { <# .SYNOPSIS Convert a domain NetBIOS name to its distinguishedName .DESCRIPTION https://docs.microsoft.com/en-us/windows/win32/api/iads/nn-iads-iadsnametranslate .INPUTS [System.String]$Domain .OUTPUTS [System.String] distinguishedName of the domain .EXAMPLE ConvertTo-DistinguishedName -Domain 'CONTOSO' DC=ad,DC=contoso,DC=com Resolve the NetBIOS domain 'CONTOSO' to its distinguishedName 'DC=ad,DC=contoso,DC=com' #> [OutputType([System.String])] param ( # NetBIOS name of the domain [Parameter(Mandatory, ValueFromPipeline, ParameterSetName = 'NetBIOS')] [string[]]$Domain, [Parameter(ParameterSetName = 'NetBIOS')] [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), # FQDN of the domain [Parameter(Mandatory, ValueFromPipeline, ParameterSetName = 'FQDN')] [string[]]$DomainFQDN, # Type of initialization to be performed # Will be translated to the corresponding integer for use as the lnSetType parameter of the IADsNameTranslate::Init method (iads.h) # https://docs.microsoft.com/en-us/windows/win32/api/iads/ne-iads-ads_name_inittype_enum [string]$InitType = 'ADS_NAME_INITTYPE_GC', # Format of the name of the directory object that will be used for the input # Will be translated to the corresponding integer for use as the lnSetType parameter of the IADsNameTranslate::Set method (iads.h) # https://docs.microsoft.com/en-us/windows/win32/api/iads/ne-iads-ads_name_type_enum [string]$InputType = 'ADS_NAME_TYPE_NT4', # Format of the name of the directory object that will be used for the output # Will be translated to the corresponding integer for use as the lnSetType parameter of the IADsNameTranslate::Get method (iads.h) # https://docs.microsoft.com/en-us/windows/win32/api/iads/ne-iads-ads_name_type_enum [string]$OutputType = 'ADS_NAME_TYPE_1779', <# AdsiProvider (WinNT or LDAP) of the servers associated with the provided FQDNs or NetBIOS names This parameter can be used to reduce calls to Find-AdsiProvider Useful when that has been done already but the DomainsByFqdn and DomainsByNetbios caches have not been updated yet #> [string]$AdsiProvider, <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) begin { $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } # Declare constants for these Windows enums # We need to because PowerShell makes it hard to directly use the Win32 API and read the enum definition # Use hashtables instead of enums since this use case is so simple $ADS_NAME_INITTYPE_dict = @{ ADS_NAME_INITTYPE_DOMAIN = 1 #Initializes a NameTranslate object by setting the domain that the object binds to. ADS_NAME_INITTYPE_SERVER = 2 #Initializes a NameTranslate object by setting the server that the object binds to. ADS_NAME_INITTYPE_GC = 3 #Initializes a NameTranslate object by locating the global catalog that the object binds to. } $ADS_NAME_TYPE_dict = @{ ADS_NAME_TYPE_1779 = 1 #Name format as specified in RFC 1779. For example, "CN=Jeff Smith,CN=users,DC=Fabrikam,DC=com". ADS_NAME_TYPE_CANONICAL = 2 #Canonical name format. For example, "Fabrikam.com/Users/Jeff Smith". ADS_NAME_TYPE_NT4 = 3 #Account name format used in Windows. For example, "Fabrikam\JeffSmith". ADS_NAME_TYPE_DISPLAY = 4 #Display name format. For example, "Jeff Smith". ADS_NAME_TYPE_DOMAIN_SIMPLE = 5 #Simple domain name format. For example, "JeffSmith@Fabrikam.com". ADS_NAME_TYPE_ENTERPRISE_SIMPLE = 6 #Simple enterprise name format. For example, "JeffSmith@Fabrikam.com". ADS_NAME_TYPE_GUID = 7 #Global Unique Identifier format. For example, "{95ee9fff-3436-11d1-b2b0-d15ae3ac8436}". ADS_NAME_TYPE_UNKNOWN = 8 #Unknown name type. The system will estimate the format. This element is a meaningful option only with the IADsNameTranslate.Set or the IADsNameTranslate.SetEx method, but not with the IADsNameTranslate.Get or IADsNameTranslate.GetEx method. ADS_NAME_TYPE_USER_PRINCIPAL_NAME = 9 #User principal name format. For example, "JeffSmith@Fabrikam.com". ADS_NAME_TYPE_CANONICAL_EX = 10 #Extended canonical name format. For example, "Fabrikam.com/Users Jeff Smith". ADS_NAME_TYPE_SERVICE_PRINCIPAL_NAME = 11 #Service principal name format. For example, "www/www.fabrikam.com@fabrikam.com". ADS_NAME_TYPE_SID_OR_SID_HISTORY_NAME = 12 #A SID string, as defined in the Security Descriptor Definition Language (SDDL), for either the SID of the current object or one from the object SID history. For example, "O:AOG:DAD:(A;;RPWPCCDCLCSWRCWDWOGA;;;S-1-0-0)" } $ChosenInitType = $ADS_NAME_INITTYPE_dict[$InitType] $ChosenInputType = $ADS_NAME_TYPE_dict[$InputType] $ChosenOutputType = $ADS_NAME_TYPE_dict[$OutputType] } process { ForEach ($ThisDomain in $Domain) { $DomainCacheResult = $DomainsByNetbios[$ThisDomain] if ($DomainCacheResult) { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache hit for '$ThisDomain'" #ConvertTo-DistinguishedName -DomainFQDN $DomainCacheResult.Dns -AdsiProvider $DomainCacheResult.AdsiProvider $DomainCacheResult.DistinguishedName } else { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache miss for '$ThisDomain'. Available keys: $($DomainsByNetBios.Keys -join ',')" Write-LogMsg @LogParams -Text "`$IADsNameTranslateComObject = New-Object -comObject 'NameTranslate' # For '$ThisDomain'" $IADsNameTranslateComObject = New-Object -comObject "NameTranslate" Write-LogMsg @LogParams -Text "`$IADsNameTranslateInterface = `$IADsNameTranslateComObject.GetType() # For '$ThisDomain'" $IADsNameTranslateInterface = $IADsNameTranslateComObject.GetType() Write-LogMsg @LogParams -Text "`$null = `$IADsNameTranslateInterface.InvokeMember('Init', 'InvokeMethod', `$Null, `$IADsNameTranslateComObject, ($ChosenInitType, `$Null)) # For '$ThisDomain'" $null = $IADsNameTranslateInterface.InvokeMember("Init", "InvokeMethod", $Null, $IADsNameTranslateComObject, ($ChosenInitType, $Null)) # For a non-domain-joined system there is no DistinguishedName for the domain # Suppress errors when calling these next 2 methods # Exception calling "InvokeMember" with "5" argument(s): "Name translation: Could not find the name or insufficient right to see name. (Exception from HRESULT: 0x80072116)" Write-LogMsg @LogParams -Text "`$null = `$IADsNameTranslateInterface.InvokeMember('Set', 'InvokeMethod', `$Null, `$IADsNameTranslateComObject, ($ChosenInputType, '$ThisDomain\')) # For '$ThisDomain'" $null = { $IADsNameTranslateInterface.InvokeMember("Set", "InvokeMethod", $Null, $IADsNameTranslateComObject, ($ChosenInputType, "$ThisDomain\")) } 2>$null # Exception calling "InvokeMember" with "5" argument(s): "Unspecified error (Exception from HRESULT: 0x80004005 (E_FAIL))" Write-LogMsg @LogParams -Text "`$IADsNameTranslateInterface.InvokeMember('Get', 'InvokeMethod', `$Null, `$IADsNameTranslateComObject, $ChosenOutputType) # For '$ThisDomain'" $null = { $null = { $IADsNameTranslateInterface.InvokeMember("Get", "InvokeMethod", $Null, $IADsNameTranslateComObject, $ChosenOutputType) } 2>$null } 2>$null } } ForEach ($ThisDomain in $DomainFQDN) { $DomainCacheResult = $DomainsByFqdn[$ThisDomain] if ($DomainCacheResult) { Write-LogMsg @LogParams -Text " # Domain FQDN cache hit for '$ThisDomain'" $DomainCacheResult.DistinguishedName } else { Write-LogMsg @LogParams -Text " # Domain FQDN cache miss for '$ThisDomain'" if (-not $PSBoundParameters.ContainsKey('AdsiProvider')) { $AdsiProvider = Find-AdsiProvider -AdsiServer $ThisDomain @LoggingParams } if ($AdsiProvider -ne 'WinNT') { "dc=$($ThisDomain -replace '\.',',dc=')" } } } } } function ConvertTo-DomainNetBIOS { param ( [string]$DomainFQDN, [string]$AdsiProvider, # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Dictionary to cache directory entries to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $DomainCacheResult = $DomainsByFqdn[$DomainFQDN] if ($DomainCacheResult) { Write-LogMsg @LogParams -Text " # Domain FQDN cache hit for '$DomainFQDN'" return $DomainCacheResult.Netbios } Write-LogMsg @LogParams -Text " # Domain FQDN cache miss for '$DomainFQDN'" if ($AdsiProvider -eq 'LDAP') { $GetDirectoryEntryParams = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios DomainsBySid = $DomainsBySid ThisFqdn = $ThisFqdn ThisHostname = $ThisHostname CimCache = $CimCache LogBuffer = $LogBuffer WhoAmI = $WhoAmI DebugOutputStream = $DebugOutputStream } $RootDSE = Get-DirectoryEntry -DirectoryPath "LDAP://$DomainFQDN/rootDSE" @GetDirectoryEntryParams Write-LogMsg @LogParams -Text "`$RootDSE.InvokeGet('defaultNamingContext')" $DomainDistinguishedName = $RootDSE.InvokeGet("defaultNamingContext") Write-LogMsg @LogParams -Text "`$RootDSE.InvokeGet('configurationNamingContext')" $ConfigurationDN = $rootDSE.InvokeGet("configurationNamingContext") $partitions = Get-DirectoryEntry -DirectoryPath "LDAP://$DomainFQDN/cn=partitions,$ConfigurationDN" @GetDirectoryEntryParams ForEach ($Child In $Partitions.Children) { If ($Child.nCName -contains $DomainDistinguishedName) { return $Child.nETBIOSName } } } else { $LengthOfNetBIOSName = $DomainFQDN.IndexOf('.') if ($LengthOfNetBIOSName -eq -1) { $DomainFQDN } else { $DomainFQDN.Substring(0, $LengthOfNetBIOSName) } } } function ConvertTo-DomainSidString { param ( # Domain DNS name to convert to the domain's SID [Parameter(Mandatory)] [string]$DomainDnsName, <# Hashtable containing cached directory entries so they don't have to be retrieved from the directory again Uses a thread-safe hashtable by default #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# AdsiProvider (WinNT or LDAP) of the servers associated with the provided FQDNs or NetBIOS names This parameter can be used to reduce calls to Find-AdsiProvider Useful when that has been done already but the DomainsByFqdn and DomainsByNetbios caches have not been updated yet #> [string]$AdsiProvider, # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } $CacheResult = $DomainsByFqdn[$DomainDnsName] if ($CacheResult) { Write-LogMsg @LogParams -Text " # Domain FQDN cache hit for '$DomainDnsName'" return $CacheResult.Sid } Write-LogMsg @LogParams -Text " # Domain FQDN cache miss for '$DomainDnsName'" if ( -not $AdsiProvider -or $AdsiProvider -eq 'LDAP' ) { $GetDirectoryEntryParams = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios DomainsBySid = $DomainsBySid ThisFqdn = $ThisFqdn CimCache = $CimCache DebugOutputStream = $DebugOutputStream } $DomainDirectoryEntry = Get-DirectoryEntry -DirectoryPath "LDAP://$DomainDnsName" @GetDirectoryEntryParams @LoggingParams try { $null = $DomainDirectoryEntry.RefreshCache('objectSid') } catch { Write-LogMsg @LogParams -Text " # LDAP connection failed to '$DomainDnsName' - $($_.Exception.Message)" Write-LogMsg @LogParams -Text "Find-LocalAdsiServerSid -ComputerName '$DomainDnsName'" $DomainSid = Find-LocalAdsiServerSid -ComputerName $DomainDnsName -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams return $DomainSid } } else { Write-LogMsg @LogParams -Text "Find-LocalAdsiServerSid -ComputerName '$DomainDnsName'" $DomainSid = Find-LocalAdsiServerSid -ComputerName $DomainDnsName -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams return $DomainSid } $DomainSid = $null if ($DomainDirectoryEntry.Properties) { $objectSIDProperty = $DomainDirectoryEntry.Properties['objectSid'] if ($objectSIDProperty.Value) { $SidByteArray = [byte[]]$objectSIDProperty.Value } else { $SidByteArray = [byte[]]$objectSIDProperty } } else { $SidByteArray = [byte[]]$DomainDirectoryEntry.objectSid } Write-LogMsg @LogParams -Text "[System.Security.Principal.SecurityIdentifier]::new([byte[]]@($($SidByteArray -join ',')), 0).ToString()" $DomainSid = [System.Security.Principal.SecurityIdentifier]::new($SidByteArray, 0).ToString() if ($DomainSid) { return $DomainSid } else { $LogParams['Type'] = 'Warning' # PS 5.1 will not allow you to override the Splat by manually calling the param, so we must update the splat Write-LogMsg @LogParams -Text " # LDAP Domain: '$DomainDnsName' has an invalid SID - $($_.Exception.Message)" $LogParams['Type'] = $DebugOutputStream } } function ConvertTo-Fqdn { <# .SYNOPSIS Convert a domain distinguishedName name or NetBIOS name to its FQDN .DESCRIPTION For the DistinguishedName parameter, uses PowerShell's -replace operator to perform the conversion For the NetBIOS parameter, uses ConvertTo-DistinguishedName to convert from NetBIOS to distinguishedName, then recursively calls this function to get the FQDN .INPUTS [System.String]$DistinguishedName .OUTPUTS [System.String] FQDN version of the distinguishedName .EXAMPLE ConvertTo-Fqdn -DistinguishedName 'DC=ad,DC=contoso,DC=com' ad.contoso.com Convert the domain distinguishedName 'DC=ad,DC=contoso,DC=com' to its FQDN format 'ad.contoso.com' #> [OutputType([System.String])] param ( # distinguishedName of the domain [Parameter( ParameterSetName = 'DistinguishedName', ValueFromPipeline )] [string[]]$DistinguishedName, # NetBIOS name of the domain [Parameter( ParameterSetName = 'NetBIOS', ValueFromPipeline )] [string[]]$NetBIOS, <# Dictionary to cache directory entries to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) begin { $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } } process { ForEach ($DN in $DistinguishedName) { $DN -replace ',DC=', '.' -replace 'DC=', '' } ForEach ($ThisNetBios in $NetBIOS) { $DomainObject = $DomainsByNetbios[$DomainNetBIOS] if ( -not $DomainObject -and -not [string]::IsNullOrEmpty($DomainNetBIOS) ) { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache miss for '$DomainNetBIOS'" $DomainObject = Get-AdsiServer -Netbios $DomainNetBIOS -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams $DomainsByNetbios[$DomainNetBIOS] = $DomainObject } $DomainObject.Dns } } } function ConvertTo-HexStringRepresentation { <# .SYNOPSIS Convert a SID from byte array format to a string representation of its hexadecimal format .DESCRIPTION Uses the custom format operator -f to format each byte as a string hex representation .INPUTS [System.Byte[]]$SIDByteArray .OUTPUTS [System.String] SID as an array of strings representing the byte array's hexadecimal values .EXAMPLE ConvertTo-HexStringRepresentation -SIDByteArray $Bytes Convert the binary SID $Bytes to a hexadecimal string representation #> [OutputType([System.String[]])] param ( # SID [byte[]]$SIDByteArray ) $SIDHexString = $SIDByteArray | ForEach-Object { '{0:X}' -f $_ } return $SIDHexString } function ConvertTo-HexStringRepresentationForLDAPFilterString { <# .SYNOPSIS Convert a SID from byte array format to a string representation of its hexadecimal format, properly formatted for an LDAP filter string .DESCRIPTION Uses the custom format operator -f to format each byte as a string hex representation .INPUTS [System.Byte[]]$SIDByteArray .OUTPUTS [System.String] SID as an array of strings representing the byte array's hexadecimal values .EXAMPLE ConvertTo-HexStringRepresentationForLDAPFilterString -SIDByteArray $Bytes Convert the binary SID $Bytes to a hexadecimal string representation, formatted for use in an LDAP filter string #> [OutputType([System.String])] param ( # SID to convert to a hex string [byte[]]$SIDByteArray ) $Hexes = $SIDByteArray | ForEach-Object { '{0:X}' -f $_ } | ForEach-Object { if ($_.Length -eq 2) { $_ } else { "0$_" } } "\$($Hexes -join '\')" } function ConvertTo-SidByteArray { <# .SYNOPSIS Convert a SID from a string to binary format (byte array) .DESCRIPTION Uses the GetBinaryForm method of the [System.Security.Principal.SecurityIdentifier] class .INPUTS [System.String]$SidString .OUTPUTS [System.Byte] SID a a byte array .EXAMPLE ConvertTo-SidByteArray -SidString $SID Convert the SID string to a byte array #> [OutputType([System.Byte[]])] param ( # SID to convert to binary [Parameter(ValueFromPipeline)] [string[]]$SidString ) process { ForEach ($ThisSID in $SidString) { $SID = [System.Security.Principal.SecurityIdentifier]::new($ThisSID) [byte[]]$Bytes = [byte[]]::new($SID.BinaryLength) $SID.GetBinaryForm($Bytes, 0) $Bytes } } } function Expand-AdsiGroupMember { <# .SYNOPSIS Use the LDAP provider to add information about group members to a DirectoryEntry of a group for easier access .DESCRIPTION Recursively retrieves group members and detailed information about them Specifically gets the SID, and resolves foreign security principals to their DirectoryEntry from the trusted domain .INPUTS [System.DirectoryServices.DirectoryEntry]$DirectoryEntry .OUTPUTS [System.DirectoryServices.DirectoryEntry] Returned with member info added now (if the DirectoryEntry is a group). .EXAMPLE [System.DirectoryServices.DirectoryEntry]::new('WinNT://localhost/Administrators') | Get-AdsiGroupMember | Expand-AdsiGroupMember Need to fix example and add notes #> [OutputType([System.DirectoryServices.DirectoryEntry])] param ( # Expecting a DirectoryEntry from the LDAP or WinNT providers, or a PSObject imitation from Get-DirectoryEntry [parameter(ValueFromPipeline)] $DirectoryEntry, # Properties of the group members to retrieve [string[]]$PropertiesToLoad = (@('Department', 'description', 'distinguishedName', 'grouptype', 'managedby', 'member', 'name', 'objectClass', 'objectSid', 'operatingSystem', 'primaryGroupToken', 'samAccountName', 'Title')), <# Hashtable containing cached directory entries so they don't need to be retrieved from the directory again Uses a thread-safe hashtable by default #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid, # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) begin { $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } # The DomainsBySID cache must be populated with trusted domains in order to translate foreign security principals if ( $DomainsBySid.Keys.Count -lt 1 ) { Write-LogMsg @LogParams -Text "# No valid DomainsBySid cache found" $DomainsBySid = ([hashtable]::Synchronized(@{})) $GetAdsiServerParams = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios DomainsBySid = $DomainsBySid DomainsByFqdn = $DomainsByFqdn ThisFqdn = $ThisFqdn CimCache = $CimCache } Get-TrustedDomain | ForEach-Object { Write-LogMsg @LogParams -Text "Get-AdsiServer -Fqdn $($_.DomainFqdn)" $null = Get-AdsiServer -Fqdn $_.DomainFqdn @GetAdsiServerParams @LoggingParams } } else { Write-LogMsg @LogParams -Text "# Valid DomainsBySid cache found" } $CacheParams = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios DomainsBySid = $DomainsBySid } $i = 0 } process { ForEach ($Entry in $DirectoryEntry) { $i++ #$status = ("$(Get-Date -Format s)`t$ThisHostname`tExpand-AdsiGroupMember`tStatus: Using ADSI to get info on group member $i`: " + $Entry.Name) #Write-LogMsg @LogParams -Text "$status" $Principal = $null if ($Entry.objectClass -contains 'foreignSecurityPrincipal') { if ($Entry.distinguishedName.Value -match '(?>^CN=)(?<SID>[^,]*)') { [string]$SID = $Matches.SID #The SID of the domain is the SID of the user minus the last block of numbers $DomainSid = $SID.Substring(0, $Sid.LastIndexOf("-")) $Domain = $DomainsBySid[$DomainSid] $GetDirectoryEntryParams = @{ ThisFqdn = $ThisFqdn CimCache = $CimCache DebugOutputStream = $DebugOutputStream } $Principal = Get-DirectoryEntry -DirectoryPath "LDAP://$($Domain.Dns)/<SID=$SID>" @GetDirectoryEntryParams @CacheParams @LoggingParams try { $null = $Principal.RefreshCache($PropertiesToLoad) } catch { #$Success = $false $Principal = $Entry Write-LogMsg @LogParams -Text " # SID '$SID' could not be retrieved from domain '$Domain'" } # Recursively enumerate group members if ($Principal.properties['objectClass'].Value -contains 'group') { Write-LogMsg @LogParams -Text "'$($Principal.properties['name'])' is a group in '$Domain'" $AdsiGroupWithMembers = Get-AdsiGroupMember -Group $Principal -CimCache $CimCache -DomainsByFqdn $DomainsByFqdn -ThisFqdn $ThisFqdn @CacheParams @LoggingParams $Principal = Expand-AdsiGroupMember -DirectoryEntry $AdsiGroupWithMembers.FullMembers -CimCache $CimCache -DomainsByFqdn $DomainsByFqdn -ThisFqdn $ThisFqdn -ThisHostName $ThisHostName @CacheParams } } } else { $Principal = $Entry } Add-SidInfo -InputObject $Principal -DomainsBySid $DomainsBySid @LoggingParams } } } function Expand-WinNTGroupMember { <# .SYNOPSIS Use the LDAP provider to add information about group members to a DirectoryEntry of a group for easier access .DESCRIPTION Recursively retrieves group members and detailed information about them .INPUTS [System.DirectoryServices.DirectoryEntry]$DirectoryEntry .OUTPUTS [System.DirectoryServices.DirectoryEntry] Returned with member info added now (if the DirectoryEntry is a group). .EXAMPLE [System.DirectoryServices.DirectoryEntry]::new('WinNT://localhost/Administrators') | Get-WinNTGroupMember | Expand-WinNTGroupMember Need to fix example and add notes #> [OutputType([System.DirectoryServices.DirectoryEntry])] param ( # Expecting a DirectoryEntry from the WinNT provider, or a PSObject imitation from Get-DirectoryEntry [Parameter(ValueFromPipeline)] $DirectoryEntry, # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Dictionary to cache directory entries to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) begin { $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } } process { ForEach ($ThisEntry in $DirectoryEntry) { if (!($ThisEntry.Properties)) { $LogParams['Type'] = 'Warning' # PS 5.1 will not allow you to override the Splat by manually calling the param, so we must update the splat Write-LogMsg @LogParams -Text "'$ThisEntry' has no properties" $LogParams['Type'] = $DebugOutputStream } elseif ($ThisEntry.Properties['objectClass'] -contains 'group') { Write-LogMsg @LogParams -Text "'$($ThisEntry.Path)' is an ADSI group" $AdsiGroup = Get-AdsiGroup -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DirectoryPath $ThisEntry.Path -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams Add-SidInfo -InputObject $AdsiGroup.FullMembers -DomainsBySid $DomainsBySid @LoggingParams } else { if ($ThisEntry.SchemaClassName -eq 'group') { Write-LogMsg @LogParams -Text "'$($ThisEntry.Path)' is a WinNT group" if ($ThisEntry.GetType().FullName -eq 'System.Collections.Hashtable') { Write-LogMsg @LogParams -Text "$($ThisEntry.Path)' is a special group with no direct memberships" Add-SidInfo -InputObject $ThisEntry -DomainsBySid $DomainsBySid @LoggingParams } else { Get-WinNTGroupMember -DirectoryEntry $ThisEntry -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams } } else { Write-LogMsg @LogParams -Text "$($ThisEntry.Path)' is a user account" Add-SidInfo -InputObject $ThisEntry -DomainsBySid $DomainsBySid @LoggingParams } } } } } function Find-AdsiProvider { <# .SYNOPSIS Determine whether a directory server is an LDAP or a WinNT server .DESCRIPTION Uses the ADSI provider to attempt to query the server using LDAP first, then WinNT second .INPUTS [System.String] AdsiServer parameter. .OUTPUTS [System.String] Possible return values are: None LDAP WinNT .EXAMPLE Find-AdsiProvider -AdsiServer localhost Find the ADSI provider of the local computer .EXAMPLE Find-AdsiProvider -AdsiServer 'ad.contoso.com' Find the ADSI provider of the AD domain 'ad.contoso.com' #> [OutputType([System.String])] param ( # IP address or hostname of the directory server whose ADSI provider type to determine [string]$AdsiServer, <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) $Log = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $AdsiProvider = $null $CommandParameters = @{ ComputerName = $AdsiServer Namespace = 'ROOT/StandardCimv2' Query = 'Select * From MSFT_NetTCPConnection Where LocalPort = 389' KeyProperty = 'LocalPort' CimCache = $CimCache DebugOutputStream = $DebugOutputStream ErrorAction = 'Ignore' LogBuffer = $LogBuffer ThisFqdn = $ThisFqdn ThisHostname = $ThisHostname WhoAmI = $WhoAmI } Write-LogMsg @Log -Text 'Get-CachedCimInstance' -Expand $CommandParameters if (Get-CachedCimInstance @CommandParameters) { #$AdsiPath = "LDAP://$AdsiServer" #Write-LogMsg @LogParams -Text "[System.DirectoryServices.DirectoryEntry]::Exists('$AdsiPath')" #try { # $null = [System.DirectoryServices.DirectoryEntry]::Exists($AdsiPath) $AdsiProvider = 'LDAP' #} catch { Write-LogMsg @LogParams -Text " # $AdsiServer did not respond to LDAP" } } if (!$AdsiProvider) { #$AdsiPath = "WinNT://$AdsiServer" #Write-LogMsg @LogParams -Text "[System.DirectoryServices.DirectoryEntry]::Exists('$AdsiPath')" #try { # $null = [System.DirectoryServices.DirectoryEntry]::Exists($AdsiPath) $AdsiProvider = 'WinNT' #} catch { # Write-LogMsg @LogParams -Text " # $AdsiServer did not respond to WinNT" #} } #if (!$AdsiProvider) { # $AdsiPath = "LDAP://$AdsiServer" # Write-LogMsg @LogParams -Text "[System.DirectoryServices.DirectoryEntry]::Exists('$AdsiPath')" # try { # $null = [System.DirectoryServices.DirectoryEntry]::Exists($AdsiPath) # $AdsiProvider = 'LDAP' # } catch { Write-LogMsg @LogParams -Text " # $AdsiServer did not respond to LDAP" } #} #if (!$AdsiProvider) { # $AdsiProvider = 'none' #} return $AdsiProvider } function Find-LocalAdsiServerSid { param ( # Name of the computer to query via CIM [string]$ComputerName, # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $CimParams = @{ CimCache = $CimCache ComputerName = $ThisHostName DebugOutputStream = $DebugOutputStream LogBuffer = $LogBuffer ThisFqdn = $ThisFqdn ThisHostname = $ThisHostname WhoAmI = $WhoAmI } Write-LogMsg @LogParams -Text "Get-CachedCimInstance -ComputerName '$ComputerName' -Query `"SELECT SID FROM Win32_UserAccount WHERE LocalAccount = 'True' AND SID LIKE 'S-1-5-21-%-500'`"" $LocalAdminAccount = Get-CachedCimInstance -Query "SELECT SID FROM Win32_UserAccount WHERE LocalAccount = 'True' AND SID LIKE 'S-1-5-21-%-500'" -KeyProperty SID @CimParams if (-not $LocalAdminAccount) { return } return $LocalAdminAccount.SID.Substring(0, $LocalAdminAccount.SID.LastIndexOf("-")) } function Get-AdsiGroup { <# .SYNOPSIS Get the directory entries for a group and its members using ADSI .DESCRIPTION Uses the ADSI components to search a directory for a group, then get its members Both the WinNT and LDAP providers are supported .INPUTS None. Pipeline input is not accepted. .OUTPUTS [System.DirectoryServices.DirectoryEntry] for each group memeber .EXAMPLE Get-AdsiGroup -DirectoryPath 'WinNT://WORKGROUP/localhost' -GroupName Administrators Get members of the local Administrators group .EXAMPLE Get-AdsiGroup -GroupName Administrators On a domain-joined computer, this will get members of the domain's Administrators group On a workgroup computer, this will get members of the local Administrators group #> [OutputType([System.DirectoryServices.DirectoryEntry])] param ( <# Path to the directory object to retrieve Defaults to the root of the current domain #> [string]$DirectoryPath = (([System.DirectoryServices.DirectorySearcher]::new()).SearchRoot.Path), # Name (CN or Common Name) of the group to retrieve [string]$GroupName, # Properties of the group members to retrieve [string[]]$PropertiesToLoad = (@('Department', 'description', 'distinguishedName', 'grouptype', 'managedby', 'member', 'name', 'objectClass', 'objectSid', 'operatingSystem', 'primaryGroupToken', 'samAccountName', 'Title')), # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Dictionary to cache directory entries to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})) ) $GroupParams = @{ DirectoryPath = $DirectoryPath PropertiesToLoad = $PropertiesToLoad DirectoryEntryCache = $DirectoryEntryCache DomainsByFqdn = $DomainsByFqdn DomainsByNetbios = $DomainsByNetbios DomainsBySid = $DomainsBySid ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI ThisFqdn = $ThisFqdn CimCache = $CimCache DebugOutputStream = $DebugOutputStream } $GroupMemberParams = @{ PropertiesToLoad = $PropertiesToLoad DirectoryEntryCache = $DirectoryEntryCache DomainsByFqdn = $DomainsByFqdn DomainsByNetbios = $DomainsByNetbios DomainsBySid = $DomainsBySid ThisHostName = $ThisHostName ThisFqdn = $ThisFqdn LogBuffer = $LogBuffer CimCache = $CimCache WhoAmI = $WhoAmI } switch -Regex ($DirectoryPath) { '^WinNT' { $GroupParams['DirectoryPath'] = "$DirectoryPath/$GroupName" $GroupMemberParams['DirectoryEntry'] = Get-DirectoryEntry @GroupParams $FullMembers = Get-WinNTGroupMember @GroupMemberParams } '^$' { # This is expected for a workgroup computer $GroupParams['DirectoryPath'] = "WinNT://localhost/$GroupName" $GroupMemberParams['DirectoryEntry'] = Get-DirectoryEntry @GroupParams $FullMembers = Get-WinNTGroupMember @GroupMemberParams } default { if ($GroupName) { $GroupParams['Filter'] = "(&(objectClass=group)(cn=$GroupName))" } else { $GroupParams['Filter'] = '(objectClass=group)' } $GroupMemberParams['Group'] = Search-Directory @GroupParams $FullMembers = Get-AdsiGroupMember @GroupMemberParams } } $FullMembers } function Get-AdsiGroupMember { <# .SYNOPSIS Get members of a group from the LDAP provider .DESCRIPTION Use ADSI to get members of a group from the LDAP provider Return the group's DirectoryEntry plus a FullMembers property containing the member DirectoryEntries .INPUTS [System.DirectoryServices.DirectoryEntry]$DirectoryEntry .OUTPUTS [System.DirectoryServices.DirectoryEntry] plus a FullMembers property .EXAMPLE [System.DirectoryServices.DirectoryEntry]::new('LDAP://ad.contoso.com/CN=Administrators,CN=BuiltIn,DC=ad,DC=contoso,DC=com') | Get-AdsiGroupMember Get members of the domain Administrators group #> [OutputType([System.DirectoryServices.DirectoryEntry])] param ( # Directory entry of the LDAP group whose members to get [Parameter(ValueFromPipeline)] $Group, # Properties of the group members to find in the directory [string[]]$PropertiesToLoad, <# Hashtable containing cached directory entries so they don't have to be retrieved from the directory again Uses a thread-safe hashtable by default #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Perform a non-recursive search of the memberOf attribute Otherwise the search will be recursive by default #> [switch]$NoRecurse, <# Search the primaryGroupId attribute only Ignore the memberOf attribute #> [switch]$PrimaryGroupOnly, # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) begin { $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } $PathRegEx = '(?<Path>LDAP:\/\/[^\/]*)' $DomainRegEx = '(?i)DC=\w{1,}?\b' $PropertiesToLoad += 'primaryGroupToken', 'objectSid', 'objectClass' $PropertiesToLoad = $PropertiesToLoad | Sort-Object -Unique $SearchParameters = @{ PropertiesToLoad = $PropertiesToLoad DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios CimCache = $CimCache ThisFqdn = $ThisFqdn } $CacheParams = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios DomainsBySid = $DomainsBySid } } process { foreach ($ThisGroup in $Group) { if (-not $ThisGroup.Properties['primaryGroupToken']) { $ThisGroup.RefreshCache('primaryGroupToken') } # The memberOf attribute does not reflect a user's Primary Group membership so the primaryGroupId attribute must be searched $primaryGroupIdFilter = "(primaryGroupId=$($ThisGroup.Properties['primaryGroupToken']))" if ($PrimaryGroupOnly) { $SearchParameters['Filter'] = $primaryGroupIdFilter } else { if ($NoRecurse) { # Non-recursive search of the memberOf attribute $MemberOfFilter = "(memberOf=$($ThisGroup.Properties['distinguishedname']))" } else { # Recursive search of the memberOf attribute $MemberOfFilter = "(memberOf:1.2.840.113556.1.4.1941:=$($ThisGroup.Properties['distinguishedname']))" } $SearchParameters['Filter'] = "(|$MemberOfFilter$primaryGroupIdFilter)" } if ($ThisGroup.Path -match $PathRegEx) { $SearchParameters['DirectoryPath'] = Add-DomainFqdnToLdapPath -DirectoryPath $Matches.Path -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams if ($ThisGroup.Path -match $DomainRegEx) { $Domain = ([regex]::Matches($ThisGroup.Path, $DomainRegEx) | ForEach-Object { $_.Value }) -join ',' $SearchParameters['DirectoryPath'] = Add-DomainFqdnToLdapPath -DirectoryPath "LDAP://$Domain" -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams } else { $SearchParameters['DirectoryPath'] = Add-DomainFqdnToLdapPath -DirectoryPath $ThisGroup.Path -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams } } else { $SearchParameters['DirectoryPath'] = Add-DomainFqdnToLdapPath -DirectoryPath $ThisGroup.Path -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams } Write-LogMsg @LogParams -Text "Search-Directory -DirectoryPath '$($SearchParameters['DirectoryPath'])' -Filter '$($SearchParameters['Filter'])'" $GroupMemberSearch = Search-Directory @SearchParameters Write-LogMsg @LogParams -Text " # '$($GroupMemberSearch.Count)' results for Search-Directory -DirectoryPath '$($SearchParameters['DirectoryPath'])' -Filter '$($SearchParameters['Filter'])'" if ($GroupMemberSearch.Count -gt 0) { $DirectoryEntryParams = @{ PropertiesToLoad = $PropertiesToLoad DomainsByFqdn = $DomainsByFqdn ThisFqdn = $ThisFqdn CimCache = $CimCache DebugOutputStream = $DebugOutputStream } $CurrentADGroupMembers = [System.Collections.Generic.List[System.DirectoryServices.DirectoryEntry]]::new() $MembersThatAreGroups = $GroupMemberSearch | Where-Object -FilterScript { $_.Properties['objectClass'] -contains 'group' } $DirectoryEntryParams = @{ PropertiesToLoad = $PropertiesToLoad DomainsByFqdn = $DomainsByFqdn ThisFqdn = $ThisFqdn CimCache = $CimCache DebugOutputStream = $DebugOutputStream } if ($MembersThatAreGroups.Count -gt 0) { $FilterBuilder = [System.Text.StringBuilder]::new("(|") ForEach ($ThisMember in $MembersThatAreGroups) { $null = $FilterBuilder.Append("(primaryGroupId=$($ThisMember.Properties['primaryGroupToken'])))") } $null = $FilterBuilder.Append(")") $PrimaryGroupFilter = $FilterBuilder.ToString() $SearchParameters['Filter'] = $PrimaryGroupFilter Write-LogMsg @LogParams -Text "Search-Directory -DirectoryPath '$($SearchParameters['DirectoryPath'])' -Filter '$($SearchParameters['Filter'])'" $PrimaryGroupMembers = Search-Directory @SearchParameters ForEach ($ThisMember in $PrimaryGroupMembers) { $FQDNPath = Add-DomainFqdnToLdapPath -DirectoryPath $ThisMember.Path -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams $DirectoryEntry = $null Write-LogMsg @LogParams -Text "Get-DirectoryEntry -DirectoryPath '$FQDNPath'" $DirectoryEntry = Get-DirectoryEntry -DirectoryPath $FQDNPath @DirectoryEntryParams @CacheParams @LoggingParams if ($DirectoryEntry) { $null = $CurrentADGroupMembers.Add($DirectoryEntry) } } } ForEach ($ThisMember in $GroupMemberSearch) { $FQDNPath = Add-DomainFqdnToLdapPath -DirectoryPath $ThisMember.Path -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams $DirectoryEntry = $null Write-LogMsg @LogParams -Text "Get-DirectoryEntry -DirectoryPath '$FQDNPath'" $DirectoryEntry = Get-DirectoryEntry -DirectoryPath $FQDNPath @DirectoryEntryParams @CacheParams @LoggingParams if ($DirectoryEntry) { $null = $CurrentADGroupMembers.Add($DirectoryEntry) } } } else { $CurrentADGroupMembers = $null } Write-LogMsg @LogParams -Text "$($ThisGroup.Properties.name) has $(($CurrentADGroupMembers | Measure-Object).Count) members" $ProcessedGroupMembers = Expand-AdsiGroupMember -DirectoryEntry $CurrentADGroupMembers -CimCache $CimCache -DomainsByFqdn $DomainsByFqdn -ThisFqdn $ThisFqdn @CacheParams @LoggingParams Add-Member -InputObject $ThisGroup -MemberType NoteProperty -Name FullMembers -Value $ProcessedGroupMembers -Force -PassThru } } } function Get-AdsiServer { <# .SYNOPSIS Get information about a directory server including the ADSI provider it hosts and its well-known SIDs .DESCRIPTION Uses the ADSI provider to query the server using LDAP first, then WinNT upon failure Uses WinRM to query the CIM class Win32_SystemAccount for well-known SIDs .INPUTS [System.String]$Fqdn .OUTPUTS [PSCustomObject] with AdsiProvider and WellKnownSIDs properties .EXAMPLE Get-AdsiServer -Fqdn localhost Find the ADSI provider of the local computer .EXAMPLE Get-AdsiServer -Fqdn 'ad.contoso.com' Find the ADSI provider of the AD domain 'ad.contoso.com' #> [OutputType([System.String])] param ( # IP address or hostname of the directory server whose ADSI provider type to determine [Parameter(ValueFromPipeline)] [string[]]$Fqdn, # NetBIOS name of the ADSI server whose information to determine [string[]]$Netbios, # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Dictionary to cache directory entries to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName,AdsiProvider,Win32Accounts properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug', [switch]$RemoveCimSession ) begin { $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } $CacheParams = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByFqdn = $DomainsByFqdn DomainsByNetbios = $DomainsByNetbios DomainsBySid = $DomainsBySid } $CimParams = @{ CimCache = $CimCache DebugOutputStream = $DebugOutputStream ThisFqdn = $ThisFqdn } } process { ForEach ($DomainFqdn in $Fqdn) { $OutputObject = $DomainsByFqdn[$DomainFqdn] if ($OutputObject) { Write-LogMsg @LogParams -Text " # Domain FQDN cache hit for '$DomainFqdn'" $OutputObject continue } Write-LogMsg @LogParams -Text "Find-AdsiProvider -AdsiServer '$DomainFqdn' # Domain FQDN cache miss for '$DomainFqdn'" $AdsiProvider = Find-AdsiProvider -AdsiServer $DomainFqdn -CimCache $CimCache -ThisFqdn $ThisFqdn @LoggingParams $CacheParams['AdsiProvider'] = $AdsiProvider Write-LogMsg @LogParams -Text "ConvertTo-DistinguishedName -DomainFQDN '$DomainFqdn' -AdsiProvider '$AdsiProvider'" $DomainDn = ConvertTo-DistinguishedName -DomainFQDN $DomainFqdn -AdsiProvider $AdsiProvider @LoggingParams Write-LogMsg @LogParams -Text "ConvertTo-DomainSidString -DomainDnsName '$DomainFqdn' -ThisFqdn '$ThisFqdn'" $DomainSid = ConvertTo-DomainSidString -DomainDnsName $DomainFqdn -ThisFqdn $ThisFqdn -CimCache $CimCache @CacheParams @LoggingParams Write-LogMsg @LogParams -Text "ConvertTo-DomainNetBIOS -DomainFQDN '$DomainFqdn'" $DomainNetBIOS = ConvertTo-DomainNetBIOS -DomainFQDN $DomainFqdn -ThisFqdn $ThisFqdn -CimCache $CimCache @CacheParams @LoggingParams <# PS C:\Users\Owner> wmic SYSACCOUNT get name,sid Name SID Everyone S-1-1-0 LOCAL S-1-2-0 CREATOR OWNER S-1-3-0 CREATOR GROUP S-1-3-1 CREATOR OWNER SERVER S-1-3-2 CREATOR GROUP SERVER S-1-3-3 OWNER RIGHTS S-1-3-4 DIALUP S-1-5-1 NETWORK S-1-5-2 BATCH S-1-5-3 INTERACTIVE S-1-5-4 SERVICE S-1-5-6 ANONYMOUS LOGON S-1-5-7 PROXY S-1-5-8 SYSTEM S-1-5-18 ENTERPRISE DOMAIN CONTROLLERS S-1-5-9 SELF S-1-5-10 Authenticated Users S-1-5-11 RESTRICTED S-1-5-12 TERMINAL SERVER USER S-1-5-13 REMOTE INTERACTIVE LOGON S-1-5-14 IUSR S-1-5-17 LOCAL SERVICE S-1-5-19 NETWORK SERVICE S-1-5-20 BUILTIN S-1-5-32 PS C:\Users\Owner> ForEach ($SidType in [System.Security.Principal.WellKnownSidType].GetEnumNames()) {$var = [System.Security.Principal.WellKnownSidType]::$SidType; [System.Security.Principal.SecurityIdentifier]::new($var,$LogonDomainSid) |Add-Member -PassThru -NotePropertyMembers @{'WellKnownSidType' = $SidType}} # PS 5.1 returns fewer results than PS 7.4 WellKnownSidType BinaryLength AccountDomainSid Value ---------------- ------------ ---------------- ----- NullSid 12 S-1-0-0 WorldSid 12 S-1-1-0 LocalSid 12 S-1-2-0 CreatorOwnerSid 12 S-1-3-0 CreatorGroupSid 12 S-1-3-1 CreatorOwnerServerSid 12 S-1-3-2 CreatorGroupServerSid 12 S-1-3-3 NTAuthoritySid 8 S-1-5 DialupSid 12 S-1-5-1 NetworkSid 12 S-1-5-2 BatchSid 12 S-1-5-3 InteractiveSid 12 S-1-5-4 ServiceSid 12 S-1-5-6 AnonymousSid 12 S-1-5-7 ProxySid 12 S-1-5-8 EnterpriseControllersSid 12 S-1-5-9 SelfSid 12 S-1-5-10 AuthenticatedUserSid 12 S-1-5-11 RestrictedCodeSid 12 S-1-5-12 TerminalServerSid 12 S-1-5-13 RemoteLogonIdSid 12 S-1-5-14 Exception calling ".ctor" with "2" argument(s): "Well-known SIDs of type LogonIdsSid cannot be created. Parameter name: sidType" At line:1 char:147 + ... ::$SidType; [System.Security.Principal.SecurityIdentifier]::new($var, ... + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : NotSpecified: (:) [], MethodInvocationException + FullyQualifiedErrorId : ArgumentException LocalSystemSid 12 S-1-5-18 LocalServiceSid 12 S-1-5-19 NetworkServiceSid 12 S-1-5-20 BuiltinDomainSid 12 S-1-5-32 BuiltinAdministratorsSid 16 S-1-5-32-544 BuiltinUsersSid 16 S-1-5-32-545 BuiltinGuestsSid 16 S-1-5-32-546 BuiltinPowerUsersSid 16 S-1-5-32-547 BuiltinAccountOperatorsSid 16 S-1-5-32-548 BuiltinSystemOperatorsSid 16 S-1-5-32-549 BuiltinPrintOperatorsSid 16 S-1-5-32-550 BuiltinBackupOperatorsSid 16 S-1-5-32-551 BuiltinReplicatorSid 16 S-1-5-32-552 BuiltinPreWindows2000CompatibleAccessSid 16 S-1-5-32-554 BuiltinRemoteDesktopUsersSid 16 S-1-5-32-555 BuiltinNetworkConfigurationOperatorsSid 16 S-1-5-32-556 AccountAdministratorSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-500 AccountGuestSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-501 AccountKrbtgtSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-502 AccountDomainAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-512 AccountDomainUsersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-513 AccountDomainGuestsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-514 AccountComputersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-515 AccountControllersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-516 AccountCertAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-517 AccountSchemaAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-518 AccountEnterpriseAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-519 AccountPolicyAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-520 AccountRasAndIasServersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-553 NtlmAuthenticationSid 16 S-1-5-64-10 DigestAuthenticationSid 16 S-1-5-64-21 SChannelAuthenticationSid 16 S-1-5-64-14 ThisOrganizationSid 12 S-1-5-15 OtherOrganizationSid 12 S-1-5-1000 BuiltinIncomingForestTrustBuildersSid 16 S-1-5-32-557 BuiltinPerformanceMonitoringUsersSid 16 S-1-5-32-558 BuiltinPerformanceLoggingUsersSid 16 S-1-5-32-559 BuiltinAuthorizationAccessSid 16 S-1-5-32-560 WinBuiltinTerminalServerLicenseServersSid 16 S-1-5-32-561 MaxDefined 16 S-1-5-32-561 # PS 7 returns more results WellKnownSidType BinaryLength AccountDomainSid Value ---------------- ------------ ---------------- ----- NullSid 12 S-1-0-0 WorldSid 12 S-1-1-0 LocalSid 12 S-1-2-0 CreatorOwnerSid 12 S-1-3-0 CreatorGroupSid 12 S-1-3-1 CreatorOwnerServerSid 12 S-1-3-2 CreatorGroupServerSid 12 S-1-3-3 NTAuthoritySid 8 S-1-5 DialupSid 12 S-1-5-1 NetworkSid 12 S-1-5-2 BatchSid 12 S-1-5-3 InteractiveSid 12 S-1-5-4 ServiceSid 12 S-1-5-6 AnonymousSid 12 S-1-5-7 ProxySid 12 S-1-5-8 EnterpriseControllersSid 12 S-1-5-9 SelfSid 12 S-1-5-10 AuthenticatedUserSid 12 S-1-5-11 RestrictedCodeSid 12 S-1-5-12 TerminalServerSid 12 S-1-5-13 RemoteLogonIdSid 12 S-1-5-14 MethodInvocationException: Exception calling ".ctor" with "2" argument(s): "Well-known SIDs of type LogonIdsSid cannot be created. (Parameter 'sidType')" LocalSystemSid 12 S-1-5-18 LocalServiceSid 12 S-1-5-19 NetworkServiceSid 12 S-1-5-20 BuiltinDomainSid 12 S-1-5-32 BuiltinAdministratorsSid 16 S-1-5-32-544 BuiltinUsersSid 16 S-1-5-32-545 BuiltinGuestsSid 16 S-1-5-32-546 BuiltinPowerUsersSid 16 S-1-5-32-547 BuiltinAccountOperatorsSid 16 S-1-5-32-548 BuiltinSystemOperatorsSid 16 S-1-5-32-549 BuiltinPrintOperatorsSid 16 S-1-5-32-550 BuiltinBackupOperatorsSid 16 S-1-5-32-551 BuiltinReplicatorSid 16 S-1-5-32-552 BuiltinPreWindows2000CompatibleAccessSid 16 S-1-5-32-554 BuiltinRemoteDesktopUsersSid 16 S-1-5-32-555 BuiltinNetworkConfigurationOperatorsSid 16 S-1-5-32-556 AccountAdministratorSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-500 AccountGuestSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-501 AccountKrbtgtSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-502 AccountDomainAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-512 AccountDomainUsersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-513 AccountDomainGuestsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-514 AccountComputersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-515 AccountControllersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-516 AccountCertAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-517 AccountSchemaAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-518 AccountEnterpriseAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-519 AccountPolicyAdminsSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-520 AccountRasAndIasServersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-553 NtlmAuthenticationSid 16 S-1-5-64-10 DigestAuthenticationSid 16 S-1-5-64-21 SChannelAuthenticationSid 16 S-1-5-64-14 ThisOrganizationSid 12 S-1-5-15 OtherOrganizationSid 12 S-1-5-1000 BuiltinIncomingForestTrustBuildersSid 16 S-1-5-32-557 BuiltinPerformanceMonitoringUsersSid 16 S-1-5-32-558 BuiltinPerformanceLoggingUsersSid 16 S-1-5-32-559 BuiltinAuthorizationAccessSid 16 S-1-5-32-560 WinBuiltinTerminalServerLicenseServersSid 16 S-1-5-32-561 MaxDefined 16 S-1-5-32-561 WinBuiltinDCOMUsersSid 16 S-1-5-32-562 WinBuiltinIUsersSid 16 S-1-5-32-568 WinIUserSid 12 S-1-5-17 WinBuiltinCryptoOperatorsSid 16 S-1-5-32-569 WinUntrustedLabelSid 12 S-1-16-0 WinLowLabelSid 12 S-1-16-4096 WinMediumLabelSid 12 S-1-16-8192 WinHighLabelSid 12 S-1-16-12288 WinSystemLabelSid 12 S-1-16-16384 WinWriteRestrictedCodeSid 12 S-1-5-33 WinCreatorOwnerRightsSid 12 S-1-3-4 WinCacheablePrincipalsGroupSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-571 WinNonCacheablePrincipalsGroupSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-572 WinEnterpriseReadonlyControllersSid 12 S-1-5-22 WinAccountReadonlyControllersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-521 WinBuiltinEventLogReadersGroup 16 S-1-5-32-573 WinNewEnterpriseReadonlyControllersSid 28 S-1-5-21-1340649458-2707494813-4121304102 S-1-5-21-1340649458-2707494813-4121304102-498 WinBuiltinCertSvcDComAccessGroup 16 S-1-5-32-574 WinMediumPlusLabelSid 12 S-1-16-8448 MethodInvocationException: Exception calling ".ctor" with "2" argument(s): "The parameter is incorrect. (Parameter 'sidType/domainSid')" WinConsoleLogonSid 12 S-1-2-1 WinThisOrganizationCertificateSid 16 S-1-5-65-1 MethodInvocationException: Exception calling ".ctor" with "2" argument(s): "The parameter is incorrect. (Parameter 'sidType/domainSid')" WinBuiltinAnyPackageSid 16 S-1-15-2-1 WinCapabilityInternetClientSid 16 S-1-15-3-1 WinCapabilityInternetClientServerSid 16 S-1-15-3-2 WinCapabilityPrivateNetworkClientServerSid 16 S-1-15-3-3 WinCapabilityPicturesLibrarySid 16 S-1-15-3-4 WinCapabilityVideosLibrarySid 16 S-1-15-3-5 WinCapabilityMusicLibrarySid 16 S-1-15-3-6 WinCapabilityDocumentsLibrarySid 16 S-1-15-3-7 WinCapabilitySharedUserCertificatesSid 16 S-1-15-3-9 WinCapabilityEnterpriseAuthenticationSid 16 S-1-15-3-8 WinCapabilityRemovableStorageSid 16 S-1-15-3-10 #> Write-LogMsg @LogParams -Text "Get-CachedCimInstance -ComputerName '$DomainFqdn' -ClassName 'Win32_Account'" $Win32Accounts = Get-CachedCimInstance -ComputerName $DomainFqdn -ClassName 'Win32_Account' -KeyProperty Caption -CacheByProperty @('Caption', 'SID') @CimParams @LoggingParams $OutputObject = [PSCustomObject]@{ DistinguishedName = $DomainDn Dns = $DomainFqdn Sid = $DomainSid Netbios = $DomainNetBIOS AdsiProvider = $AdsiProvider Win32Accounts = $Win32Accounts } $DomainsBySid[$OutputObject.Sid] = $OutputObject $DomainsByNetbios[$OutputObject.Netbios] = $OutputObject $DomainsByFqdn[$DomainFqdn] = $OutputObject $OutputObject } ForEach ($DomainNetbios in $Netbios) { $OutputObject = $DomainsByNetbios[$DomainNetbios] if ($OutputObject) { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache hit for '$DomainNetbios'" $OutputObject continue } Write-LogMsg @LogParams -Text "Get-CachedCimSession -ComputerName '$DomainNetbios' # Domain NetBIOS cache hit for '$DomainNetbios'" $CimSession = Get-CachedCimSession -ComputerName $DomainNetbios -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams Write-LogMsg @LogParams -Text "Find-AdsiProvider -AdsiServer '$DomainDnsName' # for '$DomainNetbios'" $AdsiProvider = Find-AdsiProvider -AdsiServer $DomainDnsName -CimCache $CimCache -ThisFqdn $ThisFqdn @LoggingParams $CacheParams['AdsiProvider'] = $AdsiProvider Write-LogMsg @LogParams -Text "ConvertTo-DistinguishedName -Domain '$DomainNetBIOS'" $DomainDn = ConvertTo-DistinguishedName -Domain $DomainNetBIOS -DomainsByNetbios $DomainsByNetbios @LoggingParams if ($DomainDn) { Write-LogMsg @LogParams -Text "ConvertTo-Fqdn -DistinguishedName '$DomainDn' # for '$DomainNetbios'" $DomainDnsName = ConvertTo-Fqdn -DistinguishedName $DomainDn -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams } else { $ParentDomainDnsName = Get-ParentDomainDnsName -DomainsByNetbios $DomainNetBIOS -CimSession $CimSession -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams $DomainDnsName = "$DomainNetBIOS.$ParentDomainDnsName" } Write-LogMsg @LogParams -Text "ConvertTo-DomainSidString -DomainDnsName '$DomainFqdn' -AdsiProvider '$AdsiProvider' -ThisFqdn '$ThisFqdn' # for '$DomainNetbios'" $DomainSid = ConvertTo-DomainSidString -DomainDnsName $DomainDnsName -ThisFqdn $ThisFqdn -CimCache $CimCache @CacheParams @LoggingParams Write-LogMsg @LogParams -Text "Get-CachedCimInstance -ComputerName '$DomainDnsName' -ClassName 'Win32_Account' # for '$DomainNetbios'" $Win32Accounts = Get-CachedCimInstance -ComputerName $DomainFqdn -ClassName 'Win32_Account' -KeyProperty Caption -CacheByProperty @('Caption', 'SID') @CimParams @LoggingParams if ($RemoveCimSession) { Remove-CimSession -CimSession $CimSession } $OutputObject = [PSCustomObject]@{ DistinguishedName = $DomainDn Dns = $DomainDnsName Sid = $DomainSid Netbios = $DomainNetBIOS AdsiProvider = $AdsiProvider Win32Accounts = $Win32Accounts } $DomainsBySid[$OutputObject.Sid] = $OutputObject $DomainsByNetbios[$OutputObject.Netbios] = $OutputObject $DomainsByFqdn[$OutputObject.Dns] = $OutputObject $OutputObject } } } function Get-CurrentDomain { <# .SYNOPSIS Use ADSI to get the current domain .DESCRIPTION Works only on domain-joined systems, otherwise returns nothing .INPUTS None. Pipeline input is not accepted. .OUTPUTS [System.DirectoryServices.DirectoryEntry] The current domain .EXAMPLE Get-CurrentDomain Get the domain of the current computer #> [OutputType([System.DirectoryServices.DirectoryEntry])] param ( # Name of the computer to query via CIM [string]$ComputerName, # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) $CimParams = @{ CimCache = $CimCache ComputerName = $ComputerName DebugOutputStream = $DebugOutputStream LogBuffer = $LogBuffer ThisFqdn = $ThisFqdn ThisHostname = $ThisHostname WhoAmI = $WhoAmI } $Comp = Get-CachedCimInstance -ClassName Win32_ComputerSystem -KeyProperty Name @CimParams if ($Comp.Domain -eq 'WORKGROUP') { # Use CIM to find the domain $SIDString = Find-LocalAdsiServerSid @CimParams $SID = $SIDString | ConvertTo-SidByteArray $OutputProperties = @{ SIDString = $SIDString ObjectSid = [PSCustomObject]@{ Value = $Sid } DistinguishedName = [PSCustomObject]@{ Value = "DC=$ComputerName" } } } else { # Use ADSI to find the domain $CurrentDomain = [adsi]::new() $null = $CurrentDomain.RefreshCache('objectSid') # Convert the objectSID attribute (byte array) to a security descriptor string formatted according to SDDL syntax (Security Descriptor Definition Language) Write-LogMsg @LogParams -Text '[System.Security.Principal.SecurityIdentifier]::new([byte[]]$CurrentDomain.objectSid.Value, 0)' $OutputProperties = @{ SIDString = & { [System.Security.Principal.SecurityIdentifier]::new([byte[]]$CurrentDomain.objectSid.Value, 0) } 2>$null } # Get any existing properties for inclusion later $InputProperties = (Get-Member -InputObject $CurrentDomain[0] -MemberType Property, CodeProperty, ScriptProperty, NoteProperty).Name # Include any existing properties found earlier ForEach ($ThisProperty in $InputProperties) { $OutputProperties[$ThisProperty] = $ThisPrincipal.$ThisProperty } } # Output the object return [PSCustomObject]$OutputProperties } function Get-DirectoryEntry { <# .SYNOPSIS Use Active Directory Service Interfaces to retrieve an object from a directory .DESCRIPTION Retrieve a directory entry using either the WinNT or LDAP provider for ADSI .INPUTS None. Pipeline input is not accepted. .OUTPUTS [System.DirectoryServices.DirectoryEntry] where possible [PSCustomObject] for security principals with no directory entry .EXAMPLE Get-DirectoryEntry distinguishedName : {DC=ad,DC=contoso,DC=com} Path : LDAP://DC=ad,DC=contoso,DC=com As the current user on a domain-joined computer, bind to the current domain and retrieve the DirectoryEntry for the root of the domain .EXAMPLE Get-DirectoryEntry distinguishedName : Path : WinNT://ComputerName As the current user on a workgroup computer, bind to the local system and retrieve the DirectoryEntry for the root of the directory #> [OutputType([System.DirectoryServices.DirectoryEntry], [PSCustomObject])] [CmdletBinding()] param ( <# Path to the directory object to retrieve Defaults to the root of the current domain #> [string]$DirectoryPath = (([System.DirectoryServices.DirectorySearcher]::new()).SearchRoot.Path), <# Credentials to use to bind to the directory Defaults to the credentials of the current user #> [pscredential]$Credential, # Properties of the target object to retrieve [string[]]$PropertiesToLoad, # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Hashtable containing cached directory entries so they don't have to be retrieved from the directory again Uses a thread-safe hashtable by default #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain FQDNs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values # This is not actually used but is here so the parameter can be included in a splat shared with other functions [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } $DirectoryEntry = $null if ($null -eq $DirectoryEntryCache[$DirectoryPath]) { switch -regex ($DirectoryPath) { <# The WinNT provider only throws an error if you try to retrieve certain accounts/identities We will create own dummy objects instead of performing the query #> '^WinNT:\/\/.*\/CREATOR OWNER$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } '^WinNT:\/\/.*\/SYSTEM$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } '^WinNT:\/\/.*\/INTERACTIVE$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } '^WinNT:\/\/.*\/Authenticated Users$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } '^WinNT:\/\/.*\/TrustedInstaller$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } '^WinNT:\/\/.*\/ALL APPLICATION PACKAGES$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } '^WinNT:\/\/.*\/ALL RESTRICTED APPLICATION PACKAGES$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } '^WinNT:\/\/.*\/Everyone$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } '^WinNT:\/\/.*\/LOCAL SERVICE$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } '^WinNT:\/\/.*\/NETWORK SERVICE$' { $DirectoryEntry = New-FakeDirectoryEntry -DirectoryPath $DirectoryPath } # Workgroup computers do not return a DirectoryEntry with a SearchRoot Path so this ends up being an empty string # This is also invoked when DirectoryPath is null for any reason # We will return a WinNT object representing the local computer's WinNT directory '^$' { Write-LogMsg @LogParams -Text "'$ThisHostname' does not seem to be domain-joined since the SearchRoot Path is empty. Defaulting to WinNT provider for localhost instead." $CimParams = @{ CimCache = $CimCache ComputerName = $ThisFqdn DebugOutputStream = $DebugOutputStream ThisFqdn = $ThisFqdn } $Workgroup = (Get-CachedCimInstance -ClassName 'Win32_ComputerSystem' -KeyProperty Name @CimParams @LoggingParams).Workgroup $DirectoryPath = "WinNT://$Workgroup/$ThisHostname" Write-LogMsg @LogParams -Text "[System.DirectoryServices.DirectoryEntry]::new('$DirectoryPath')" if ($Credential) { $DirectoryEntry = [System.DirectoryServices.DirectoryEntry]::new($DirectoryPath, $($Credential.UserName), $($Credential.GetNetworkCredential().password)) } else { $DirectoryEntry = [System.DirectoryServices.DirectoryEntry]::new($DirectoryPath) } $SampleUser = @($DirectoryEntry.PSBase.Children | Where-Object -FilterScript { $_.schemaclassname -eq 'user' })[0] | Add-SidInfo -DomainsBySid $DomainsBySid @LoggingParams $DirectoryEntry | Add-Member -MemberType NoteProperty -Name 'Domain' -Value $SampleUser.Domain -Force } # Otherwise the DirectoryPath is an LDAP path or a WinNT path (treated the same at this stage) default { Write-LogMsg @LogParams -Text "[System.DirectoryServices.DirectoryEntry]::new('$DirectoryPath')" if ($Credential) { $DirectoryEntry = [System.DirectoryServices.DirectoryEntry]::new($DirectoryPath, $($Credential.UserName), $($Credential.GetNetworkCredential().password)) } else { $DirectoryEntry = [System.DirectoryServices.DirectoryEntry]::new($DirectoryPath) } } } $DirectoryEntryCache[$DirectoryPath] = $DirectoryEntry } else { #Write-LogMsg @LogParams -Text "DirectoryEntryCache hit for '$DirectoryPath'" $DirectoryEntry = $DirectoryEntryCache[$DirectoryPath] } if ($PropertiesToLoad) { try { # If the $DirectoryPath was invalid, this line will return an error $null = $DirectoryEntry.RefreshCache($PropertiesToLoad) } catch { $LogParams['Type'] = 'Warning' # PS 5.1 will not allow you to override the Splat by manually calling the param, so we must update the splat # Ensure that the error message appears on 1 line # Use .Trim() to remove leading and trailing whitespace # Use -replace to remove an errant line break in the following specific error I encountered: The following exception occurred while retrieving member "RefreshCache": "The group name could not be found.`r`n" Write-LogMsg @LogParams -Text "'$DirectoryPath' could not be retrieved. Error: $($_.Exception.Message.Trim() -replace '\s"',' "')" return } } return $DirectoryEntry } function Get-ParentDomainDnsName { param ( # NetBIOS name of the domain whose parent domain DNS to return [string]$DomainNetbios, # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Existing CIM session to the computer (to avoid creating redundant CIM sessions) [CimSession]$CimSession, # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug', [switch]$RemoveCimSession ) $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } if (-not $CimSession) { Write-LogMsg @LogParams -Text "Get-CachedCimSession -ComputerName '$DomainNetbios'" $CimSession = Get-CachedCimSession -ComputerName $DomainNetbios -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams } Write-LogMsg @LogParams -Text "((Get-CachedCimInstance -ComputerName '$DomainNetbios' -ClassName CIM_ComputerSystem -ThisFqdn '$ThisFqdn').domain # for '$DomainNetbios'" $ParentDomainDnsName = (Get-CachedCimInstance -ComputerName $DomainNetbios -ClassName CIM_ComputerSystem -ThisFqdn $ThisFqdn -KeyProperty Name -CimCache $CimCache @LoggingParams).domain if ($ParentDomainDnsName -eq 'WORKGROUP' -or $null -eq $ParentDomainDnsName) { # For workgroup computers there is no parent domain DNS (workgroups operate on NetBIOS) # There could also be unexpeted scenarios where the parent domain DNS is null # In all of these cases, we will use the primary DNS search suffix (that is where the OS would attempt to register DNS records for the computer) Write-LogMsg @LogParams -Text "(Get-DnsClientGlobalSetting -CimSession `$CimSession).SuffixSearchList[0] # for '$DomainNetbios'" $ParentDomainDnsName = (Get-DnsClientGlobalSetting -CimSession $CimSession).SuffixSearchList[0] } if ($RemoveCimSession) { Remove-CimSession -CimSession $CimSession } return $ParentDomainDnsName } function Get-TrustedDomain { <# .SYNOPSIS Returns a dictionary of trusted domains by the current computer .DESCRIPTION Works only on domain-joined systems Use nltest to get the domain trust relationships for the domain of the current computer Use ADSI's LDAP provider to get each trusted domain's DNS name, NETBIOS name, and SID For each trusted domain the key is the domain's SID, or its NETBIOS name if the -KeyByNetbios switch parameter was used For each trusted domain the value contains the details retrieved with ADSI .INPUTS None. Pipeline input is not accepted. .OUTPUTS [PSCustomObject] One object per trusted domain, each with a DomainFqdn property and a DomainNetbios property .EXAMPLE Get-TrustedDomain Get the trusted domains of the current computer .NOTES #> [OutputType([PSCustomObject])] param ( <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> $ThisHostname = (HOSTNAME.EXE), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } # Errors are expected on non-domain-joined systems # Redirecting the error stream to null only suppresses the error in the console; it will still be in the transcript # Instead, redirect the error stream to the output stream and filter out the errors by type Write-LogMsg @LogParams -Text "$('& nltest /domain_trusts 2>&1')" $nltestresults = & nltest /domain_trusts 2>&1 $RegExForEachTrust = '(?<index>[\d]*): (?<netbios>\S*) (?<dns>\S*).*' ForEach ($Result in $nltestresults) { if ($Result.GetType() -eq [string]) { if ($Result -match $RegExForEachTrust) { [PSCustomObject]@{ DomainFqdn = $Matches.dns DomainNetbios = $Matches.netbios } } } } } function Get-WinNTGroupMember { <# .SYNOPSIS Get members of a group from the WinNT provider .DESCRIPTION Get members of a group from the WinNT provider Convert them from COM objects into usable DirectoryEntry objects .INPUTS [System.DirectoryServices.DirectoryEntry]$DirectoryEntry .OUTPUTS [System.DirectoryServices.DirectoryEntry] for each group member .EXAMPLE [System.DirectoryServices.DirectoryEntry]::new('WinNT://localhost/Administrators') | Get-WinNTGroupMember Get members of the local Administrators group #> [OutputType([System.DirectoryServices.DirectoryEntry])] param ( # DirectoryEntry [System.DirectoryServices.DirectoryEntry] of the WinNT group whose members to get [Parameter(ValueFromPipeline)] $DirectoryEntry, # Properties of the group members to find in the directory [string[]]$PropertiesToLoad, <# Dictionary to cache directory entries to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) begin { $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } $PropertiesToLoad += 'Department', 'description', 'distinguishedName', 'grouptype', 'managedby', 'member', 'name', 'objectClass', 'objectSid', 'operatingSystem', 'primaryGroupToken', 'samAccountName', 'Title' $PropertiesToLoad = $PropertiesToLoad | Sort-Object -Unique } process { ForEach ($ThisDirEntry in $DirectoryEntry) { $SourceDomain = $ThisDirEntry.Path | Split-Path -Parent | Split-Path -Leaf # Retrieve the members of local groups if ($null -ne $ThisDirEntry.Properties['groupType'] -or $ThisDirEntry.schemaclassname -eq 'group') { # Assembly: System.DirectoryServices.dll # Namespace: System.DirectoryServices # DirectoryEntry.Invoke(String, Object[]) Method # Calls a method on the native Active Directory Domain Services object # https://docs.microsoft.com/en-us/dotnet/api/system.directoryservices.directoryentry.invoke?view=dotnet-plat-ext-6.0 # I am using it to call the IADsGroup::Members method # The IADsGroup programming interface is part of the iads.h header # The iads.h header is part of the ADSI component of the Win32 API # The IADsGroup::Members method retrieves a collection of the immediate members of the group. # The collection does not include the members of other groups that are nested within the group. # The default implementation of this method uses LsaLookupSids to query name information for the group members. # LsaLookupSids has a maximum limitation of 20480 SIDs it can convert, therefore that limitation also applies to this method. # Returns a pointer to an IADsMembers interface pointer that receives the collection of group members. The caller must release this interface when it is no longer required. # https://docs.microsoft.com/en-us/windows/win32/api/iads/nf-iads-iadsgroup-members # The IADsMembers::Members method would use the same provider but I have chosen not to implement that here # Recursion through nested groups can be handled outside of Get-WinNTGroupMember for now # Maybe that could be a feature in the future # https://docs.microsoft.com/en-us/windows/win32/adsi/adsi-object-model-for-winnt-providers?redirectedfrom=MSDN $DirectoryMembers = & { $ThisDirEntry.Invoke('Members') } 2>$null Write-LogMsg @LogParams -Text " # '$($ThisDirEntry.Path)' has $(($DirectoryMembers | Measure-Object).Count) members # For $($ThisDirEntry.Path)" $MembersToGet = @{ 'WinNTMembers' = @() } $MemberParams = @{ DirectoryEntryCache = $DirectoryEntryCache PropertiesToLoad = $PropertiesToLoad DomainsByNetbios = $DomainsByNetbios LogBuffer = $LogBuffer WhoAmI = $WhoAmI CimCache = $CimCache ThisFqdn = $ThisFqdn } ForEach ($DirectoryMember in $DirectoryMembers) { # The IADsGroup::Members method returns ComObjects # But proper .Net objects are much easier to work with # So we will convert the ComObjects into DirectoryEntry objects $DirectoryPath = Invoke-ComObject -ComObject $DirectoryMember -Property 'ADsPath' $MemberDomainDn = $null if ($DirectoryPath -match 'WinNT:\/\/(?<Domain>[^\/]*)\/(?<Acct>.*$)') { Write-LogMsg @LogParams -Text " # '$DirectoryPath' has a domain of '$($Matches.Domain)' and an account name of '$($Matches.Acct)'" $MemberName = $Matches.Acct $MemberDomainNetbios = $Matches.Domain $DomainCacheResult = $DomainsByNetbios[$MemberDomainNetbios] if ($DomainCacheResult) { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache hit for '$MemberDomainNetBios'" if ( "WinNT:\\$MemberDomainNetbios" -ne $SourceDomain ) { $MemberDomainDn = $DomainCacheResult.DistinguishedName } } else { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache miss for '$MemberDomainNetBios'. Available keys: $($DomainsByNetBios.Keys -join ',')" } if ($DirectoryPath -match 'WinNT:\/\/(?<Domain>[^\/]*)\/(?<Middle>[^\/]*)\/(?<Acct>.*$)') { Write-LogMsg @LogParams -Text " # '$DirectoryPath' is named '$($Matches.Acct)' and is on ADSI server '$($Matches.Middle)' joined to the domain '$($Matches.Domain)'" if ($Matches.Middle -eq ($ThisDirEntry.Path | Split-Path -Parent | Split-Path -Leaf)) { $MemberDomainDn = $null } } } else { Write-LogMsg @LogParams -Text " # '$DirectoryPath' does not match 'WinNT:\/\/(?<Domain>[^\/]*)\/(?<Acct>.*$)'" } # LDAP directories have a distinguishedName if ($MemberDomainDn) { # LDAP directories support searching # Combine all members' samAccountNames into a single search per directory distinguishedName # Use a hashtable with the directory path as the key and a string as the definition # The string is a partial LDAP filter, just the segments of the LDAP filter for each samAccountName Write-LogMsg @LogParams -Text " # '$MemberName' is a domain security principal" $MembersToGet["LDAP://$MemberDomainDn"] += "(samaccountname=$MemberName)" } else { # WinNT directories do not support searching so we will retrieve each member individually # Use a hashtable with 'WinNTMembers' as the key and an array of WinNT directory paths as the value Write-LogMsg @LogParams -Text " # '$DirectoryPath' is a local security principal" $MembersToGet['WinNTMembers'] += $DirectoryPath } } # Get and Expand the directory entries for the WinNT group members ForEach ($ThisMember in $MembersToGet['WinNTMembers']) { $MemberParams['DirectoryPath'] = $ThisMember Write-LogMsg @LogParams -Text "Get-DirectoryEntry -DirectoryPath '$DirectoryPath'" $MemberDirectoryEntry = Get-DirectoryEntry @MemberParams Expand-WinNTGroupMember -DirectoryEntry $MemberDirectoryEntry -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams } # Remove the WinNTMembers key from the hashtable so the only remaining keys are distinguishedName(s) of LDAP directories $MembersToGet.Remove('WinNTMembers') # Get and Expand the directory entries for the LDAP group members $MembersToGet.Keys | ForEach-Object { $MemberParams['DirectoryPath'] = $_ $MemberParams['Filter'] = "(|$($MembersToGet[$_]))" $MemberDirectoryEntries = Search-Directory @MemberParams Expand-WinNTGroupMember -DirectoryEntry $MemberDirectoryEntries -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams } } else { Write-LogMsg @LogParams -Text " # '$($ThisDirEntry.Path)' is not a group" } } } } function Invoke-ComObject { <# .SYNOPSIS Invoke a member method of a ComObject [__ComObject] .DESCRIPTION Use the InvokeMember method to invoke the InvokeMethod or GetProperty or SetProperty methods By default, invokes the GetProperty method for the specified Property If the Value parameter is specified, invokes the SetProperty method for the specified Property If the Method switch is specified, invokes the InvokeMethod method .INPUTS None. Pipeline input is not accepted. .OUTPUTS The output of the invoked method is returned directly .EXAMPLE $ComObject = [System.DirectoryServices.DirectoryEntry]::new('WinNT://localhost/Administrators').Invoke('Members') | Select -First 1 Invoke-ComObject -ComObject $ComObject -Property AdsPath Get the first member of the local Administrators group on the current computer Then use Invoke-ComObject to invoke the GetProperty method and return the value of the AdsPath property #> param ( # The ComObject whose member method to invoke [Parameter(Mandatory)] $ComObject, # The property to use with the invoked method [Parameter(Mandatory)] [String]$Property, # The value to set with the SetProperty method, or the name of the method to run with the InvokeMethod method $Value, # Use the InvokeMethod method of the ComObject [Switch]$Method ) <# # Don't remember what this is for If ($ComObject -IsNot "__ComObject") { If (!$ComInvoke) { $Global:ComInvoke = @{} } If (!$ComInvoke.$ComObject) { $ComInvoke.$ComObject = New-Object -ComObject $ComObject } $ComObject = $ComInvoke.$ComObject } #> If ($Method) { $Invoke = "InvokeMethod" } ElseIf ($MyInvocation.BoundParameters.ContainsKey("Value")) { $Invoke = "SetProperty" } Else { $Invoke = "GetProperty" } [__ComObject].InvokeMember($Property, $Invoke, $Null, $ComObject, $Value) } function New-FakeDirectoryEntry { <# Used in place of a DirectoryEntry for certain WinNT security principals that do not have objects in the directory The WinNT provider only throws an error if you try to retrieve certain accounts/identities #> param ( [string]$DirectoryPath ) $LastSlashIndex = $DirectoryPath.LastIndexOf('/') $StartIndex = $LastSlashIndex + 1 $Name = $DirectoryPath.Substring($StartIndex, $DirectoryPath.Length - $StartIndex) $Parent = $DirectoryPath.Substring(0, $LastSlashIndex) $Path = $DirectoryPath $SchemaEntry = [System.DirectoryServices.DirectoryEntry] switch -regex ($DirectoryPath) { 'CREATOR OWNER$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-3-0' $Description = 'A SID to be replaced by the SID of the user who creates a new object. This SID is used in inheritable ACEs.' $SchemaClassName = 'user' } 'SYSTEM$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-18' $Description = 'By default, the SYSTEM account is granted Full Control permissions to all files on an NTFS volume' $SchemaClassName = 'user' } 'INTERACTIVE$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-4' $Description = 'Users who log on for interactive operation. This is a group identifier added to the token of a process when it was logged on interactively.' $SchemaClassName = 'group' } 'Authenticated Users$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-11' $Description = 'Any user who accesses the system through a sign-in process has the Authenticated Users identity.' $SchemaClassName = 'group' } 'TrustedInstaller$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-80-956008885-3418522649-1831038044-1853292631-2271478464' $Description = 'Most of the operating system files are owned by the TrustedInstaller security identifier (SID)' $SchemaClassName = 'user' } 'ALL APPLICATION PACKAGES$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-15-2-1' $Description = 'All applications running in an app package context. SECURITY_BUILTIN_PACKAGE_ANY_PACKAGE' $SchemaClassName = 'group' } 'ALL RESTRICTED APPLICATION PACKAGES$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-15-2-2' $Description = 'SECURITY_BUILTIN_PACKAGE_ANY_RESTRICTED_PACKAGE' $SchemaClassName = 'group' } 'Everyone$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-1-0' $Description = "A group that includes all users; aka 'World'." $SchemaClassName = 'group' } 'LOCAL SERVICE$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-19' $Description = 'A local service account' $SchemaClassName = 'user' } 'NETWORK SERVICE$' { $objectSid = ConvertTo-SidByteArray -SidString 'S-1-5-20' $Description = 'A network service account' $SchemaClassName = 'user' } } $Properties = @{ Name = $Name Description = $Description objectSid = $objectSid SchemaClassName = $SchemaClassName } $Object = [PSCustomObject]@{ Name = $Name Description = $Description objectSid = $objectSid SchemaClassName = $SchemaClassName Parent = $Parent Path = $Path SchemaEntry = $SchemaEntry Properties = $Properties } Add-Member -InputObject $Object -Name RefreshCache -MemberType ScriptMethod -Value {} Add-Member -InputObject $Object -Name Invoke -MemberType ScriptMethod -Value {} return $Object } function Resolve-IdentityReference { <# .SYNOPSIS Use ADSI to lookup info about IdentityReferences from Access Control Entries that came from Discretionary Access Control Lists .DESCRIPTION Based on the IdentityReference proprety of each Access Control Entry: Resolve SID to NT account name and vise-versa Resolve well-known SIDs Resolve generic defaults like 'NT AUTHORITY' and 'BUILTIN' to the applicable computer or domain name .INPUTS None. Pipeline input is not accepted. .OUTPUTS [PSCustomObject] with IdentityReferenceNetBios,IdentityReferenceDns, and SIDString properties (each strings) .EXAMPLE Resolve-IdentityReference -IdentityReference 'BUILTIN\Administrator' -AdsiServer (Get-AdsiServer 'localhost') Get information about the local Administrator account #> [OutputType([PSCustomObject])] param ( # IdentityReference from an Access Control Entry # Expecting either a SID (S-1-5-18) or an NT account name (CONTOSO\User) [Parameter(Mandatory)] [string]$IdentityReference, # Object from Get-AdsiServer representing the directory server and its attributes [PSObject]$AdsiServer, <# Dictionary to cache directory entries to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), <# Dictionary to cache known servers to avoid redundant lookups Defaults to an empty thread-safe hashtable #> [hashtable]$AdsiServersByDns = [hashtable]::Synchronized(@{}), # Hashtable with known domain NetBIOS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), # Hashtable with known domain SIDs as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsBySid = ([hashtable]::Synchronized(@{})), # Hashtable with known domain DNS names as keys and objects with Dns,NetBIOS,SID,DistinguishedName properties as values [hashtable]$DomainsByFqdn = ([hashtable]::Synchronized(@{})), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } $GetDirectoryEntryParams = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios DomainsBySid = $DomainsBySid } $ServerNetBIOS = $AdsiServer.Netbios # Many Well-Known SIDs cannot be translated with the Translate method # Instead Get-AdsiServer used CIM to find instances of the Win32_Account class on the server # and update the Win32_AccountBySID and Win32_AccountByCaption caches # Search the caches now $CacheResult = $CimCache[$ServerNetBIOS]['Win32_AccountBySID'][$IdentityReference] if ($CacheResult) { Write-LogMsg @LogParams -Text " # Win32_AccountBySID CIM instance cache hit for '$IdentityReference' on '$ServerNetBios'" return [PSCustomObject]@{ IdentityReference = $IdentityReference SIDString = $CacheResult.SID IdentityReferenceNetBios = $CacheResult.Caption -replace "^$ThisHostname\\", "$ThisHostname\" # required for ps 5.1 support #IdentityReferenceNetBios = $CacheResult.Caption.Replace("$ThisHostname\","$ThisHostname\",[System.StringComparison]::CurrentCultureIgnoreCase) # PS 7 more efficient IdentityReferenceDns = "$($AdsiServer.Dns)\$($CacheResult.Name)" } } else { Write-LogMsg @LogParams -Text " # Win32_AccountBySID CIM instance cache miss for '$IdentityReference' on '$ServerNetBIOS'" } $split = $IdentityReference.Split('\') $DomainNetBIOS = $ServerNetBIOS $Name = $split[1] if ($Name) { # A Win32_Account's Caption property is a NetBIOS-resolved IdentityReference # NT Authority\SYSTEM would be SERVER123\SYSTEM as a Win32_Account on a server with hostname server123 # This could also match on a domain account since those can be returned as Win32_Account, not sure if that will be a bug or what $CacheResult = $CimCache[$ServerNetBIOS]['Win32_AccountByCaption']["$ServerNetBIOS\$Name"] if ($CacheResult) { Write-LogMsg @LogParams -Text " # Win32_AccountByCaption CIM instance cache hit for '$ServerNetBIOS\$Name' on '$ServerNetBIOS'" if ($ServerNetBIOS -eq $CacheResult.Domain) { $DomainDns = $AdsiServer.Dns } if (-not $DomainDns) { $DomainCacheResult = $DomainsByNetbios[$CacheResult.Domain] if ($DomainCacheResult) { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache hit for '$($CacheResult.Domain)'" $DomainDns = $DomainCacheResult.Dns } else { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache miss for '$($CacheResult.Domain)'" } } if (-not $DomainDns) { $DomainDns = ConvertTo-Fqdn -NetBIOS $DomainNetBIOS -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams $DomainDn = $DomainsByNetbios[$DomainNetBIOS].DistinguishedName } return [PSCustomObject]@{ IdentityReference = $IdentityReference SIDString = $CacheResult.SID IdentityReferenceNetBios = $CacheResult.Caption -replace "^$ThisHostname\\", "$ThisHostname\" # required for ps 5.1 support # PS 7 more efficient IdentityReferenceNetBios = $CacheResult.Caption.Replace("$ThisHostname\","$ThisHostname\",[System.StringComparison]::CurrentCultureIgnoreCase) IdentityReferenceDns = "$DomainDns\$($CacheResult.Name)" } } else { Write-LogMsg @LogParams -Text " # Win32_AccountByCaption CIM instance cache miss for '$ServerNetBIOS\$Name' on '$ServerNetBIOS'" } } $CacheResult = $CimCache[$ServerNetBIOS]['Win32_AccountByCaption']["$ServerNetBIOS\$IdentityReference"] if ($CacheResult) { # IdentityReference is an NT Account Name without a \, and has been cached from this server Write-LogMsg @LogParams -Text " # Win32_AccountByCaption CIM instance cache hit for '$ServerNetBIOS\$IdentityReference' on '$ServerNetBIOS'" return [PSCustomObject]@{ IdentityReference = $IdentityReference SIDString = $CacheResult.SID IdentityReferenceNetBios = $CacheResult.Caption.Replace("$ThisHostname\", "$ThisHostname\") # required for ps 5.1 support # PS 7 more efficient IdentityReferenceNetBios = $CacheResult.Caption.Replace("$ThisHostname\","$ThisHostname\",[System.StringComparison]::CurrentCultureIgnoreCase) IdentityReferenceDns = "$($AdsiServer.Dns)\$($CacheResult.Name)" } } else { Write-LogMsg @LogParams -Text " # Win32_AccountByCaption CIM instance cache miss for '$ServerNetBIOS\$IdentityReference' on '$ServerNetBIOS'" } # If no match was found in any cache, the path forward depends on the IdentityReference switch -Wildcard ($IdentityReference) { "S-1-*" { # IdentityReference is a Revision 1 SID <# Use the SecurityIdentifier.Translate() method to translate the SID to an NT Account name This .Net method makes it impossible to redirect the error stream directly Wrapping it in a scriptblock (which is then executed with &) fixes the problem I don't understand exactly why The scriptblock will evaluate null if the SID cannot be translated, and the error stream redirection supresses the error (except in the transcript which catches it) #> Write-LogMsg @LogParams -Text "[System.Security.Principal.SecurityIdentifier]::new('$IdentityReference').Translate([System.Security.Principal.NTAccount])" $SecurityIdentifier = [System.Security.Principal.SecurityIdentifier]::new($IdentityReference) $NTAccount = & { $SecurityIdentifier.Translate([System.Security.Principal.NTAccount]).Value } 2>$null Write-LogMsg @LogParams -Text " # Translated NTAccount name for '$IdentityReference' is '$NTAccount'" # The SID of the domain is everything up to (but not including) the last hyphen $DomainSid = $IdentityReference.Substring(0, $IdentityReference.LastIndexOf("-")) # Search the cache of domains, first by SID, then by NetBIOS name $DomainCacheResult = $DomainsBySID[$DomainSid] if ($DomainCacheResult) { Write-LogMsg @LogParams -Text " # Domain SID cache hit for '$DomainSid'" } else { Write-LogMsg @LogParams -Text " # Domain SID cache miss for '$DomainSid'" $split = $NTAccount -split '\\' $DomainFromSplit = $split[0] if ( $DomainFromSplit.Contains(' ') -or $DomainFromSplit.Contains('BUILTIN\') ) { $NameFromSplit = $split[1] $DomainNetBIOS = $ServerNetBIOS $Caption = "$ServerNetBIOS\$NameFromSplit" # Update the caches $Win32Acct = [PSCustomObject]@{ SID = $IdentityReference Caption = $Caption Domain = $ServerNetBIOS Name = $NameFromSplit } Write-LogMsg @LogParams -Text " # Add '$Caption' to the 'Win32_AccountByCaption' cache for '$ServerNetBIOS'" $CimCache[$ServerNetBIOS]['Win32_AccountByCaption'][$Caption] = $Win32Acct Write-LogMsg @LogParams -Text " # Add '$IdentityReference' to the 'Win32_AccountBySID' cache for '$ServerNetBIOS'" $CimCache[$ServerNetBIOS]['Win32_AccountBySID'][$IdentityReference] = $Win32Acct } else { $DomainNetBIOS = $DomainFromSplit } $DomainCacheResult = $DomainsByNetbios[$split[0]] } if ($DomainCacheResult) { $DomainNetBIOS = $DomainCacheResult.Netbios $DomainDns = $DomainCacheResult.Dns } else { Write-LogMsg @LogParams -Text " # Domain SID '$DomainSid' is unknown. Domain NetBIOS is '$DomainNetBIOS'" $DomainDns = ConvertTo-Fqdn -NetBIOS $DomainNetBIOS -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams } $AdsiServer = Get-AdsiServer -Fqdn $DomainDns -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams if ($NTAccount) { # Recursively call this function to resolve the new IdentityReference we have $ResolveIdentityReferenceParams = @{ IdentityReference = $NTAccount AdsiServer = $AdsiServer AdsiServersByDns = $AdsiServersByDns DirectoryEntryCache = $DirectoryEntryCache DomainsBySID = $DomainsBySID DomainsByNetbios = $DomainsByNetbios DomainsByFqdn = $DomainsByFqdn ThisHostName = $ThisHostName ThisFqdn = $ThisFqdn LogBuffer = $LogBuffer CimCache = $CimCache WhoAmI = $WhoAmI } $Resolved = Resolve-IdentityReference @ResolveIdentityReferenceParams } else { $Resolved = [PSCustomObject]@{ IdentityReference = $IdentityReference SIDString = $IdentityReference IdentityReferenceNetBios = $CacheResult.Caption -replace "^$ThisHostname\\", "$ThisHostname\" # required for ps 5.1 support #IdentityReferenceNetBios = $CacheResult.Caption.Replace("$ThisHostname\","$ThisHostname\",[System.StringComparison]::CurrentCultureIgnoreCase) # PS 7 more efficient IdentityReferenceDns = "$DomainDns\$IdentityReference" } } return $Resolved } "NT SERVICE\*" { # Some of them are services (yes services can have SIDs, notably this includes TrustedInstaller but it is also common with SQL) if ($ServerNetBIOS -eq $ThisHostName) { Write-LogMsg @LogParams -Text "sc.exe showsid $Name" [string[]]$ScResult = & sc.exe showsid $Name } else { Write-LogMsg @LogParams -Text "Invoke-Command -ComputerName $ServerNetBIOS -ScriptBlock { & sc.exe showsid `$args[0] } -ArgumentList $Name" [string[]]$ScResult = Invoke-Command -ComputerName $ServerNetBIOS -ScriptBlock { & sc.exe showsid $args[0] } -ArgumentList $Name } $ScResultProps = @{} $ScResult | ForEach-Object { $Prop, $Value = ($_ -split ':').Trim() $ScResultProps[$Prop] = $Value } $SIDString = $ScResultProps['SERVICE SID'] #$Caption = $IdentityReference -replace 'NT SERVICE', $ServerNetBIOS -replace "^$ThisHostname\\", "$ThisHostname\" $Caption = $IdentityReference.Replace('NT SERVICE', $ServerNetBIOS) $DomainCacheResult = $DomainsByNetbios[$ServerNetBIOS] if ($DomainCacheResult) { $DomainDns = $DomainCacheResult.Dns } if (-not $DomainDns) { $DomainDns = ConvertTo-Fqdn -NetBIOS $ServerNetBIOS -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams } # Update the caches $Win32Acct = [PSCustomObject]@{ SID = $SIDString Caption = $Caption Domain = $ServerNetBIOS Name = $Name } Write-LogMsg @LogParams -Text " # Add '$Caption' to the 'Win32_AccountByCaption' cache for '$ServerNetBIOS'" $CimCache[$ServerNetBIOS]['Win32_AccountByCaption'][$Caption] = $Win32Acct Write-LogMsg @LogParams -Text " # Add '$SIDString' to the 'Win32_AccountBySID' cache for '$ServerNetBIOS'" $CimCache[$ServerNetBIOS]['Win32_AccountBySID'][$SIDString] = $Win32Acct return [PSCustomObject]@{ IdentityReference = $IdentityReference SIDString = $SIDString IdentityReferenceNetBios = $Caption IdentityReferenceDns = "$DomainDns\$Name" } } "APPLICATION PACKAGE AUTHORITY\*" { <# These SIDs cannot be resolved from the NTAccount name: PS C:> [System.Security.Principal.SecurityIdentifier]::new('S-1-15-2-1').Translate([System.Security.Principal.NTAccount]).Translate([System.Security.Principal.SecurityIdentifier]) MethodInvocationException: Exception calling "Translate" with "1" argument(s): "Some or all identity references could not be translated." Even though resolving the reverse direction works: PS C:> [System.Security.Principal.SecurityIdentifier]::new('S-1-15-2-1').Translate([System.Security.Principal.NTAccount]) Value ----- APPLICATION PACKAGE AUTHORITY\ALL APPLICATION PACKAGES So we will instead hardcode a map of SIDs #> $KnownSIDs = @{ # https://learn.microsoft.com/en-us/windows/win32/secauthz/app-container-sid-constants 'APPLICATION PACKAGE AUTHORITY\ALL APPLICATION PACKAGES' = 'S-1-15-2-1' 'APPLICATION PACKAGE AUTHORITY\ALL RESTRICTED APPLICATION PACKAGES' = 'S-1-15-2-2' # Capability SIDs introduced in Windows 8 https://learn.microsoft.com/en-us/windows/win32/secauthz/capability-sid-constants 'APPLICATION PACKAGE AUTHORITY\Your Internet connection' = 'S-1-15-3-1' 'APPLICATION PACKAGE AUTHORITY\Your Internet connection, including incoming connections from the Internet' = 'S-1-15-3-2' 'APPLICATION PACKAGE AUTHORITY\Your home or work networks' = 'S-1-15-3-3' 'APPLICATION PACKAGE AUTHORITY\Your pictures library' = 'S-1-15-3-4' 'APPLICATION PACKAGE AUTHORITY\Your videos library' = 'S-1-15-3-5' 'APPLICATION PACKAGE AUTHORITY\Your music library' = 'S-1-15-3-6' 'APPLICATION PACKAGE AUTHORITY\Your documents library' = 'S-1-15-3-7' 'APPLICATION PACKAGE AUTHORITY\Your Windows credentials' = 'S-1-15-3-8' 'APPLICATION PACKAGE AUTHORITY\Software and hardware certificates or a smart card' = 'S-1-15-3-9' 'APPLICATION PACKAGE AUTHORITY\Removable storage' = 'S-1-15-3-10' 'APPLICATION PACKAGE AUTHORITY\Your Appointments' = 'S-1-15-3-11' 'APPLICATION PACKAGE AUTHORITY\Your Contacts' = 'S-1-15-3-12' } $SIDString = $KnownSIDs[$IdentityReference] #$Caption = $IdentityReference -replace 'APPLICATION PACKAGE AUTHORITY', $ServerNetBIOS -replace "^$ThisHostname\\", "$ThisHostname\" $Caption = $IdentityReference.Replace('APPLICATION PACKAGE AUTHORITY', $ServerNetBIOS) $DomainCacheResult = $DomainsByNetbios[$ServerNetBIOS] if ($DomainCacheResult) { $DomainDns = $DomainCacheResult.Dns } if (-not $DomainDns) { $DomainDns = ConvertTo-Fqdn -NetBIOS $ServerNetBIOS -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams } # Update the caches $Win32Acct = [PSCustomObject]@{ SID = $SIDString Caption = $Caption Domain = $ServerNetBIOS Name = $Name } Write-LogMsg @LogParams -Text " # Add '$Caption' to the 'Win32_AccountByCaption' cache for '$ServerNetBIOS'" $CimCache[$ServerNetBIOS]['Win32_AccountByCaption'][$Caption] = $Win32Acct Write-LogMsg @LogParams -Text " # Add '$SIDString' to the 'Win32_AccountBySID' cache for '$ServerNetBIOS'" $CimCache[$ServerNetBIOS]['Win32_AccountBySID'][$SIDString] = $Win32Acct return [PSCustomObject]@{ IdentityReference = $IdentityReference SIDString = $SIDString IdentityReferenceNetBios = $Caption IdentityReferenceDns = "$DomainDns\$Name" } } "BUILTIN\*" { # Some built-in groups such as BUILTIN\Users and BUILTIN\Administrators are not in the CIM class or translatable with the NTAccount.Translate() method # But they may have real DirectoryEntry objects # Try to find the DirectoryEntry object locally on the server $DirectoryPath = "$($AdsiServer.AdsiProvider)`://$ServerNetBIOS/$Name" $DirectoryEntry = Get-DirectoryEntry -DirectoryPath $DirectoryPath @GetDirectoryEntryParams @LoggingParams $SIDString = (Add-SidInfo -InputObject $DirectoryEntry -DomainsBySid $DomainsBySid @LoggingParams).SidString #$Caption = $IdentityReference -replace 'BUILTIN', $ServerNetBIOS -replace "^$ThisHostname\\", "$ThisHostname\" $Caption = $IdentityReference.Replace('BUILTIN', $ServerNetBIOS) $DomainDns = $AdsiServer.Dns # Update the caches $Win32Acct = [PSCustomObject]@{ SID = $SIDString Caption = $Caption Domain = $ServerNetBIOS Name = $Name } Write-LogMsg @LogParams -Text " # Add '$Caption' to the 'Win32_AccountByCaption' cache for '$ServerNetBIOS'" $CimCache[$ServerNetBIOS]['Win32_AccountByCaption'][$Caption] = $Win32Acct Write-LogMsg @LogParams -Text " # Add '$SIDString' to the 'Win32_AccountBySID' SID cache for '$ServerNetBIOS'" $CimCache[$ServerNetBIOS]['Win32_AccountBySID'][$SIDString] = $Win32Acct return [PSCustomObject]@{ IdentityReference = $IdentityReference SIDString = $SIDString IdentityReferenceNetBios = $Caption IdentityReferenceDns = "$DomainDns\$Name" } } } # The IdentityReference is an NTAccount # Resolve NTAccount to SID # Start by determining the domain if (-not [string]::IsNullOrEmpty($DomainNetBIOS)) { $DomainNetBIOSCacheResult = $DomainsByNetbios[$DomainNetBIOS] if (-not $DomainNetBIOSCacheResult) { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache miss for '$($DomainNetBIOS)'." $DomainNetBIOSCacheResult = Get-AdsiServer -Netbios $DomainNetBIOS -CimCache $CimCache -DirectoryEntryCache $DirectoryEntryCache -DomainsByFqdn $DomainsByFqdn -DomainsByNetbios $DomainsByNetbios -DomainsBySid $DomainsBySid -ThisFqdn $ThisFqdn @LoggingParams $DomainsByNetbios[$DomainNetBIOS] = $DomainNetBIOSCacheResult } else { Write-LogMsg @LogParams -Text " # Domain NetBIOS cache hit for '$($DomainNetBIOS)'." } $DomainDn = $DomainNetBIOSCacheResult.DistinguishedName $DomainDns = $DomainNetBIOSCacheResult.Dns # Try to resolve the account against the server the Access Control Entry came from (which may or may not be the directory server for the account) Write-LogMsg @LogParams -Text "[System.Security.Principal.NTAccount]::new('$ServerNetBIOS', '$Name').Translate([System.Security.Principal.SecurityIdentifier])" $NTAccount = [System.Security.Principal.NTAccount]::new($ServerNetBIOS, $Name) $SIDString = & { $NTAccount.Translate([System.Security.Principal.SecurityIdentifier]) } 2>$null if (-not $SIDString) { # Try to resolve the account against the domain indicated in its NT Account Name (which may or may not be the correct ADSI server for the account, it won't be if it's NT AUTHORITY\SYSTEM for example) Write-LogMsg @LogParams -Text "[System.Security.Principal.NTAccount]::new('$DomainNetBIOS', '$Name')" $NTAccount = [System.Security.Principal.NTAccount]::new($DomainNetBIOS, $Name) Write-LogMsg @LogParams -Text "[System.Security.Principal.NTAccount]::new('$DomainNetBIOS', '$Name').Translate([System.Security.Principal.SecurityIdentifier])" $SIDString = & { $NTAccount.Translate([System.Security.Principal.SecurityIdentifier]) } 2>$null } else { $DomainNetBIOS = $ServerNetBIOS } if (-not $SIDString) { # Try to resolve the account against the domain indicated in its NT Account Name # Add this domain to our list of known domains try { $SearchPath = Add-DomainFqdnToLdapPath -DirectoryPath "LDAP://$DomainDn" -ThisFqdn $ThisFqdn -CimCache $CimCache @LoggingParams $SearchParams = @{ CimCache = $CimCache DebugOutputStream = $DebugOutputStream DirectoryEntryCache = $DirectoryEntryCache DirectoryPath = $SearchPath DomainsByNetbios = $DomainsByNetbios Filter = "(samaccountname=$Name)" PropertiesToLoad = @('objectClass', 'distinguishedName', 'name', 'grouptype', 'description', 'managedby', 'member', 'objectClass', 'Department', 'Title') ThisFqdn = $ThisFqdn } $DirectoryEntry = Search-Directory @SearchParams @LoggingParams $SIDString = (Add-SidInfo -InputObject $DirectoryEntry -DomainsBySid $DomainsBySid @LoggingParams).SidString } catch { $LogParams['Type'] = 'Warning' # PS 5.1 will not allow you to override the Splat by manually calling the param, so we must update the splat Write-LogMsg @LogParams -Text "'$IdentityReference' could not be resolved against its directory. Error: $($_.Exception.Message)" $LogParams['Type'] = $DebugOutputStream } } if (-not $SIDString) { # Try to find the DirectoryEntry object directly on the server $DirectoryPath = "$($AdsiServer.AdsiProvider)`://$ServerNetBIOS/$Name" $DirectoryEntry = Get-DirectoryEntry -DirectoryPath $DirectoryPath @GetDirectoryEntryParams @LoggingParams $SIDString = (Add-SidInfo -InputObject $DirectoryEntry -DomainsBySid $DomainsBySid @LoggingParams).SidString } if ($SIDString) { $DomainNetBIOS = $ServerNetBIOS } # This covers unresolved SIDs for deleted accounts, broken domain trusts, etc. if ( '' -eq "$Name" ) { $Name = $IdentityReference Write-LogMsg @LogParams -Text " # An IdentityReference girl has no name ($Name)" } else { Write-LogMsg @LogParams -Text " # '$IdentityReference' is named '$Name'" } return [PSCustomObject]@{ IdentityReference = $IdentityReference SIDString = $SIDString IdentityReferenceNetBios = "$DomainNetBios\$Name" #-replace "^$ThisHostname\\", "$ThisHostname\" IdentityReferenceDns = "$DomainDns\$Name" } } } function Search-Directory { <# .SYNOPSIS Use Active Directory Service Interfaces to search an LDAP directory .DESCRIPTION Find directory entries using the LDAP provider for ADSI (the WinNT provider does not support searching) Provides a wrapper around the [System.DirectoryServices.DirectorySearcher] class .INPUTS None. Pipeline input is not accepted. .OUTPUTS [System.DirectoryServices.DirectoryEntry] .EXAMPLE Search-Directory -Filter '' As the current user on a domain-joined computer, bind to the current domain and search for all directory entries matching the LDAP filter #> param ( <# Path to the directory object to retrieve Defaults to the root of the current domain #> [string]$DirectoryPath = (([adsisearcher]'').SearchRoot.Path), # Filter for the LDAP search [string]$Filter, # Number of records per page of results [int]$PageSize = 1000, # Additional properties to return [string[]]$PropertiesToLoad, # Credentials to use [pscredential]$Credential, # Scope of the search [string]$SearchScope = 'subtree', # Cache of CIM sessions and instances to reduce connections and queries [hashtable]$CimCache = ([hashtable]::Synchronized(@{})), <# Hashtable containing cached directory entries so they don't have to be retrieved from the directory again Uses a thread-safe hashtable by default #> [hashtable]$DirectoryEntryCache = ([hashtable]::Synchronized(@{})), [hashtable]$DomainsByNetbios = ([hashtable]::Synchronized(@{})), <# FQDN of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE and [System.Net.Dns]::GetHostByName() #> [string]$ThisFqdn = ([System.Net.Dns]::GetHostByName((HOSTNAME.EXE)).HostName), <# Hostname of the computer running this function. Can be provided as a string to avoid calls to HOSTNAME.EXE #> [string]$ThisHostName = (HOSTNAME.EXE), # Username to record in log messages (can be passed to Write-LogMsg as a parameter to avoid calling an external process) [string]$WhoAmI = (whoami.EXE), # Log messages which have not yet been written to disk [hashtable]$LogBuffer = ([hashtable]::Synchronized(@{})), # Output stream to send the log messages to [ValidateSet('Silent', 'Quiet', 'Success', 'Debug', 'Verbose', 'Output', 'Host', 'Warning', 'Error', 'Information', $null)] [string]$DebugOutputStream = 'Debug' ) $LogParams = @{ ThisHostname = $ThisHostname Type = $DebugOutputStream Buffer = $LogBuffer WhoAmI = $WhoAmI } $DirectoryEntryParameters = @{ DirectoryEntryCache = $DirectoryEntryCache DomainsByNetbios = $DomainsByNetbios ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI CimCache = $CimCache ThisFqdn = $ThisFqdn } if ($Credential) { $DirectoryEntryParameters['Credential'] = $Credential } if (($null -eq $DirectoryPath -or '' -eq $DirectoryPath)) { $CimParams = @{ CimCache = $CimCache ComputerName = $ThisFqdn DebugOutputStream = $DebugOutputStream ThisFqdn = $ThisFqdn } $LoggingParams = @{ ThisHostname = $ThisHostname LogBuffer = $LogBuffer WhoAmI = $WhoAmI } $Workgroup = (Get-CachedCimInstance -ClassName 'Win32_ComputerSystem' -KeyProperty Name @CimParams @LoggingParams).Workgroup $DirectoryPath = "WinNT://$Workgroup/$ThisHostname" } $DirectoryEntryParameters['DirectoryPath'] = $DirectoryPath $DirectoryEntry = Get-DirectoryEntry @DirectoryEntryParameters Write-LogMsg @LogParams -Text "`$DirectorySearcher = [System.DirectoryServices.DirectorySearcher]::new(([System.DirectoryServices.DirectoryEntry]::new('$DirectoryPath')))" $DirectorySearcher = [System.DirectoryServices.DirectorySearcher]::new($DirectoryEntry) if ($Filter) { Write-LogMsg @LogParams -Text "`$DirectorySearcher.Filter = '$Filter'" $DirectorySearcher.Filter = $Filter } Write-LogMsg @LogParams -Text "`$DirectorySearcher.PageSize = '$PageSize'" $DirectorySearcher.PageSize = $PageSize Write-LogMsg @LogParams -Text "`$DirectorySearcher.SearchScope = '$SearchScope'" $DirectorySearcher.SearchScope = $SearchScope ForEach ($Property in $PropertiesToLoad) { Write-LogMsg @LogParams -Text "`$DirectorySearcher.PropertiesToLoad.Add('$Property')" $null = $DirectorySearcher.PropertiesToLoad.Add($Property) } Write-LogMsg @LogParams -Text "`$DirectorySearcher.FindAll()" $SearchResultCollection = $DirectorySearcher.FindAll() # TODO: Fix this. Problems in integration testing trying to use the objects later if I dispose them here now. # Error: Cannot access a disposed object. #$null = $DirectorySearcher.Dispose() #$null = $DirectoryEntry.Dispose() $Output = [System.DirectoryServices.SearchResult[]]::new($SearchResultCollection.Count) $SearchResultCollection.CopyTo($Output, 0) #$null = $SearchResultCollection.Dispose() return $Output } <# # Add any custom C# classes as usable (exported) types $CSharpFiles = Get-ChildItem -Path "$PSScriptRoot\*.cs" ForEach ($ThisFile in $CSharpFiles) { Add-Type -Path $ThisFile.FullName -ErrorAction Stop } #> Export-ModuleMember -Function @('Add-DomainFqdnToLdapPath','Add-SidInfo','ConvertFrom-DirectoryEntry','ConvertFrom-IdentityReferenceResolved','ConvertFrom-PropertyValueCollectionToString','ConvertFrom-ResultPropertyValueCollectionToString','ConvertFrom-SearchResult','ConvertFrom-SidString','ConvertTo-DecStringRepresentation','ConvertTo-DistinguishedName','ConvertTo-DomainNetBIOS','ConvertTo-DomainSidString','ConvertTo-Fqdn','ConvertTo-HexStringRepresentation','ConvertTo-HexStringRepresentationForLDAPFilterString','ConvertTo-SidByteArray','Expand-AdsiGroupMember','Expand-WinNTGroupMember','Find-AdsiProvider','Find-LocalAdsiServerSid','Get-ADSIGroup','Get-ADSIGroupMember','Get-AdsiServer','Get-CurrentDomain','Get-DirectoryEntry','Get-ParentDomainDnsName','Get-TrustedDomain','Get-WinNTGroupMember','Invoke-ComObject','New-FakeDirectoryEntry','Resolve-IdentityReference','Search-Directory') |