functions/New-DbaDbMaskingConfig.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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
function New-DbaDbMaskingConfig {
    <#
    .SYNOPSIS
        Generates a new data masking configuration file to be used with Invoke-DbaDbDataMasking
 
    .DESCRIPTION
        Generates a new data masking configuration file. This file is important to apply any data masking to the data in a database.
 
        Note that the following column and data types are not currently supported:
        Identity
        ForeignKey
        Computed
        Hierarchyid
        Geography
        Geometry
        Xml
 
        Read more here:
        https://sachabarbs.wordpress.com/2018/06/11/bogus-simple-fake-data-tool/
        https://github.com/bchavez/Bogus
 
    .PARAMETER SqlInstance
        The target SQL Server instance or instances.
 
    .PARAMETER SqlCredential
        Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential)
 
    .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 Path
        Path where to save the generated JSON files.
        Th naming convention will be "servername.databasename.tables.json"
 
    .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
        Tags: DataMasking, Database
        Author: Sander Stad (@sqlstad, sqlstad.nl) | Chrissy LeMaire (@cl, netnerds.net)
 
        Website: https://dbatools.io
        Copyright: (c) 2018 by dbatools, licensed under MIT
        License: MIT https://opensource.org/licenses/MIT
 
    .LINK
        https://dbatools.io/New-DbaDbMaskingConfig
 
    .EXAMPLE
        New-DbaDbMaskingConfig -SqlInstance SQLDB1 -Database DB1 -Path C:\Temp\clone
 
        Process all tables and columns for database DB1 on instance SQLDB1
 
    .EXAMPLE
        New-DbaDbMaskingConfig -SqlInstance SQLDB1 -Database DB1 -Table Customer -Path C:\Temp\clone
 
        Process only table Customer with all the columns
 
    .EXAMPLE
        New-DbaDbMaskingConfig -SqlInstance SQLDB1 -Database DB1 -Table Customer -Column City -Path C:\Temp\clone
 
        Process only table Customer and only the column named "City"
 
    #>

    [CmdLetBinding()]
    param (
        [parameter(Mandatory)]
        [DbaInstanceParameter[]]$SqlInstance,
        [PSCredential]$SqlCredential,
        [string[]]$Database,
        [string[]]$Table,
        [string[]]$Column,
        [parameter(Mandatory)]
        [string]$Path,
        [string]$Locale = 'en',
        [switch]$Force,
        [switch]$EnableException
    )
    begin {

        # Get all the different column types
        try {
            $columnTypes = Get-Content -Path "$script:PSModuleRoot\bin\datamasking\columntypes.json" | ConvertFrom-Json
        } catch {
            Stop-Function -Message "Something went wrong importing the column types" -ErrorRecord $_ -Continue
        }
        # Check if the Path is accessible
        if (-not (Test-Path -Path $Path)) {
            try {
                $null = New-Item -Path $Path -ItemType Directory -Force:$Force
            } catch {
                Stop-Function -Message "Could not create Path directory" -ErrorRecord $_ -Target $Path
            }
        } else {
            if ((Get-Item $path) -isnot [System.IO.DirectoryInfo]) {
                Stop-Function -Message "$Path is not a directory"
            }
        }

        $supportedDataTypes = 'bit', 'bool', 'char', 'date', 'datetime', 'datetime2', 'decimal', 'int', 'money', 'nchar', 'ntext', 'nvarchar', 'smalldatetime', 'text', 'time', 'uniqueidentifier', 'userdefineddatatype', 'varchar'
    }

    process {
        if (Test-FunctionInterrupt) {
            return
        }

        if ($SqlInstance) {
            $InputObject += Get-DbaDatabase -SqlInstance $SqlInstance -SqlCredential $SqlCredential -Database $Database
        }

        $results = @()
        foreach ($db in $InputObject) {
            $server = $db.Parent
            $tables = @()

            # Get the tables
            if ($Table) {
                $tablecollection = $db.Tables | Where-Object Name -in $Table
            } else {
                $tablecollection = $db.Tables
            }

            if ($tablecollection.Count -lt 1) {
                Stop-Function -Message "The database does not contain any tables" -Target $db -Continue
            }

            # Loop through the tables
            foreach ($tableobject in $tablecollection) {
                Write-Message -Message "Processing table $($tableobject.Name)" -Level Verbose

                $hasUniqueIndex = $false

                if ($tableobject.Indexes.IsUnique) {
                    $hasUniqueIndex = $true
                }

                $columns = @()

                # Get the columns
                if ($Column) {
                    [array]$columncollection = $tableobject.Columns | Where-Object Name -in $Column
                } else {
                    [array]$columncollection = $tableobject.Columns
                }

                foreach ($columnobject in $columncollection) {
                    # Skip incompatible columns
                    if ($columnobject.Identity) {
                        Write-Message -Level Verbose -Message "Skipping $columnobject because it is an identity column"
                        continue
                    }

                    if ($columnobject.IsForeignKey) {
                        Write-Message -Level Verbose -Message "Skipping $columnobject because it is a foreign key"
                        continue
                    }

                    if ($columnobject.Computed) {
                        Write-Message -Level Verbose -Message "Skipping $columnobject because it is a computed column"
                        continue
                    }

                    if ($server.VersionMajor -ge 13 -and $columnobject.GeneratedAlwaysType -ne 'None') {
                        Write-Message -Level Verbose -Message "Skipping $columnobject because it is a computed column for temporal tables"
                        continue
                    }

                    if ($columnobject.DataType.Name -notin $supportedDataTypes) {
                        Write-Message -Level Verbose -Message "Skipping $columnobject because it is not a supported data type"
                        continue
                    }

                    if ($columnobject.DataType.SqlDataType.ToString().ToLower() -eq 'xml') {
                        Write-Message -Level Verbose -Message "Skipping $columnobject because it is a xml column"
                        continue
                    }

                    $maskingType = $min = $null
                    $columnLength = $columnobject.Datatype.MaximumLength
                    $columnType = $columnobject.DataType.SqlDataType.ToString().ToLower()

                    if ($columnobject.InPrimaryKey -and $columnobject.DataType.SqlDataType.ToString().ToLower() -notmatch 'date') {
                        $min = 2
                    }
                    if (-not $columnType) {
                        $columnType = $columnobject.DataType.Name.ToLower()
                    }

                    # Get the masking type with the synonym
                    $maskingType = $columnTypes | Where-Object {
                        $columnobject.Name -in $_.Synonym
                    }

                    if ($maskingType) {
                        # Make it easier to get the type name
                        $maskingType = $maskingType | Select-Object TypeName -ExpandProperty TypeName

                        switch ($maskingType.ToLower()) {
                            "address" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Address"
                                    SubType         = "StreetAddress"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "bic" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Finance"
                                    SubType         = "Bic"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "bitcoin" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Finance"
                                    SubType         = "BitcoinAddress"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "country" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Address"
                                    SubType         = "Country"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "countrycode" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Address"
                                    SubType         = "CountryCode"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "ethereum" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Finance"
                                    SubType         = "EthereumAddress"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "city" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Address"
                                    SubType         = "City"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "creditcardcvv" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Finance"
                                    SubType         = "CreditCardCvv"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "company" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Company"
                                    SubType         = "CompanyName"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "creditcard" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Finance"
                                    SubType         = "CreditcardNumber"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "email" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Internet"
                                    SubType         = "Email"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "firstname" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Name"
                                    SubType         = "Firstname"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "fullname" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Name"
                                    SubType         = "FullName"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "iban" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Finance"
                                    SubType         = "Iban"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "lastname" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Name"
                                    SubType         = "Lastname"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "latitude" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Address"
                                    SubType         = "Latitude"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "longitude" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Address"
                                    SubType         = "Longitude"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "phone" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Phone"
                                    SubType         = "PhoneNumber"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "state" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Address"
                                    SubType         = "State"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "stateabbr" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Address"
                                    SubType         = "StateAbbr"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "zipcode" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Address"
                                    SubType         = "Zipcode"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                            "username" {
                                $columns += [PSCustomObject]@{
                                    Name            = $columnobject.Name
                                    ColumnType      = $columnType
                                    CharacterString = $null
                                    MinValue        = $min
                                    MaxValue        = $columnLength
                                    MaskingType     = "Internet"
                                    SubType         = "UserName"
                                    Format          = $null
                                    Deterministic   = $false
                                    Nullable        = $columnobject.Nullable
                                }
                            }
                        }
                    } else {
                        $type = "Random"

                        switch ($columnType) {
                            {
                                $_ -in "bit", "bool"
                            } {
                                $subType = "Bool"
                                $MaxValue = $null
                            }
                            "bigint" {
                                $subType = "Number"
                                $MaxValue = 9223372036854775807
                            }
                            "int" {
                                $subType = "Number"
                                $MaxValue = 2147483647
                            }
                            "date" {
                                $subType = "Date"
                                $MaxValue = $null
                            }
                            "datetime" {
                                $subType = "Date"
                                $MaxValue = $null
                            }
                            "datetime2" {
                                $subType = "Date"
                                $MaxValue = $null
                            }
                            "decimal" {
                                $subType = "Decimal"
                                $MaxValue = $null
                            }
                            "float" {
                                $subType = "Float"
                                $MaxValue = $null
                            }
                            "money" {
                                $type = "Commerce"
                                $subType = "Price"
                                $min = -922337203685477.5808
                                $MaxValue = 922337203685477.5807
                            }
                            "smallint" {
                                $subType = "Number"
                                $MaxValue = 32767
                            }
                            "smalldatetime" {
                                $subType = "Date"
                                $MaxValue = $null
                            }
                            "text" {
                                $subType = "String"
                                $maxValue = 2147483647
                            }
                            "tinyint" {
                                $subType = "Number"
                                $MaxValue = 255
                            }
                            "varbinary" {
                                $subType = "Byte"
                                $MaxValue = $columnLength
                            }
                            "userdefineddatatype" {
                                if ($columnLength -eq 1) {
                                    $subType = "Bool"
                                    $MaxValue = $columnLength
                                } else {
                                    $subType = "String"
                                    $MaxValue = $columnLength
                                }
                            }
                            default {
                                $subType = "String"
                                $MaxValue = $columnLength
                            }
                        }

                        $columns += [PSCustomObject]@{
                            Name            = $columnobject.Name
                            ColumnType      = $columnType
                            CharacterString = $null
                            MinValue        = $min
                            MaxValue        = $MaxValue
                            MaskingType     = $type
                            SubType         = $subType
                            Format          = $null
                            Deterministic   = $false
                            Nullable        = $columnobject.Nullable
                        }
                    }
                }


                # Check if something needs to be generated
                if ($columns) {
                    $tables += [PSCustomObject]@{
                        Name           = $tableobject.Name
                        Schema         = $tableobject.Schema
                        Columns        = $columns
                        HasUniqueIndex = $hasUniqueIndex
                    }
                } else {
                    Write-Message -Message "No columns match for masking in table $($tableobject.Name)" -Level Verbose
                }
            }

            # Check if something needs to be generated
            if ($tables) {
                $results += [PSCustomObject]@{
                    Name   = $db.Name
                    Tables = $tables
                }
            } else {
                Write-Message -Message "No columns match for masking in table $($tableobject.Name)" -Level Verbose
            }
        }

        # Write the data to the Path
        if ($results) {
            try {
                $filenamepart = $server.Name.Replace('\', '$').Replace('TCP:', '').Replace(',', '.')
                $temppath = "$Path\$($filenamepart).$($db.Name).tables.json"

                if (-not $script:isWindows) {
                    $temppath = $temppath.Replace("\", "/")
                }
                Set-Content -Path $temppath -Value ($results | ConvertTo-Json -Depth 5)
                Get-ChildItem -Path $temppath
            } catch {
                Stop-Function -Message "Something went wrong writing the results to the $Path" -Target $Path -Continue -ErrorRecord $_
            }
        } else {
            Write-Message -Message "No tables to save for database $($db.Name) on $($server.Name)" -Level Verbose
        }
    }
}