Posh-ACME

4.0.0

ACMEv2 protocol client for generating certificates using Let's Encrypt (or other ACMEv2 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.0.0

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

Install-PSResource -Name Posh-ACME -Version 4.0.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 Publish-Challenge Remove-PAAccount Remove-PAOrder Remove-PAServer Revoke-PAAuthorization 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.0.0 (2020-12-18)

There is a 3.x to 4.x [migration guide](https://github.com/rmbolger/Posh-ACME/wiki/Frequently-Asked-Questions-%28FAQ%29#how-do-i-upgrade-from-3x-to-4x) in the FAQ on the wiki. But no changes should be necessary for users with existing certs that are renewing using `Submit-Renewal` unless they were also using the `-NewKey` parameter which has been removed. Orders can now be configured to always generate a new private key using `Set-PAOrder -AlwaysNewKey`.

### New Features

* The DNS plugin system has been revamped to support both dns-01 and http-01 challenges. (#124)
 * All existing DNS plugins have been upgraded to the new plugin format. See the README in the plugins folder for details and instructions on how to upgrade your own custom plugins.
 * There are two new http-01 challenge plugins called `WebRoot` and `WebSelfHost`. See their usage guides for details.
* Plugin args are now saved per-order rather than per-account and as JSON rather than XML.
 * This has the side effect that new orders using the same plugin(s) as a previous order will no longer reuse the previous args.
 * Added `Get-PAPluginArgs` which returns a hashtable with the plugin args associated with the current or specified order. You can use this to retrieve another order's plugin args and use that object with your new order.
 * Pre-4.x plugin args will be automatically migrated to per-order plugin args the first time an account is selected using `Set-PAAccount` or on module load for the last selected account. The old file will be backed up with a ".v3" extension in case you need to revert.
* Portable, Cross-Platform encryption is now supported for secure plugin parameters on disk and can be configured on a per-account basis. It is based on a 256-bit AES key generated for the account. This makes it possible to migrate a Posh-ACME config between users, machines, or OSes without needing to re-configure secure plugin args. (#150)
 * To enable, set the `UseAltPluginEncryption` switch on `New-PAAccount` or `Set-PAAccount`. This will immediately re-encrypt plugin args for all orders associated with the account.
 * To disable/revert, run `Set-PAAccount -UseAltPluginEncryption:$false`.
 * If you believe the encryption key has been compromised, use `Set-PAAccount -ResetAltPluginEncryption` to generate a new key and re-encrypt everything.
* `Get-PAPlugin` is a new function that replaces `Get-DnsPlugins` and `Get-DnsPluginHelp`.
 * With no parameters, lists all plugins and their details
 * With a plugin parameter, shows the details for just that plugin
 * With a plugin and `-Help`, shows the plugin's help
 * With a plugin and `-Guide`, opens the default browser to the plugin's online guide
 * With a plugin and `-Params`, displays the plugin-specific parameter sets (#151)
* Added `AlwaysNewKey` switch to `New-PACertificate`, `New-PAOrder`, and `Set-PAOrder`. This flag tells Posh-ACME to always generate a new private key on renewals. The old parameters for key replacement have been removed. (#181)
* Added `UseSerialValidation` switch to `New-PACertificate`, `New-PAOrder`, and `Set-PAOrder`. This flag tells Posh-ACME to process the order's authorization challenges serially rather than in parallel. This is primarily useful for providers like DuckDNS that only allow a single TXT record to be written at a time.
* Added `Complete-PAOrder` which does the final processing steps like downloading the signed cert and updating renewal window for an order that has reached the 'ready' state. This avoids the need to use `New-PACertificate` when doing custom certificate workflows.
* The PfxPass parameter on order objects is now obfuscated when serialized to disk. (#207)
* Added `PfxPassSecure` (SecureString) parameter to `New-PACertificate`, `New-PAOrder`, and `Set-PAOrder` which takes precedence over `PfxPass` if specified. (#207)
* Added `DnsAlias` and `OCSPMustStaple` parameters to `Set-PAOrder`. Changing an order's OCSPMustStaple value will throw a warning that it only affects future certificates generated from the order.
* Added `Plugin`, `PluginArgs`, `DnsAlias`, `DnsSleep`, and `ValidationTimeout` parameters to `New-PAOrder`.
* The `DirectoryUrl` parameter in `Set-PAServer` is now optional. If not specified, it will use the currently active server.
* An attempt will now be made to send anonymous telemetry data to the Posh-ACME team when `Submit-OrderFinalize` is called directly or indirectly.
 * The only data sent is the standard HTTP User-Agent header which includes the Posh-ACME version, PowerShell version, and generic OS platform (Windows/Linux/MacOS/Unknown).
 * This can be disabled per ACME server using a new `DisableTelemetry` parameter in `Set-PAServer`.
 * The data will be used to guide future development decisions in the module.
 * The same User-Agent header is also sent with all calls to the ACME server which is a requirement of the protocol and can't be disabled.
* Added `NoRefresh` switch to `Set-PAServer` which prevents a request to the ACME server to update endpoint and nonce info. This is useful for updating local preferences without making a server round-trip.
* BUYPASS_PROD and BUYPASS_TEST are now recognized shortcuts for the the buypass.com CA environments when you use `Set-PAServer`.
* ZEROSSL_PROD is now a recognized shortcut for the zerossl.com CA when you use `Set-PAServer`.
* Added tab completion for `DirectoryUrl` in `Set-PAServer`.
* Added `Quiet` parameter to `Get-PAServer` which will prevent warnings if the specified server was not found.
* `Remove-PAServer` will now throw a warning instead of an error if the specified server doesn't exist on disk.
* Orders can now be passed by pipeline to `Submit-ChallengeValidation` and `Submit-OrderFinalize`.
* ACME protocol web request details have been moved from Verbose to Debug output and cleaned up so they're easier to follow. Web requests made from plugins will still be in Verbose output for the time being.
* Experimental support for IP address identifiers ([RFC 8738](https://tools.ietf.org/html/rfc8738)) in new orders. This allows you to get a cert for an IP address if your ACME server supports it.
* Private keys for Accounts and Certificates can now use ECC P-521 (secp521r1) based keys using the `ec-521` key length parameter. *This requires support at the ACME server level as well.*

### Breaking Changes

* Function Changes
 * `Publish-DnsChallenge` is now `Publish-Challenge`
 * `Unpublish-DnsChallenge` is now `Unpublish-Challenge`
 * `Save-DnsChallenge` is now `Save-Challenge`
 * `Get-DnsPlugins` and `Get-DnsPluginHelp` have been replaced by `Get-PAPlugin`
 * `Get-PAAuthorizations` is now `Get-PAAuthorization`. The plural function name is still avaialble as an alias but is deprecated and may be removed in a future release.
 * `Invoke-HttpChallengeListener` is deprecated and may be removed in a future release. Users should migrate to the `WebSelfHost` plugin.
* Parameter Changes
 * All `DnsPlugin` parameters are now `Plugin` with a `DnsPlugin` alias for backwards compatibility. The alias should be considered deprecated and may be removed in a future release.
 * The `NoPrefix` switch in Publish/Unpublish-Challenge has been replaced with a `DnsAlias` parameter that will override the `Domain` parameter if specified. "_acme-challenge." will not be automatically added to the `DnsAlias` parameter.
 * `NewKey` has been removed from `Submit-Renewal`
 * `NewKey`/`NewCertKey` have been replaced by `AlwaysNewKey` in `New-PACertificate` and `New-PAOrder`
 * `AlwaysNewKey` has been added to `Set-PAOrder`
 * `DnsPlugin`, `PluginArgs`, `DnsAlias`, `DnsSleep`, `ValidationTimeout` and `Account` parameters have been removed from `Submit-ChallengeValidation`. The account associated with the order must be the currently active account. The rest of the parameters are read directly from the order object and can be modified in advance with `Set-PAOrder` if necessary.
 * `Account` parameter has been removed from `Submit-OrderFinalize`. The account associated with the order must be the currently active account.

### Fixes

* Using `Get-PAOrder` with `-Refresh` will no longer throw a terminating error if the ACME server returns an error. It will warn and return the cached copy of the order instead.
* Fixed `Remove-PAServer` not being able to remove a server that is unreachable.
* `Remove-PAServer` no longer requires confirmation when there are no cached accounts associated with the specified server in the local config.

FileList

Version History

Version Downloads Last updated
4.26.0 29,609 11/2/2024
4.25.1 164,012 9/3/2024
4.25.0 39,968 8/18/2024
4.24.0 131,095 6/19/2024
4.23.1 58,127 5/23/2024
4.23.0 44,424 5/4/2024
4.22.0 46,133 4/13/2024
4.21.0 75,154 3/8/2024
4.20.0 174,524 12/13/2023
4.19.0 125,670 8/26/2023
4.18.0 50,549 6/28/2023
4.17.1 48,918 3/29/2023
4.17.0 26,561 2/21/2023
4.16.0 59,755 11/23/2022
4.15.1 46,080 9/9/2022
4.15.0 9,283 8/27/2022
4.14.0 128,084 4/13/2022
4.13.1 21,975 3/14/2022
4.13.0 4,848 3/7/2022
4.12.0 37,207 1/14/2022
4.11.0 32,175 11/24/2021
4.10.0 32,403 10/6/2021
4.9.0 13,255 9/21/2021
4.8.1 7,311 9/12/2021
4.8.0 5,258 9/10/2021
4.7.1 11,200 8/28/2021
4.7.0 3,292 8/24/2021
4.6.0 143,740 7/26/2021
4.5.0 64,767 5/29/2021
4.4.0 23,087 5/3/2021
4.3.2 41,971 3/14/2021
4.3.1 1,113 3/12/2021
4.3.0 18,545 2/24/2021
4.2.0 28,506 2/1/2021
4.1.0 19,105 1/18/2021
4.0.0 (current version) 39,863 12/19/2020
3.20.0 46,407 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,834 5/7/2020
3.13.0 16,533 4/11/2020
3.12.0 36,345 12/10/2019
3.11.0 4,961 11/12/2019
3.10.0 8,568 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 38,967 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