DSCResources/DSC_AdcsEnrollmentPolicyWebService/DSC_AdcsEnrollmentPolicyWebService.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
$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'

<#
    .SYNOPSIS
        Returns an object containing the current state information for the ADCS Enrollment
        Policy Web Service on the server.
 
    .PARAMETER AuthenticationType
        Specifies the authentication type used by the Certificate Enrollment Policy Web Service.
 
    .PARAMETER SslCertThumbprint
        Specifies the thumbprint of the certificate used by Internet Information Service (IIS)
        to enable support for required Secure Sockets Layer (SSL).
 
    .PARAMETER Credential
        If the Certificate Enrollment Policy Web service is configured to use Standalone
        certification authority, then an account that is a member of the local Administrators
        on the CA is required. If the Certificate Enrollment Policy Web service is configured
        to use an Enterprise CA, then an account that is a member of Domain Admins is
        required.
 
    .PARAMETER KeyBasedRenewal
        Configures the Certificate Enrollment Policy Web Service to operate in key-based renewal
        mode. Defaults to False.
 
    .PARAMETER Ensure
        Specifies whether the Certificate Authority should be installed or uninstalled. Defaults
        to Present.
 
    .OUTPUTS
        Returns an object containing the ADCS AdcsEnrollmentPolicyWebService
        state information.
#>

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet('Certificate', 'Kerberos', 'UserName')]
        [System.String]
        $AuthenticationType,

        [Parameter(Mandatory = $true)]
        [ValidateScript( { $_ | Test-Thumbprint } )]
        [System.String]
        $SslCertThumbprint,

        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        [System.Management.Automation.Credential()]
        $Credential,

        [Parameter()]
        [System.Boolean]
        $KeyBasedRenewal = $false
    )

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

    $installed = Test-AdcsEnrollmentPolicyWebServiceInstallState `
        -AuthenticationType $AuthenticationType `
        -KeyBasedRenewal $KeyBasedRenewal
    if ($installed -eq $false)
    {
        $Ensure = 'Absent'
    }
    else
    {
        $Ensure = 'Present'
    }

    return @{
        AuthenticationType = $AuthenticationType
        SslCertThumbprint  = $SslCertThumbprint
        Credential         = $Credential
        KeyBasedRenewal    = $KeyBasedRenewal
        Ensure             = $Ensure
    }
} # function Get-TargetResource

<#
    .SYNOPSIS
        Installs or uinstalls the ADCS Enrollment Policy Web Service from the server.
 
    .PARAMETER AuthenticationType
        Specifies the authentication type used by the Certificate Enrollment Policy Web Service.
 
    .PARAMETER SslCertThumbprint
        Specifies the thumbprint of the certificate used by Internet Information Service (IIS)
        to enable support for required Secure Sockets Layer (SSL).
 
    .PARAMETER Credential
        If the Certificate Enrollment Policy Web service is configured to use Standalone
        certification authority, then an account that is a member of the local Administrators
        on the CA is required. If the Certificate Enrollment Policy Web service is configured
        to use an Enterprise CA, then an account that is a member of Domain Admins is
        required.
 
    .PARAMETER KeyBasedRenewal
        Configures the Certificate Enrollment Policy Web Service to operate in key-based renewal
        mode. Defaults to False.
 
    .PARAMETER Ensure
        Specifies whether the Certificate Authority should be installed or uninstalled. Defaults
        to Present.
#>

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet('Certificate', 'Kerberos', 'UserName')]
        [System.String]
        $AuthenticationType,

        [Parameter(Mandatory = $true)]
        [ValidateScript( { $_ | Test-Thumbprint } )]
        [System.String]
        $SslCertThumbprint,

        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        [System.Management.Automation.Credential()]
        $Credential,

        [Parameter()]
        [System.Boolean]
        $KeyBasedRenewal = $false,

        [Parameter()]
        [ValidateSet('Present', 'Absent')]
        [System.String]
        $Ensure = 'Present'
    )

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

    $adcsEnrollmentPolicyWebServiceParameters = @{ } + $PSBoundParameters
    $null = $adcsEnrollmentPolicyWebServiceParameters.Remove('Ensure')
    $null = $adcsEnrollmentPolicyWebServiceParameters.Remove('Debug')
    $null = $adcsEnrollmentPolicyWebServiceParameters.Remove('ErrorAction')

    $errorMessage = ''

    try
    {
        if ($Ensure -eq 'Present')
        {
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.InstallingAdcsEnrollmentPolicyWebServiceMessage -f $AuthenticationType)
                ) -join '' )

            $errorMessage = (Install-AdcsEnrollmentPolicyWebService @adcsEnrollmentPolicyWebServiceParameters -Force).ErrorString
        }
        else
        {
            $null = $adcsEnrollmentPolicyWebServiceParameters.Remove('SslCertThumbprint')
            $null = $adcsEnrollmentPolicyWebServiceParameters.Remove('Credential')

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

            $errorMessage = (Uninstall-AdcsEnrollmentPolicyWebService @adcsEnrollmentPolicyWebServiceParameters -Force).ErrorString
        }
    }
    catch
    {
        $errorMessage = $_.Exception.Message
    }

    if (-not [System.String]::IsNullOrEmpty($errorMessage))
    {
        Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                $($script:localizedData.AdcsEnrollmentPolicyWebServiceErrorMessage -f $errorMessage)
            ) -join '' )
        New-InvalidOperationException -Message $errorMessage
    }
} # function Set-TargetResource

<#
    .SYNOPSIS
        Tests is the ADCS Enrollment Policy Web Service is in the desired state.
 
    .PARAMETER AuthenticationType
        Specifies the authentication type used by the Certificate Enrollment Policy Web Service.
 
    .PARAMETER SslCertThumbprint
        Specifies the thumbprint of the certificate used by Internet Information Service (IIS)
        to enable support for required Secure Sockets Layer (SSL).
 
    .PARAMETER Credential
        If the Certificate Enrollment Policy Web service is configured to use Standalone
        certification authority, then an account that is a member of the local Administrators
        on the CA is required. If the Certificate Enrollment Policy Web service is configured
        to use an Enterprise CA, then an account that is a member of Domain Admins is
        required.
 
    .PARAMETER KeyBasedRenewal
        Configures the Certificate Enrollment Policy Web Service to operate in key-based renewal
        mode. Defaults to False.
 
    .PARAMETER Ensure
        Specifies whether the Certificate Authority should be installed or uninstalled. Defaults
        to Present.
 
    .OUTPUTS
        Returns true if the ADCS Enrollment Policy Web Service is in the correct state.
#>

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

        [Parameter(Mandatory = $true)]
        [ValidateScript( { $_ | Test-Thumbprint } )]
        [System.String]
        $SslCertThumbprint,

        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        [System.Management.Automation.Credential()]
        $Credential,

        [Parameter()]
        [System.Boolean]
        $KeyBasedRenewal = $false,

        [Parameter()]
        [ValidateSet('Present', 'Absent')]
        [System.String]
        $Ensure = 'Present'
    )

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

    $installed = Test-AdcsEnrollmentPolicyWebServiceInstallState `
        -AuthenticationType $AuthenticationType `
        -KeyBasedRenewal $KeyBasedRenewal

    if ($installed -eq $true)
    {
        # Enrollment Policy Web Service is already installed
        if ($Ensure -eq 'Present')
        {
            # CA is installed and should be - change not required
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.AdcsEnrollmentPolicyWebServiceInstalledAndShouldBeMessage -f $AuthenticationType)
                ) -join '' )

            return $true
        }
        else
        {
            # CA is installed and should not be - change required
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.AdcsEnrollmentPolicyWebServiceInstalledButShouldNotBeMessage -f $AuthenticationType)
                ) -join '' )

            return $false
        }
    }
    else
    {
        # Enrollment Policy Web Service is not installed
        if ($Ensure -eq 'Present')
        {
            # CA is not installed but should be - change required
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.AdcsEnrollmentPolicyWebServiceNotInstalledButShouldBeMessage -f $AuthenticationType)
                ) -join '' )

            return $false
        }
        else
        {
            # CA is not installed and should not be - change not required
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.AdcsEnrollmentPolicyWebServiceNotInstalledAndShouldNotBeMessage -f $AuthenticationType)
                ) -join '' )

            return $true
        }
    }
} # function Test-TargetResource

<#
    .SYNOPSIS
        Tests the install state of the ADCS Enrollment Policy Web Service for the specified
        Authentication Type and Key Based Renewal settings. The function uses the existence
        of the IIS Web Aplication to determine it it is installed.
 
    .PARAMETER AuthenticationType
        Specifies the authentication type used by the Certificate Enrollment Policy Web Service.
 
    .PARAMETER KeyBasedRenewal
        Configures the Certificate Enrollment Policy Web Service to operate in key-based renewal
        mode. Defaults to False.
 
    .OUTPUTS
        Returns true if the ADCS Enrollment Policy Web Service is installed.
#>

function Test-AdcsEnrollmentPolicyWebServiceInstallState
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidateSet('Certificate', 'Kerberos', 'UserName')]
        [System.String]
        $AuthenticationType,

        [Parameter()]
        [System.Boolean]
        $KeyBasedRenewal = $false
    )

    Write-Verbose -Message ( @(
            "$($MyInvocation.MyCommand): "
            $($script:localizedData.TestingAdcsEnrollmentPolicyWebServiceInstallStateMessage -f $AuthenticationType, $KeyBasedRenewal)
        ) -join '' )

    # Determine the expected name of the Web Application
    if ($AuthenticationType -eq 'UserName')
    {
        # When the AuthenticationType is UserName the Web App actually ends with USernamePassword
        $webAppAutenticationType = 'UsernamePassword'
    }
    else
    {
        $webAppAutenticationType = $AuthenticationType
    }

    if ($KeyBasedRenewal -eq $true)
    {
        $enrollmentPolicyWebServiceWebAppName = "KeyBasedRenewal_ADPolicyProvider_CEP_$webAppAutenticationType"
    }
    else
    {
        $enrollmentPolicyWebServiceWebAppName = "ADPolicyProvider_CEP_$webAppAutenticationType"
    }

    # Does the Web Application exist for the Enrollment Policy Web Service
    $enrollmentPolicyWebServiceWebApp = Get-WebApplication | Where-Object -FilterScript {
        $_.Applicationpool -eq 'WSEnrollmentPolicyServer' -and
        (Split-Path -Path $_.PhysicalPath -Leaf) -eq $enrollmentPolicyWebServiceWebAppName
    }

    if ($null -eq $enrollmentPolicyWebServiceWebApp)
    {
        Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                $($script:localizedData.AdcsEnrollmentPolicyWebServiceInstallIsNotInstalledMessage -f $AuthenticationType, $KeyBasedRenewal)
            ) -join '' )

        return $false
    }
    else
    {
        Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                $($script:localizedData.AdcsEnrollmentPolicyWebServiceInstallIsInstalledMessage -f $AuthenticationType, $KeyBasedRenewal)
            ) -join '' )

        return $true
    }
} # function Test-AdcsEnrollmentPolicyWebServiceInstallState

<#
    .SYNOPSIS
    Validates whether a given certificate is valid based on the hash algoritms available on the
    system.
 
    .PARAMETER Thumbprint
    One or more thumbprints to Test.
 
    .PARAMETER Quiet
    Returns $false if the thumbprint is not valid. By default this function throws an exception if
    validation fails.
 
    .EXAMPLE
    Test-Thumbprint `
        -Thumbprint fd94e3a5a7991cb6ed3cd5dd01045edf7e2284de
 
    .EXAMPLE
    Test-Thumbprint `
        -Thumbprint fd94e3a5a7991cb6ed3cd5dd01045edf7e2284de,0000e3a5a7991cb6ed3cd5dd01045edf7e220000 `
        -Quiet
 
    .EXAMPLE
    Get-ChildItem -Path Cert:\LocalMachine -Recurse |
        Where-Object -FilterScript { $_.Thumbprint } |
        Select-Object -Expression Thumbprint |
        Test-Thumbprint -Verbose
#>

function Test-Thumbprint
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true,
            ValueFromPipeline)]
        [ValidateNotNullOrEmpty()]
        [System.String[]]
        $Thumbprint,

        [Parameter()]
        [Switch]
        $Quiet
    )

    begin
    {
        # Get FIPS registry key
        $fips = [System.Int32] (Get-ItemProperty -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\Lsa\FipsAlgorithmPolicy' -ErrorAction SilentlyContinue).Enabled

        # Get a list of Hash Providers
        $allHashProviders = [System.AppDomain]::CurrentDomain.GetAssemblies().GetTypes()

        if ($fips -eq $true)
        {
            # Support only FIPS compliant Hash Algorithms
            $hashProviders = $allHashProviders | Where-Object -FilterScript {
                $_.BaseType.BaseType -eq [System.Security.Cryptography.HashAlgorithm] -and
                ($_.Name -cmatch 'Provider$' -and $_.Name -cnotmatch 'MD5')
            }
        }
        else
        {
            $hashProviders = $allHashProviders | Where-Object -FilterScript {
                $_.BaseType.BaseType -eq [System.Security.Cryptography.HashAlgorithm] -and
                ($_.Name -cmatch 'Managed$' -or $_.Name -cmatch 'Provider$')
            }
        }

        # Get a list of all Valid Hash types and lengths into an array
        $validHashes = @()

        foreach ($hashProvider in $hashProviders)
        {
            $bitSize = ( New-Object -TypeName $hashProvider ).HashSize
            $validHash = New-Object `
                -TypeName PSObject `
                -Property @{
                    Hash      = $hashProvider.BaseType.Name
                    BitSize   = $bitSize
                    HexLength = $bitSize / 4
                }
            $validHashes += @( $validHash )
        }
    }

    process
    {
        foreach ($hash in $Thumbprint)
        {
            $isValid = $false

            foreach ($algorithm in $validHashes)
            {
                if ($hash -cmatch "^[a-fA-F0-9]{$($algorithm.HexLength)}$")
                {
                    $isValid = $true
                }
            }

            if ($Quiet -or $isValid)
            {
                $isValid
            }
            else
            {
                New-InvalidOperationException `
                    -Message ($script:localizedData.InvalidHashAlgorithmErrorMessage -f $hash)
            }
        }
    }
} # end function Test-Thumbprint

Export-ModuleMember -Function *-TargetResource