pki: T5886: add support for ACME protocol (LetsEncrypt) #2758
Conversation
This file contains 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
vyosbot
requested review from
a team,
dmbaturin,
sarthurdev,
zdc,
jestabro and
sever-sever
and removed request for
a team
sarthurdev
approved these changes
Jan 6, 2024
The "idea" of this PR is to add new CLI nodes under the pki subsystem to
activate ACME for any given certificate.
vyos@vyos# set pki certificate NAME acme
Possible completions:
+ domain-name Domain Name
email Email address to associate with certificate
listen-address Local IPv4 addresses to listen on
rsa-key-size Size of the RSA key (default: 2048)
url Remote URL (default:
https://acme-v02.api.letsencrypt.org/directory)
Users choose if the CLI based custom certificates are used
set pki certificate EXAMPLE acme certificate <base64>
or if it should be generated via ACME.
The ACME server URL defaults to LetsEncrypt but can be changed to their staging
API for testing to not get blacklisted.
set pki certificate EXAMPLE acme url https://acme-staging-v02.api.letsencrypt.org/directory
Certificate retrieval has a certbot --dry-run stage in verify() to see if it
can be generated.
After successful generation, the certificate is stored in under
/config/auth/letsencrypt. Once a certificate is referenced in the CLI (e.g. set
interfaces ethernet eth0 eapol certificate EXAMPLE) we call
vyos.config.get_config_dict() which will (if with_pki=True is set) blend in the
base64 encoded certificate into the JSON data structure normally used when
using a certificate set by the CLI.
Using this "design" does not need any change to any other code referencing the
PKI system, as the base64 encoded certificate is already there.
certbot renewal will call the PKI python script to trigger dependency updates.
* show log certbot * monitor log certbot * renew certbot
dmbaturin
approved these changes
Jan 7, 2024
| #include <include/listen-address-ipv4-single.xml.i> | ||
| <leafNode name="rsa-key-size"> | ||
| <properties> | ||
| <help>Size of the RSA key</help> |
There was a problem hiding this comment.
At least Let's Encrypt has already supported issuing ECDSA certs for a while (certbot --key-type=ecdsa), I think we should add support for it as well.
There was a problem hiding this comment.
Definately, but in a separate PR please, as rhe consuming services need to be made aware of it, too
12 tasks
|
@Mergifyio backport sagitta |
✅ Backports have been created
|
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.
Change Summary
pki: T5886: add support for ACME protocol (LetsEncrypt)
The "idea" of this PR is to add new CLI nodes under the pki subsystem to activate ACME for any given certificate.
Users choose if the CLI based custom certificates are used
set pki certificate EXAMPLE acme certificate <base64>or if it should be generated via ACME.The ACME server URL defaults to LetsEncrypt but can be changed to their staging API for testing to not get blacklisted.
set pki certificate EXAMPLE acme url https://acme-staging-v02.api.letsencrypt.org/directoryCertificate retrieval has a
certbot --dry-runstage inverify()to see if it can be generated.After successful generation, the certificate is stored in under
/config/auth/letsencrypt. Once a certificate is referenced in the CLI (e.g.set interfaces ethernet eth0 eapol certificate EXAMPLE) we callvyos.config.get_config_dict()which will (ifwith_pki=Trueis set) blend in the base64 encoded certificate into the JSON data structure normally used when using a certificate set by the CLI.Using this "design" does not need any change to any other code referencing the PKI system, as the base64 encoded certificate is already there.
certbot renewal will call the PKI python script to trigger dependency updates.
Types of changes
Related Task(s)
Related PR(s)
Component(s) name
pki, cerbot, https
Proposed changes
How to test
Smoketest result
Checklist: