DSCResources/MSFT_xCertificateExport/MSFT_xCertificateExport.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 |
#Requires -Version 4.0 $modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules' # Import the Certificate Common Modules Import-Module -Name (Join-Path -Path $modulePath ` -ChildPath (Join-Path -Path 'CertificateDsc.Common' ` -ChildPath 'CertificateDsc.Common.psm1')) # Import the Certificate Resource Helper Module Import-Module -Name (Join-Path -Path $modulePath ` -ChildPath (Join-Path -Path 'CertificateDsc.ResourceHelper' ` -ChildPath 'CertificateDsc.ResourceHelper.psm1')) # Import Localization Strings $localizedData = Get-LocalizedData ` -ResourceName 'MSFT_xCertificateExport' ` -ResourcePath (Split-Path -Parent $Script:MyInvocation.MyCommand.Path) <# .SYNOPSIS Returns the current state of the exported certificate. .PARAMETER Path The path to the file you that will contain the exported certificate. #> function Get-TargetResource { [CmdletBinding()] [OutputType([Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Path ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.GettingCertificateExportMessage -f $Path) ) -join '' ) $result = @{ Path = $Path IsExported = (Test-Path -Path $Path) } return $result } # end function Get-TargetResource <# .SYNOPSIS Exports the certificate. .PARAMETER Path The path to the file you that will contain the exported certificate. .PARAMETER Thumbprint The thumbprint of the certificate to export. Certificate selector parameter. .PARAMETER FriendlyName The friendly name of the certificate to export. Certificate selector parameter. .PARAMETER Subject The subject of the certificate to export. Certificate selector parameter. .PARAMETER DNSName The subject alternative name of the certificate to export must contain these values. Certificate selector parameter. .PARAMETER Issuer The issuer of the certificate to export. Certificate selector parameter. .PARAMETER KeyUsage The key usage of the certificate to export must contain these values. Certificate selector parameter. .PARAMETER EnhancedKeyUsage The enhanced key usage of the certificate to export must contain these values. Certificate selector parameter. .PARAMETER Store The Windows Certificate Store Name to search for the certificate to export from. Certificate selector parameter. Defaults to 'My'. .PARAMETER AllowExpired Allow an expired certificate to be exported. Certificate selector parameter. .PARAMETER MatchSource Causes an existing exported certificate to be compared with the certificate identified for export and re-exported if it does not match. .PARAMETER Type Specifies the type of certificate to export. Defaults to 'Cert'. .PARAMETER ChainOption Specifies the options for building a chain when exporting a PFX certificate. Defaults to 'BuildChain'. .PARAMETER Password Specifies the password used to protect an exported PFX file. .PARAMETER ProtectTo Specifies an array of strings for the username or group name that can access the private key of an exported PFX file without any password. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Path, [Parameter()] [System.String] $Thumbprint, [Parameter()] [System.String] $FriendlyName, [Parameter()] [System.String] $Subject, [Parameter()] [System.String[]] $DNSName, [Parameter()] [System.String] $Issuer, [Parameter()] [System.String[]] $KeyUsage, [Parameter()] [System.String[]] $EnhancedKeyUsage, [Parameter()] [System.String] $Store = 'My', [Parameter()] [System.Boolean] $AllowExpired, [Parameter()] [System.Boolean] $MatchSource, [Parameter()] [ValidateSet("Cert", "P7B", "SST", "PFX")] [System.String] $Type = 'Cert', [Parameter()] [ValidateSet("BuildChain", "EndEntityCertOnly")] [System.String] $ChainOption = 'BuildChain', [Parameter()] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Password, [Parameter()] [System.String[]] $ProtectTo ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.SettingCertificateExportMessage -f $Path) ) -join '' ) $findCertificateParameters = @{} + $PSBoundParameters $null = $findCertificateParameters.Remove('Path') $null = $findCertificateParameters.Remove('MatchSource') $null = $findCertificateParameters.Remove('Type') $null = $findCertificateParameters.Remove('ChainOption') $null = $findCertificateParameters.Remove('Password') $null = $findCertificateParameters.Remove('ProtectTo') $foundCertificates = @(Find-Certificate @findCertificateParameters) if ($foundCertificates.Count -eq 0) { # A certificate matching the specified certificate selector parameters could not be found Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.CertificateToExportNotFound -f $Path, $Type, $Store) ) -join '' ) } else { $certificateToExport = $foundCertificates[0] $certificateThumbprintToExport = $certificateToExport.Thumbprint Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.CertificateToExportFound -f $certificateThumbprintToExport, $Path) ) -join '' ) # Export the certificate $exportCertificateParameters = @{ FilePath = $Path Cert = $certificateToExport Force = $true } if ($Type -in @('Cert', 'P7B', 'SST')) { $exportCertificateParameters += @{ Type = $Type } Export-Certificate @exportCertificateParameters } elseif ($Type -eq 'PFX') { $exportCertificateParameters += @{ Password = $Password.Password ChainOption = $ChainOption } if ($PSBoundParameters.ContainsKey('ProtectTo')) { $exportCertificateParameters += @{ ProtectTo = $ProtectTo } } # if Export-PfxCertificate @exportCertificateParameters } # if Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.CertificateExported -f $certificateThumbprintToExport, $Path, $Type) ) -join '' ) } # if } # end function Set-TargetResource <# .SYNOPSIS Tests the state of the currently exported certificate. .PARAMETER Path The path to the file you that will contain the exported certificate. .PARAMETER Thumbprint The thumbprint of the certificate to export. Certificate selector parameter. .PARAMETER FriendlyName The friendly name of the certificate to export. Certificate selector parameter. .PARAMETER Subject The subject of the certificate to export. Certificate selector parameter. .PARAMETER DNSName The subject alternative name of the certificate to export must contain these values. Certificate selector parameter. .PARAMETER Issuer The issuer of the certificate to export. Certificate selector parameter. .PARAMETER KeyUsage The key usage of the certificate to export must contain these values. Certificate selector parameter. .PARAMETER EnhancedKeyUsage The enhanced key usage of the certificate to export must contain these values. Certificate selector parameter. .PARAMETER Store The Windows Certificate Store Name to search for the certificate to export from. Certificate selector parameter. Defaults to 'My'. .PARAMETER AllowExpired Allow an expired certificate to be exported. Certificate selector parameter. .PARAMETER MatchSource Causes an existing exported certificate to be compared with the certificate identified for export and re-exported if it does not match. .PARAMETER Type Specifies the type of certificate to export. Defaults to 'Cert'. .PARAMETER ChainOption Specifies the options for building a chain when exporting a PFX certificate. Defaults to 'BuildChain'. .PARAMETER Password Specifies the password used to protect an exported PFX file. .PARAMETER ProtectTo Specifies an array of strings for the username or group name that can access the private key of an exported PFX file without any password. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Path, [Parameter()] [System.String] $Thumbprint, [Parameter()] [System.String] $FriendlyName, [Parameter()] [System.String] $Subject, [Parameter()] [System.String] $Issuer, [Parameter()] [System.String[]] $DNSName, [Parameter()] [System.String[]] $KeyUsage, [Parameter()] [System.String[]] $EnhancedKeyUsage, [Parameter()] [System.String] $Store = 'My', [Parameter()] [System.Boolean] $AllowExpired, [Parameter()] [System.Boolean] $MatchSource, [Parameter()] [ValidateSet("Cert", "P7B", "SST", "PFX")] [System.String] $Type = 'Cert', [Parameter()] [ValidateSet("BuildChain", "EndEntityCertOnly")] [System.String] $ChainOption = 'BuildChain', [Parameter()] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Password, [Parameter()] [System.String[]] $ProtectTo ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.TestingCertificateExportMessage -f $Path) ) -join '' ) $findCertificateParameters = @{} + $PSBoundParameters $null = $findCertificateParameters.Remove('Path') $null = $findCertificateParameters.Remove('MatchSource') $null = $findCertificateParameters.Remove('Type') $null = $findCertificateParameters.Remove('ChainOption') $null = $findCertificateParameters.Remove('Password') $null = $findCertificateParameters.Remove('ProtectTo') $foundCertificates = @(Find-Certificate @findCertificateParameters) if ($foundCertificates.Count -eq 0) { # A certificate matching the specified certificate selector parameters could not be found Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.CertificateToExportNotFound -f $Path, $Type, $Store) ) -join '' ) return $true } else { $certificateToExport = $foundCertificates[0] $certificateThumbprintToExport = $certificateToExport.Thumbprint Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.CertificateToExportFound -f $certificateThumbprintToExport, $Path) ) -join '' ) if (Test-Path -Path $Path) { if ($MatchSource) { # The certificate has already been exported, but we need to make sure it matches Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.CertificateAlreadyExportedMatchSource -f $certificateThumbprintToExport, $Path) ) -join '' ) # Need to now compare the existing exported cert content with the found cert $exportedCertificate = New-Object -TypeName 'System.Security.Cryptography.X509Certificates.X509Certificate2Collection' if ($Type -in @('Cert', 'P7B', 'SST')) { $exportedCertificate.Import($Path) } elseif ($Type -eq 'PFX') { $exportedCertificate.Import($Path, $Password, [System.Security.Cryptography.X509Certificates.X509KeyStorageFlags]::PersistKeySet) } # if if ($certificateThumbprintToExport -notin $exportedCertificate.Thumbprint) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.CertificateAlreadyExportedNotMatchSource -f $certificateThumbprintToExport, $Path) ) -join '' ) return $false } # if } else { # This certificate is already exported and we don't want to check it is # the right certificate. Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.CertificateAlreadyExported -f $certificateThumbprintToExport, $Path) ) -join '' ) } # if return $true } else { # The found certificate has not been exported yet Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): ", $($LocalizedData.CertificateNotExported -f $certificateThumbprintToExport, $Path) ) -join '' ) return $false } # if } # if } # end function Test-TargetResource Export-ModuleMember -Function *-TargetResource |