{ config, lib, pkgs, ... }: with lib; let cfg = config.security.acme; certOpts = { name, ... }: { options = { webroot = mkOption { type = types.str; example = "/var/lib/acme/acme-challenges"; description = '' Where the webroot of the HTTP vhost is located. .well-known/acme-challenge/ directory will be created below the webroot if it doesn't exist. http://example.org/.well-known/acme-challenge/ must also be available (notice unencrypted HTTP). ''; }; server = mkOption { type = types.nullOr types.str; default = null; description = '' ACME Directory Resource URI. Defaults to let's encrypt production endpoint, https://acme-v02.api.letsencrypt.org/directory, if unset. ''; }; domain = mkOption { type = types.str; default = name; description = "Domain to fetch certificate for (defaults to the entry name)"; }; email = mkOption { type = types.nullOr types.str; default = null; description = "Contact email address for the CA to be able to reach you."; }; user = mkOption { type = types.str; default = "root"; description = "User running the ACME client."; }; group = mkOption { type = types.str; default = "root"; description = "Group running the ACME client."; }; allowKeysForGroup = mkOption { type = types.bool; default = false; description = '' Give read permissions to the specified group () to read SSL private certificates. ''; }; postRun = mkOption { type = types.lines; default = ""; example = "systemctl reload nginx.service"; description = '' Commands to run after new certificates go live. Typically the web server and other servers using certificates need to be reloaded. Executed in the same directory with the new certificate. ''; }; directory = mkOption { type = types.str; readOnly = true; default = "/var/lib/acme/${name}"; description = "Directory where certificate and other state is stored."; }; extraDomains = mkOption { type = types.attrsOf (types.nullOr types.str); default = {}; example = literalExample '' { "example.org" = "/srv/http/nginx"; "mydomain.org" = null; } ''; description = '' A list of extra domain names, which are included in the one certificate to be issued, with their own server roots if needed. ''; }; dnsProvider = mkOption { type = types.nullOr types.str; example = "route53"; default = null; description = "DNS Challenge provider"; }; credentialsFile = mkOption { type = types.str; description = '' File containing DNS provider credentials passed as environment variables. See https://go-acme.github.io/lego/dns/ for more information. ''; example = "/var/src/secrets/example.org-route53-api-token"; }; dnsPropagationCheck = mkOption { type = types.bool; default = true; description = '' Toggles LEGo DNS propagation check, which is used alongside DNS-01 challenge to ensure the DNS entries required are available ''; }; }; }; in { ###### interface imports = [ (mkRemovedOptionModule [ "security" "acme" "production" ] '' Use security.acme.server to define your staging ACME server URL instead. To use the let's encrypt staging server, use security.acme.server = "https://acme-staging-v02.api.letsencrypt.org/directory". '' ) (mkRemovedOptionModule [ "security" "acme" "directory"] "ACME Directory is now hardcoded to /var/lib/acme and its permisisons are managed by systemd. See https://github.com/NixOS/nixpkgs/issues/53852 for more info.") (mkRemovedOptionModule [ "security" "acme" "preDelay"] "This option has been removed. If you want to make sure that something executes before certificates are provisioned, add a RequiredBy=acme-\${cert}.service to the service you want to execute before the cert renewal") (mkRemovedOptionModule [ "security" "acme" "activationDelay"] "This option has been removed. If you want to make sure that something executes before certificates are provisioned, add a RequiredBy=acme-\${cert}.service to the service you want to execute before the cert renewal") (mkChangedOptionModule [ "security" "acme" "validMin"] [ "security" "acme" "validMinDays"] (config: config.security.acme.validMin / (24 * 3600))) ]; options = { security.acme = { validMinDays = mkOption { type = types.int; default = 30; description = "Minimum remaining validity before renewal in days."; }; email = mkOption { type = types.nullOr types.str; default = null; description = "Contact email address for the CA to be able to reach you."; }; renewInterval = mkOption { type = types.str; default = "weekly"; description = '' Systemd calendar expression when to check for renewal. See systemd.time 7. ''; }; server = mkOption { type = types.nullOr types.str; default = null; description = '' ACME Directory Resource URI. Defaults to let's encrypt production endpoint, https://acme-v02.api.letsencrypt.org/directory, if unset. ''; }; preliminarySelfsigned = mkOption { type = types.bool; default = true; description = '' Whether a preliminary self-signed certificate should be generated before doing ACME requests. This can be useful when certificates are required in a webserver, but ACME needs the webserver to make its requests. With preliminary self-signed certificate the webserver can be started and can later reload the correct ACME certificates. ''; }; acceptTerms = mkOption { type = types.bool; default = true; description = '' Accept the current Let's Encrypt terms of service. See https://letsencrypt.org/repository/ ''; }; certs = mkOption { default = { }; type = with types; attrsOf (submodule certOpts); description = '' Attribute set of certificates to get signed and renewed. Creates acme-''${cert}.{service,timer} systemd units for each certificate defined here. Other services can add dependencies to those units if they rely on the certificates being present, or trigger restarts of the service if certificates get renewed. ''; example = literalExample '' { "example.com" = { webroot = "/var/www/challenges/"; email = "foo@example.com"; extraDomains = { "www.example.com" = null; "foo.example.com" = "/var/www/foo/"; }; }; "bar.example.com" = { webroot = "/var/www/challenges/"; email = "bar@example.com"; }; } ''; }; }; }; ###### implementation config = mkMerge [ (mkIf (cfg.certs != { }) { assertions = let certs = (mapAttrsToList (k: v: v) cfg.certs); in [ { assertion = all (certOpts: certOpts.dnsProvider == null || certOpts.webroot == null) certs; message = '' Options `security.acme.certs..dnsProvider` and `security.acme.certs..webroot` are mutually exclusive. ''; } { assertion = cfg.email != null || all (certOpts: certOpts.email != null) certs; message = '' You must define `security.acme.certs..email` or `security.acme.email` to register with the CA. ''; } ]; systemd.services = let services = concatLists servicesLists; servicesLists = mapAttrsToList certToServices cfg.certs; certToServices = cert: data: let # StateDirectory must be relative, and will be created under /var/lib by systemd lpath = "acme/${cert}"; apath = "/var/lib/${lpath}"; spath = "/var/lib/acme/.lego"; rights = if data.allowKeysForGroup then "750" else "700"; globalOpts = [ "-d" data.domain "--email" data.email "--path" "." ] ++ optionals (cfg.acceptTerms) [ "--accept-tos" ] ++ optionals (data.dnsProvider != null && !cfg.dnsPropagationCheck) [ "--dns.disable-cp" ] ++ concatLists (mapAttrsToList (name: root: [ "-d" name ]) data.extraDomains) ++ (if data.dnsProvider != null then [ "--dns" data.dnsProvider ] else [ "--http" "--http.webroot" data.webroot ]) ++ optionals (cfg.server != null || data.server != null) ["--server" (if data.server == null then cfg.server else data.server)]; runOpts = escapeShellArgs (globalOpts ++ [ "run" ]); renewOpts = escapeShellArgs (globalOpts ++ [ "renew" "--days" (toString cfg.validMinDays) ]); acmeService = { description = "Renew ACME Certificate for ${cert}"; after = [ "network.target" "network-online.target" ]; wants = [ "network-online.target" ]; serviceConfig = { Type = "oneshot"; # With RemainAfterExit the service is considered active even # after the main process having exited, which means when it # gets changed, the activation phase restarts it, meaning # the permissions of the StateDirectory get adjusted # according to the specified group RemainAfterExit = true; User = data.user; Group = data.group; PrivateTmp = true; StateDirectory = "acme/.lego ${lpath}"; StateDirectoryMode = rights; WorkingDirectory = spath; # Only try loading the credentialsFile if the dns challenge is enabled EnvironmentFile = if data.dnsProvider != null then data.credentialsFile else null; ExecStart = pkgs.writeScript "acme-start" '' #!${pkgs.runtimeShell} -e ${pkgs.lego}/bin/lego ${renewOpts} || ${pkgs.lego}/bin/lego ${runOpts} ''; ExecStartPost = let script = pkgs.writeScript "acme-post-start" '' #!${pkgs.runtimeShell} -e cd ${apath} # Test that existing cert is older than new cert KEY=${spath}/certificates/*${data.domain}.key if [ -e $KEY -a $KEY -nt key.pem ]; then cp -p ${spath}/certificates/*${data.domain}.key key.pem cp -p ${spath}/certificates/*${data.domain}.crt cert.pem cp -p ${spath}/certificates/*${data.domain}.issuer.crt chain.pem cat cert.pem chain.pem > fullchain.pem cat key.pem cert.pem chain.pem > full.pem chmod ${rights} *.pem chown '${data.user}:${data.group}' *.pem fi ${data.postRun} ''; in "+${script}"; }; }; selfsignedService = { description = "Create preliminary self-signed certificate for ${cert}"; path = [ pkgs.openssl ]; script = '' workdir="$(mktemp -d)" # Create CA openssl genrsa -des3 -passout pass:xxxx -out $workdir/ca.pass.key 2048 openssl rsa -passin pass:xxxx -in $workdir/ca.pass.key -out $workdir/ca.key openssl req -new -key $workdir/ca.key -out $workdir/ca.csr \ -subj "/C=UK/ST=Warwickshire/L=Leamington/O=OrgName/OU=Security Department/CN=example.com" openssl x509 -req -days 1 -in $workdir/ca.csr -signkey $workdir/ca.key -out $workdir/ca.crt # Create key openssl genrsa -des3 -passout pass:xxxx -out $workdir/server.pass.key 2048 openssl rsa -passin pass:xxxx -in $workdir/server.pass.key -out $workdir/server.key openssl req -new -key $workdir/server.key -out $workdir/server.csr \ -subj "/C=UK/ST=Warwickshire/L=Leamington/O=OrgName/OU=IT Department/CN=example.com" openssl x509 -req -days 1 -in $workdir/server.csr -CA $workdir/ca.crt \ -CAkey $workdir/ca.key -CAserial $workdir/ca.srl -CAcreateserial \ -out $workdir/server.crt # Copy key to destination cp $workdir/server.key ${apath}/key.pem # Create fullchain.pem (same format as "simp_le ... -f fullchain.pem" creates) cat $workdir/{server.crt,ca.crt} > "${apath}/fullchain.pem" # Create full.pem for e.g. lighttpd cat $workdir/{server.key,server.crt,ca.crt} > "${apath}/full.pem" # Give key acme permissions chown '${data.user}:${data.group}' "${apath}/"{key,fullchain,full}.pem chmod ${rights} "${apath}/"{key,fullchain,full}.pem ''; serviceConfig = { Type = "oneshot"; PrivateTmp = true; StateDirectory = lpath; User = data.user; Group = data.group; }; unitConfig = { # Do not create self-signed key when key already exists ConditionPathExists = "!${apath}/key.pem"; }; }; in ( [ { name = "acme-${cert}"; value = acmeService; } ] ++ optional cfg.preliminarySelfsigned { name = "acme-selfsigned-${cert}"; value = selfsignedService; } ); servicesAttr = listToAttrs services; in servicesAttr; systemd.tmpfiles.rules = flip mapAttrsToList cfg.certs (cert: data: "d ${data.webroot}/.well-known/acme-challenge - ${data.user} ${data.group}"); systemd.timers = flip mapAttrs' cfg.certs (cert: data: nameValuePair ("acme-${cert}") ({ description = "Renew ACME Certificate for ${cert}"; wantedBy = [ "timers.target" ]; timerConfig = { OnCalendar = cfg.renewInterval; Unit = "acme-${cert}.service"; Persistent = "yes"; AccuracySec = "5m"; RandomizedDelaySec = "1h"; }; }) ); systemd.targets.acme-selfsigned-certificates = mkIf cfg.preliminarySelfsigned {}; systemd.targets.acme-certificates = {}; }) ]; meta = { maintainers = with lib.maintainers; [ abbradar fpletz globin m1cr0man ]; doc = ./acme.xml; }; }