There is a 3.x to 4.x migration guide 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
andWebSelfHost
. 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 onNew-PAAccount
orSet-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.
- To enable, set the
Get-PAPlugin
is a new function that replacesGet-DnsPlugins
andGet-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 toNew-PACertificate
,New-PAOrder
, andSet-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 toNew-PACertificate
,New-PAOrder
, andSet-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 useNew-PACertificate
when doing custom certificate workflows. - The PfxPass parameter on order objects is now obfuscated when serialized to disk. (#207)
- Added
PfxPassSecure
(SecureString) parameter toNew-PACertificate
,New-PAOrder
, andSet-PAOrder
which takes precedence overPfxPass
if specified. (#207) - Added
DnsAlias
andOCSPMustStaple
parameters toSet-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
, andValidationTimeout
parameters toNew-PAOrder
. - The
DirectoryUrl
parameter inSet-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 inSet-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 toSet-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
inSet-PAServer
. - Added
Quiet
parameter toGet-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
andSubmit-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) 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 nowPublish-Challenge
Unpublish-DnsChallenge
is nowUnpublish-Challenge
Save-DnsChallenge
is nowSave-Challenge
Get-DnsPlugins
andGet-DnsPluginHelp
have been replaced byGet-PAPlugin
Get-PAAuthorizations
is nowGet-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 theWebSelfHost
plugin.
- Parameter Changes
- All
DnsPlugin
parameters are nowPlugin
with aDnsPlugin
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 aDnsAlias
parameter that will override theDomain
parameter if specified. "_acme-challenge." will not be automatically added to theDnsAlias
parameter. NewKey
has been removed fromSubmit-Renewal
NewKey
/NewCertKey
have been replaced byAlwaysNewKey
inNew-PACertificate
andNew-PAOrder
AlwaysNewKey
has been added toSet-PAOrder
DnsPlugin
,PluginArgs
,DnsAlias
,DnsSleep
,ValidationTimeout
andAccount
parameters have been removed fromSubmit-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 withSet-PAOrder
if necessary.Account
parameter has been removed fromSubmit-OrderFinalize
. The account associated with the order must be the currently active account.
- All
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.