Merge pull request #26 from jmcook1/master

Add option for friendly name

Author: J0F3

Request-Certificate.ps1

@@ -33,7 +33,7 @@ Kudos to jbpaux for contributing improvements and fixes on GitHub!
 #>
 
 <#
-.SYNOPSIS 
+.SYNOPSIS
 Requests a certificate from a Windows CA
 
 .DESCRIPTION
@@ -46,9 +46,9 @@ The CA must support this type of certificate otherwise the request will fail.
 
 With the Export parameter it's also possible to export the requested certificate (with private key) directly to a .pfx file instead of storing it in the local computer store.
 
-You can also use the Import-CSV cmdlet with Request-Certificate.ps1 to request multiple certificates. 
+You can also use the Import-CSV cmdlet with Request-Certificate.ps1 to request multiple certificates.
 To do this, use the Import-CSV cmdlet to create custom objects from a comma-separated value (CSV) file that contains a list of object properties (such as CN, SAN etc. ). Then pass these objects through the pipeline to Request-Certificate.ps1 to request the certificates.
-    
+
 .PARAMETER CN
 Specifies the common name for the subject of the certificate(s).
 Mostly its the FQDN of a website or service.
@@ -57,15 +57,15 @@ e.g. test.jofe.ch
 .PARAMETER SAN
 Specifies a comma separated list of subject alternate names (FQDNs) for the certificate
 The syntax is {tag}={value}.
-Valid tags are: email, upn, dns, guid, url, ipaddress, oid 
+Valid tags are: email, upn, dns, guid, url, ipaddress, oid
 e.g. dns=test.jofe.ch,[email protected]
 
 .PARAMETER TemplateName
-Specifies the name for the temple of the CA to issue the certificate(s). 
+Specifies the name for the temple of the CA to issue the certificate(s).
 The default value is "WebServer".
 
 .PARAMETER KeyLength
-Specifies the key length in Bit for the certificate. 
+Specifies the key length in Bit for the certificate.
 Possible Values: 1024,2048,3072,4096,15360
 Default Value: 2048
 
@@ -94,6 +94,10 @@ e.g. jofe.ch
 Specifies the optional department value in the subject of the certificate(s).
 e.g. IT
 
+.PARAMETER FriendlyName
+Specifies the optional friendly name value of the certificate(s).
+e.g. "[CA Issued by] My Certificate"
+
 .PARAMETER AddCNinSAN
 Specifies the CN will be added to the SAN list if not already provided. This ensures compatibility with
 modern browsers.
@@ -110,7 +114,7 @@ Specify the Password (as plain String or SecureString) used on the export.
 
 .INPUTS
 System.String
-Common name for the subject, SAN , Country, State etc. of the certificate(s) as a string 
+Common name for the subject, SAN , Country, State etc. of the certificate(s) as a string
 
 .OUTPUTS
 None. Request-Certificate.ps1 does not generate any output.
@@ -133,33 +137,33 @@ The user will be asked for the value for the CN of the certificate.
 
 .EXAMPLE
 C:\PS> .\Request-Certificate.ps1 -CN "webserver.test.ch" -CAName "testsrv.test.ch\Test CA" -TemplateName "Webservercert"
- 
+
 Description
 -----------
 This command requests a certificate form the CA testsrv.test.ch\Test CA with the certificate template "Webservercert"
 and a CN of webserver.test.ch
-The user will be asked for the value for the SAN of the certificate. 
+The user will be asked for the value for the SAN of the certificate.
+
 
- 
 .EXAMPLE
 Get-Content .\certs.txt | .\Request-Certificate.ps1 -Export
 
 Description
 -----------
-Gets common names from the file certs.txt and request for each a certificate. 
+Gets common names from the file certs.txt and request for each a certificate.
 Each certificate will then be saved withe the private key in a .pfx file.
 
 .EXAMPLE
 C:\PS> .\Request-Certificate.ps1 -CN "webserver.test.ch" -SAN "DNS=webserver.test.ch,DNS=srvweb.test.local"
- 
+
 Description
 -----------
 This command requests a certificate with a CN of webserver.test.ch and subject alternative names (SANs)
 The SANs of the certificate are the DNS names webserver.test.ch and srvweb.test.local.
 
 .EXAMPLE
 C:\PS> Import-Csv .\sancertificates.csv -UseCulture | .\Request-Certificate.ps1 -verbose -Export -CAName "testsrv.test.ch\Test CA"
- 
+
 Description
 -----------
 This example requests multiple SAN certificates from the "Test CA" CA running on the server "testsrv.test.ch".
@@ -171,15 +175,15 @@ CN;SAN
 test1.test.ch;DNS=test1san1.test.ch,DNS=test1san2.test.ch
 test2.test.ch;DNS=test2san1.test.ch,DNS=test2san2.test.ch
 test3.test.ch;DNS=test3san1.test.ch,DNS=test3san2.test.ch
-		   
+
 .NOTES
 
 Version    : 1.4, 01/31/2019
-Changes    : 
+Changes    :
 	Thanks to David Allsopp c/o dra27 on GitHub
-	- Better default for CAName so it is not needed when only one CA is available. 
+	- Better default for CAName so it is not needed when only one CA is available.
 	- ProviderName specified in the request inf file
-	
+
 Version    : 1.3, 10/20/2018
 Changes    :
 	- Improvements in temp file handling
@@ -219,6 +223,8 @@ Param(
     [Parameter(Mandatory = $False, ValueFromPipelineByPropertyName = $True)]
     [string]$Department,
     [Parameter(Mandatory = $False, ValueFromPipelineByPropertyName = $True)]
+    [string]$FriendlyName = "<None>" ,
+    [Parameter(Mandatory = $False, ValueFromPipelineByPropertyName = $True)]
     [switch]$AddCNinSAN,
     [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $True, ParameterSetName='Export')]
     [switch]$Export,
@@ -272,11 +278,12 @@ KeySpec=1
 Exportable = TRUE
 RequestType = PKCS10
 ProviderName = "Microsoft Enhanced Cryptographic Provider v1.0"
+FriendlyName = "$FriendlyName"
 [RequestAttributes]
 CertificateTemplate = "$TemplateName"
 "@
 
-    
+
     #check if SAN certificate is requested
     if ($PSBoundParameters.ContainsKey('SAN')) {
         #each SAN must be a array element
@@ -299,9 +306,9 @@ CertificateTemplate = "$TemplateName"
         Write-Host "Requesting SAN certificate with subject $CN and SAN: $($SAN -join ',')" -ForegroundColor Green
         Write-Debug "Parameter values: CN = $CN, TemplateName = $TemplateName, CAName = $CAName, SAN = $($SAN -join ' ')"
 
-        Write-Verbose "A value for the SAN is specified. Requesting a SAN certificate." 
+        Write-Verbose "A value for the SAN is specified. Requesting a SAN certificate."
         Write-Debug "Add Extension for SAN to the inf file..."
-        $file += 
+        $file +=
 @'
 
 [Extensions]
@@ -336,7 +343,7 @@ CertificateTemplate = "$TemplateName"
         #write the file to debug logs (if debug enabled)
         Write-Debug $file
         #create new request inf file
-        Set-Content -Path $inf -Value $file 
+        Set-Content -Path $inf -Value $file
 
         #show inf file if -verbose is used
         Get-Content -Path $inf | Write-Verbose
@@ -349,7 +356,7 @@ CertificateTemplate = "$TemplateName"
 
         write-verbose "Sending certificate request to CA"
         Write-Debug "CAName = $CAName"
-            
+
         if (!$PSBoundParameters.ContainsKey('CAName')) {
             $rootDSE = [System.DirectoryServices.DirectoryEntry]'LDAP://RootDSE'
             $searchBase = [System.DirectoryServices.DirectoryEntry]"LDAP://$($rootDSE.configurationNamingContext)"
@@ -384,7 +391,7 @@ CertificateTemplate = "$TemplateName"
 
         if (($LastExitCode -eq 0) -and ($? -eq $true)) {
             Write-Host "Certificate request successfully finished!" -ForegroundColor Green
-		    	
+
         }
         else {
             throw "Request failed with unknown error. Try with -verbose -debug parameter"
@@ -405,33 +412,33 @@ CertificateTemplate = "$TemplateName"
                 Write-Debug "Exporting without password"
                 $certbytes = $cert.export([System.Security.Cryptography.X509Certificates.X509ContentType]::pfx)
             }
-            
+
 
             #write pfx file
             if ($PSBoundParameters.ContainsKey('ExportPath')) {
-                $pfxPath = Join-Path -Path (Resolve-Path -Path $ExportPath) -ChildPath "$filename.pfx" 
+                $pfxPath = Join-Path -Path (Resolve-Path -Path $ExportPath) -ChildPath "$filename.pfx"
             }
             else {
                 $pfxPath = ".\$filename.pfx"
             }
             $certbytes | Set-Content -Encoding Byte -Path $pfxPath -ea Stop
             Write-Host "Certificate successfully exported to `"$pfxPath`"!" -ForegroundColor Green
-		    
+
             Write-Verbose "deleting exported certificate from computer store"
             # delete certificate from computer store
             $certstore = new-object system.security.cryptography.x509certificates.x509Store('My', 'LocalMachine')
             $certstore.Open('ReadWrite')
             $certstore.Remove($cert)
-            $certstore.close() 
-		    
+            $certstore.close()
+
         }
         else {
             Write-Debug "export parameter is not set. => script finished"
             Write-Host "The certificate with the subject $CN is now installed in the computer store !" -ForegroundColor Green
         }
     }
     catch {
-        #show error message (non terminating error so that the rest of the pipeline input get processed) 
+        #show error message (non terminating error so that the rest of the pipeline input get processed)
         Write-Error $_
     }
     finally {