Skip to content

Commit

Permalink
Update manifest and docs to 6.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
gdbarron committed Dec 12, 2024
1 parent a2e960b commit eec8edc
Show file tree
Hide file tree
Showing 14 changed files with 397 additions and 224 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
## 6.7.0
- Add `Set-VcCertificateRequest` to approve requests. Optionally, use `-Wait` for the certificate to be issued and certificate details to be available.
- Add `Initialize-PSSodium -Force` to force installation of the module if it doesn't exist. This is used by the new parameters `Export-VcCertificate -Force`, `Import-VcCertificate -Force`, `New-VcMachine -Force`, `New-VcMachineCommonKeystore -Force`, and `New-VcMachineIis -Force`.
- Update `New-VcCertificate` to retrieve default validity date from the issuing template instead of a set 90 days
- Fix `Find-VdcCertificate -CountOnly` error [#309](https://github.com/Venafi/VenafiPS/issues/309)
- Updates to better facilitate moving certificates/keys between environments.
- Update `Export-VcCertificate -PKCS12` to allow exporting to base64 in addition to a file.
- Add standard names for Format in return objects in TLSPC and TLSPDC.
- Add PrivateKeyPasswordCredential in return objects to keep from having to provide again further down the pipeline
- Add `Invoke-VcGraphQL` for queries and mutations. This isn't used for too much as of now, but the framework is here for when it's needed.
- Update `Get-VcData` to use `Invoke-VcGraphQL` for Application and Team id and names. Quite often we are just converting names into IDs so graphql should give us a performance bump as opposed to the REST api.
- Deprecated `Add-VcCertificateAssociation`


## 6.6.1
- Fix bogus error during `New-VcMachineCommonKeystore` [#304](https://github.com/Venafi/VenafiPS/issues/304)
- Update VC machine creation components due to API deprecation
Expand Down Expand Up @@ -752,5 +766,6 @@ This is a major release. Although every attempt has been made to be backwards c






34 changes: 17 additions & 17 deletions VenafiPS/VenafiPS.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Generated by: Greg Brownstein
#
# Generated on: 11/28/2024
# Generated on: 12/12/2024
#

@{
Expand All @@ -12,7 +12,7 @@
RootModule = 'VenafiPS.psm1'

# Version number of this module.
ModuleVersion = '6.7'
ModuleVersion = '6.7.0'

# Supported PSEditions
# CompatiblePSEditions = @()
Expand Down Expand Up @@ -69,20 +69,19 @@ PowerShellVersion = '5.1'
# 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 = 'Add-VcTeamMember', 'Add-VcTeamOwner',
'Add-VdcAdaptableHash', 'Add-VdcCertificateAssociation',
'Add-VdcEngineFolder', 'Add-VdcTeamMember', 'Add-VdcTeamOwner',
'Convert-VdcObject', 'ConvertTo-VdcGuid', 'ConvertTo-VdcPath',
'Export-VcCertificate', 'Export-VdcCertificate',
'Export-VdcVaultObject', 'Find-VcCertificate',
'Find-VcCertificateInstance', 'Find-VcCertificateRequest',
'Find-VcLog', 'Find-VcMachine', 'Find-VcMachineIdentity',
'Find-VdcCertificate', 'Find-VdcClient', 'Find-VdcEngine',
'Find-VdcIdentity', 'Find-VdcObject', 'Find-VdcVaultId',
'Get-VcApplication', 'Get-VcCertificate', 'Get-VcConnector',
'Get-VcIssuingTemplate', 'Get-VcMachine', 'Get-VcMachineIdentity',
'Get-VcSatellite', 'Get-VcTag', 'Get-VcTeam', 'Get-VcUser',
'Get-VcWebhook', 'Get-VdcAttribute', 'Get-VdcCertificate',
FunctionsToExport = 'Add-VcTeamMember', 'Add-VcTeamOwner', 'Add-VdcAdaptableHash',
'Add-VdcCertificateAssociation', 'Add-VdcEngineFolder',
'Add-VdcTeamMember', 'Add-VdcTeamOwner', 'Convert-VdcObject',
'ConvertTo-VdcGuid', 'ConvertTo-VdcPath', 'Export-VcCertificate',
'Export-VdcCertificate', 'Export-VdcVaultObject',
'Find-VcCertificate', 'Find-VcCertificateInstance',
'Find-VcCertificateRequest', 'Find-VcLog', 'Find-VcMachine',
'Find-VcMachineIdentity', 'Find-VdcCertificate', 'Find-VdcClient',
'Find-VdcEngine', 'Find-VdcIdentity', 'Find-VdcObject',
'Find-VdcVaultId', 'Get-VcApplication', 'Get-VcCertificate',
'Get-VcConnector', 'Get-VcIssuingTemplate', 'Get-VcMachine',
'Get-VcMachineIdentity', 'Get-VcSatellite', 'Get-VcTag', 'Get-VcTeam',
'Get-VcUser', 'Get-VcWebhook', 'Get-VdcAttribute', 'Get-VdcCertificate',
'Get-VdcClassAttribute', 'Get-VdcCredential', 'Get-VdcCustomField',
'Get-VdcEngineFolder', 'Get-VdcIdentity', 'Get-VdcIdentityAttribute',
'Get-VdcObject', 'Get-VdcPermission', 'Get-VdcSystemStatus',
Expand All @@ -109,7 +108,8 @@ FunctionsToExport = 'Add-VcTeamMember', 'Add-VcTeamOwner',
'Set-VdcCredential', 'Set-VdcPermission',
'Set-VdcWorkflowTicketStatus', 'Test-VdcIdentity', 'Test-VdcObject',
'Test-VdcToken', 'Write-VdcLog', 'Set-VcCertificate',
'Get-VcSatelliteWorker', 'Remove-VcSatelliteWorker', 'Set-VcCertificateRequest'
'Get-VcSatelliteWorker', 'Remove-VcSatelliteWorker',
'Set-VcCertificateRequest'

# 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 = @()
Expand Down
15 changes: 15 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
## 6.7.0
- Add `Set-VcCertificateRequest` to approve requests. Optionally, use `-Wait` for the certificate to be issued and certificate details to be available.
- Add `Initialize-PSSodium -Force` to force installation of the module if it doesn't exist. This is used by the new parameters `Export-VcCertificate -Force`, `Import-VcCertificate -Force`, `New-VcMachine -Force`, `New-VcMachineCommonKeystore -Force`, and `New-VcMachineIis -Force`.
- Update `New-VcCertificate` to retrieve default validity date from the issuing template instead of a set 90 days
- Fix `Find-VdcCertificate -CountOnly` error [#309](https://github.com/Venafi/VenafiPS/issues/309)
- Updates to better facilitate moving certificates/keys between environments.
- Update `Export-VcCertificate -PKCS12` to allow exporting to base64 in addition to a file.
- Add standard names for Format in return objects in TLSPC and TLSPDC.
- Add PrivateKeyPasswordCredential in return objects to keep from having to provide again further down the pipeline
- Add `Invoke-VcGraphQL` for queries and mutations. This isn't used for too much as of now, but the framework is here for when it's needed.
- Update `Get-VcData` to use `Invoke-VcGraphQL` for Application and Team id and names. Quite often we are just converting names into IDs so graphql should give us a performance bump as opposed to the REST api.
- Deprecated `Add-VcCertificateAssociation`


## 6.6.1
- Fix bogus error during `New-VcMachineCommonKeystore` [#304](https://github.com/Venafi/VenafiPS/issues/304)
- Update VC machine creation components due to API deprecation
Expand Down Expand Up @@ -752,5 +766,6 @@ This is a major release. Although every attempt has been made to be backwards c






157 changes: 0 additions & 157 deletions docs/functions/Add-VcCertificateAssociation.md

This file was deleted.

43 changes: 25 additions & 18 deletions docs/functions/Export-VcCertificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ Export certificate data from TLSPC
### PEM (Default)
```
Export-VcCertificate -ID <String> [-PrivateKeyPassword <PSObject>] [-IncludeChain] [-OutPath <String>]
[-ThrottleLimit <Int32>] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
[-ThrottleLimit <Int32>] [-Force] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

### PKCS12
```
Export-VcCertificate -ID <String> -PrivateKeyPassword <PSObject> -OutPath <String> [-PKCS12]
[-ThrottleLimit <Int32>] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Export-VcCertificate -ID <String> -PrivateKeyPassword <PSObject> [-OutPath <String>] [-PKCS12]
[-ThrottleLimit <Int32>] [-Force] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -130,7 +132,7 @@ In the case of PKCS12, the file will be saved to the root of the folder.
```yaml
Type: String
Parameter Sets: PEM
Parameter Sets: (All)
Aliases:

Required: False
Expand All @@ -140,20 +142,9 @@ Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: PKCS12
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PKCS12
Export the certificate and private key in PKCS12 format.
Export the certificate and private key in PKCS12 format.
The default is PEM.
Requires PowerShell v7.1+.
```yaml
Expand Down Expand Up @@ -186,6 +177,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Force
Force installation of PSSodium if not already installed
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -VenafiSession
Authentication for the function.
The value defaults to the script session object $VenafiSession created by New-VenafiSession.
Expand Down Expand Up @@ -228,7 +234,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
### PSCustomObject
## NOTES
This function requires the use of sodium encryption.
This function requires PSSodium.
Install it from the PSGallery or use -Force to automatically install.
PS v7.1+ is required.
On Windows, the latest Visual C++ redist must be installed.
See https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist.
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/Find-VcCertificateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ PS C:\> {{ Add example code here }}
## PARAMETERS

### -Status
Request status, either ISSUED or FAILED
Request status, one of 'NEW', 'PENDING', 'PENDING_APPROVAL', 'PENDING_FINAL_APPROVAL', 'REJECTED_APPROVAL', 'REQUESTED', 'ISSUED', 'REJECTED', 'CANCELLED', 'REVOKED', 'FAILED', 'DELETED'

```yaml
Type: String
Expand Down
Loading

0 comments on commit eec8edc

Please sign in to comment.