From 762a73f1609454afff051803d86dd58a356d97c7 Mon Sep 17 00:00:00 2001 From: Greg Brownstein Date: Tue, 9 Nov 2021 20:04:55 +0000 Subject: [PATCH] Update manifest and docs to 3.3.1 ***NO_CI*** --- VenafiPS/VenafiPS.psd1 | 4 ++-- docs/changelog.md | 6 +++++ docs/functions/Get-TppCustomField.md | 7 +++--- docs/functions/Import-TppCertificate.md | 31 ++++++++++++++++++------- docs/functions/New-TppCertificate.md | 26 +++++++++++++++++---- 5 files changed, 55 insertions(+), 19 deletions(-) diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1 index 60386f2d..5daa4d94 100644 --- a/VenafiPS/VenafiPS.psd1 +++ b/VenafiPS/VenafiPS.psd1 @@ -3,7 +3,7 @@ # # Generated by: Greg Brownstein # -# Generated on: 11/1/2021 +# Generated on: 11/9/2021 # @{ @@ -12,7 +12,7 @@ RootModule = 'VenafiPS.psm1' # Version number of this module. -ModuleVersion = '3.3.0' +ModuleVersion = '3.3.1' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/docs/changelog.md b/docs/changelog.md index 584684ad..4eade045 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,9 @@ +## 3.3.1 +- Remove validation/limitation from `Get-TppCustomField` to only retrieve classes of type X509 Certificate and Device +- Retrieve Application Base custom fields during `New-VenafiSession` +- Fix parameter sets in `Import-TppCertificate` requiring PrivateKey be provided with PKCS#12 certificate, [#37](https://github.com/gdbarron/VenafiPS/issues/37) +- Add `-CertificateAuthorityAttribute` to `New-TppCertificate` to submit values to the CA during enrollment + ## 3.3.0 - Add support for local token/key storage with [PowerShell SecretManagement](https://devblogs.microsoft.com/powershell/secretmanagement-and-secretstore-are-generally-available/). Store your access or refresh token securely and have VenafiPS use it to create a new session. - Add `Get-TppClassAttribute` to list all attributes for a specific class. Helpful for attribute validation and getting values for all attributes. diff --git a/docs/functions/Get-TppCustomField.md b/docs/functions/Get-TppCustomField.md index 5cdbbf09..6805a50a 100644 --- a/docs/functions/Get-TppCustomField.md +++ b/docs/functions/Get-TppCustomField.md @@ -10,7 +10,7 @@ Get-TppCustomField [-Class] [[-VenafiSession] ] [ -CertificatePath [-Name ] - [-EnrollmentAttribute ] [-Reconcile] [-PassThru] [-VenafiSession ] - [] + [-EnrollmentAttribute ] [-Password ] [-Reconcile] [-PassThru] + [-VenafiSession ] [] ``` ### ByFileWithPrivateKey @@ -29,8 +29,8 @@ Import-TppCertificate -PolicyPath -CertificateData [-Name -CertificateData [-Name ] - [-EnrollmentAttribute ] [-Reconcile] [-PassThru] [-VenafiSession ] - [] + [-EnrollmentAttribute ] [-Password ] [-Reconcile] [-PassThru] + [-VenafiSession ] [] ``` ## DESCRIPTION @@ -131,10 +131,9 @@ Accept wildcard characters: False ``` ### -PrivateKey -The private key data. -Requires a Password. +Private key data; requires a value for Password. For a PEM certificate, the private key is in either the RSA or PKCS#8 format. -If the CertificateData field contains a PKCS#12 formatted certificate, this parameter is ignored because only one private key is allowed. +Do not provide for a PKCS#12 certificate as the private key is already included. ```yaml Type: String @@ -149,7 +148,19 @@ Accept wildcard characters: False ``` ### -Password -Password required when including a private key. +Password required if the certificate has a private key. + +```yaml +Type: SecureString +Parameter Sets: ByFile, ByData +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ```yaml Type: SecureString @@ -225,6 +236,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### TppObject, if PassThru provided ## NOTES -Must have Master Admin permission or must have View, Read, Write, Create and Private Key Write permission to the Certificate object. ## RELATED LINKS + +[https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Certificates-Import.php](https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Certificates-Import.php) + diff --git a/docs/functions/New-TppCertificate.md b/docs/functions/New-TppCertificate.md index db19bcf2..a69898ca 100644 --- a/docs/functions/New-TppCertificate.md +++ b/docs/functions/New-TppCertificate.md @@ -8,15 +8,17 @@ Enrolls or provisions a new certificate ### ByName (Default) ``` New-TppCertificate -Path -Name [-CommonName ] [-CertificateType ] - [-CertificateAuthorityPath ] [-ManagementType ] [-SubjectAltName ] - [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] + [-CertificateAuthorityPath ] [-CertificateAuthorityAttribute ] + [-ManagementType ] [-SubjectAltName ] [-PassThru] + [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` ### BySubject ``` New-TppCertificate -Path -CommonName [-CertificateType ] - [-CertificateAuthorityPath ] [-ManagementType ] [-SubjectAltName ] - [-PassThru] [-VenafiSession ] [-WhatIf] [-Confirm] [] + [-CertificateAuthorityPath ] [-CertificateAuthorityAttribute ] + [-ManagementType ] [-SubjectAltName ] [-PassThru] + [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -140,6 +142,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CertificateAuthorityAttribute +Name/value pairs providing any CA attributes to store with the Certificate object. +During enrollment, these values will be submitted to the CA. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ManagementType The level of management that Trust Protection Platform applies to the certificate: - Enrollment: Default.