Public/Test-ALHADGroupmembership.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
<#PSScriptInfo
.VERSION 1.1.0 .GUID 31231287-50ef-41f6-a780-411712bee2fe .AUTHOR Dieter Koch .COMPANYNAME .COPYRIGHT (c) 2021-2023 Dieter Koch .TAGS .LICENSEURI https://github.com/admins-little-helper/ALH/blob/main/LICENSE .PROJECTURI https://github.com/admins-little-helper/ALH .ICONURI .EXTERNALMODULEDEPENDENCIES .REQUIREDSCRIPTS .EXTERNALSCRIPTDEPENDENCIES .RELEASENOTES 1.0 Initial Release. 1.1.0 Made script accept values for paramter Identity from pipeline. #> <# .DESCRIPTION Contains function to test if a given user, group, computer or contact is member of a given Active Directory group. #> function Test-ALHADGroupmembership { <# .SYNOPSIS A PowerShell function to test if a given user, group, computer or contact is member of a given Active Directory group. .DESCRIPTION A PowerShell function to test if a given user, group, computer or contact is member of a given Active Directory group. The function returns a PSCustomObject showing some information about the object found in AD and true or false about memberhsip of the given group, in case it was found. .PARAMETER Identity The samAccountName of the AD object, for which group membership should be checked. .PARAMETER Group The samAccountName of the AD group, whose members will be checked. .PARAMETER SearchBase AD SearchBase. If omitted, the base DN will be set from current AD domain. .EXAMPLE Test-GroupMembership -Identity $env:USERNAME -Group "GroupA" Check, if the currently logged on user is member of a group named GroupA. .EXAMPLE Test-GroupMembership -Identity mike,john -Group "Group1" Check, if the users named mike and john are member of a group named Group1. .INPUTS nothing .OUTPUTS PSCustomObject .NOTES Author: Dieter Koch Email: diko@admins-little-helper.de .LINK https://github.com/admins-little-helper/ALH/blob/main/Help/Test-ALHADGroupmembership.txt #> [CmdletBinding()] param( [Parameter(ValueFromPipeline, HelpMessage = 'Enter one or more user names')] [ValidateNotNullOrEmpty()] [string[]] $Identity, [Parameter(Mandatory)] [string] $Group, [AllowEmptyString()] [string] $SearchBase, [switch] $Recurse ) begin { function Get-xADGroupMember { [CmdletBinding()] param( [Parameter(Mandatory = $true)] [string] $Group ) $SearchFilter = "(&(objectCategory=group)(samaccountname=$Group))" $Search = New-Object DirectoryServices.DirectorySearcher($SearchFilter) try { $Results = $Search.FindAll() $Results | Out-Null foreach ($member in $Results.Properties["Member"]) { Write-Verbose -Message "Checking if member is also a group: $member" $MemberSearchFilter = "(&(objectCategory=group)(distinguishedName=$member))" $MemberSearch = New-Object DirectoryServices.DirectorySearcher($MemberSearchFilter) try { $MemberResults = $MemberSearch.FindAll() $MemberResults | Out-Null } catch { Write-Verbose -Message "An unknown error occured" } if ($null -ne $MemberResults -and $MemberResults.Count -gt 0) { Write-Verbose -Message "Member is a group. Call function recursively." Get-xADGroupMember -Group $MemberResults.Properties["samAccountName"] } } $Results } catch { Write-Verbose -Message "An unknown error occured" } } [array]$GroupResults = Get-xADGroupMember -Group $Group if ($Recurse.IsPresent) { Write-Verbose -Message "Running recursivly..." $GroupResults += foreach ($member in $GroupResults.Properties["Member"]) { Write-Verbose -Message "Checking if member is also a group: $member" $MemberSearchFilter = "(&(objectCategory=group)(distinguishedName=$member))" $MemberSearch = New-Object DirectoryServices.DirectorySearcher($MemberSearchFilter) try { $MemberResults = $MemberSearch.FindAll() $MemberResults | Out-Null } catch { Write-Verbose -Message "An unknown error occured" } if ($null -ne $MemberResults -and $MemberResults.Count -gt 0) { Write-Verbose -Message "Member is a group. Call function recursively." Get-xADGroupMember -Group $MemberResults.Properties["samAccountName"] } } } } process { if ($null -ne $GroupResults -and $GroupResults.Count -gt 0) { foreach ($SingleIdentity in $Identity) { $samAccountName = $null $distinguishedName = $null $objectCategory = $null $IsMember = $null $MemberOfGroup = @() $ADObjectSearchFilter = "(|(&(objectCategory=computer)(samaccountname=$SingleIdentity`$))(&(objectCategory=person)(samaccountname=$SingleIdentity))(&(objectCategory=group)(samaccountname=$SingleIdentity)))" $ADObjectSearch = New-Object DirectoryServices.DirectorySearcher($ADObjectSearchFilter) try { $ADObjectResult = $ADObjectSearch.FindAll() $ADObjectResult | Out-Null } catch [System.Management.Automation.RuntimeException] { Write-Verbose -Message "Error occured" } catch [System.ArgumentException] { if ($_.Exception.InnerException.Message -eq "The $($ADObjectSearchFilter) search filter is invalid.") { Write-Verbose -Message "Search filter invalid. Most probably the given samAccountName was not found in AD for any user, computer or contact." } else { Write-Verbose -Message $_.Exception.InnerException.Message } } catch { Write-Verbose -Message "An unknown error occured" } if ($null -ne $ADObjectResult -and $ADObjectResult.Count -gt 0) { Write-Verbose -Message "AD object found: $($ADObjectResult.Properties["distinguishedName"])" $samAccountName = $ADObjectResult.Properties["samAccountName"][0] $distinguishedName = $ADObjectResult.Properties["distinguishedName"][0] $objectCategory = $ADObjectResult.Properties["objectCategory"][0] $BaseObject = $ADObjectResult foreach ($GroupResult in $GroupResults) { Write-Verbose -Message "Group found: $($GroupResult.Properties["distinguishedName"])" Write-Verbose -Message "Group member count: $($GroupResult.Properties["Member"].count)" if ($GroupResult.Properties["Member"] -contains $ADObjectResult.Properties["distinguishedName"]) { Write-Verbose -Message "AD object is member of group" $IsMember = $true $MemberOfGroup += $GroupResult.Properties["Name"] } else { if ($Group -eq "Domain Users") { Write-Warning -Message "You specified domain users group. This group is special because it's member attribute by default is empty. See https://ldapwiki.com/wiki/Domain%20Users for more information." } else { Write-Verbose -Message "AD object is NOT member of group" $IsMember = $false } } } } else { Write-Verbose -Message "No AD object found with samAccountName '$SingleIdentity'" } [PSCustomObject] @{ IdentitySeachString = $SingleIdentity samAccountName = $samAccountName distinguishedName = $distinguishedName objectCategory = $objectCategory Group = $Group IsMember = $IsMember MemberOfGroup = $MemberOfGroup BaseObject = $BaseObject } } } else { Write-Verbose -Message "No AD group found with samAccountName '$Group'" } } } #region EndOfScript <# ################################################################################ ################################################################################ # # ______ _ __ _____ _ _ # | ____| | | / _| / ____| (_) | | # | |__ _ __ __| | ___ | |_ | (___ ___ _ __ _ _ __ | |_ # | __| | '_ \ / _` | / _ \| _| \___ \ / __| '__| | '_ \| __| # | |____| | | | (_| | | (_) | | ____) | (__| | | | |_) | |_ # |______|_| |_|\__,_| \___/|_| |_____/ \___|_| |_| .__/ \__| # | | # |_| ################################################################################ ################################################################################ # created with help of http://patorjk.com/software/taag/ #> #endregion |