Get-Vc CA, Set-Vc template (#382)

Author: gdbarron

RELEASE.md

@@ -1,3 +1,5 @@
-- Add `Get-VdcCertificate -IncludeStatus` to include `Status` and `StatusText` properties in the response.  These correspond to the Certificate Status as seen in the WebAdmin Certificate -> Summary tab.
-- Add `Export-VcReport` to export a Certificate Manager SaaS custom report either to a file or pipeline as a pscustomobject.
-- Final round of VenafiSession improvements.  All advanced use cases, eg. pipe from one environment to another, are now working across ps5/ps7 and parallel processing or not.
+- Add `Set-VcIssuingTemplate` to update template settings. This is super helpful if you want to change the CA associated with your templates in bulk.  Currently, CA product options are supported with additional product details to be supported in the future.
+- Add `Get-VcIssuingTemplate -CertificateAuthority` to retrieve templates for a specific CA
+- Add `Get-VcCertificateAuthority` and associated `Get-VcData -Type 'CertificateAuthority'`
+- Rename TLSPDC/TLSPC to Certificate Manager Self-Hosted/SaaS in documentation/help
+- Add `Get-ThreadJobAvailability` to look for and load module on demand and only PSv5 when using `Invoke-VenafiParallel`.  This should slightly enhance module load speed and parallel processing on PSv7.

Tests/New-VenafiSession.Tests.ps1

@@ -4,9 +4,10 @@ BeforeAll {
 }
 Describe 'New-VenafiSession' {
     BeforeAll {
+        # not a real api key.  made up for unit testing.
         $cred = New-Object System.Management.Automation.PSCredential('AccessToken', ('9655b66c-8e5e-4b2b-b43e-edfa33b70e5f' | ConvertTo-SecureString -AsPlainText -Force))
     }
-    Context 'TLSPC key' {
+    Context 'Certificate Manager, SaaS key' {
         # BeforeAll {
         #     Mock New-VenafiSession -MockWith {
         #         $newSession = [VenafiSession] @{
@@ -18,8 +19,8 @@ Describe 'New-VenafiSession' {
         #     }
         #     $sess = New-VenafiSession -VaasKey $cred -PassThru
         # }
-        # It 'should set platform to TLSPC' {
-        #     $sess.Platform | Should -Be 'TLSPC'
+        # It 'should set platform to Certificate Manager, SaaS' {
+        #     $sess.Platform | Should -Be 'Certificate Manager, SaaS'
         # }
         # It 'should set AuthType to Key' {
         #     $sess.AuthType | Should -Be 'Key'

VenafiPS/Private/Find-VcObject.ps1

@@ -1,10 +1,10 @@
 function Find-VcObject {
     <#
     .SYNOPSIS
-    Find different objects on TLSPC
+    Find different objects on Certificate Manager, SaaS
 
     .DESCRIPTION
-    Find objects of type ActivityLog, Machine, MachineIdentity, CertificateRequest, CertificateInstance on TLSPC.
+    Find objects of type ActivityLog, Machine, MachineIdentity, CertificateRequest, CertificateInstance on Certificate Manager, SaaS.
     Supports -First for page size; the max page size is 1000.
     To find certificate objects, use Find-VcCertificate.
 
@@ -32,7 +32,7 @@ function Find-VcObject {
     .PARAMETER VenafiSession
     Authentication for the function.
     The value defaults to the script session object $VenafiSession created by New-VenafiSession.
-    A TLSPC key can also provided.
+    A Certificate Manager, SaaS key can also provided.
 
     .OUTPUTS
     PSCustomObject

VenafiPS/Private/Get-ThreadJobAvailability.ps1

@@ -0,0 +1,6 @@
+function Get-ThreadJobAvailability {
+    if ($null -eq $script:ThreadJobAvailable) {
+        $script:ThreadJobAvailable = ($null -ne (Get-Module -Name Microsoft.PowerShell.ThreadJob -ListAvailable))
+    }
+    return $script:ThreadJobAvailable
+}

VenafiPS/Private/Get-VcData.ps1

@@ -19,7 +19,7 @@ function Get-VcData {
         [string] $InputObject,
 
         [parameter(Mandatory)]
-        [ValidateSet('Application', 'VSatellite', 'Certificate', 'IssuingTemplate', 'Team', 'Machine', 'Tag', 'Plugin', 'Credential', 'Algorithm', 'User', 'CloudProvider', 'CloudKeystore')]
+        [ValidateSet('Application', 'VSatellite', 'Certificate', 'IssuingTemplate', 'Team', 'Machine', 'Tag', 'Plugin', 'Credential', 'Algorithm', 'User', 'CloudProvider', 'CloudKeystore', 'CertificateAuthority')]
         [string] $Type,
 
         [parameter(Mandatory, ValueFromPipeline, ParameterSetName = 'Name')]
@@ -168,6 +168,24 @@ function Get-VcData {
                 break
             }
 
+            'CertificateAuthority' {
+                if ( -not $script:vcCertificateAuthority ) {
+                    $script:vcCertificateAuthority = Get-VcCertificateAuthority -All | Sort-Object -Property name
+                    $latest = $true
+                }
+
+                $allObject = $script:vcCertificateAuthority
+
+                if ( $InputObject ) {
+                    $thisObject = $allObject | Where-Object { $InputObject -in $_.name, $_.certificateAuthorityId }
+                    if ( -not $thisObject -and -not $latest ) {
+                        $script:vcCertificateAuthority = Get-VcCertificateAuthority -All | Sort-Object -Property name
+                        $thisObject = $script:vcCertificateAuthority | Where-Object { $InputObject -in $_.name, $_.certificateAuthorityId }
+                    }
+                }
+                break
+            }
+
             'Credential' {
                 if ( -not $script:vcCredential ) {
                     $script:vcCredential = Invoke-VenafiRestMethod -UriLeaf "credentials" |

VenafiPS/Private/Get-VenafiSession.ps1

@@ -26,14 +26,14 @@ function Get-VenafiSession {
         }
         # elseif ( $env:VDC_TOKEN ) {
         #     $env:VDC_TOKEN
-        #     Write-Debug 'Using TLSPDC token environment variable'
+        #     Write-Debug 'Using Certificate Manager, Self-Hosted token environment variable'
         # }
         # elseif ( $env:VC_KEY ) {
         #     $env:VC_KEY
-        #     Write-Debug 'Using TLSPC key environment variable'
+        #     Write-Debug 'Using Certificate Manager, SaaS key environment variable'
         # }
         else {
-            throw [System.ArgumentException]::new('Please run New-VenafiSession or provide a TLSPC key or TLSPDC token to -VenafiSession.')
+            throw [System.ArgumentException]::new('Please run New-VenafiSession or provide a Certificate Manager, SaaS key or Certificate Manager, Self-Hosted token to -VenafiSession.')
         }
 
         # find out the platform from the calling function

VenafiPS/Private/Invoke-VenafiParallel.ps1

@@ -77,9 +77,7 @@ function Invoke-VenafiParallel {
 
     # if ThreadJob module is not available, throttle to 1 so multithreading isn't used
     if ( $PSVersionTable.PSVersion.Major -eq 5 ) {
-        if ( -not $script:ThreadJobAvailable ) {
-            $goParallel = $false
-        }
+        $goParallel = Get-ThreadJobAvailability
     }
 
     # no need for parallel processing overhead if just processing a few
@@ -133,7 +131,8 @@ function Invoke-VenafiParallel {
         # import via path instead of just module name to support non-standard paths, eg. development work
 
         # ParallelImportPath is set during module import
-        Import-Module $using:script:ParallelImportPath -Force
+        # bypass is skipping items in psm1 that aren't needed during parallel processing
+        Import-Module $using:script:ParallelImportPath -Force -ArgumentList 'bypass'
 
         # bring in the venafi session from the calling ps session
         $script:VenafiSession = $using:VenafiSession

VenafiPS/Private/Test-VenafiSession.ps1

@@ -4,7 +4,7 @@ function Test-VenafiSession {
     Validate authentication session/key/token
 
     .DESCRIPTION
-    Validate authentication session from New-VenafiSession, a TLSPC key, or TLSPDC token.
+    Validate authentication session from New-VenafiSession, a Certificate Manager, SaaS key, or Certificate Manager, Self-Hosted token.
 
     .PARAMETER InvocationInfo
     InvocationInfo from calling function
@@ -56,15 +56,15 @@ function Test-VenafiSession {
                 $VenafiSession = $script:VenafiSession
             }
             else {
-                throw 'Please run New-VenafiSession or provide a TLSPC key or TLSPDC token.'
+                throw 'Please run New-VenafiSession or provide a Certificate Manager, SaaS key or Certificate Manager, Self-Hosted token.'
             }
         }
 
         switch ($VenafiSession.GetType().Name) {
             'PSCustomObject' {
 
                 if ( -not $VenafiSession.Key -and -not $VenafiSession.Token ) {
-                    throw "You must first connect to either TLSPC or a TLSPDC server with New-VenafiSession"
+                    throw "You must first connect to either Certificate Manager, SaaS or a Certificate Manager, Self-Hosted server with New-VenafiSession"
                 }
 
                 # make sure the auth type and url we have match
@@ -75,7 +75,7 @@ function Test-VenafiSession {
 
                 if ( $Platform -eq 'VDC' ) {
                     if ( $VenafiSession.Token.Expires -and $VenafiSession.Token.Expires -lt (Get-Date).ToUniversalTime() ) {
-                        throw 'TLSPDC token has expired.  Execute New-VenafiSession and rerun your command.'
+                        throw 'Certificate Manager, Self-Hosted token has expired.  Execute New-VenafiSession and rerun your command.'
                     }
                 }
 
@@ -93,7 +93,7 @@ function Test-VenafiSession {
             }
 
             Default {
-                throw "Unknown session '$VenafiSession'.  Please run New-VenafiSession or provide a TLSPC key or TLSPDC access token."
+                throw "Unknown session '$VenafiSession'.  Please run New-VenafiSession or provide a Certificate Manager, SaaS key or Certificate Manager, Self-Hosted access token."
             }
         }
 

VenafiPS/Public/Add-VcTeamMember.ps1

@@ -4,7 +4,7 @@ function Add-VcTeamMember {
     Add members to a team
 
     .DESCRIPTION
-    Add members to a TLSPC team
+    Add members to a Certificate Manager, SaaS team
 
     .PARAMETER Team
     Team ID or name to add to
@@ -15,15 +15,15 @@ function Add-VcTeamMember {
     .PARAMETER VenafiSession
     Authentication for the function.
     The value defaults to the script session object $VenafiSession created by New-VenafiSession.
-    A TLSPC key can also provided.
+    A Certificate Manager, SaaS key can also provided.
 
     .INPUTS
     Team
 
     .EXAMPLE
     Add-VcTeamMember -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Member @('ca7ff555-88d2-4bfc-9efa-2630ac44c1f3', 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f4')
 
-    Add members to a TLSPC team
+    Add members to a Certificate Manager, SaaS team
 
     #>
 

VenafiPS/Public/Add-VcTeamOwner.ps1

@@ -4,7 +4,7 @@ function Add-VcTeamOwner {
     Add owners to a team
 
     .DESCRIPTION
-    Add owners to a TLSPC team
+    Add owners to a Certificate Manager, SaaS team
 
     .PARAMETER Team
     Team ID or name
@@ -16,7 +16,7 @@ function Add-VcTeamOwner {
     .PARAMETER VenafiSession
     Authentication for the function.
     The value defaults to the script session object $VenafiSession created by New-VenafiSession.
-    A TLSPC key can also provided.
+    A Certificate Manager, SaaS key can also provided.
 
     .INPUTS
     Team