functions/Test-DbaValidLogin.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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
Function Test-DbaValidLogin {
<#
.SYNOPSIS
Test-DbaValidLogin finds any logins on SQL instance that are AD logins with either disabled AD user accounts or ones that no longer exist
 
.DESCRIPTION
The purpose of this function is to find SQL Server logins that are used by active directory users that are either disabled or removed from the domain. It allows you to
keep your logins accurate and up to date by removing accounts that are no longer needed.
 
.PARAMETER SqlInstance
SQL instance to check. You must have sysadmin access and server version must be SQL Server version 2000 or greater.
 
.PARAMETER SqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted.
 
.PARAMETER Login
Filters the results to only the login you wish - this list is auto-populated from the server.
 
.PARAMETER ExcludeLogin
Excludes any login you pass into it from the results - this list is auto-populated from the server.
 
.PARAMETER FilterBy
By default the function returns both Logins and Groups. you can use the FilterBy parameter to only return Groups (GroupsOnly) or Logins (LoginsOnly)
 
.PARAMETER IgnoreDomains
By default we traverse all domains in the forest and all trusted domains. You can exclude domains by adding them to the IgnoreDomains
 
.PARAMETER Detailed
Returns a more detailed result, showing if the login on SQL Server is enabled or disabled and what type of account it is in AD
 
.PARAMETER Silent
Use this switch to disable any kind of verbose messages
 
.NOTES
Author: Stephen Bennett: https://sqlnotesfromtheunderground.wordpress.com/
Author: Chrissy LeMaire (@cl), netnerds.net
 
dWebsite: https://dbatools.io
Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
 
.LINK
https://dbatools.io/Test-DbaValidLogin
 
.EXAMPLE
Test-DbaValidLogin -SqlInstance Dev01
 
Tests all logins in the domain ran from (check $env:domain) that are either disabled or do not exist
 
.EXAMPLE
Test-DbaValidLogin -SqlInstance Dev01 -FilterBy GroupsOnly -Detailed
 
Tests all Active directory groups that have logins on Dev01 returning a detailed view.
 
.EXAMPLE
Test-DbaValidLogin -SqlInstance Dev01 -ExcludeDomains subdomain
 
Tests all logins excluding any that are from the subdomain Domain
 
#>

[CmdletBinding()]
Param (
[parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $true)]
[Alias("ServerInstance", "SqlServer", "SqlServers")]
[DbaInstanceParameter[]]$SqlInstance,
[PSCredential]
$SqlCredential,
[object[]]$Login,
[object[]]$ExcludeLogin,
[ValidateSet("LoginsOnly", "GroupsOnly")]
[string]$FilterBy = "None",
[string[]]$IgnoreDomains,
[switch]$Detailed,
[switch]$Silent
)

begin {
if ($IgnoreDomains) {
$IgnoreDomainsNormalized = $IgnoreDomains.toUpper()
Write-Message -Message ("Excluding logins for domains " + ($IgnoreDomains -join ',')) -Level Verbose
}
if ($Detailed) {
Write-Message -Message "Detailed is deprecated and will be removed in dbatools 1.0" -Once "DetailedDeprecation" -Level Warning
}

$MappingRaw = @{
'SCRIPT'                                 = 1
'ACCOUNTDISABLE'                         = 2
'HOMEDIR_REQUIRED'                       = 8
'LOCKOUT'                                = 16
'PASSWD_NOTREQD'                         = 32
'PASSWD_CANT_CHANGE'                     = 64
'ENCRYPTED_TEXT_PASSWORD_ALLOWED'        = 128
'TEMP_DUPLICATE_ACCOUNT'                 = 256
'NORMAL_ACCOUNT'                         = 512
'INTERDOMAIN_TRUST_ACCOUNT'              = 2048
'WORKSTATION_TRUST_ACCOUNT'              = 4096
'SERVER_TRUST_ACCOUNT'                   = 8192
'DONT_EXPIRE_PASSWD'                     = 65536
'MNS_LOGON_ACCOUNT'                      = 131072
'SMARTCARD_REQUIRED'                     = 262144
'TRUSTED_FOR_DELEGATION'                 = 524288
'NOT_DELEGATED'                          = 1048576
'USE_DES_KEY_ONLY'                       = 2097152
'DONT_REQUIRE_PREAUTH'                   = 4194304
'PASSWORD_EXPIRED'                       = 8388608
'TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION' = 16777216
'NO_AUTH_DATA_REQUIRED'                  = 33554432
'PARTIAL_SECRETS_ACCOUNT'                = 67108864
}
}
process {
foreach ($instance in $SqlInstance) {
try {
$server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $sqlcredential
Write-Message -Message "Connected to: $instance" -Level Verbose
}
catch {
Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
}


# we can only validate AD logins
$allwindowsloginsgroups = $server.Logins | Where-Object { $_.LoginType -in ('WindowsUser', 'WindowsGroup') }

# we cannot validate local users
$allwindowsloginsgroups = $allwindowsloginsgroups | Where-Object { $_.Name.StartsWith("NT ") -eq $false -and $_.Name.StartsWith($server.NetName) -eq $false -and $_.Name.StartsWith("BUILTIN") -eq $false }
if ($Login) {
$allwindowsloginsgroups = $allwindowsloginsgroups | Where-Object { $Login -contains $_.Name }
}
if ($ExcludeLogin) {
$allwindowsloginsgroups = $allwindowsloginsgroups | Where-Object { $ExcludeLogin -notcontains $_.Name }
}
switch ($FilterBy) {
"LoginsOnly" {
Write-Message -Message "Search restricted to logins" -Level Verbose
$windowslogins = $allwindowsloginsgroups | Where-Object { $_.LoginType -eq 'WindowsUser' }
}
"GroupsOnly" {
Write-Message -Message "Search restricted to groups" -Level Verbose
$windowsGroups = $allwindowsloginsgroups | Where-Object { $_.LoginType -eq 'WindowsGroup' }
}
"None" {
Write-Message -Message "Search both logins and groups" -Level Verbose
$windowslogins = $allwindowsloginsgroups | Where-Object { $_.LoginType -eq 'WindowsUser' }
$windowsGroups = $allwindowsloginsgroups | Where-Object { $_.LoginType -eq 'WindowsGroup' }
}
}
foreach ($login in $windowslogins) {
$adlogin = $login.Name
$loginsid = $login.Sid -join ''
$domain, $username = $adlogin.Split("\")
if ($domain.toUpper() -in $IgnoreDomainsNormalized) {
Write-Message -Message "Skipping Login $adlogin" -Level Verbose
continue
}
Write-Message -Message "Parsing Login $adlogin" -Level Verbose
$exists = $false
try {
$u = Get-DbaADObject -ADObject $adlogin -Type User -Silent
$founduser = $u.GetUnderlyingObject()
$foundsid = $founduser.objectSid.Value -join ''
if ($founduser) {
$exists = $true
}
if ($foundsid -ne $loginsid) {
Write-Message -Message "SID mismatch detected for $adlogin" -Level Warning
Write-Message -Message "SID mismatch detected for $adlogin (MSSQL: $loginsid, AD: $foundsid)" -Level Debug
$exists = $false
}
}
catch {
Write-Message -Message "AD Searcher Error for $username" -Level Warning
}

$UAC = $founduser.Properties.userAccountControl

$additionalProps = @{
AccountNotDelegated               = $null
AllowReversiblePasswordEncryption = $null
CannotChangePassword              = $null
PasswordExpired                   = $null
Lockedout                         = $null
Enabled                           = $null
PasswordNeverExpires              = $null
PasswordNotRequired               = $null
SmartcardLogonRequired            = $null
TrustedForDelegation              = $null
}
if ($UAC) {
$additionalProps = @{
AccountNotDelegated               = [bool]($UAC.Value -band $MappingRaw['NOT_DELEGATED'])
AllowReversiblePasswordEncryption = [bool]($UAC.Value -band $MappingRaw['ENCRYPTED_TEXT_PASSWORD_ALLOWED'])
CannotChangePassword              = [bool]($UAC.Value -band $MappingRaw['PASSWD_CANT_CHANGE'])
PasswordExpired                   = [bool]($UAC.Value -band $MappingRaw['PASSWORD_EXPIRED'])
Lockedout                         = [bool]($UAC.Value -band $MappingRaw['LOCKOUT'])
Enabled                           = !($UAC.Value -band $MappingRaw['ACCOUNTDISABLE'])
PasswordNeverExpires              = [bool]($UAC.Value -band $MappingRaw['DONT_EXPIRE_PASSWD'])
PasswordNotRequired               = [bool]($UAC.Value -band $MappingRaw['PASSWD_NOTREQD'])
SmartcardLogonRequired            = [bool]($UAC.Value -band $MappingRaw['SMARTCARD_REQUIRED'])
TrustedForDelegation              = [bool]($UAC.Value -band $MappingRaw['TRUSTED_FOR_DELEGATION'])
UserAccountControl                = $UAC.Value
}
}
$rtn = [PSCustomObject]@{
Server                            = $server.DomainInstanceName
Domain                            = $domain
Login                             = $username
Type                              = "User"
Found                             = $exists
DisabledInSQLServer               = $login.IsDisabled
AccountNotDelegated               = $additionalProps.AccountNotDelegated
AllowReversiblePasswordEncryption = $additionalProps.AllowReversiblePasswordEncryption
CannotChangePassword              = $additionalProps.CannotChangePassword
PasswordExpired                   = $additionalProps.PasswordExpired
Lockedout                         = $additionalProps.Lockedout
Enabled                           = $additionalProps.Enabled
PasswordNeverExpires              = $additionalProps.PasswordNeverExpires
PasswordNotRequired               = $additionalProps.PasswordNotRequired
SmartcardLogonRequired            = $additionalProps.SmartcardLogonRequired
TrustedForDelegation              = $additionalProps.TrustedForDelegation
UserAccountControl                = $additionalProps.UserAccountControl
}
if ($Detailed) {
Select-DefaultView -InputObject $rtn -ExcludeProperty UserAccountControl
}
else {
Select-DefaultView -InputObject $rtn -ExcludeProperty UserAccountControl, AccountNotDelegated, AllowReversiblePasswordEncryption, CannotChangePassword, PasswordNeverExpires, SmartcardLogonRequired, TrustedForDelegation
}

}

foreach ($login in $windowsGroups) {
$adlogin = $login.Name
$loginsid = $login.Sid -join ''
$domain, $groupname = $adlogin.Split("\")
if ($domain.toUpper() -in $IgnoreDomainsNormalized) {
Write-Message -Message "Skipping Login $adlogin" -Level Verbose
continue
}
Write-Message -Message "Parsing Login $adlogin on $server" -Level Verbose
$exists = $false
if ($true) {
$u = Get-DbaADObject -ADObject $adlogin -Type Group -Silent
$founduser = $u.GetUnderlyingObject()
if ($founduser) {
$exists = $true
}
$foundsid = $founduser.objectSid.Value -join ''
if ($foundsid -ne $loginsid) {
Write-Message -Message "SID mismatch detected for $adlogin" -Level Warning
Write-Message -Message "SID mismatch detected for $adlogin (MSSQL: $loginsid, AD: $foundsid)" -Level Debug
$exists = $false
}
}
else {
Write-Warning -Message "AD Searcher Error for $groupname on $server" -Level Warning
}
$rtn = [PSCustomObject]@{
Server                            = $server.DomainInstanceName
Domain                            = $domain
Login                             = $groupname
Type                              = "Group"
Found                             = $exists
DisabledInSQLServer               = $login.IsDisabled
AccountNotDelegated               = $null
AllowReversiblePasswordEncryption = $null
CannotChangePassword              = $null
PasswordExpired                   = $null
Lockedout                         = $null
Enabled                           = $null
PasswordNeverExpires              = $null
PasswordNotRequired               = $null
SmartcardLogonRequired            = $null
TrustedForDelegation              = $null
UserAccountControl                = $null
}
if ($Detailed) {
Select-DefaultView -InputObject $rtn -ExcludeProperty UserAccountControl
}
else {
Select-DefaultView -InputObject $rtn -ExcludeProperty UserAccountControl, AccountNotDelegated, AllowReversiblePasswordEncryption, CannotChangePassword, PasswordNeverExpires, SmartcardLogonRequired, TrustedForDelegation
}
}
}
}
}