Repository files navigation

For an introduction to the ACME protocol and its DNS verification part, you can refer to our beta releaseblog post.

Agnos is a single-binary program allowing you to easily obtain certificates (including wildcards) fromLet's Encrypt usingDNS-01 challenges. It answers Let's Encrypt DNS queries on its own, bypassing the need for API calls to your DNS provider.

DNS-01 is summarized by Let's Encrypt documentation as such:

Pros

• You can use this challenge to issue certificates containing wildcard domain names.
• It works well even if you have multiple web servers.

Cons

• Keeping API credentials on your web server is risky.
• Your DNS provider might not offer an API.
• Your DNS API may not provide information on propagation times.

By serving its own DNS answers, agnos:

• Nullify the need for API and API credentials
• Nullify all concerns regarding propagation times

Hence,agnos removes virtually all downsides of dns-01 challenges.

Agnos leverages let's encrypt capability to follow DNSNS records. It requires you to add to your DNS zone:

1. AnA (orAAAA) record pointing to the public-facing IP address of the server on which agnos will run. On this server, UDP port 53 (the one used by DNS) should be open and free.
2. For each domain you will want to validate, anNS record for the corresponding_acme-challenge sub-domain, indicating that agnos should be used as a name server for this specific domain.

1. Installation
   1. Released binary
   2. Archlinux AUR package
   3. Packaging on other systems
   4. Building
   5. Setting capabilities to not run agnos as root
2. Usage
   1. Let's Encrypt accounts
   2. Agnos configuration
      1. General
      2. Accounts
      3. Certificates
   3. Configuration of your DNS provider
   4. Running agnos
   5. Systemd units
3. Developers
   1. Integration testing
4. User feedback requested

These instructions are given for a Linux system but a similar process will likely work on all Unixes, and maybe windows.

Pre-compiled binaries for Linux/amd64 are available for every taggedrelease. Be aware that they are statically built using musl and vendoring their own openssl so that they can easily be installed even on older distributions.

Agnos is available in theAUR. You can install it using:yay -S agnos.

If you have packaged agnos for another system, feel free to open a PR to add it to the list.

Agnos is written in Rust. To build it you will need to have the rust toolchain installed. On most distributions, this should be done usingrustup.

Once you have obtained the source, the following command will build the binaries and put them in the root directory of the repo.

cd agnos/make build-release

or more explicitly:

cargo build --locked --bins --releasestrip target/release/agnosstrip target/release/agnos-generate-accounts-keysln target/release/agnos agnosln target/release/agnos-generate-accounts-keys agnos-generate-accounts-keys

Because agnos listen on the low-numbered port 53, it requires special privileges. Running it as root will do, but if you (understandably) don't want to do that, the following command is for you:

# as rootsetcap'cap_net_bind_service=+ep' agnos# agnos is the file of the binary as compiled above

Let's Encrypt accounts are identified by an e-mail address and a private RSA key. To generate such a key, use the following command:

openssl genrsa 2048> /path/to/store/the/key.pem

or if you prefer a larger key:

openssl genrsa 4096> /path/to/store/the/key.pem

Alternatively, you can use the providedagnos-generate-accounts-keys binary to automatically generate private keys for the accounts listed in the configuration file.

agnos-generate-accounts-keys --key-size 4096 your_config.toml

Agnos is configured via a singleTOML file. A commented example is available inconfig_example.toml.

It is advised to use absolute rather than relative paths in the configuration file.

There are three "levels" in the configuration:

The general configuration level is where the IP address to listen on is provided.

dns_listen_addr ="1.2.3.4:53"

Several Let's Encrypt accounts can be specified. For each account, an e-mail address and the path to the account RSA private key must be provided.

[[accounts]]email="contact@doma.in"private_key_path ="priv_key.pem"

For each account, several certificates can be ordered. Each certificate can cover multiple domains. On disk, a certificate is represented by two files: the full certificate chain, and the private key of the certificate (different from the account private key). This certificate private key is regenerated on each certificate renewal by default but if one is already present on disk, it can be reused by setting thereuse_private_key option to trueIn the configuration file,accounts.certificates is a TOMLarray of tables meaning that several certificates can be attached to one account by writing them one after the other.

# A first certificate ordered for that account.[[accounts.certificates]]domains =  ["doma.in","*.doma.in"]fullchain_output_file ="fullchain_A.pem"key_output_file ="cert_key_A.pem"# Renew certificate 30 days in advance of its expiration# (this is the default value and can be omitted).renewal_days_advance =30# Regenerate a private key for the certificate on each renewal# (this is the default value and can be omitted).reuse_private_key =false# A second certificate ordered for that account.[[accounts.certificates]]renewal_days_advance =21# Renew certificate 21 days in advance of its expiration.domains =  ["examp.le","another.examp.le","and.a.completely.different.one"]fullchain_output_file ="fullchain_B.pem"key_output_file ="cert_key_B.pem"# Re-use the existing private key.# If no key is present at `key_output_file`, a new one will be generated.reuse_private_key =true

Say that we have the following domains we want to obtain a certificate (or multiple certificates) for:

• doma.in
• its wildcard variant:*.doma.in
• examp.le
• andanother.examp.le.

Notice here that we are not requesting a certificate for*.examp.le but only for one subdomain:another.examp.le.

Let's encrypt DNS-01 challenge is going to ask for TXT DNS records on the following three domains:

• _acme-challenge.doma.in (for bothdoma.in and its wildcard)
• _acme-challenge.examp.le
• _acme-challenge.another.examp.le

Let's assume that agnos is going to run on a server whose public-facing IP address is1.2.3.4. The goal is to indicate that the three_acme_challenge domains cited above are managed by agnos usingNS DNS records.NS records usually point to domain names, so we will also set anA record onagnos-ns.doma.in to point to1.2.3.4 (hereagnos-ns.doma.in is entirely arbitrary, it could be another, completely independent domain, you control, likemy-agnos.com).

We create the following records:

In the zone ofdoma.in

agnos-ns.doma.in            A       1.2.3.4_acme-challenge.doma.in     NS      agnos-ns.doma.in

In the zone ofexamp.le

_acme-challenge.examp.le            NS      agnos-ns.doma.in_acme-challenge.another.examp.le    NS      agnos-ns.doma.in

Note: Though it may seem cumbersome, this must only be done once from your DNS provider web interface. Once it is done, you will never have to touch aTXT record.

agnos takes a single command line argument, the path to its configuration file, and two optional flags:--no-staging to use Let's Encrypt production server, and--debug to display more debug information. Help is available viaagnos --help.

When running, it checks whether the certificates of the full chain are going to expire in the next 30 days (by default), and only renew them in that case, so it is suitable to be used in a cron job.

A systemd unit and timers are provided in thesystemd folder of this repo.

PRs and issues are very welcome.

Build using usualcargo commands.

Integration testing is done using nix-shell. Launch it withnix-shell integration-testing/shell.nix --pure --run agnos-test-script.

If you are using agnos, please consider telling me about your user experience here:#62.