functions/datamasking/Invoke-PSDCDataMasking.ps1
|
function Invoke-PSDCDataMasking { <# .SYNOPSIS Invoke-PSDCDataMasking generates random data for tables .DESCRIPTION Invoke-PSDCDataMasking is able to generate random data for tables. It will use a configuration file that can be made manually or generated using New-PSDCMaskingConfiguration .PARAMETER SqlInstance SQL Server name or SMO object representing the SQL Server to connect to. This will be where the database is currently located .PARAMETER SqlCredential 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 -SqlCredential parameter. Windows Authentication will be used if SqlCredential 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 Credential Allows you to login to servers or folders To use: $scred = Get-Credential, then pass $scred object to the -Credential parameter. .PARAMETER Database Databases to process through .PARAMETER Table Tables to process. By default all the tables will be processed .PARAMETER Column Columns to process. By default all the columns will be processed .PARAMETER FilePath Configuration file that contains the which tables and columns need to be masked .PARAMETER Locale Set the local to enable certain settings in the masking .PARAMETER Force Forcefully execute commands when needed .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .NOTES Author: Sander Stad (@sqlstad, sqlstad.nl) Website: https://psdatabaseclone.org Copyright: (C) Sander Stad, sander@sqlstad.nl License: MIT https://opensource.org/licenses/MIT .LINK https://psdatabaseclone.org/ .EXAMPLE Invoke-PSDCDataMasking -SqlInstance SQLDB1 -Database DB1 -FilePath C:\Temp\DB1.tables.json Apply the data masking configuration from the file "DB1.tables.json" to the database #> [CmdLetBinding()] [OutputType('System.String')] param( [parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [object]$SqlInstance, [System.Management.Automation.PSCredential] $SqlCredential, [System.Management.Automation.PSCredential] $Credential, [parameter(Mandatory = $true)] [string[]]$Database, [parameter(Mandatory = $true)] [Alias('Path', 'FullName')] [object]$FilePath, [string]$Locale = 'en', [switch]$Force, [switch]$EnableException ) begin { # Try connecting to the instance Write-PSFMessage -Message "Attempting to connect to Sql Server $SqlInstance.." -Level Verbose try { $server = Connect-DbaInstance -SqlInstance $SqlInstance -SqlCredential $SqlCredential } catch { Stop-PSFFunction -Message "Could not connect to Sql Server instance $SqlInstance" -ErrorRecord $_ -Target $SqlInstance return } # Check if the destination is accessible if (-not (Test-Path -Path $FilePath -Credential $Credential)) { Stop-PSFFunction -Message "Could not find masking config file" -ErrorRecord $_ -Target $MaskingConfigFile return } # Get all the items that should be processed [array]$tables = Get-Content -Path $FilePath -Credential $Credential | ConvertFrom-Json # Set defaults $charString = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789' # Create the faker objects $faker = New-Object Bogus.Faker($Locale) } process { if (Test-PSFFunctionInterrupt) { return } # Get all the items that should be processed try { $tables = Get-Content -Path $FilePath -Credential $Credential -ErrorAction Stop | ConvertFrom-Json -ErrorAction Stop } catch { Stop-PSFFunction -Message "Could not parse masking config file" -ErrorRecord $_ -Target $FilePath return } foreach ($instance in $SqlInstance) { try { $server = Connect-DbaInstance -SqlInstance $instance -SqlCredential $SqlCredential } catch { Stop-PSFFunction -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue } foreach ($db in (Get-DbaDatabase -SqlInstance $server -Database $Database)) { foreach ($table in $tables.Tables) { if ($table.Name -in $db.Tables.Name) { try { $query = "SELECT * FROM [$($table.Schema)].[$($table.Name)]" $data = $db.Query($query) | ConvertTo-DbaDataTable } catch { Stop-PSFFunction -Message "Something went wrong retrieving the data from table $($table.Name)" -Target $Database } # Loop through each of the rows and change them foreach ($row in $data.Rows) { $updates = $wheres = @() # Loop thorough the columns foreach ($column in $table.Columns) { $newValue = switch ($column.MaskingType.ToLower()) { { $_ -in 'name', 'address', 'finance' } { $faker.$($column.MaskingType).$($column.SubType)() } { $_ -in 'date', 'datetime', 'datetime2', 'smalldatetime' } { ($faker.Date.Past()).ToString("yyyyMMdd") } "number" { $faker.$($column.MaskingType).$($column.SubType)($column.MaxLength) } "shuffle" { ($row.($column.Name) -split '' | Sort-Object { Get-Random }) -join '' } "string" { $faker.$($column.MaskingType).String2($column.MaxLength, $charString) } default { if (-not $column.MaxLength) { $column.MaxLength = 10 } if ($column.ColumnType -in 'date', 'datetime', 'datetime2', 'smalldatetime') { ($faker.Date.Past()).ToString("yyyyMMdd") } else { $faker.Random.String2(1, $column.MaxLength, $charString) } } } $oldValue = ($row.$($column.Name)).Tostring().Replace("'", "''") $newValue = ($newValue).Tostring().Replace("'", "''") $updates += "[$($column.Name)] = '$newValue'" $wheres += "[$($column.Name)] = '$oldValue'" } $updatequery = "UPDATE [$($table.Schema)].[$($table.Name)] SET $($updates -join ', ') WHERE $($wheres -join ' AND ')" try { Write-PSFMessage -Level Debug -Message $updatequery $db.Query($updatequery) [pscustomobject]@{ SqlInstance = $db.Parent.Name Database = $db.Name Schema = $table.Schema Table = $table.Name Query = $updatequery Status = "Success" } } catch { Stop-PSFFunction -Message "Could not execute the query: $updatequery" -Target $updatequery -Continue } } } else { Stop-PSFFunction -Message "Table $($table.Name) is not present" -Target $Database -Continue } } } } } } |