Skip to content

Latest commit

 

History

History
230 lines (142 loc) · 14.1 KB

README.md

File metadata and controls

230 lines (142 loc) · 14.1 KB
Raw

ACMEd

Build Status License MIT OR Apache 2.0

The Automatic Certificate Management Environment (ACME), is an internet standard (RFC 8555) which allows to automate X.509 certificates signing by a Certification Authority (CA). ACMEd is one of the many clients for this protocol.

Key features

  • http-01, dns-01 and tls-alpn-01 challenges
  • IP identifier validation extension RFC 8738
  • RSA 2048, RSA 4096, ECDSA P-256, ECDSA P-384, ECDSA P-521, Ed25519 and Ed448 certificates and account keys
  • Internationalized domain names support
  • Fully customizable challenge validation action
  • Fully customizable archiving method (yes, you can use git or anything else)
  • Nice and simple configuration file
  • A pre-built set of hooks that can be used in most circumstances
  • Run as a deamon: no need to set-up timers, crontab or other time-triggered process
  • Retry of HTTPS request rejected with a badNonce or other recoverable errors
  • Customizable HTTPS requests rate limits
  • External account binding
  • Optional key pair reuse (useful for HPKP)
  • For a given certificate, each domain name may be validated using a different challenge
  • A standalone server dedicated to the tls-alpn-01 challenge validation (tacd)

Planned features

  • STAR certificates RFC 8739
  • Daemon and certificates management via the acmectl tool
  • HTTP/2 support

Project status

This project is usable, but is still a work in progress. Each release should works well and accordingly to its documentation. Because the API has not been stabilized yet, breaking changes may occur. Therefore, before any upgrade, you are invited to read the CHANGELOG and check if any change can break your setup.

Please keep in mind this software has neither been subject to a peer review nor to a security audit.

Documentation

The wiki will provides you with an overview as well as guides. You may contribute to it by creating a PR on the acmed-wiki repository.

For exhaustive references, the following man pages are available:

  • acmed (8)
  • acmed.toml (5)
  • tacd (8)

An easy way to read those pages without installing ACMEd is to downloads and pipe them to the man utility:

curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/acmed.8" | man -l -
curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/acmed.toml.5" | man -l -
curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/tacd.8" | man -l -

Alternatively, using zsh, you can use the following variants. Useful on system where man is unable to read from stdin (yes BSD, that's you).

man =(curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/acmed.8")
man =(curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/acmed.toml.5")
man =(curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/tacd.8")

Build from source

In order to compile ACMEd, you will need the Rust compiler and its package manager, Cargo. The minimum supported Rust version(MSRV) is 1.74, although it is recommended to use the latest stable one.

ACMEd depends OpenSSL 1.1.0 or higher.

On systems based on Debian/Ubuntu, you may need to install the libssl-dev, build-essential and pkg-config packages.

On Alpine Linux, you may need to install the openssl-dev and alpine-sdk packages.

$ make
$ make install

To build ACMEd and tacd inside a temporary Docker container, use the contrib/docker/build-docker.sh helper script. It currently supports Debian Buster / Stretch.

You can also build a container image for some k8s deployement, use the contrib/docker/build-docker-image.sh script. It supports the same targets as the build-docker.sh script.

When build succeed, you can start the container with docker run --rm -v /path/to/conf/dir:/etc/acmed acmed:buster.

Advanced options

You can specify a space or comma separated list of features to activate in the FEATURE variable. The possible features are:

  • openssl_dyn (default): use OpenSSL as the cryptographic library, dynamically linked (mutually exclusive with openssl_vendored).
  • openssl_vendored: use OpenSSL as the cryptographic library, statically linked (mutually exclusive with openssl_dyn).

You can also specify the target triple to build for in the TARGET variable. Please note that, if used, this variable must be specified for both make and make install.

For example, you can build statically linked binaries using the openssl_vendored feature and the x86_64-unknown-linux-musl target.

make FEATURES="openssl_vendored" TARGET="x86_64-unknown-linux-musl"

The following environment variables can be used to change default values at compile and/or install time:

  • PREFIX (install): system user prefix (default to /usr)
  • BINDIR (install): system binary directory (default to $PREFIX/bin)
  • DATADIR (install): system data directory (default to $PREFIX/share)
  • MAN5DIR (install): system directory where pages 5 manuals are located (default to $DATADIR/man/man5)
  • MAN8DIR (install): system directory where pages 8 manuals are located (default to $DATADIR/man/man8)
  • SYSCONFDIR (compile and install): system configuration directory (default to /etc)
  • VARLIBDIR (compile and install): directory for persistent data modified by ACMEd (default to /var/lib)
  • RUNSTATEDIR (compile): system run-time variable data (default to /run)
  • ACMED_DEFAULT_ACCOUNTS_DIR (compile): directory where account files are stored (default to $VARLIBDIR/acmed/accounts)
  • ACMED_DEFAULT_CERT_DIR (compile): directory where certificates and private keys are stored (default to $VARLIBDIR/acmed/certs)
  • ACMED_DEFAULT_CERT_FORMAT (compile): format for certificates and private keys files names (default to { name }_{ key_type }.{ file_type }.{ ext })
  • ACMED_DEFAULT_CONFIG_FILE (compile): main configuration file (default to $SYSCONFDIR/acmed/acmed.toml)
  • ACMED_DEFAULT_PID_FILE (compile): PID file for the main acmed process (default to $RUNSTATEDIR/acmed.pid)
  • TACD_DEFAULT_PID_FILE (compile): PID file for the tacd process (default to $RUNSTATEDIR/tacd.pid)

For example, the following will compile a binary that will use the /usr/share/etc/acmed/acmed.toml configuration file and will be installed in the /usr/local/bin directory :

make SYSCONFDIR="/usr/share/etc"
make BINDIR="/usr/local/bin" install

Packaging

Most of the time, when packaging, you want to install the program in a dedicated directory. This is possible using the DESTDIR variable.

make DESTDIR="/path/to/my/package/directory" install

Packager tip: If you package ACMEd in a way it does not run as root, you might want to create another package that provides the Polkit rule file located in the contrib/polkit directory. This package should depends on both acmed and Polkit.

Frequently Asked Questions

Why this project?

After testing multiple ACME clients, I found out none of them supported all the features I expected (see the key features above). It may have been possible to contribute or fork an existing project, however I believe those project made architectural choices incompatible with what i wanted, and therefore it would be as much or less work to start a new project from scratch.

Is it free and open-source software?

Yes, ACMEd is dual-licensed under the MIT and Apache 2.0 terms. See LICENSE-MIT.txt and LICENSE-APACHE-2.0.txt for details.

The man pages, the default hooks configuration file, the CHANGELOG.md and the README.md files are released under the GNU All-Permissive License.

Can it automatically change my server configuration?

Short answer: No.

Long answer: At some points in a certificate's life, ACMEd triggers some hooks in order to let you customize how some actions are done, therefore you can use those hooks to modify any server configuration you wish. However, this may not be what you are looking for since it cannot proactively detect which certificates should be emitted since ACMEd only manages certificates that have already been declared in the configuration files.

How should I configure my TLS server?

You decide. ACMEd only retrieve the certificate for you, it does not impose any specific configuration or limitation on how to use it. For the record, if you are looking for security recommendations on TLS deployment, you can follow the ANSSI TLS guide (the english version might not be the latest version of this document, if possible use the french one).

Is it suitable for beginners?

It depends on your definition of a beginner. This software is intended to be used by system administrators with a certain knowledge of their environment. Furthermore, it is also expected to know the bases of the ACME protocol. Let's Encrypt wrote a nice article about how it works.

It doesn't work!

ACMEd releases do work properly. Knowing that new users tend to shoot themselves in the foot with hooks, you might want to check those before considering moving away to a different software. Files path and permissions are very common traps, you definitely want to check those.

By the way, don't forget to change the log verbosity using --log-level trace.

Should ACMEd run as root?

Running ACMEd as root is the simplest configuration since you do not have to worry about access rights, especially within hooks (Eg: restart a service).

However, if you are concerned with safety, you should create a dedicated user for ACMEd. Before doing so, please consider the following points:

  • Will my services be able to read both the private key and the certificate?
  • Will the ACMEd user be able to execute the hooks?

The last one could be achieved using either sudo or Polkit (see the contrib/polkit directory).

Why is there no option to run ACMEd as a specific user or group?

The reason some services has such an option is because at startup they may have to load data only accessible by root, hence they have to change the user themselves after those data are loaded. For example, this is wildly used in web servers so they load a private key, which should only be accessible by root. Since ACMEd does not have such requirement, it should be run directly as the correct user.

How can I run ACMEd with systemd?

The contrib/systemd contains examples of a service file as well as a sysusers.d and a tmpfiles.d file. Those files might need adjustments in order to work on your system (e.g. paths, user, group,...), but it's probably a good starting point.

Does ACMEd uses any threading or parallelization?

Yes, ACMEd is asynchronous and uses a multi-thread runtime. In order to check the number of threads, you may run the following command:

ps -T -p "$(pgrep acmed)"

Can I use the same account on different endpoints?

Yes, that is possible. However, you should aware that some certificate authorities (e.g. Let's Encrypt) have policies restricting the use multiple accounts. Please check your CA's documentation.

Why is RSA 2048 the default certificate key type?

Short answer: it is sufficiently secured, has good performances and is wildly supported.

Before choosing a different algorithm for your certificate's signature, you might want to consider all of those three points.

  • For security, you may refer to the table 2 of the NIST SP 800-57 Part 1.
  • For performances, you can launch the following command on your machine: openssl speed rsa2048 rsa3072 rsa4096 ecdsap256 ecdsap384 ecdsap521 ed25519 ed448. Your server will be affected by the signature performances and the clients connecting to it will be affected by the verification performances.
  • Nowadays, every client support ECDSA. Therefore, unless you have very specific requirements, you can safely use it. At time of writing, EdDSA certificates are not yet supported, but it might become a thing in the future.

Currently, security and client support aren't the main concerns since every possible type of certificates is good enough on those two points. The performances clearly favors ECDSA P-256, Ed25519 and RSA 2048. The later has been chosen as the default because it's the most wildly used as Certification Authorities root and intermediate certificates. This choice may change in favor of ECDSA since Let's Encrypt issued a full ECDSA certificates chain.

Why is ECDSA P-256 the default account key type?

RFC 8555 section 6.2 defines ECDSA P-256 as the only account key type that any ACME servers must implement. It is therefore the best choice for the default value.

Why can I chose the CSR's digest type but not the certificate's?

Well, you sign the CSR, so obviously you can chose which digest to use. However, the certificate is signed by the certificate authority, so its digest choice is up to your CA. I agree that being able to chose the CSR's digest type is of low importance, sorry if it gave you false hopes about the certificate.