DSCResources/DSC_AdcsTemplate/DSC_AdcsTemplate.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
$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 a CA Template.
 
    .PARAMETER Name
        Specifies the name of a certificate template. This name must always be the
        template short name without spaces, and not the template display name.
 
    .PARAMETER Ensure
        Specifies whether the Template should be added or removed.
#>

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

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

    try
    {
        $CATemplate = Get-CATemplate -Verbose:$false | Where-Object -Property Name -eq $Name
    }
    catch
    {
        New-InvalidOperationException -Message $script:localizedData.InvalidOperationGettingAdcsTemplateMessage -ErrorRecord $_
    }

    if ($CATemplate)
    {
        # Template is added
        $Ensure = 'Present'
    }
    else
    {
        # Template is removed
        $Ensure = 'Absent'
    }

    return @{
        Name   = $Name
        Ensure = $Ensure
    }
} # function Get-TargetResource

<#
    .SYNOPSIS
        Adds or removes a CA Template.
 
    .PARAMETER Name
        Specifies the name of a certificate template. This name must always be the
        template short name without spaces, and not the template display name.
 
    .PARAMETER Ensure
        Specifies whether the Template should be added or removed.
#>

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

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

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

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

        try
        {
            Add-CATemplate -Name $Name -Verbose:$false
        }
        catch
        {
            New-InvalidOperationException -Message $($script:localizedData.InvalidOperationAddingAdcsTemplateMessage -f $Name) -ErrorRecord $_
        }
    }
    else
    {
        Write-Verbose -Message ( @(
                "$($MyInvocation.MyCommand): "
                $($script:localizedData.RemovingAdcsTemplateMessage -f $Name)
            ) -join '' )

        try
        {
            Remove-CATemplate -Name $Name -Force -Verbose:$false
        }
        catch
        {
            New-InvalidOperationException -Message $($script:localizedData.InvalidOperationRemovingAdcsTemplateMessage -f $Name) -ErrorRecord $_
        }
    }
} # function Set-TargetResource

<#
    .SYNOPSIS
        Tests if the CA Template is in the desired state.
 
    .PARAMETER Name
        Specifies the name of a certificate template. This name must always be the
        template short name without spaces, and not the template display name.
 
    .PARAMETER Ensure
        Specifies whether the Template should be added or removed.
 
    .OUTPUTS
        Returns true if the CA Template is in the desired state.
#>

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

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

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

    $currentState = Get-TargetResource -Name $Name
    if ($Ensure -eq 'Present')
    {
        if ($currentState.Ensure -eq 'Present')
        {
            # CA Template is added and should be - change not required
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.AdcsTemplateAddedAndShouldBeMessage -f $Name)
                ) -join '' )

            return $true
        }
        else
        {
            # CA Template is not added but should be - change required
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.AdcsTemplateNotAddedButShouldBeMessage -f $Name)
                ) -join '' )

            return $false
        }
    }
    else
    {
        if ($currentState.Ensure -eq 'Present')
        {
            # CA Template is installed and should not be - change required
            Write-Verbose -Message ( @(
                    "$($MyInvocation.MyCommand): "
                    $($script:localizedData.AdcsTemplateAddedButShouldNotBeMessage -f $Name)
                ) -join '' )

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

            return $true
        }
    }
} # function Test-TargetResource

Export-ModuleMember -Function *-TargetResource