Skip to content

Commit

Permalink
Update manifest and docs to 6.7.1
Browse files Browse the repository at this point in the history
  • Loading branch information
gdbarron committed Dec 13, 2024
1 parent 3cd8b03 commit c78b9b0
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 19 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 6.7.1
- Update `New-VcCertificate -IssuingTemplate` to allow an alias to be provided, [#313](https://github.com/Venafi/VenafiPS/issues/313). `-IssuingTemplate` is now also optional if the application only has 1 associated template.
- Add `Set-VcCertificateRequest -RejectReason` to specify a reason for rejection. The default is 'Rejection processed by VenafiPS'.

## 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`.
Expand Down Expand Up @@ -767,5 +771,6 @@ This is a major release. Although every attempt has been made to be backwards c






4 changes: 2 additions & 2 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: 12/12/2024
# Generated on: 12/13/2024
#

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

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

# Supported PSEditions
# CompatiblePSEditions = @()
Expand Down
5 changes: 5 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 6.7.1
- Update `New-VcCertificate -IssuingTemplate` to allow an alias to be provided, [#313](https://github.com/Venafi/VenafiPS/issues/313). `-IssuingTemplate` is now also optional if the application only has 1 associated template.
- Add `Set-VcCertificateRequest -RejectReason` to specify a reason for rejection. The default is 'Rejection processed by VenafiPS'.

## 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`.
Expand Down Expand Up @@ -767,5 +771,6 @@ This is a major release. Although every attempt has been made to be backwards c






33 changes: 21 additions & 12 deletions docs/functions/New-VcCertificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@ Create certificate request

### Ask (Default)
```
New-VcCertificate -Application <String> -IssuingTemplate <String> -CommonName <String> [-Organization <String>]
[-OrganizationalUnit <String[]>] [-City <String>] [-State <String>] [-Country <String>] [-SanDns <String[]>]
[-SanIP <String[]>] [-SanUri <String[]>] [-SanEmail <String[]>] [-ValidUntil <DateTime>] [-PassThru]
[-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
New-VcCertificate -Application <String> [-IssuingTemplate <String>] -CommonName <String>
[-Organization <String>] [-OrganizationalUnit <String[]>] [-City <String>] [-State <String>]
[-Country <String>] [-SanDns <String[]>] [-SanIP <String[]>] [-SanUri <String[]>] [-SanEmail <String[]>]
[-ValidUntil <DateTime>] [-PassThru] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
```

### Csr
```
New-VcCertificate -Application <String> -IssuingTemplate <String> -Csr <String> [-SanDns <String[]>]
New-VcCertificate -Application <String> [-IssuingTemplate <String>] -Csr <String> [-SanDns <String[]>]
[-SanIP <String[]>] [-SanUri <String[]>] [-SanEmail <String[]>] [-ValidUntil <DateTime>] [-PassThru]
[-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
Expand All @@ -34,26 +35,33 @@ Create certificate

### EXAMPLE 2
```
New-VcCertificate -Application 'MyApp' -CommonName 'app.mycert.com'
```

Create certificate with the template associated with the application

### EXAMPLE 3
```
New-VcCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -CommonName 'app.mycert.com' -SanIP '1.2.3.4'
```

Create certificate with optional SAN data

### EXAMPLE 3
### EXAMPLE 4
```
New-VcCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -CommonName 'app.mycert.com' -ValidUntil (Get-Date).AddMonths(6)
```

Create certificate with specific validity

### EXAMPLE 4
### EXAMPLE 5
```
New-VcCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -CommonName 'app.mycert.com' -PassThru
```

Create certificate and return the created object

### EXAMPLE 5
### EXAMPLE 6
```
New-VcCertificate -Application 'MyApp' -IssuingTemplate 'MSCA - 1 year' -Csr "-----BEGIN CERTIFICATE REQUEST-----\nMIICYzCCAUsCAQAwHj....BoiNIqtVQxFsfT+\n-----END CERTIFICATE REQUEST-----\n"
```
Expand All @@ -63,7 +71,7 @@ Create certificate with a CSR
## PARAMETERS

### -Application
Application name (wildcards supported) or id to associate this certificate.
Application name or id to associate this certificate with.

```yaml
Type: String
Expand All @@ -78,15 +86,16 @@ Accept wildcard characters: False
```
### -IssuingTemplate
Issuing template name (wildcards supported) or id to use.
The template must be available with the selected Application.
Issuing template id, name, or alias.
The template must be associated with the provided Application.
If the application has only one template, this parameter is optional.
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Expand Down
33 changes: 28 additions & 5 deletions docs/functions/Set-VcCertificateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Update an existing application
## SYNTAX

```
Set-VcCertificateRequest -ID <String> [-Approve] [-Wait] [-PassThru] [-VenafiSession <PSObject>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-VcCertificateRequest -ID <String> [-Approve] [-RejectReason <String>] [-Wait] [-PassThru]
[-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -32,20 +32,27 @@ Reject a request

### EXAMPLE 3
```
Set-VcCertificateRequest -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Approve:$false -RejectReason 'not needed'
```

Reject a request with a specific reason

### EXAMPLE 4
```
Set-VcCertificateRequest -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Approve -Wait
```

Approve a request and wait for the certificate request to finish processing

### EXAMPLE 4
### EXAMPLE 5
```
Set-VcCertificateRequest -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Approve -Wait -PassThru
```

Approve a request and wait for the certificate request to finish processing.
Once finished, return the resulting object which contains the newly created certificate details.

### EXAMPLE 5
### EXAMPLE 6
```
Find-VcCertificateRequest -Status PENDING_APPROVAL | Set-VcCertificateRequest -Approve
```
Expand All @@ -56,7 +63,7 @@ Use the Find filter to narrow the scope of requests found.
## PARAMETERS

### -ID
{{ Fill ID Description }}
The certificate request id to process.

```yaml
Type: String
Expand Down Expand Up @@ -85,6 +92,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RejectReason
In the case of rejection, provide a reason.
The default will be 'reject'.
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Rejection processed by VenafiPS
Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the certificate request to either be issued or fail.
Depending on the speed of your CA, this could take some time.
Expand Down

0 comments on commit c78b9b0

Please sign in to comment.