Add multi-SAN support to LetsEncrypt - Azure#1692
Open
peterbrooknz wants to merge 2 commits into
Open
Conversation
|
Review this PR in Hyponome for a side-by-side diff of the step-template JSON and any embedded scripts. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
The underlying ACME tooling used by this step template already supports certificates containing multiple Subject Alternative Names (SANs). However, the current template only exposes support for a single certificate name, with the existing exception that a wildcard certificate such as *.example.com may also include the corresponding root domain (example.com) as a SAN.
This limitation makes it difficult to request a single certificate covering multiple related domains and wildcard domains, despite the capability already being available.
For example, it is currently not possible to request a certificate containing:
*.api.example.com
api.example.com
*.internal.example.com
using a single step template invocation.
Results
This PR adds an optional parameter to expose ACME's existing multi-SAN functionality:
Property Value
Name LE_AzureDNS_AdditionalSANs
Label Additional SANs
Help Text Optional list of additional Subject Alternative Names to include in the certificate request. Enter one or more domain names (including wildcard domains if required) separated by commas, semicolons, or new lines.
Example values:
*.api.example.com
api.example.com
*.internal.example.com
When specified, the supplied domains are added to the certificate's SAN list alongside the primary certificate name.
Compatibility
This change is fully backwards compatible.
The new parameter is optional and ignored when not provided. Existing projects and deployments will continue to behave exactly as they do today, with no configuration changes required.
Benefits
Exposes functionality already supported by the underlying ACME tooling.
Allows a single certificate to cover multiple related domains and wildcard domains.
Reduces certificate management overhead where several hostnames are deployed together.
Introduces no behavioural changes for existing consumers of the step template.
After
New parameter:

Pre-requisites
Idshould be a GUID that is not00000000-0000-0000-0000-000000000000Idproperty (updating theIdwill break the Library sync functionality in Octopus).Versionshould be incremented, otherwise the integration with Octopus won't update the step template correctly$LastModifiedByfield must be present, and (optionally) updated with the correct authorCategoryhas been created:{categoryname}.pngmust be present under thestep-templates/logosfolderswitchin thehumanizefunction ingulpfile.babel.jsmust have acasestatement corresponding to itFixes # . If there is an open issue that this PR fixes add it here, otherwise just remove this line