Update manifest and docs to 3.3.1 ***NO_CI***

Venafi · Nov 9, 2021 · 762a73f · 762a73f
1 parent 2873ab0
commit 762a73f
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 19 deletions.
diff --git 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
@@ -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
@@ -10,7 +10,7 @@ Get-TppCustomField [-Class] <String> [[-VenafiSession] <VenafiSession>] [<Common
 ```
 
 ## DESCRIPTION
-Get details about custom fields for either certificates or devices
+Get details about custom fields
 
 ## EXAMPLES
 
@@ -24,8 +24,7 @@ Get custom fields for certificates
 ## PARAMETERS
 
 ### -Class
-Class to get details on. 
-Value can be either Device or X509 Certificate
+Class to get details on
 
 ```yaml
 Type: String
@@ -35,7 +34,7 @@ Aliases:
 Required: True
 Position: 1
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 

diff --git a/docs/functions/Import-TppCertificate.md b/docs/functions/Import-TppCertificate.md
@@ -8,8 +8,8 @@ Import a certificate
 ### ByFile (Default)
 ```
 Import-TppCertificate -PolicyPath <String> -CertificatePath <String> [-Name <String>]
- [-EnrollmentAttribute <Hashtable>] [-Reconcile] [-PassThru] [-VenafiSession <VenafiSession>]
- [<CommonParameters>]
+ [-EnrollmentAttribute <Hashtable>] [-Password <SecureString>] [-Reconcile] [-PassThru]
+ [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
 ### ByFileWithPrivateKey
@@ -29,8 +29,8 @@ Import-TppCertificate -PolicyPath <String> -CertificateData <String> [-Name <Str
 ### ByData
 ```
 Import-TppCertificate -PolicyPath <String> -CertificateData <String> [-Name <String>]
- [-EnrollmentAttribute <Hashtable>] [-Reconcile] [-PassThru] [-VenafiSession <VenafiSession>]
- [<CommonParameters>]
+ [-EnrollmentAttribute <Hashtable>] [-Password <SecureString>] [-Reconcile] [-PassThru]
+ [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
 ## 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
@@ -8,15 +8,17 @@ Enrolls or provisions a new certificate
 ### ByName (Default)
 ```
 New-TppCertificate -Path <String> -Name <String> [-CommonName <String>] [-CertificateType <String>]
- [-CertificateAuthorityPath <String>] [-ManagementType <TppManagementType>] [-SubjectAltName <Hashtable[]>]
- [-PassThru] [-VenafiSession <VenafiSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-CertificateAuthorityPath <String>] [-CertificateAuthorityAttribute <Hashtable>]
+ [-ManagementType <TppManagementType>] [-SubjectAltName <Hashtable[]>] [-PassThru]
+ [-VenafiSession <VenafiSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### BySubject
 ```
 New-TppCertificate -Path <String> -CommonName <String> [-CertificateType <String>]
- [-CertificateAuthorityPath <String>] [-ManagementType <TppManagementType>] [-SubjectAltName <Hashtable[]>]
- [-PassThru] [-VenafiSession <VenafiSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-CertificateAuthorityPath <String>] [-CertificateAuthorityAttribute <Hashtable>]
+ [-ManagementType <TppManagementType>] [-SubjectAltName <Hashtable[]>] [-PassThru]
+ [-VenafiSession <VenafiSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## 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.