Update manifest and docs to 6.0.0

Venafi · Nov 16, 2023 · 4b6a50d · 4b6a50d
1 parent 6512af2
commit 4b6a50d
Show file tree

Hide file tree

Showing 135 changed files with 6,826 additions and 5,842 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,32 @@
+## 6.0.0
+This is a major release.  Although every attempt has been made to be backwards compatible, **existing scripts will likely require some updates**.  Please read the full release notes.
+
+- TPP is now TLS Protect Datacenter (TLSPDC) and VaaS is now TLS Protect Cloud (TLSPC).  All functions have been renamed to prefix with `-Vdc` (Venafi Datacenter) or `-Vc` (Venafi Cloud).  Combined platform functions, those prefixed with `-Venafi`, have all been updated to dedicated platform functions.  The desire to add additional functionality for each platform and reduce parameter set complexity drove this decision.  The only exception to this rule are the functions related to the session.  Aliases have been added where applicable.
+- VenafiPS is now signed.  `Test-ModuleHash` has been deprecated.
+- VenafiSession is stored for nested operations each time a function is called directly.  This has 2 main benefits:
+   - Performance enhancement bypassing `Test-VenafiSession` in nested functions
+   - No longer need to pass VenafiSession to each function when sending function output down the pipeline
+ - Parallel functionality added for many functions, notably export and import certificates.  Ensure you are using PowerShell v7!
+ - Add Certificate, Key, and Chain PEM to `Export-VdcCertificate` and `Export-VcCertificate` Base64 output
+ - For PSCredential objects which only required a password and not username, add the ability to provide either a password String, SecureString, or PSCredential.
+ - `Find-VaasObject` has been replaced with dedicated functions `Find-VcCertificateRequest`, `Find-VcLog`, `Find-VcMachine`, and `Find-VcMachineIdentity`.  These functions have property filters specific to their types making it super easy to search.
+ - Environment variable names updated:
+  - TPP_SERVER -> VDC_SERVER
+  - TPP_TOKEN -> VDC_TOKEN
+  - VAAS_KEY -> VC_KEY
+ - Add keystore/private key import to `Import-VcCertificate`
+ - Update `Invoke-VenafiParallel` to be version aware.  Parallel on PowerShell v7+, synchronous otherwise
+ - Add option to save .crt/.key with `Export-VdcCertificate` , [#226](https://github.com/Venafi/VenafiPS/issues/226)
+ - Update TLSPC searching to make -Order case insensitive
+ - Fix `Get-TppAttribute -Disabled` not working, [#221](https://github.com/Venafi/VenafiPS/issues/221)
+ - Fix exporting JKS to a file, [#225](https://github.com/Venafi/VenafiPS/issues/225)
+ - Add option to save exported certificate and key to separate files, [#226](https://github.com/Venafi/VenafiPS/issues/226)
+ - `Revoke-TppCertificate` deprecated, use `Invoke-VdcCertificateAction -Revoke`
+ - Dedicated removal functions created for TLSPC
+ - Add filters `-IsSelfSigned` and `-IsWildcard` to `Find-VdcCertificate`
+ - CodeSign Protect functions have been deprecated
+
+
 ## 5.8.1
 - Remove deprecated application server types from `New-VaasCertificate`
 
@@ -566,5 +595,6 @@
 
 
 
+
 
 
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,141 +3,156 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 08/02/2023
+# Generated on: 11/16/2023
 #
 
 @{
 
-    # Script module or binary module file associated with this manifest.
-    RootModule        = 'VenafiPS.psm1'
+# Script module or binary module file associated with this manifest.
+RootModule = 'VenafiPS.psm1'
 
-    # Version number of this module.
-    ModuleVersion     = '6.0'
+# Version number of this module.
+ModuleVersion = '6.0.0'
 
-    # Supported PSEditions
-    # CompatiblePSEditions = @()
+# Supported PSEditions
+# CompatiblePSEditions = @()
 
-    # ID used to uniquely identify this module
-    GUID              = 'a1c0ef7c-8499-4ac4-9659-52ca91258d13'
+# ID used to uniquely identify this module
+GUID = 'a1c0ef7c-8499-4ac4-9659-52ca91258d13'
 
-    # Author of this module
-    Author            = 'Venafi'
+# Author of this module
+Author = 'Venafi'
 
-    # Company or vendor of this module
-    CompanyName       = 'Venafi'
+# Company or vendor of this module
+CompanyName = 'Venafi'
 
-    # Copyright statement for this module
-    Copyright         = '(c) Venafi. All rights reserved.'
+# Copyright statement for this module
+Copyright = '(c) Venafi. All rights reserved.'
 
-    # Description of the functionality provided by this module
-    Description       = 'Automate your Venafi TLS Protect Datacenter and Cloud platforms!'
+# Description of the functionality provided by this module
+Description = 'Automate your Venafi TLS Protect Datacenter and Cloud platforms!'
 
-    # Minimum version of the PowerShell engine required by this module
-    PowerShellVersion = '5.1'
+# Minimum version of the PowerShell engine required by this module
+PowerShellVersion = '5.1'
 
-    # Name of the PowerShell host required by this module
-    # PowerShellHostName = ''
+# Name of the PowerShell host required by this module
+# PowerShellHostName = ''
 
-    # Minimum version of the PowerShell host required by this module
-    # PowerShellHostVersion = ''
+# Minimum version of the PowerShell host required by this module
+# PowerShellHostVersion = ''
 
-    # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-    # DotNetFrameworkVersion = ''
+# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+# DotNetFrameworkVersion = ''
 
-    # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
-    # ClrVersion = ''
+# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
+# ClrVersion = ''
 
-    # Processor architecture (None, X86, Amd64) required by this module
-    # ProcessorArchitecture = ''
+# Processor architecture (None, X86, Amd64) required by this module
+# ProcessorArchitecture = ''
 
-    # Modules that must be imported into the global environment prior to importing this module
-    # RequiredModules = @()
+# Modules that must be imported into the global environment prior to importing this module
+# RequiredModules = @()
 
-    # Assemblies that must be loaded prior to importing this module
-    # RequiredAssemblies = @()
+# Assemblies that must be loaded prior to importing this module
+# RequiredAssemblies = @()
 
-    # Script files (.ps1) that are run in the caller's environment prior to importing this module.
-    ScriptsToProcess  = 'Classes\TppPermission.ps1', 'Classes\VenafiSession.ps1',
-    'Enum\TppCertificateStage.ps1',
-    'Enum\TppConfigResult.ps1',
-    'Enum\TppEventSeverity.ps1', 'Enum\TppIdentityType.ps1',
-    'Enum\TppManagementType.ps1', 'Enum\TppMetadataResult.ps1',
-    'Enum\TppSecretStoreResult.ps1', 'Enum\TppWorkflowResult.ps1'
+# Script files (.ps1) that are run in the caller's environment prior to importing this module.
+ScriptsToProcess = 'Classes\TppPermission.ps1', 'Classes\VenafiSession.ps1',
+               'Enum\TppCertificateStage.ps1', 'Enum\TppConfigResult.ps1',
+               'Enum\TppEventSeverity.ps1', 'Enum\TppIdentityType.ps1',
+               'Enum\TppManagementType.ps1', 'Enum\TppMetadataResult.ps1',
+               'Enum\TppSecretStoreResult.ps1', 'Enum\TppWorkflowResult.ps1'
 
-    # Type files (.ps1xml) to be loaded when importing this module
-    # TypesToProcess = @()
+# Type files (.ps1xml) to be loaded when importing this module
+# TypesToProcess = @()
 
-    # Format files (.ps1xml) to be loaded when importing this module
-    # FormatsToProcess = @()
+# Format files (.ps1xml) to be loaded when importing this module
+# FormatsToProcess = @()
 
-    # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
-    # NestedModules = @()
+# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
+# NestedModules = @()
 
-    # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-    FunctionsToExport = '*'
+# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
+FunctionsToExport = '*'
 
-    # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
-    CmdletsToExport   = @()
+# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
+CmdletsToExport = @()
 
-    # Variables to export from this module
-    VariablesToExport = 'VenafiSession'
+# Variables to export from this module
+VariablesToExport = 'VenafiSession'
 
-    # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
-    # alises must be listed out for PS core, https://github.com/PowerShell/PowerShell/issues/19099
-    AliasesToExport   =@('Set-VaasCertificateAssignment', 'Add-TppAdaptableHash', 'Add-TppCertificateAssociation', 'Add-TppEngineFolder', 'Convert-TppObject', 'ConvertTo-TppGuid', 'ConvertTo-TppPath', 'Find-TppClient', 'Find-TppEngine', 'Find-TppIdentity', 'fto', 'Find-TppObject',
-    'Find-TppVaultId', 'Get-VaasApplication', 'Get-VaasConnector', 'Get-TppIdentity', 'Get-VaasIssuingTemplate', 'Get-VaasMachine', 'Get-VaasSatellite', 'Get-TppAttribute', 'Get-TppClassAttribute', 'Get-TppCredential', 'Get-TppCustomField', 'Get-TppIdentity',
-    'Get-TppIdentityAttribute', 'Get-TppObject', 'gvdo', 'Get-TppPermission', 'Get-TppSystemStatus', 'Get-TppTeam', 'Get-TppVersion', 'Get-TppWorkflowTicket', 'Import-VaasCertificate', 'Import-TppCertificate', 'Invoke-VaasWorkflow','Invoke-TppRestMethod',
-    'Move-TppObject','New-VaasApplication', 'New-VaasCertificate', 'New-VaasConnector', 'New-VaasMachine', 'New-VaasMachineCommonKeystore', 'New-VaasMachineIis', 'New-TppCapiApplication', 'New-TppCertificate', 'New-TppCustomField', 'New-TppObject', 'New-TppPolicy', 'New-TppToken',
-    'Remove-TppCertificate', 'Remove-TppClient', 'Remove-TppEngineFolder', 'Remove-TppObject', 'Remove-TppPermission', 'Rename-TppObject', 'Revoke-TppGrant', 'Revoke-TppToken', 'Search-TppHistory', 'Set-VaasTeam', 'Set-TppAttribute', 'Set-TppCredential', 'Set-TppPermission', 'Set-TppWorkflowTicketStatus', 'Test-TppIdentity',
-    'Test-TppObject', 'Test-TppToken', 'Write-TppLog')
+# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
+AliasesToExport = 'Set-VaasCertificateAssignment', 'Add-TppAdaptableHash',
+               'Add-TppCertificateAssociation', 'Add-TppEngineFolder',
+               'Convert-TppObject', 'ConvertTo-TppGuid', 'ConvertTo-TppPath',
+               'Find-TppClient', 'Find-TppEngine', 'Find-TppIdentity', 'fto',
+               'Find-TppObject', 'Find-TppVaultId', 'Get-VaasApplication',
+               'Get-VaasConnector', 'Get-TppIdentity', 'Get-VaasIssuingTemplate',
+               'Get-VaasMachine', 'Get-VaasSatellite', 'Get-TppAttribute',
+               'Get-TppClassAttribute', 'Get-TppCredential', 'Get-TppCustomField',
+               'Get-TppIdentityAttribute', 'Get-TppObject', 'gvdo',
+               'Get-TppPermission', 'Get-TppSystemStatus', 'Get-TppTeam',
+               'Get-TppVersion', 'Get-TppWorkflowTicket', 'Import-VaasCertificate',
+               'Import-TppCertificate', 'Invoke-VaasWorkflow',
+               'Invoke-TppRestMethod', 'Move-TppObject', 'New-VaasApplication',
+               'New-VaasCertificate', 'New-VaasConnector', 'New-VaasMachine',
+               'New-VaasMachineCommonKeystore', 'New-VaasMachineIis',
+               'New-TppCapiApplication', 'New-TppCertificate', 'New-TppCustomField',
+               'New-TppObject', 'New-TppPolicy', 'New-TppToken',
+               'Remove-TppCertificate', 'Remove-TppClient', 'Remove-TppEngineFolder',
+               'Remove-TppObject', 'Remove-TppPermission', 'Rename-TppObject',
+               'Revoke-TppGrant', 'Revoke-TppToken', 'Search-TppHistory',
+               'Set-VaasTeam', 'Set-TppAttribute', 'Set-TppCredential',
+               'Set-TppPermission', 'Set-TppWorkflowTicketStatus',
+               'Test-TppIdentity', 'Test-TppObject', 'Test-TppToken', 'Write-TppLog'
 
-    # DSC resources to export from this module
-    # DscResourcesToExport = @()
+# DSC resources to export from this module
+# DscResourcesToExport = @()
 
-    # List of all modules packaged with this module
-    # ModuleList = @()
+# List of all modules packaged with this module
+# ModuleList = @()
 
-    # List of all files packaged with this module
-    # FileList = @()
+# List of all files packaged with this module
+# FileList = @()
 
-    # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
-    PrivateData       = @{
+# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
+PrivateData = @{
 
-        PSData = @{
+    PSData = @{
 
-            # Tags applied to this module. These help with module discovery in online galleries.
-            Tags         = 'Venafi', 'SSL', 'TLS', 'API', 'devsecops', 'powershell'
+        # Tags applied to this module. These help with module discovery in online galleries.
+        Tags = 'Venafi','SSL','TLS','API','devsecops','powershell'
 
-            # A URL to the license for this module.
-            LicenseUri   = 'https://github.com/Venafi/VenafiPS/blob/main/LICENSE'
+        # A URL to the license for this module.
+        LicenseUri = 'https://github.com/Venafi/VenafiPS/blob/main/LICENSE'
 
-            # A URL to the main website for this project.
-            ProjectUri   = 'https://github.com/Venafi/VenafiPS'
+        # A URL to the main website for this project.
+        ProjectUri = 'https://github.com/Venafi/VenafiPS'
 
-            # A URL to an icon representing this module.
-            IconUri      = 'https://raw.githubusercontent.com/Venafi/VenafiPS/main/images/venafi_logo.png'
+        # A URL to an icon representing this module.
+        IconUri = 'https://raw.githubusercontent.com/Venafi/VenafiPS/main/images/venafi_logo.png'
 
-            # ReleaseNotes of this module
-            ReleaseNotes = 'https://github.com/Venafi/VenafiPS/blob/main/CHANGELOG.md'
+        # ReleaseNotes of this module
+        ReleaseNotes = 'https://github.com/Venafi/VenafiPS/blob/main/CHANGELOG.md'
 
-            # Prerelease string of this module
-            # Prerelease = ''
+        # Prerelease string of this module
+        # Prerelease = ''
 
-            # Flag to indicate whether the module requires explicit user acceptance for install/update/save
-            # RequireLicenseAcceptance = $false
+        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
+        # RequireLicenseAcceptance = $false
 
-            # External dependent modules of this module
-            # ExternalModuleDependencies = @()
+        # External dependent modules of this module
+        # ExternalModuleDependencies = @()
 
-        } # End of PSData hashtable
+    } # End of PSData hashtable
 
-    } # End of PrivateData hashtable
+ } # End of PrivateData hashtable
 
-    # HelpInfo URI of this module
-    HelpInfoURI       = 'http://venafips.readthedocs.io/'
+# HelpInfo URI of this module
+HelpInfoURI = 'http://venafips.readthedocs.io/'
 
-    # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
-    # DefaultCommandPrefix = ''
+# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
+# DefaultCommandPrefix = ''
 
 }
 
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,32 @@
+## 6.0.0
+This is a major release.  Although every attempt has been made to be backwards compatible, **existing scripts will likely require some updates**.  Please read the full release notes.
+
+- TPP is now TLS Protect Datacenter (TLSPDC) and VaaS is now TLS Protect Cloud (TLSPC).  All functions have been renamed to prefix with `-Vdc` (Venafi Datacenter) or `-Vc` (Venafi Cloud).  Combined platform functions, those prefixed with `-Venafi`, have all been updated to dedicated platform functions.  The desire to add additional functionality for each platform and reduce parameter set complexity drove this decision.  The only exception to this rule are the functions related to the session.  Aliases have been added where applicable.
+- VenafiPS is now signed.  `Test-ModuleHash` has been deprecated.
+- VenafiSession is stored for nested operations each time a function is called directly.  This has 2 main benefits:
+   - Performance enhancement bypassing `Test-VenafiSession` in nested functions
+   - No longer need to pass VenafiSession to each function when sending function output down the pipeline
+ - Parallel functionality added for many functions, notably export and import certificates.  Ensure you are using PowerShell v7!
+ - Add Certificate, Key, and Chain PEM to `Export-VdcCertificate` and `Export-VcCertificate` Base64 output
+ - For PSCredential objects which only required a password and not username, add the ability to provide either a password String, SecureString, or PSCredential.
+ - `Find-VaasObject` has been replaced with dedicated functions `Find-VcCertificateRequest`, `Find-VcLog`, `Find-VcMachine`, and `Find-VcMachineIdentity`.  These functions have property filters specific to their types making it super easy to search.
+ - Environment variable names updated:
+  - TPP_SERVER -> VDC_SERVER
+  - TPP_TOKEN -> VDC_TOKEN
+  - VAAS_KEY -> VC_KEY
+ - Add keystore/private key import to `Import-VcCertificate`
+ - Update `Invoke-VenafiParallel` to be version aware.  Parallel on PowerShell v7+, synchronous otherwise
+ - Add option to save .crt/.key with `Export-VdcCertificate` , [#226](https://github.com/Venafi/VenafiPS/issues/226)
+ - Update TLSPC searching to make -Order case insensitive
+ - Fix `Get-TppAttribute -Disabled` not working, [#221](https://github.com/Venafi/VenafiPS/issues/221)
+ - Fix exporting JKS to a file, [#225](https://github.com/Venafi/VenafiPS/issues/225)
+ - Add option to save exported certificate and key to separate files, [#226](https://github.com/Venafi/VenafiPS/issues/226)
+ - `Revoke-TppCertificate` deprecated, use `Invoke-VdcCertificateAction -Revoke`
+ - Dedicated removal functions created for TLSPC
+ - Add filters `-IsSelfSigned` and `-IsWildcard` to `Find-VdcCertificate`
+ - CodeSign Protect functions have been deprecated
+
+
 ## 5.8.1
 - Remove deprecated application server types from `New-VaasCertificate`
 
@@ -566,5 +595,6 @@
 
 
 
+