Posh-ACME

4.7.0

ACME protocol client for obtaining certificates using Let's Encrypt (or other ACME compliant CA)

Minimum PowerShell version

5.1

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name Posh-ACME -RequiredVersion 4.7.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name Posh-ACME -Version 4.7.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) 2018 Ryan Bolger. All rights reserved.

Package Details

Author(s)

  • Ryan Bolger

Tags

LetsEncrypt ssl tls certificates acme Linux Mac

Functions

Complete-PAOrder Export-PAAccountKey Get-KeyAuthorization Get-PAAccount Get-PAAuthorization Get-PACertificate Get-PAOrder Get-PAPlugin Get-PAPluginArgs Get-PAServer Install-PACertificate Invoke-HttpChallengeListener New-PAAccount New-PACertificate New-PAOrder New-PAAuthorization Publish-Challenge Remove-PAAccount Remove-PAOrder Remove-PAServer Revoke-PAAuthorization Revoke-PACertificate Save-Challenge Send-ChallengeAck Set-PAAccount Set-PAOrder Set-PAServer Submit-ChallengeValidation Submit-OrderFinalize Submit-Renewal Unpublish-Challenge

PSEditions

Desktop Core

Dependencies

This module has no dependencies.

Release Notes

## 4.7.0 (2021-08-24)

* Servers, Accounts, and Orders all now have configurable Names that also determine the name of their associated folders in the config on the filesystem. (#345) This is a fairly large change, but significant effort has been spent implementing it so that dependent scripts will not break.
 * **Please backup your current config before customizing your object names.** Previous Posh-ACME versions will break trying to read configs with custom names.
 * All customized names may only use the following characters to avoid cross-platform filesystem compatibility issues: `0-9 a-z A-Z - . _ !`.
 * A `NewName` parameter has been added to `Set-PAServer`, `Set-PAAccount`, and `Set-PAOrder` to change the name of each type of object.
 * Server related functions now have an optional `Name` parameter which can be used instead of or in addition to the `DirectoryUrl` parameter. This includes `Get/Remove/Set-PAServer`.
 * If a server doesn't already exist, `Set-PAServer` will use the `-Name` parameter for the new server's name. If the server already exists, it is ignored.
 * Returned server objects now have `Name` and `Folder` properties.
 * Despite being able to customize Server names, you may still only have a single instance of each unique ACME server in your config. This may chang in a future major version.
 * Account related functions that have an `ID` parameter now have a `Name` parameter alias. This includes `Get/Remove/Set-PAAccount` and `Export-PAAccountKey`. The ID parameter should be considered deprecated and in future major versions will be replaced by `Name`.
 * The `ID` parameter was added to `New-PAAccount` to allow setting the customized ID on creation instead of using the server provided default value.
 * Returned account objects now have a `Folder` property and the `id` property now reflects the customizable value.
 * The `id` property on account objects is deprecated and will be changed to `Name` in a future major version.
 * Order related functions now have an optional `Name` parameter to distinguish between multiple orders that may have the same `MainDomain`. This includes `Get/Revoke/New-PACertificate`, `Get/New/Set/Remove-PAOrder`, `Get-PAPluginArgs`, `Invoke-HttpChallengeListener`, and `Submit-Renewal`. In most cases, the `Name` parameter can also be used by itself as a unique identifier for orders.
 * The `Name` parameter on `New-PACertificate` and `New-PAOrder` allows setting the customized order name on creation instead of using the MainDomain default value.
 * Returned order objects now have a `Name` property (not to be confused with `FriendlyName` which only affects the certificate associated with the order).
 * Order related error and log messages that previously mentioned the order's MainDomain have been changed to use the order's Name instead.
 * To retain backwards compatibility with existing 4.x dependent scripts, `Get-PAOrder` will return the single, most recent order when used with `-MainDomain` even if there are multiple matching orders. This also affects `Get-PACertificate` which uses Get-PAOrder under the hood.
 * `Set-PAOrder`, `Revoke-PACertificate`, and `Remove-PAOrder` will throw an error if only `MainDomain` is specified and it matches multiple orders. Specify the `Name` parameter as well to ensure a unique order match.
* Custom plugins can now be loaded from an alternate filesystem location by creating a `POSHACME_PLUGINS` environment variable before the module is loaded. The value should be a folder path that contains uniquely named .ps1 plugin files. If any custom plugins have the same name as native plugins, a warning will be thrown and they will not be loaded.
* Added `New-PAAuthorization` which allows the creation of authorization objects outside the context of an order. NOTE: BuyPass is the only free ACME CA that currently supports this feature.
* Added a `OnlyReturnExisting` parameter to `New-PAAccount` when using an imported key which instructs the ACME server to only return account details if an account already exists for that key.
* Added a `NoSwitch` parameter to `Set-PAServer` so you can modify the active server without switching to it.
* The `AllSANs` field on PACertificate objects now reflects the SAN list on the actual certificate instead of its associated ACME order (just in case the two lists have divered for some strange reason).
* Added missing help on `Get-PAPluginArgs`.
* Default formatting for PAServer objects has been tweaked to show more useful info.
* Default formatting for PAOrder object now includes `Name` and has removed `OSCPMustStaple`.
* The `Quiet` parameter has been removed from the `Get-PAServer -List` parameter set because it didn't make sense.
* Fixed an example in `Remove-PAServer` help.
* Added workaround for BuyPass bug that prevents some error details from being parsed.
* Adjusted support for Account Key Rollover to more closely follow RFC8555 which fixes a bug using it with BuyPass
* Changed some logic in `Revoke-PACertificate` so that it works with BuyPass which doesn't seem to support revocation using the cert's private key.
* Orders using an ECC private key will no longer include Key Encipherment in the CSR's keyUsage when submitting an order for finalization. Key Encipherment is not supported for ECDSA certs and some CAs were rejecting the finalization.

FileList

Version History

Version Downloads Last updated
4.26.0 59,327 11/2/2024
4.25.1 164,020 9/3/2024
4.25.0 40,008 8/18/2024
4.24.0 131,117 6/19/2024
4.23.1 58,135 5/23/2024
4.23.0 44,455 5/4/2024
4.22.0 46,133 4/13/2024
4.21.0 75,156 3/8/2024
4.20.0 174,756 12/13/2023
4.19.0 125,681 8/26/2023
4.18.0 50,552 6/28/2023
4.17.1 48,921 3/29/2023
4.17.0 26,565 2/21/2023
4.16.0 59,843 11/23/2022
4.15.1 46,081 9/9/2022
4.15.0 9,283 8/27/2022
4.14.0 128,520 4/13/2022
4.13.1 21,980 3/14/2022
4.13.0 4,848 3/7/2022
4.12.0 37,242 1/14/2022
4.11.0 32,175 11/24/2021
4.10.0 32,404 10/6/2021
4.9.0 13,276 9/21/2021
4.8.1 7,311 9/12/2021
4.8.0 5,301 9/10/2021
4.7.1 11,202 8/28/2021
4.7.0 (current version) 3,292 8/24/2021
4.6.0 144,518 7/26/2021
4.5.0 64,767 5/29/2021
4.4.0 23,089 5/3/2021
4.3.2 41,971 3/14/2021
4.3.1 1,113 3/12/2021
4.3.0 18,554 2/24/2021
4.2.0 28,506 2/1/2021
4.1.0 19,105 1/18/2021
4.0.0 39,863 12/19/2020
3.20.0 46,555 11/25/2020
3.19.0 6,267 11/20/2020
3.18.1 11,399 11/12/2020
3.18.0 6,365 11/8/2020
3.17.0 24,991 10/9/2020
3.16.0 19,382 8/31/2020
3.15.1 20,833 7/8/2020
3.15.0 4,874 6/22/2020
3.14.0 16,835 5/7/2020
3.13.0 16,533 4/11/2020
3.12.0 36,356 12/10/2019
3.11.0 4,961 11/12/2019
3.10.0 8,629 11/6/2019
3.9.0 1,227 10/26/2019
3.8.0 11,908 9/27/2019
3.7.0 1,057 9/18/2019
3.6.0 3,256 8/20/2019
3.5.0 39,391 6/21/2019
3.4.0 1,954 4/30/2019
3.3.0 969 3/24/2019
3.2.1 590 3/4/2019
3.2.0 1,383 1/22/2019
3.1.1 515 12/22/2018
3.1.0 110 12/16/2018
3.0.1 331 11/30/2018
3.0.0 360 11/13/2018
2.9.1 419 10/26/2018
2.9.0 357 10/6/2018
2.8.0 476 9/12/2018
2.7.1 334 8/30/2018
2.7.0 288 8/12/2018
2.6.0 116 8/1/2018
2.5.0 296 7/12/2018
2.4.0 409 6/1/2018
2.3.0 38 5/29/2018
2.2.0 80 5/24/2018
2.1.1 64 5/19/2018
2.1.0 40 5/18/2018
2.0.1 229 5/13/2018
2.0 43 5/12/2018
1.1 86 5/2/2018
1.0 27 4/28/2018
Show less