portable version of acme-client, a secure ACME client
C Roff Makefile
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
GNUmakefile
LICENSE.md No commit message May 18, 2016
Linux-seccomp.md Just a quick edit to counter some people getting hung up. You were ri… Feb 3, 2017
README.md No longer supporting older OpenBSD. Mar 12, 2017
acctproc.c
acme-client.1 Sync. Jul 2, 2017
base64.c Sync. Sep 2, 2016
certproc.c Sync. Oct 29, 2016
chngproc.c Sync. Jul 2, 2017
compat-setresgid.c setreuid et al are on Linux, too. May 19, 2016
compat-setresuid.c setreuid et al are on Linux, too. May 19, 2016
config.h Revert netproc chroot to being in use and use ca_mem instead of ca_fi… Nov 2, 2016
dbg.c Sync. Sep 2, 2016
dnsproc.c Sync. Oct 31, 2016
extern.h Sync. Jul 2, 2017
fileproc.c
http.c
http.h Sync. Oct 29, 2016
jsmn.c Sync. May 22, 2016
jsmn.h
json.c Sync. Sep 2, 2016
keyproc.c Sync. Jul 2, 2017
main.c Sync. Jul 2, 2017
netproc.c Sync. Jul 2, 2017
revokeproc.c
rsa.c Sync. Oct 31, 2016
rsa.h Sync. Oct 31, 2016
sandbox-darwin.c Make up to date with sandbox interface. Aug 22, 2016
sandbox-null.c Make up to date with sandbox interface. Aug 22, 2016
sandbox-pledge.c
sandbox-seccomp.c Add fstat as noted in #11 Dec 9, 2016
util-pledge.c Sync. Jun 1, 2016
util-portable.c Revert netproc chroot to being in use and use ca_mem instead of ca_fi… Nov 2, 2016
util.c Sync. Jan 28, 2017

README.md

Synopsis

acme-client-portable is yet another ACME client, specifically for Let's Encrypt, but one with a strong focus on security.

It was named letskencrypt-portable until version 0.1.11.

Please see kristaps.bsd.lv/acme-client for stable releases: this repository is for current development of the portable branch, which tracks acme-client with goop to allow compilation and secure operation on Linux, Mac OS X, NetBSD, and FreeBSD (hence "-portable"). You will need libressl on all systems and libbsd on Linux (except for musl libc systems like Alpine).

Linux has an experimental libseccomp sandbox, but you must enable it yourself. Details in Linux-seccomp.md.

This repository mirrors the master CVS repository: any source changes will occur on the master and be pushed periodically to GitHub. If you have bug reports or patches, either file them here or e-mail them to me. Feature requests will be ignored unless joined by a patch.

What are the difference between this and the non-portable release?

  • Conditional support for OpenBSD's sandbox, Mac OS X, or experimentally on Linux.
  • Proper preprocessor flags for unlocking some Linux functions.
  • Different library names on Linux.
  • Uses GNU make instead of BSD make.

This version tries its best to be secure, but some of its supported operating systems are hostile to security.

On both Linux and Mac OS X, for example, the DNS resolution process is effectively run in the main file-system and un-sandboxed due to the complexity of lookups (needing mDNSresponder in the latter case or a slew of mystery files in the former).

Moreover, while the sandbox on Mac OS X (which is deprecated?) exists, its behaviour is not well-documented and, morever, is weakened to co-exist with the file-system jail.

Feature requests will be ignored unless joined by a patch. If there's something you need, I'm happy to work with you to make it happen. If you really need it, I'm available for contract (contact me by e-mail).

Configuration

Since your system might not be one of the tested ones (FreeBSD, Linux, Linux with musl libc, etc.), you may need to tune some of the values in the GNUmakefile or config.h. Please tell me if you do so, so I can accommodate in future releases.

In the former, you can adjust system-specific compilation flags.

In the latter, you can set the NOBODY_USER value to be the name of an unprivileged user for privilege dropping. You can also set DEFAULT_CA_FILE for the location of the certificate file loaded by libtls. There's also PATH_VAR_EMPTY, which should be an empty directory into which we can create our jail.

License

Sources use the ISC (like OpenBSD) license. See the LICENSE.md file for details.

The jsmn.c and jsmn.h files use the MIT license. See https://github.com/zserge/jsmn for details.