functions/Copy-SqlLogin.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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
Function Copy-SqlLogin
{
<#
.SYNOPSIS
Migrates logins from source to destination SQL Servers. Supports SQL Server versions 2000 and above.

.DESCRIPTION
SQL Server 2000: Migrates logins with SIDs, passwords, server roles and database roles.

SQL Server 2005 & above: Migrates logins with SIDs, passwords, defaultdb, server roles & securables,
database permissions & securables, login attributes (enforce password policy, expiration, etc)

The login hash algorithm changed in SQL Server 2012, and is not backwards compatible with previous SQL
versions. This means that while SQL Server 2000 logins can be migrated to SQL Server 2012, logins
created in SQL Server 2012 can only be migrated to SQL Server 2012 and above.

THIS CODE IS PROVIDED "AS IS", WITH NO WARRANTIES.

.PARAMETER Source
Source SQL Server.You must have sysadmin access and server version must be SQL Server version 2000 or greater.

.PARAMETER Destination
Destination SQL Server. You must have sysadmin access and server version must be SQL Server version 2000 or greater.

.PARAMETER SourceSqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:

$scred = Get-Credential, then pass $scred object to the -SourceSqlCredential parameter.

Windows Authentication will be used if DestinationSqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.     
To connect as a different Windows user, run PowerShell as that user.

.PARAMETER DestinationSqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:

$dcred = Get-Credential, then pass this $dcred to the -DestinationSqlCredential parameter.

Windows Authentication will be used if DestinationSqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.     
To connect as a different Windows user, run PowerShell as that user.

.PARAMETER Exclude
Excludes specified logins. This list is auto-populated for tab completion.

.PARAMETER Login
Migrates ONLY specified logins. This list is auto-populated for tab completion. Multiple logins allowed.

.PARAMETER SyncOnly
Syncs only SQL Server login permissions, roles, etc. Does not add or drop logins or users. If a matching login does not exist on the destination, the login will be skipped.
Credential removal not currently supported for Syncs. TODO: Application role sync

.PARAMETER OutFile
Calls Export-SqlLogin and exports all logins to a T-SQL formatted file. This does not perform a copy, so no destination is required.

.PARAMETER SyncSaName
Want to sync up the name of the sa account on the source and destination? Use this switch.
 
.PARAMETER Force
Force drops and recreates logins. Logins that own jobs cannot be dropped at this time.

.NOTES
Author: Chrissy LeMaire (@cl), netnerds.net
Requires: sysadmin access on SQL Servers

dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

.LINK
https://dbatools.io/Copy-SqlLogin

.EXAMPLE
Copy-SqlLogin -Source sqlserver2014a -Destination sqlcluster -Force

Copies all logins from source server to destination server. If a SQL login on source exists on the destination,
the destination login will be dropped and recreated.

.EXAMPLE
Copy-SqlLogin -Source sqlserver2014a -Destination sqlcluster -Exclude realcajun -SourceSqlCredential $scred -DestinationSqlCredential $dcred

Authenticates to SQL Servers using SQL Authentication.

Copies all logins except for realcajun. If a login already exists on the destination, the login will not be migrated.

.EXAMPLE
Copy-SqlLogin -Source sqlserver2014a -Destination sqlcluster -Login realcajun, netnerds -force

Copies ONLY logins netnerds and realcajun. If login realcajun or netnerds exists on the destination, they will be dropped and recreated.

.EXAMPLE
Copy-SqlLogin -Source sqlserver2014a -Destination sqlcluster -SyncOnly

Syncs only SQL Server login permissions, roles, etc. Does not add or drop logins or users. If a matching login does not exist on the destination, the login will be skipped.

.NOTES
Author: Chrissy LeMaire (@cl), netnerds.net
Requires: sysadmin access on SQL Servers
Limitations: Does not support Application Roles yet

#>

    
    [CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess = $true)]
    Param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [object]$Source,
        [parameter(ParameterSetName = "Live", Mandatory = $true)]
        [object]$Destination,
        [object]$SourceSqlCredential,
        [object]$DestinationSqlCredential,
        [switch]$SyncOnly,
        [parameter(ParameterSetName = "File", Mandatory = $true)]
        [string]$OutFile,
        [parameter(ParameterSetName = "Live")]
        [switch]$Force,
        [switch]$SyncSaName,
        [object]$pipelogin
    )
    
    DynamicParam { if ($source) { return Get-ParamSqlLogins -SqlServer $source -SqlCredential $SourceSqlCredential } }
    
    BEGIN
    {
        
        Function Copy-Login
        {
            foreach ($sourcelogin in $sourceserver.logins)
            {
                
                $username = $sourcelogin.name
                if ($Logins -ne $null -and $Logins -notcontains $username) { continue }
                if ($sourcelogin.id -eq 1) { continue }
                if ($Exclude -contains $username -or $username.StartsWith("##") -or $username -eq 'sa') { Write-Output "Skipping $username"; continue }
                $servername = Resolve-NetBiosName $sourceserver
                
                $currentlogin = $sourceserver.ConnectionContext.truelogin
                
                if ($currentlogin -eq $username -and $force)
                {
                    If ($Pscmdlet.ShouldProcess("console", "Stating $username is skipped because it is performing the migration."))
                    {
                        Write-Warning "Cannot drop login performing the migration. Skipping"
                    }
                    continue
                }
                
                $userbase = ($username.Split("\")[0]).ToLower()
                if ($servername -eq $userbase -or $username.StartsWith("NT "))
                {
                    If ($Pscmdlet.ShouldProcess("console", "Stating $username is skipped because it is a local machine name."))
                    {
                        Write-Output "$username is skipped because it is a local machine name."
                    }
                    continue
                }
                
                if (($login = $destserver.Logins.Item($username)) -ne $null -and !$force)
                {
                    If ($Pscmdlet.ShouldProcess("console", "Stating $username is skipped because it exists at destination."))
                    {
                        Write-Output "$username already exists in destination. Use -force to drop and recreate."
                    }
                    continue
                }
                
                if ($login -ne $null -and $force)
                {
                    if ($username -eq $destserver.ServiceAccount)
                    {
                        Write-Warning "$username is the destination service account. Skipping drop."
                        continue
                    }
                    
                    If ($Pscmdlet.ShouldProcess($destination, "Dropping $username"))
                    {
                        # Kill connections, delete user
                        Write-Output "Attempting to migrate $username"
                        Write-Output "Force was specified. Attempting to drop $username on $destination"
                        try
                        {
                            $destserver.EnumProcesses() | Where { $_.Login -eq $username } | ForEach-Object { $destserver.KillProcess($_.spid) }
                            
                            $owneddbs = $destserver.Databases | Where { $_.Owner -eq $username }
                            
                            foreach ($owneddb in $owneddbs)
                            {
                                Write-Output "Changing database owner for $($owneddb.name) from $username to sa"
                                $owneddb.SetOwner('sa')
                                $owneddb.Alter()
                            }
                            
                            $ownedjobs = $destserver.JobServer.Jobs | Where { $_.OwnerLoginName -eq $username }
                            
                            foreach ($ownedjob in $ownedjobs)
                            {
                                Write-Output "Changing job owner for $($ownedjob.name) from $username to sa"
                                $ownedjob.set_OwnerLoginName('sa')
                                $ownedjob.Alter()
                            }
                            
                            $login.drop()
                            Write-Output "Successfully dropped $username on $destination"
                        }
                        catch
                        {
                            $ex = $_.Exception.Message
                            if ($ex -ne $null) { $ex.trim() }
                            Write-Error "Could not drop $username`: $ex"
                            Write-Exception $_
                            continue
                        }
                    }
                }
                
                If ($Pscmdlet.ShouldProcess($destination, "Adding SQL login $username"))
                {
                    Write-Output "Attempting to add $username to $destination"
                    $destlogin = New-Object Microsoft.SqlServer.Management.Smo.Login($destserver, $username)
                    Write-Output "Setting $username SID to source username SID"
                    $destlogin.set_Sid($sourcelogin.get_Sid())
                    
                    $defaultdb = $sourcelogin.DefaultDatabase
                    Write-Output "Setting login language to $($sourcelogin.Language)"
                    $destlogin.Language = $sourcelogin.Language
                    
                    if ($destserver.databases[$defaultdb] -eq $null)
                    {
                        Write-Warning "$defaultdb does not exist on destination. Setting defaultdb to master."
                        $defaultdb = "master"
                    }
                    Write-Output "Set $username defaultdb to $defaultdb"
                    $destlogin.DefaultDatabase = $defaultdb
                    
                    $checkexpiration = "ON"; $checkpolicy = "ON"
                    if ($sourcelogin.PasswordPolicyEnforced -eq $false) { $checkpolicy = "OFF" }
                    if (!$sourcelogin.PasswordExpirationEnabled) { $checkexpiration = "OFF" }
                    
                    $destlogin.PasswordPolicyEnforced = $sourcelogin.PasswordPolicyEnforced
                    $destlogin.PasswordExpirationEnabled = $sourcelogin.PasswordExpirationEnabled
                    
                    # Attempt to add SQL Login User
                    if ($sourcelogin.LoginType -eq "SqlLogin")
                    {
                        $destlogin.LoginType = "SqlLogin"
                        $sourceloginname = $sourcelogin.name
                        
                        switch ($sourceserver.versionMajor)
                        {
                            0 { $sql = "SELECT convert(varbinary(256),password) as hashedpass FROM master.dbo.syslogins WHERE loginname='$sourceloginname'" }
                            8 { $sql = "SELECT convert(varbinary(256),password) as hashedpass FROM dbo.syslogins WHERE name='$sourceloginname'" }
                            9 { $sql = "SELECT convert(varbinary(256),password_hash) as hashedpass FROM sys.sql_logins where name='$sourceloginname'" }
                            default
                            {
                                $sql = "SELECT CAST(CONVERT(varchar(256), CAST(LOGINPROPERTY(name,'PasswordHash')
      AS varbinary (256)), 1) AS nvarchar(max)) as hashedpass FROM sys.server_principals
      WHERE principal_id = $($sourcelogin.id)"

                            }
                        }
                        
                        try { $hashedpass = $sourceserver.ConnectionContext.ExecuteScalar($sql) }
                        catch
                        {
                            $hashedpassdt = $sourceserver.databases['master'].ExecuteWithResults($sql)
                            $hashedpass = $hashedpassdt.Tables[0].Rows[0].Item(0)
                        }
                        
                        if ($hashedpass.gettype().name -ne "String")
                        {
                            $passtring = "0x"; $hashedpass | % { $passtring += ("{0:X}" -f $_).PadLeft(2, "0") }
                            $hashedpass = $passtring
                        }
                        
                        try
                        {
                            $destlogin.Create($hashedpass, [Microsoft.SqlServer.Management.Smo.LoginCreateOptions]::IsHashed)
                            $destlogin.refresh()
                            Write-Output "Successfully added $username to $destination"
                        }
                        catch
                        {
                            try
                            {
                                $sid = "0x"; $sourcelogin.sid | % { $sid += ("{0:X}" -f $_).PadLeft(2, "0") }
                                $sqlfailsafe = "CREATE LOGIN [$username] WITH PASSWORD = $hashedpass HASHED, SID = $sid,
            DEFAULT_DATABASE = [$defaultdb], CHECK_POLICY = $checkpolicy,
            CHECK_EXPIRATION = $checkexpiration, DEFAULT_LANGUAGE = [$language]"

                                
                                $null = $destserver.ConnectionContext.ExecuteNonQuery($sqlfailsafe)
                                $destlogin = $destserver.logins[$username]
                                Write-Output "Successfully added $username to $destination"
                            }
                            catch
                            {
                                Write-Warning "Failed to add $username to $destination`: $_"
                                Write-Exception $_
                                continue
                            }
                        }
                    }
                    # Attempt to add Windows User
                    elseif ($sourcelogin.LoginType -eq "WindowsUser" -or $sourcelogin.LoginType -eq "WindowsGroup")
                    {
                        Write-Output "Adding as login type $($sourcelogin.LoginType)"
                        $destlogin.LoginType = $sourcelogin.LoginType
                        Write-Output "Setting language as $($sourcelogin.Language)"
                        $destlogin.Language = $sourcelogin.Language
                        
                        try
                        {
                            $destlogin.Create()
                            $destlogin.Refresh()
                            Write-Output "Successfully added $username to $destination"
                        }
                        catch
                        {
                            Write-Warning "Failed to add $username to $destination"
                            Write-Exception $_
                            continue
                        }
                    }
                    
                    # This script does not currently support certificate mapped or asymmetric key users.
                    else
                    {
                        Write-Warning "$($sourcelogin.LoginType) logins not supported. $($sourcelogin.name) skipped."
                        continue
                    }
                    
                    if ($sourcelogin.IsDisabled)
                    {
                        try { $destlogin.Disable() }
                        catch { Write-Warning "$username disabled on source, but could not be disabled on destination."; Write-Exception $_ }
                    }
                    if ($sourcelogin.DenyWindowsLogin)
                    {
                        try { $destlogin.DenyWindowsLogin = $true }
                        catch { Write-Warning "$username denied login on source, but could not be denied login on destination."; Write-Exception $_ }
                    }
                }
                If ($Pscmdlet.ShouldProcess($destination, "Updating SQL login $username permissions"))
                {
                    Update-SqlPermissions -sourceserver $sourceserver -sourcelogin $sourcelogin -destserver $destserver -destlogin $destlogin
                }
            }
        }
        
        Write-Output "Attempting to connect to SQL Servers.."
        $sourceserver = Connect-SqlServer -SqlServer $Source -SqlCredential $SourceSqlCredential
        $source = $sourceserver.DomainInstanceName
        
        if ($Destination.length -gt 0)
        {
            $destserver = Connect-SqlServer -SqlServer $Destination -SqlCredential $DestinationSqlCredential
            $destination = $destserver.DomainInstanceName
            
            if ($sourceserver.versionMajor -gt 10 -and $destserver.versionMajor -lt 11)
            {
                throw "SQL login migration from SQL Server version $($sourceserver.versionMajor) to $($destserver.versionMajor) not supported. Halting."
            }
            
            if ($sourceserver.versionMajor -lt 8 -or $destserver.versionMajor -lt 8) { throw "SQL Server 7 and below not supported. Quitting." }
        }
        
        $elapsed = [System.Diagnostics.Stopwatch]::StartNew()
        $started = Get-Date
        
        If ($Pscmdlet.ShouldProcess("console", "Showing time started message"))
        {
            Write-Output "Migration started: $started"
        }
        
        # Convert from RuntimeDefinedParameter object to regular array
        $Logins = $psboundparameters.Logins
        $Exclude = $psboundparameters.Exclude
        
        if ($Logins.length -eq 0)
        {
            $Logins = $sourceserver.logins.name
        }
        
        if ($psboundparameters.Logins -gt 0)
        {
            $loginparms += @{ 'Logins' = $logins }
        }
        
        if ($psboundparameters.Exclude -gt 0)
        {
            $loginparms += @{ 'Exclude' = $exclude }
        }
        
        return $serverparms
    }
    
    PROCESS
    {
        if ($pipelogin.Length -gt 0)
        {
            $Source = $pipelogin[0].parent.name
            $logins = $pipelogin.name
        }
        
        if ($SyncOnly)
        {
            Sync-SqlLoginPermissions -Source $Source -Destination $Destination $loginparms
            return
        }
        
        if ($OutFile)
        {
            Export-SqlLogin -SqlServer $source -FilePath $OutFile $loginparms
            return
        }
        
        If ($Pscmdlet.ShouldProcess("console", "Showing migration attempt message"))
        {
            Write-Output "Attempting Login Migration"
        }
        
        Copy-Login -sourceserver $sourceserver -destserver $destserver -Logins $Logins -Exclude $Exclude -Force $force
        
        $sa = $sourceserver.Logins | Where-Object { $_.id -eq 1 }
        $destsa = $destserver.Logins | Where-Object { $_.id -eq 1 }
        $saname = $sa.name
        
        if ($saname -ne $destsa.name -and $SyncSaName -eq $true)
        {
            Write-Output "Changing sa username to match source ($saname)"
            If ($Pscmdlet.ShouldProcess($destination, "Changing sa username to match source ($saname)"))
            {
                $destsa.Rename($saname)
                $destsa.alter()
            }
        }
    }
    
    END
    {
        
        If ($Pscmdlet.ShouldProcess("console", "Showing time elapsed message"))
        {
            Write-Output "Login migration completed: $(Get-Date)"
            $totaltime = ($elapsed.Elapsed.toString().Split(".")[0])
            $sourceserver.ConnectionContext.Disconnect()
            
            if ($Destination.length -gt 0)
            {
                $destserver.ConnectionContext.Disconnect()
            }
            
            Write-Output "Total elapsed time: $totaltime"
        }
    }
}