7b87554ca1
In 0c7c1660f7 I have set allowSubstitutes
to false, which avoided the substitution of the certificates.
Unfortunately substitution may still happen later when the certificate
is merged with the CA bundle. So the merged CA bundle might be
substituted from a binary cache but the certificate itself is built
locally, which could result in a different certificate in the bundle.
So instead of adding just yet another workaround, I've now hardcoded all
the certificates and keys in a separate file. This also moves
letsencrypt.nix into its own directory so we don't mess up
nixos/tests/common too much.
This was long overdue and should finally make the dependency graph for
the ACME test more deterministic.
Signed-off-by: aszlig <aszlig@nix.build>
445 lines
16 KiB
Nix
445 lines
16 KiB
Nix
# Fully pluggable module to have Letsencrypt's Boulder ACME service running in
|
|
# a test environment.
|
|
#
|
|
# The certificate for the ACME service is exported as:
|
|
#
|
|
# config.test-support.letsencrypt.caCert
|
|
#
|
|
# This value can be used inside the configuration of other test nodes to inject
|
|
# the snakeoil certificate into security.pki.certificateFiles or into package
|
|
# overlays.
|
|
#
|
|
# Another value that's needed if you don't use a custom resolver (see below for
|
|
# notes on that) is to add the letsencrypt node as a nameserver to every node
|
|
# that needs to acquire certificates using ACME, because otherwise the API host
|
|
# for letsencrypt.org can't be resolved.
|
|
#
|
|
# A configuration example of a full node setup using this would be this:
|
|
#
|
|
# {
|
|
# letsencrypt = import ./common/letsencrypt;
|
|
#
|
|
# example = { nodes, ... }: {
|
|
# networking.nameservers = [
|
|
# nodes.letsencrypt.config.networking.primaryIPAddress
|
|
# ];
|
|
# security.pki.certificateFiles = [
|
|
# nodes.letsencrypt.config.test-support.letsencrypt.caCert
|
|
# ];
|
|
# };
|
|
# }
|
|
#
|
|
# By default, this module runs a local resolver, generated using resolver.nix
|
|
# from the parent directory to automatically discover all zones in the network.
|
|
#
|
|
# If you do not want this and want to use your own resolver, you can just
|
|
# override networking.nameservers like this:
|
|
#
|
|
# {
|
|
# letsencrypt = { nodes, ... }: {
|
|
# imports = [ ./common/letsencrypt ];
|
|
# networking.nameservers = [
|
|
# nodes.myresolver.config.networking.primaryIPAddress
|
|
# ];
|
|
# };
|
|
#
|
|
# myresolver = ...;
|
|
# }
|
|
#
|
|
# Keep in mind, that currently only _one_ resolver is supported, if you have
|
|
# more than one resolver in networking.nameservers only the first one will be
|
|
# used.
|
|
#
|
|
# Also make sure that whenever you use a resolver from a different test node
|
|
# that it has to be started _before_ the ACME service.
|
|
{ config, pkgs, lib, ... }:
|
|
|
|
let
|
|
softhsm = pkgs.stdenv.mkDerivation rec {
|
|
name = "softhsm-${version}";
|
|
version = "1.3.8";
|
|
|
|
src = pkgs.fetchurl {
|
|
url = "https://dist.opendnssec.org/source/${name}.tar.gz";
|
|
sha256 = "0flmnpkgp65ym7w3qyg78d3fbmvq3aznmi66rgd420n33shf7aif";
|
|
};
|
|
|
|
configureFlags = [ "--with-botan=${pkgs.botan}" ];
|
|
buildInputs = [ pkgs.sqlite ];
|
|
};
|
|
|
|
pkcs11-proxy = pkgs.stdenv.mkDerivation {
|
|
name = "pkcs11-proxy";
|
|
|
|
src = pkgs.fetchFromGitHub {
|
|
owner = "SUNET";
|
|
repo = "pkcs11-proxy";
|
|
rev = "944684f78bca0c8da6cabe3fa273fed3db44a890";
|
|
sha256 = "1nxgd29y9wmifm11pjcdpd2y293p0dgi0x5ycis55miy97n0f5zy";
|
|
};
|
|
|
|
postPatch = "patchShebangs mksyscalls.sh";
|
|
|
|
nativeBuildInputs = [ pkgs.cmake ];
|
|
buildInputs = [ pkgs.openssl pkgs.libseccomp ];
|
|
};
|
|
|
|
mkGoDep = { goPackagePath, url ? "https://${goPackagePath}", rev, sha256 }: {
|
|
inherit goPackagePath;
|
|
src = pkgs.fetchgit { inherit url rev sha256; };
|
|
};
|
|
|
|
goose = let
|
|
owner = "liamstask";
|
|
repo = "goose";
|
|
rev = "8488cc47d90c8a502b1c41a462a6d9cc8ee0a895";
|
|
version = "20150116";
|
|
|
|
in pkgs.buildGoPackage rec {
|
|
name = "${repo}-${version}";
|
|
|
|
src = pkgs.fetchFromBitbucket {
|
|
name = "${name}-src";
|
|
inherit rev owner repo;
|
|
sha256 = "1jy0pscxjnxjdg3hj111w21g8079rq9ah2ix5ycxxhbbi3f0wdhs";
|
|
};
|
|
|
|
goPackagePath = "bitbucket.org/${owner}/${repo}";
|
|
subPackages = [ "cmd/goose" ];
|
|
extraSrcs = map mkGoDep [
|
|
{ goPackagePath = "github.com/go-sql-driver/mysql";
|
|
rev = "2e00b5cd70399450106cec6431c2e2ce3cae5034";
|
|
sha256 = "085g48jq9hzmlcxg122n0c4pi41sc1nn2qpx1vrl2jfa8crsppa5";
|
|
}
|
|
{ goPackagePath = "github.com/kylelemons/go-gypsy";
|
|
rev = "08cad365cd28a7fba23bb1e57aa43c5e18ad8bb8";
|
|
sha256 = "1djv7nii3hy451n5jlslk0dblqzb1hia1cbqpdwhnps1g8hqjy8q";
|
|
}
|
|
{ goPackagePath = "github.com/lib/pq";
|
|
rev = "ba5d4f7a35561e22fbdf7a39aa0070f4d460cfc0";
|
|
sha256 = "1mfbqw9g00bk24bfmf53wri5c2wqmgl0qh4sh1qv2da13a7cwwg3";
|
|
}
|
|
{ goPackagePath = "github.com/mattn/go-sqlite3";
|
|
rev = "2acfafad5870400156f6fceb12852c281cbba4d5";
|
|
sha256 = "1rpgil3w4hh1cibidskv1js898hwz83ps06gh0hm3mym7ki8d5h7";
|
|
}
|
|
{ goPackagePath = "github.com/ziutek/mymysql";
|
|
rev = "0582bcf675f52c0c2045c027fd135bd726048f45";
|
|
sha256 = "0bkc9x8sgqbzgdimsmsnhb0qrzlzfv33fgajmmjxl4hcb21qz3rf";
|
|
}
|
|
{ goPackagePath = "golang.org/x/net";
|
|
url = "https://go.googlesource.com/net";
|
|
rev = "10c134ea0df15f7e34d789338c7a2d76cc7a3ab9";
|
|
sha256 = "14cbr2shl08gyg85n5gj7nbjhrhhgrd52h073qd14j97qcxsakcz";
|
|
}
|
|
];
|
|
};
|
|
|
|
boulder = let
|
|
owner = "letsencrypt";
|
|
repo = "boulder";
|
|
rev = "9c6a1f2adc4c26d925588f5ae366cfd4efb7813a";
|
|
version = "20180129";
|
|
|
|
in pkgs.buildGoPackage rec {
|
|
name = "${repo}-${version}";
|
|
|
|
src = pkgs.fetchFromGitHub {
|
|
name = "${name}-src";
|
|
inherit rev owner repo;
|
|
sha256 = "09kszswrifm9rc6idfaq0p1mz5w21as2qbc8gd5pphrq9cf9pn55";
|
|
};
|
|
|
|
postPatch = ''
|
|
# compat for go < 1.8
|
|
sed -i -e 's/time\.Until(\([^)]\+\))/\1.Sub(time.Now())/' \
|
|
test/ocsp/helper/helper.go
|
|
|
|
find test -type f -exec sed -i -e '/libpkcs11-proxy.so/ {
|
|
s,/usr/local,${pkcs11-proxy},
|
|
}' {} +
|
|
|
|
sed -i -r \
|
|
-e '/^def +install/a \ return True' \
|
|
-e 's,exec \./bin/,,' \
|
|
test/startservers.py
|
|
|
|
cat ${lib.escapeShellArg snakeOilCerts.ca.key} > test/test-ca.key
|
|
cat ${lib.escapeShellArg snakeOilCerts.ca.cert} > test/test-ca.pem
|
|
'';
|
|
|
|
# Until vendored pkcs11 is go 1.9 compatible
|
|
preBuild = ''
|
|
rm -r go/src/github.com/letsencrypt/boulder/vendor/github.com/miekg/pkcs11
|
|
'';
|
|
|
|
# XXX: Temporarily brought back putting the source code in the output,
|
|
# since e95f17e2720e67e2eabd59d7754c814d3e27a0b2 was removing that from
|
|
# buildGoPackage.
|
|
preInstall = ''
|
|
mkdir -p $out
|
|
pushd "$NIX_BUILD_TOP/go"
|
|
while read f; do
|
|
echo "$f" | grep -q '^./\(src\|pkg/[^/]*\)/${goPackagePath}' \
|
|
|| continue
|
|
mkdir -p "$(dirname "$out/share/go/$f")"
|
|
cp "$NIX_BUILD_TOP/go/$f" "$out/share/go/$f"
|
|
done < <(find . -type f)
|
|
popd
|
|
'';
|
|
|
|
extraSrcs = map mkGoDep [
|
|
{ goPackagePath = "github.com/miekg/pkcs11";
|
|
rev = "6dbd569b952ec150d1425722dbbe80f2c6193f83";
|
|
sha256 = "1m8g6fx7df6hf6q6zsbyw1icjmm52dmsx28rgb0h930wagvngfwb";
|
|
}
|
|
];
|
|
|
|
goPackagePath = "github.com/${owner}/${repo}";
|
|
buildInputs = [ pkgs.libtool ];
|
|
};
|
|
|
|
boulderSource = "${boulder.out}/share/go/src/${boulder.goPackagePath}";
|
|
|
|
softHsmConf = pkgs.writeText "softhsm.conf" ''
|
|
0:/var/lib/softhsm/slot0.db
|
|
1:/var/lib/softhsm/slot1.db
|
|
'';
|
|
|
|
snakeOilCerts = import ./snakeoil-certs.nix;
|
|
|
|
wfeDomain = "acme-v01.api.letsencrypt.org";
|
|
wfeCertFile = snakeOilCerts.${wfeDomain}.cert;
|
|
wfeKeyFile = snakeOilCerts.${wfeDomain}.key;
|
|
|
|
siteDomain = "letsencrypt.org";
|
|
siteCertFile = snakeOilCerts.${siteDomain}.cert;
|
|
siteKeyFile = snakeOilCerts.${siteDomain}.key;
|
|
|
|
# Retrieved via:
|
|
# curl -s -I https://acme-v01.api.letsencrypt.org/terms \
|
|
# | sed -ne 's/^[Ll]ocation: *//p'
|
|
tosUrl = "https://letsencrypt.org/documents/2017.11.15-LE-SA-v1.2.pdf";
|
|
tosPath = builtins.head (builtins.match "https?://[^/]+(.*)" tosUrl);
|
|
|
|
tosFile = pkgs.fetchurl {
|
|
url = tosUrl;
|
|
sha256 = "0yvyckqzj0b1xi61sypcha82nanizzlm8yqy828h2jbza7cxi26c";
|
|
};
|
|
|
|
resolver = let
|
|
message = "You need to define a resolver for the letsencrypt test module.";
|
|
firstNS = lib.head config.networking.nameservers;
|
|
in if config.networking.nameservers == [] then throw message else firstNS;
|
|
|
|
cfgDir = pkgs.stdenv.mkDerivation {
|
|
name = "boulder-config";
|
|
src = "${boulderSource}/test/config";
|
|
nativeBuildInputs = [ pkgs.jq ];
|
|
phases = [ "unpackPhase" "patchPhase" "installPhase" ];
|
|
postPatch = ''
|
|
sed -i -e 's/5002/80/' -e 's/5002/443/' va.json
|
|
sed -i -e '/listenAddress/s/:4000/:80/' wfe.json
|
|
sed -i -r \
|
|
-e ${lib.escapeShellArg "s,http://boulder:4000/terms/v1,${tosUrl},g"} \
|
|
-e 's,http://(boulder|127\.0\.0\.1):4000,https://${wfeDomain},g' \
|
|
-e '/dnsResolver/s/127\.0\.0\.1:8053/${resolver}:53/' \
|
|
*.json
|
|
if grep 4000 *.json; then exit 1; fi
|
|
|
|
# Change all ports from 1909X to 909X, because the 1909X range of ports is
|
|
# allocated by startservers.py in order to intercept gRPC communication.
|
|
sed -i -e 's/\<1\(909[0-9]\)\>/\1/' *.json
|
|
|
|
# Patch out all additional issuer certs
|
|
jq '. + {ca: (.ca + {Issuers:
|
|
[.ca.Issuers[] | select(.CertFile == "test/test-ca.pem")]
|
|
})}' ca.json > tmp
|
|
mv tmp ca.json
|
|
'';
|
|
installPhase = "cp -r . \"$out\"";
|
|
};
|
|
|
|
components = {
|
|
gsb-test-srv.args = "-apikey my-voice-is-my-passport";
|
|
gsb-test-srv.waitForPort = 6000;
|
|
gsb-test-srv.first = true;
|
|
boulder-sa.args = "--config ${cfgDir}/sa.json";
|
|
boulder-wfe.args = "--config ${cfgDir}/wfe.json";
|
|
boulder-ra.args = "--config ${cfgDir}/ra.json";
|
|
boulder-ca.args = "--config ${cfgDir}/ca.json";
|
|
boulder-va.args = "--config ${cfgDir}/va.json";
|
|
boulder-publisher.args = "--config ${cfgDir}/publisher.json";
|
|
boulder-publisher.waitForPort = 9091;
|
|
ocsp-updater.args = "--config ${cfgDir}/ocsp-updater.json";
|
|
ocsp-updater.after = [ "boulder-publisher" ];
|
|
ocsp-responder.args = "--config ${cfgDir}/ocsp-responder.json";
|
|
ct-test-srv = {};
|
|
mail-test-srv.args = let
|
|
key = "${boulderSource}/test/mail-test-srv/minica-key.pem";
|
|
crt = "${boulderSource}/test/mail-test-srv/minica.pem";
|
|
in
|
|
"--closeFirst 5 --cert ${crt} --key ${key}";
|
|
};
|
|
|
|
commonPath = [ softhsm pkgs.mariadb goose boulder ];
|
|
|
|
mkServices = a: b: with lib; listToAttrs (concatLists (mapAttrsToList a b));
|
|
|
|
componentServices = mkServices (name: attrs: let
|
|
mkSrvName = n: "boulder-${n}.service";
|
|
firsts = lib.filterAttrs (lib.const (c: c.first or false)) components;
|
|
firstServices = map mkSrvName (lib.attrNames firsts);
|
|
firstServicesNoSelf = lib.remove "boulder-${name}.service" firstServices;
|
|
additionalAfter = firstServicesNoSelf ++ map mkSrvName (attrs.after or []);
|
|
needsPort = attrs ? waitForPort;
|
|
inits = map (n: "boulder-init-${n}.service") [ "mysql" "softhsm" ];
|
|
portWaiter = {
|
|
name = "boulder-${name}";
|
|
value = {
|
|
description = "Wait For Port ${toString attrs.waitForPort} (${name})";
|
|
after = [ "boulder-real-${name}.service" "bind.service" ];
|
|
requires = [ "boulder-real-${name}.service" ];
|
|
requiredBy = [ "boulder.service" ];
|
|
serviceConfig.Type = "oneshot";
|
|
serviceConfig.RemainAfterExit = true;
|
|
script = let
|
|
netcat = "${pkgs.netcat-openbsd}/bin/nc";
|
|
portCheck = "${netcat} -z 127.0.0.1 ${toString attrs.waitForPort}";
|
|
in "while ! ${portCheck}; do :; done";
|
|
};
|
|
};
|
|
in lib.optional needsPort portWaiter ++ lib.singleton {
|
|
name = if needsPort then "boulder-real-${name}" else "boulder-${name}";
|
|
value = {
|
|
description = "Boulder ACME Component (${name})";
|
|
after = inits ++ additionalAfter;
|
|
requires = inits;
|
|
requiredBy = [ "boulder.service" ];
|
|
path = commonPath;
|
|
environment.GORACE = "halt_on_error=1";
|
|
environment.SOFTHSM_CONF = softHsmConf;
|
|
environment.PKCS11_PROXY_SOCKET = "tcp://127.0.0.1:5657";
|
|
serviceConfig.WorkingDirectory = boulderSource;
|
|
serviceConfig.ExecStart = "${boulder}/bin/${name} ${attrs.args or ""}";
|
|
serviceConfig.Restart = "on-failure";
|
|
};
|
|
}) components;
|
|
|
|
in {
|
|
imports = [ ../resolver.nix ];
|
|
|
|
options.test-support.letsencrypt.caCert = lib.mkOption {
|
|
type = lib.types.path;
|
|
description = ''
|
|
A certificate file to use with the <literal>nodes</literal> attribute to
|
|
inject the snakeoil CA certificate used in the ACME server into
|
|
<option>security.pki.certificateFiles</option>.
|
|
'';
|
|
};
|
|
|
|
config = {
|
|
test-support = {
|
|
resolver.enable = let
|
|
isLocalResolver = config.networking.nameservers == [ "127.0.0.1" ];
|
|
in lib.mkOverride 900 isLocalResolver;
|
|
letsencrypt.caCert = snakeOilCerts.ca.cert;
|
|
};
|
|
|
|
# This has priority 140, because modules/testing/test-instrumentation.nix
|
|
# already overrides this with priority 150.
|
|
networking.nameservers = lib.mkOverride 140 [ "127.0.0.1" ];
|
|
networking.firewall.enable = false;
|
|
|
|
networking.extraHosts = ''
|
|
127.0.0.1 ${toString [
|
|
"sa.boulder" "ra.boulder" "wfe.boulder" "ca.boulder" "va.boulder"
|
|
"publisher.boulder" "ocsp-updater.boulder" "admin-revoker.boulder"
|
|
"boulder" "boulder-mysql" wfeDomain
|
|
]}
|
|
${config.networking.primaryIPAddress} ${wfeDomain} ${siteDomain}
|
|
'';
|
|
|
|
services.mysql.enable = true;
|
|
services.mysql.package = pkgs.mariadb;
|
|
|
|
services.nginx.enable = true;
|
|
services.nginx.recommendedProxySettings = true;
|
|
# This fixes the test on i686
|
|
services.nginx.commonHttpConfig = ''
|
|
server_names_hash_bucket_size 64;
|
|
'';
|
|
services.nginx.virtualHosts.${wfeDomain} = {
|
|
onlySSL = true;
|
|
enableACME = false;
|
|
sslCertificate = wfeCertFile;
|
|
sslCertificateKey = wfeKeyFile;
|
|
locations."/".proxyPass = "http://127.0.0.1:80";
|
|
};
|
|
services.nginx.virtualHosts.${siteDomain} = {
|
|
onlySSL = true;
|
|
enableACME = false;
|
|
sslCertificate = siteCertFile;
|
|
sslCertificateKey = siteKeyFile;
|
|
locations.${tosPath}.extraConfig = "alias ${tosFile};";
|
|
};
|
|
|
|
systemd.services = {
|
|
pkcs11-daemon = {
|
|
description = "PKCS11 Daemon";
|
|
after = [ "boulder-init-softhsm.service" ];
|
|
before = map (n: "${n}.service") (lib.attrNames componentServices);
|
|
wantedBy = [ "multi-user.target" ];
|
|
environment.SOFTHSM_CONF = softHsmConf;
|
|
environment.PKCS11_DAEMON_SOCKET = "tcp://127.0.0.1:5657";
|
|
serviceConfig.ExecStart = let
|
|
softhsmLib = "${softhsm}/lib/softhsm/libsofthsm.so";
|
|
in "${pkcs11-proxy}/bin/pkcs11-daemon ${softhsmLib}";
|
|
};
|
|
|
|
boulder-init-mysql = {
|
|
description = "Boulder ACME Init (MySQL)";
|
|
after = [ "mysql.service" ];
|
|
serviceConfig.Type = "oneshot";
|
|
serviceConfig.RemainAfterExit = true;
|
|
serviceConfig.WorkingDirectory = boulderSource;
|
|
path = commonPath;
|
|
script = "${pkgs.bash}/bin/sh test/create_db.sh";
|
|
};
|
|
|
|
boulder-init-softhsm = {
|
|
description = "Boulder ACME Init (SoftHSM)";
|
|
environment.SOFTHSM_CONF = softHsmConf;
|
|
serviceConfig.Type = "oneshot";
|
|
serviceConfig.RemainAfterExit = true;
|
|
serviceConfig.WorkingDirectory = boulderSource;
|
|
preStart = "mkdir -p /var/lib/softhsm";
|
|
path = commonPath;
|
|
script = ''
|
|
softhsm --slot 0 --init-token \
|
|
--label intermediate --pin 5678 --so-pin 1234
|
|
softhsm --slot 0 --import test/test-ca.key \
|
|
--label intermediate_key --pin 5678 --id FB
|
|
softhsm --slot 1 --init-token \
|
|
--label root --pin 5678 --so-pin 1234
|
|
softhsm --slot 1 --import test/test-root.key \
|
|
--label root_key --pin 5678 --id FA
|
|
'';
|
|
};
|
|
|
|
boulder = {
|
|
description = "Boulder ACME Server";
|
|
after = map (n: "${n}.service") (lib.attrNames componentServices);
|
|
wantedBy = [ "multi-user.target" ];
|
|
serviceConfig.Type = "oneshot";
|
|
serviceConfig.RemainAfterExit = true;
|
|
script = let
|
|
ports = lib.range 8000 8005 ++ lib.singleton 80;
|
|
netcat = "${pkgs.netcat-openbsd}/bin/nc";
|
|
mkPortCheck = port: "${netcat} -z 127.0.0.1 ${toString port}";
|
|
checks = "(${lib.concatMapStringsSep " && " mkPortCheck ports})";
|
|
in "while ! ${checks}; do :; done";
|
|
};
|
|
} // componentServices;
|
|
};
|
|
}
|