DSCResources/DSC_AdcsCertificationAuthoritySettings/DSC_AdcsCertificationAuthoritySettings.psm1

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
#Requires -Version 5.0

$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'

# Import the ADCS Deployment Resource Common Module.
Import-Module -Name (Join-Path -Path $modulePath `
        -ChildPath (Join-Path -Path 'ActiveDirectoryCSDsc.Common' `
            -ChildPath 'ActiveDirectoryCSDsc.Common.psm1'))

Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')

# Import Localization Strings.
$script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'

<#
    This is an array of all the parameters used by this resource.
    The CurrentValue, NewValue and MockedValue properties are only used by
    tests but are stored here so that a duplicate table does not have
    to be created.
#>

$script:parameterList = Import-LocalizedData `
    -BaseDirectory $PSScriptRoot `
    -FileName 'DSC_AdcsCertificationAuthoritySettings.data.psd1'

# A flags enum containing the Certificate Authority audit filter flags
[flags()]
enum CertificateAuthorityAuditFilter
{
    StartAndStopADCS = 1
    BackupAndRestoreCADatabase = 2
    IssueAndManageCertificateRequests = 4
    RevokeCertificatesAndPublishCRLs = 8
    ChangeCASecuritySettings = 16
    StoreAndRetrieveArchivedKeys = 32
    ChangeCAConfiguration = 64
}

<#
    This it the registry settings path that Certificate Authority settings
    can be found.
#>

$script:certificateAuthorityRegistrySettingsPath = 'HKLM:\System\CurrentControlSet\Services\CertSvc\Configuration'

<#
    .SYNOPSIS
        Returns an object containing the current state information for the Active Directory
        Certificate Authority settings.
 
    .PARAMETER IsSingleInstance
        Specifies the resource is a single instance, the value must be 'Yes'.
 
    .OUTPUTS
        Returns an object containing the Active Directory Certificate Authority Settings.
#>

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet('Yes')]
        [System.String]
        $IsSingleInstance
    )

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($script:localizedData.GettingAdcsCaSettingsMessage)
        ) -join '' )

    $currentcertificateAuthoritySettings = Get-CertificateAuthoritySettings

    # Generate the return object
    $returnValue = @{
        IsSingleInstance = 'Yes'
    }

    # Loop through each of the parameters and add it to the return object
    foreach ($parameter in $script:parameterList.GetEnumerator())
    {
        switch ($parameter.Value.Type)
        {
            'String[]'
            {
                if ($null -ne $currentcertificateAuthoritySettings.$($parameter.Name))
                {
                    $parameterValue = $currentcertificateAuthoritySettings.$($parameter.Name) -split '\\n'
                }
                else
                {
                    $parameterValue = [System.String[]] @()
                }
                break
            }

            'Flags'
            {
                if ($null -ne $currentcertificateAuthoritySettings.AuditFilter)
                {
                    $parameterValue = [System.String[]] (Convert-AuditFilterToStringArray `
                        -AuditFilter $currentcertificateAuthoritySettings.AuditFilter)
                }
                else
                {
                    $parameterValue = [System.String[]] @()
                }
                break
            }

            'UInt32'
            {
                $parameterValue = [System.UInt32] $currentcertificateAuthoritySettings.$($parameter.Name)
                break
            }

            default
            {
                $parameterValue = $currentcertificateAuthoritySettings.$($parameter.Name)
                break
            }
        }

        $returnValue += @{
            $($parameter.Name) = $parameterValue
        }
    } # foreach

    return $returnValue
} # function Get-TargetResource

<#
    .SYNOPSIS
        Updates the Active Directory Certificate Authority settings.
 
    .PARAMETER IsSingleInstance
        Specifies the resource is a single instance, the value must be 'Yes'.
 
    .PARAMETER CACertPublicationURLs
        Specifies an array of Certificate Authority certificate publication URLs,
        each prepended with an integer representing the type of URL endpoint.
 
    .PARAMETER CRLPublicationURLs
        Specifies an array of Certificate Revocation List publication URLs,
        each prepended with an integer representing the type of URL endpoint.
 
    .PARAMETER CRLOverlapUnits
        Specifies the number of units for the certificate revocation list
        overlap period.
 
    .PARAMETER CRLOverlapPeriod
        Specifies the units of measurement for the certificate revocation list
        overlap period.
 
    .PARAMETER CRLPeriodUnits
        Specifies the number of units for the certificate revocation period.
 
    .PARAMETER CRLPeriod
        Specifies the units of measurement for the certificate revocation period.
 
    .PARAMETER ValidityPeriodUnits
        Specifies the number of units for the validity period of certificates
        issued by this certificate authority.
 
    .PARAMETER ValidityPeriod
        Specifies the units of measurement for the validity period of certificates
        issued by this certificate authority.
 
    .PARAMETER DSConfigDN
        Specifies the distinguished name of the directory services configuration
        object that contains this certificate authority in the Active
        Directory.
 
    .PARAMETER DSDomainDN
        Specifies the distinguished name of the directory services object that contains
        this certificate authority in the Active Directory.
 
    .PARAMETER AuditFilter
        Specifies an array of audit categories to enable audit logging for.
#>

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet('Yes')]
        [System.String]
        $IsSingleInstance,

        [Parameter()]
        [System.String[]]
        $CACertPublicationURLs,

        [Parameter()]
        [System.String[]]
        $CRLPublicationURLs,

        [Parameter()]
        [System.UInt32]
        $CRLOverlapUnits,

        [Parameter()]
        [ValidateSet('Hours', 'Days', 'Weeks', 'Months', 'Years')]
        [System.String]
        $CRLOverlapPeriod,

        [Parameter()]
        [System.UInt32]
        $CRLPeriodUnits,

        [Parameter()]
        [ValidateSet('Hours', 'Days', 'Weeks', 'Months', 'Years')]
        [System.String]
        $CRLPeriod,

        [Parameter()]
        [System.UInt32]
        $ValidityPeriodUnits,

        [Parameter()]
        [ValidateSet('Hours', 'Days', 'Weeks', 'Months', 'Years')]
        [System.String]
        $ValidityPeriod,

        [Parameter()]
        [System.String]
        $DSConfigDN,

        [Parameter()]
        [System.String]
        $DSDomainDN,

        [Parameter()]
        [ValidateSet('StartAndStopADCS', 'BackupAndRestoreCADatabase', 'IssueAndManageCertificateRequests', 'RevokeCertificatesAndPublishCRLs', 'ChangeCASecuritySettings', 'StoreAndRetrieveArchivedKeys', 'ChangeCAConfiguration')]
        [System.String[]]
        $AuditFilter
    )

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $script:localizedData.SettingAdcsCaSettingsMessage
        ) -join '' )

    $currentSettings = Get-TargetResource `
        -IsSingleInstance $IsSingleInstance `
        -Verbose:$VerbosePreference

    $settingUpdated = $false

    <#
        Step through each parameter and update any that are passed
        and the current value differs from the desired value.
    #>

    foreach ($parameter in $script:parameterList.GetEnumerator())
    {
        $updateParameter = $false
        $parameterName = $parameter.Name
        $parameterCurrentValue = $currentSettings.$parameterName
        $parameterDesiredValue = (Get-Variable -Name $parameterName).Value

        if ($PSBoundParameters.ContainsKey($parameterName))
        {
            switch ($parameter.Value.Type)
            {
                'String[]'
                {
                    $updateParameter = (Compare-Object `
                            -ReferenceObject $parameterCurrentValue `
                            -DifferenceObject $parameterDesiredValue).Count -ne 0
                    $parameterNewValue = $parameterDesiredValue -join '\n'
                    break
                }

                'Flags'
                {
                    $updateParameter = (Compare-Object `
                            -ReferenceObject $parameterCurrentValue `
                            -DifferenceObject $parameterDesiredValue).Count -ne 0
                    $parameterNewValue = Convert-StringArrayToAuditFilter -StringArray $parameterDesiredValue
                    break
                }

                default
                {
                    $updateParameter = $parameterCurrentValue -ne $parameterDesiredValue
                    $parameterNewValue = $parameterDesiredValue
                }
            }

            # A parameter needs to be updated
            if ($updateParameter)
            {
                $parameterUpdated = $true

                Set-CertificateAuthoritySetting `
                    -Name $parameterName `
                    -Value $parameterNewValue `
                    -Verbose:$VerbosePreference
            }
        } # if
    } # foreach

    if ($parameterUpdated)
    {
        Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                $script:localizedData.RestartingCertSvcMessage
            ) -join '' )

        $null = Restart-ServiceIfExists -Name 'CertSvc'
    }
} # function Set-TargetResource

<#
    .SYNOPSIS
        Updates the Active Directory Certificate Authority settings.
 
    .PARAMETER IsSingleInstance
        Specifies the resource is a single instance, the value must be 'Yes'.
 
    .PARAMETER CACertPublicationURLs
        Specifies an array of Certificate Authority certificate publication URLs,
        each prepended with an integer representing the type of URL endpoint.
 
    .PARAMETER CRLPublicationURLs
        Specifies an array of Certificate Revocation List publication URLs,
        each prepended with an integer representing the type of URL endpoint.
 
    .PARAMETER CRLOverlapUnits
        Specifies the number of units for the certificate revocation list
        overlap period.
 
    .PARAMETER CRLOverlapPeriod
        Specifies the units of measurement for the certificate revocation list
        overlap period.
 
    .PARAMETER CRLPeriodUnits
        Specifies the number of units for the certificate revocation period.
 
    .PARAMETER CRLPeriod
        Specifies the units of measurement for the certificate revocation period.
 
    .PARAMETER ValidityPeriodUnits
        Specifies the number of units for the validity period of certificates
        issued by this certificate authority.
 
    .PARAMETER ValidityPeriod
        Specifies the units of measurement for the validity period of certificates
        issued by this certificate authority.
 
    .PARAMETER DSConfigDN
        Specifies the distinguished name of the directory services configuration
        object that contains this certificate authority in the Active
        Directory.
 
    .PARAMETER DSDomainDN
        Specifies the distinguished name of the directory services object that contains
        this certificate authority in the Active Directory.
 
    .PARAMETER AuditFilter
        Specifies an array of audit categories to enable audit logging for.
#>

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet('Yes')]
        [System.String]
        $IsSingleInstance,

        [Parameter()]
        [System.String[]]
        $CACertPublicationURLs,

        [Parameter()]
        [System.String[]]
        $CRLPublicationURLs,

        [Parameter()]
        [System.UInt32]
        $CRLOverlapUnits,

        [Parameter()]
        [ValidateSet('Hours', 'Days', 'Weeks', 'Months', 'Years')]
        [System.String]
        $CRLOverlapPeriod,

        [Parameter()]
        [System.UInt32]
        $CRLPeriodUnits,

        [Parameter()]
        [ValidateSet('Hours', 'Days', 'Weeks', 'Months', 'Years')]
        [System.String]
        $CRLPeriod,

        [Parameter()]
        [System.UInt32]
        $ValidityPeriodUnits,

        [Parameter()]
        [ValidateSet('Hours', 'Days', 'Weeks', 'Months', 'Years')]
        [System.String]
        $ValidityPeriod,

        [Parameter()]
        [System.String]
        $DSConfigDN,

        [Parameter()]
        [System.String]
        $DSDomainDN,

        [Parameter()]
        [ValidateSet('StartAndStopADCS', 'BackupAndRestoreCADatabase', 'IssueAndManageCertificateRequests', 'RevokeCertificatesAndPublishCRLs', 'ChangeCASecuritySettings', 'StoreAndRetrieveArchivedKeys', 'ChangeCAConfiguration')]
        [System.String[]]
        $AuditFilter
    )

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $script:localizedData.TestingAdcsCaSettingsMessage
        ) -join '' )

    $currentSettings = Get-TargetResource `
        -IsSingleInstance $IsSingleInstance `
        -Verbose:$VerbosePreference

    $null = $PSBoundParameters.Remove('IsSingleInstance')

    return Test-DscParameterState `
        -CurrentValues $currentSettings `
        -DesiredValues $PSBoundParameters `
        -Verbose:$VerbosePreference
} # function Test-TargetResource

<#
    .SYNOPSIS
        Return the settings for the installed certificate authotity.
 
    .DESCRIPTION
        Get the settings for the installed certificate authotity
        from the registry and return them.
 
        If no active certificate authority is found in the registry
        then an exception is thrown.
#>

function Get-CertificateAuthoritySettings
{
    [CmdletBinding()]
    [OutputType([System.Management.Automation.PSCustomObject[]])]
    param ()

    $activeCertificateAuthority = Get-ItemPropertyValue `
        -Path $script:certificateAuthorityRegistrySettingsPath `
        -Name 'Active' `
        -ErrorAction SilentlyContinue

    if ([System.String]::IsNullOrEmpty($activeCertificateAuthority))
    {
        New-ObjectNotFoundException -Message ($script:localizedData.CertificateAuthorityNoneActive -f `
                $script:certificateAuthorityRegistrySettingsPath)
    }

    $certificateAuthorityRegistryPath = Join-Path `
        -Path $script:certificateAuthorityRegistrySettingsPath `
        -ChildPath $activeCertificateAuthority

    return Get-ItemProperty `
        -Path $certificateAuthorityRegistryPath
} # function Get-CertificateAuthoritySettings

<#
    .SYNOPSIS
        Convers an audit filter flags bit field into an array of strings
        containing the friendly names of the audit filter flag.
 
    .PARAMETER AuditFilter
        The audit filter bit field to convert to an array of strings.
#>

function Convert-AuditFilterToStringArray
{
    [CmdletBinding()]
    [OutputType([System.String[]])]
    param
    (
        [Parameter()]
        [ValidateRange(0, 127)]
        [System.Int32]
        $AuditFilter
    )

    if ($AuditFilter -eq 0)
    {
        return [System.String[]] @()
    }

    return ([CertificateAuthorityAuditFilter] $AuditFilter -split ', ')
} # function Convert-AuditFilterToStringArray

<#
    .SYNOPSIS
        Convers an array of strings containing audit filter friendly
        names into an audit filter flags field.
 
    .PARAMETER AuditFilter
        The audit filter bit field to convert to an array of strings.
#>

function Convert-StringArrayToAuditFilter
{
    [CmdletBinding()]
    [OutputType([System.Int32])]
    param
    (
        [Parameter()]
        [ValidateSet('StartAndStopADCS', 'BackupAndRestoreCADatabase', 'IssueAndManageCertificateRequests', 'RevokeCertificatesAndPublishCRLs', 'ChangeCASecuritySettings', 'StoreAndRetrieveArchivedKeys', 'ChangeCAConfiguration')]
        [System.String[]]
        $StringArray
    )

    if ($StringArray.Count -eq 0)
    {
        return 0
    }

    return ([CertificateAuthorityAuditFilter] $StringArray).value__
} # function Convert-StringArrayToAuditFilter

<#
    .SYNOPSIS
        Convers an array of strings containing audit filter friendly
        names into an audit filter flags field.
 
    .PARAMETER AuditFilter
        The audit filter bit field to convert to an array of strings.
#>

function Set-CertificateAuthoritySetting
{
    [CmdletBinding()]
    param
    (
        [Parameter()]
        [System.String]
        $Name,

        [Parameter()]
        [System.String]
        $Value
    )

    & "$($ENV:SystemRoot)\system32\certutil.exe" @('-setreg', "CA\$Name", $Value)

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            ($script:localizedData.UpdatingAdcsCaSettingMessage -f $Name, $Value)
        ) -join '' )
} # function Set-CertificateAuthoritySetting

Export-ModuleMember -Function *-TargetResource