DSCResources/MSFT_WaitForCertificateServices/MSFT_WaitForCertificateServices.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
# Suppressed as per PSSA Rule Severity guidelines for unit/integration tests:
# https://github.com/PowerShell/DscResources/blob/master/PSSARuleSeverities.md
#Requires -Version 4.0

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

# Import the Certificate PDT Helper Module
Import-Module -Name (Join-Path -Path $modulePath `
        -ChildPath (Join-Path -Path 'CertificateDsc.PDT' `
            -ChildPath 'CertificateDsc.PDT.psm1'))

# Import the Certificate Resource Common Module.
Import-Module -Name (Join-Path -Path $modulePath `
        -ChildPath (Join-Path -Path 'CertificateDsc.Common' `
            -ChildPath 'CertificateDsc.Common.psm1'))

# Import Localization Strings.
$script:localizedData = Get-LocalizedData -ResourceName 'MSFT_WaitForCertificateServices'

<#
    .SYNOPSIS
    Returns the current state of the wait for Active Directory Certificate
    Service Certificate Authority resource.
 
    .PARAMETER CAServerFQDN
    The FQDN of the Active Directory Certificate Service Certificate Authority to wait
    for. Leave empty to automatically detect.
 
    .PARAMETER CARootName
    The name of the Active Directory Certificate Service Certificate Authority to wait
    for. Leave empty to automatically detect.
 
    .PARAMETER RetryIntervalSeconds
    Specifies the number of seconds to wait for the Active Directory Certificate
    Service Certificate Authority to become available. Defaults to 10 seconds.
 
    .PARAMETER RetryCount
    The number of times to loop the retry interval while waiting for the Active
    Directory Certificate Service Certificate Authority. Defaults to 60 retries.
#>

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $CAServerFQDN,

        [Parameter(Mandatory = $true)]
        [System.String]
        $CARootName,

        [Parameter()]
        [System.UInt32]
        $RetryIntervalSeconds = 10,

        [Parameter()]
        [System.UInt32]
        $RetryCount = 60
    )

    $certificateAuthorityFullName = "$CAServerFQDN\$CARootName"

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

    $returnValue = @{
        CAServerFQDN         = $CAServerFQDN
        CARootName           = $CARootName
        RetryIntervalSeconds = $RetryIntervalSeconds
        RetryCount           = $RetryCount
    }
    return $returnValue
} # function Get-TargetResource

<#
    .SYNOPSIS
    Waits for the Active Directory Certificate Service Certificate Authority to become
    available or times out.
 
    .PARAMETER CAServerFQDN
    The FQDN of the Active Directory Certificate Service Certificate Authority to wait
    for. Leave empty to automatically detect.
 
    .PARAMETER CARootName
    The name of the Active Directory Certificate Service Certificate Authority to wait
    for. Leave empty to automatically detect.
 
    .PARAMETER RetryIntervalSeconds
    Specifies the number of seconds to wait for the Active Directory Certificate
    Service Certificate Authority to become available. Defaults to 10 seconds.
 
    .PARAMETER RetryCount
    The number of times to loop the retry interval while waiting for the Active
    Directory Certificate Service Certificate Authority. Defaults to 60 retries.
#>

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

        [Parameter(Mandatory = $true)]
        [System.String]
        $CARootName,

        [Parameter()]
        [System.UInt32]
        $RetryIntervalSeconds = 10,

        [Parameter()]
        [System.UInt32]
        $RetryCount = 60
    )

    $certificateAuthorityFullName = "$CAServerFQDN\$CARootName"

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

    $certificateAuthorityFound = $false

    for ($count = 0; $count -lt $RetryCount; $count++)
    {
        if (Test-CertificateAuthority `
                -CAServerFQDN $CAServerFQDN `
                -CARootName $CARootName)
        {
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.CertificateAuthorityFoundMessage -f $certificateAuthorityFullName)
                ) -join '' )

            $certificateAuthorityFound = $true
            break
        }
        else
        {
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.CertificateAuthorityNotFoundRetryingMessage -f $certificateAuthorityFullName, $RetryIntervalSeconds)
                ) -join '' )

            Start-Sleep -Seconds $RetryIntervalSeconds
        } # if
    } # for

    if (-not $certificateAuthorityFound)
    {
        New-InvalidOperationException `
            -Message $($script:localizedData.CertificateAuthorityNotFoundAfterError -f $certificateAuthorityFullName, $RetryCount)
    } # if
} # function Set-TargetResource

<#
    .SYNOPSIS
    Waits for the Active Directory Certificate Service Certificate Authority to
    become available or times out.
 
    .PARAMETER CAServerFQDN
    The FQDN of the Active Directory Certificate Service Certificate Authority to wait
    for. Leave empty to automatically detect.
 
    .PARAMETER CARootName
    The name of the Active Directory Certificate Service Certificate Authority to wait
    for. Leave empty to automatically detect.
 
    .PARAMETER RetryIntervalSeconds
    Specifies the number of seconds to wait for the Active Directory Certificate
    Service Certificate Authority to become available. Defaults to 10 seconds.
 
    .PARAMETER RetryCount
    The number of times to loop the retry interval while waiting for the Active
    Directory Certificate Service Certificate Authority. Defaults to 60 retries.
#>

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

        [Parameter(Mandatory = $true)]
        [System.String]
        $CARootName,

        [Parameter()]
        [System.UInt32]
        $RetryIntervalSeconds = 10,

        [Parameter()]
        [System.UInt32]
        $RetryCount = 60
    )

    $certificateAuthorityFullName = "$CAServerFQDN\$CARootName"

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

    if (Test-CertificateAuthority `
            -CAServerFQDN $CAServerFQDN `
            -CARootName $CARootName)
    {
        Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                $($script:localizedData.CertificateAuthorityFoundMessage -f $certificateAuthorityFullName)
            ) -join '' )

        return $true
    }

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

    return $false
} # function Test-TargetResource

Export-ModuleMember -Function *-TargetResource