commit 9b8ea589ea6415cb1be6d07f2f4ff9d3c7b99335 · pyrox.dev/nixpkgs

nixos/doc/manual/redirects.json

···

       1468
       1468
        
         "module-security-acme-fix-jws": [

     

       1469
       1469
        
           "index.html#module-security-acme-fix-jws"

     

       1470
       1470
        
         ],

     

       1471
       1471
       +
         "module-security-acme-reload-dependencies": [

     

       1472
       1472
       +
           "index.html#module-security-acme-reload-dependencies"

     

       1473
       1473
       +
         ],

     

       1471
       1474
        
         "module-programs-zsh-ohmyzsh": [

     

       1472
       1475
        
           "index.html#module-programs-zsh-ohmyzsh"

     

       1473
       1476
        
         ],

+15

nixos/doc/manual/release-notes/rl-2511.section.md

···

       171
       171
        
       

     

       172
       172
        
       - `services.gitea` supports sending notifications with sendmail again. To do this, activate the parameter `services.gitea.mailerUseSendmail` and configure SMTP server.

     

       173
       173
        
       

     

       174
       174
       +
       - Revamp of the ACME certificate acquisication and renewal process to help scale systems with lots (100+) of certificates.

     

       175
       175
       +
       

     

       176
       176
       +
         Units and targets have been reshaped to better support more specific dependency propagation and avoid

     

       177
       177
       +
         superfluously triggering unchanged units:

     

       178
       178
       +
       

     

       179
       179
       +
         If a service requires a syntactically valid certificate to start it should now depend on the `acme-{certname}.service` unit.

     

       180
       180
       +
       

     

       181
       181
       +
         We now always generate initial self-signed certificates as this drastically simplifies the dependency structure. As a result, the option `security.acme.preliminarySelfsigned` has been removed.

     

       182
       182
       +
       

     

       183
       183
       +
         Instead of the previous `acme-finished-{certname}.target`s there are now `acme-order-renew-{certname}.service`s that will be activated

     

       184
       184
       +
         in a delayed fashion to ensure that bootstrapping with servers like nginx that take part in the acquisition/renewal process works

     

       185
       185
       +
         smoothly. Dependencies on `acme-finished` units should move to `acme-order-renew`.

     

       186
       186
       +
       

     

       187
       187
       +
         Note that system activation will complete before all certificates may have been renewed or acquired.

     

       188
       188
       +
       

     

       174
       189
        
       - `libvirt` now supports using `nftables` backend.

     

       175
       190
        
         - The `virtualisation.libvirtd.firewallBackend` option can be used to configure the firewall backend used by libvirtd.

     

       176
       191

+9 -1

nixos/modules/security/acme/default.md

···

       318
       318
        
       

     

       319
       319
        
         # Now you must augment OpenSMTPD's systemd service to load

     

       320
       320
        
         # the certificate files.

     

       321
       321
       -
         systemd.services.opensmtpd.requires = [ "acme-finished-mail.example.com.target" ];

     

       321
       321
       +
         systemd.services.opensmtpd.requires = [ "acme-mail.example.com.service" ];

     

       322
       322
        
         systemd.services.opensmtpd.serviceConfig.LoadCredential =

     

       323
       323
        
           let

     

       324
       324
        
             certDir = config.security.acme.certs."mail.example.com".directory;

     
···

       376
       376
        
       # Note: Do this for all certs that share the same account email address

     

       377
       377
        
       systemctl start acme-example.com.service

     

       378
       378
        
       ```

     

       379
       379
       +
       

     

       380
       380
       +
       ## Ensuring dependencies for services that need to be reloaded when a certificate challenges {#module-security-acme-reload-dependencies}

     

       381
       381
       +
       

     

       382
       382
       +
       Services that depend on ACME certificates and need to be reloaded can use one of two approaches to reload upon successfull certificate acquisition or renewal:

     

       383
       383
       +
       

     

       384
       384
       +
       1. **Using the `security.acme.certs.<name>.reloadServices` option**: This will cause `systemctl try-reload-or-restart` to be run for the listed services.

     

       385
       385
       +
       

     

       386
       386
       +
       2. **Using a separate reload unit**: if you need perform more complex actions you can implement a separate reload unit but need to ensure that it lists the `acme-renew-<name>.service` unit both as `wantedBy` AND `after`. See the nginx module implementation with its `nginx-config-reload` service.

+164 -189

nixos/modules/security/acme/default.nix

···

       24
       24
        
         # Since that service is a oneshot with RemainAfterExit,

     

       25
       25
        
         # the folder will exist during all renewal services.

     

       26
       26
        
         lockdir = "/run/acme/";

     

       27
       27
       -
         concurrencyLockfiles = map (n: "${toString n}.lock") (lib.range 1 cfg.maxConcurrentRenewals);

     

       28
       28
       -
         # Assign elements of `baseList` to each element of `needAssignmentList`, until the latter is exhausted.

     

       29
       29
       -
         # returns: [{fst = "element of baseList"; snd = "element of needAssignmentList"}]

     

       30
       30
       -
         roundRobinAssign =

     

       31
       31
       -
           baseList: needAssignmentList:

     

       32
       32
       -
           if baseList == [ ] then [ ] else _rrCycler baseList baseList needAssignmentList;

     

       33
       33
       -
         _rrCycler =

     

       34
       34
       -
           with builtins;

     

       35
       35
       -
           origBaseList: workingBaseList: needAssignmentList:

     

       36
       36
       -
           if (workingBaseList == [ ] || needAssignmentList == [ ]) then

     

       37
       37
       -
             [ ]

     

       38
       38
       -
           else

     

       39
       39
       -
             [

     

       40
       40
       -
               {

     

       41
       41
       -
                 fst = head workingBaseList;

     

       42
       42
       -
                 snd = head needAssignmentList;

     

       43
       43
       -
               }

     

       44
       44
       -
             ]

     

       45
       45
       -
             ++ _rrCycler origBaseList (

     

       46
       46
       -
               if (tail workingBaseList == [ ]) then origBaseList else tail workingBaseList

     

       47
       47
       -
             ) (tail needAssignmentList);

     

       48
       48
       -
         attrsToList = lib.mapAttrsToList (

     

       49
       49
       -
           attrname: attrval: {

     

       50
       50
       -
             name = attrname;

     

       51
       51
       -
             value = attrval;

     

       52
       52
       -
           }

     

       53
       53
       -
         );

     

       54
       54
       -
         # for an AttrSet `funcsAttrs` having functions as values, apply single arguments from

     

       55
       55
       -
         # `argsList` to them in a round-robin manner.

     

       56
       56
       -
         # Returns an attribute set with the applied functions as values.

     

       57
       57
       -
         roundRobinApplyAttrs =

     

       58
       58
       -
           funcsAttrs: argsList:

     

       59
       59
       -
           lib.listToAttrs (

     

       60
       60
       -
             map (x: {

     

       61
       61
       -
               inherit (x.snd) name;

     

       62
       62
       -
               value = x.snd.value x.fst;

     

       63
       63
       -
             }) (roundRobinAssign argsList (attrsToList funcsAttrs))

     

       64
       64
       -
           );

     

       27
       27
       +
       

     

       65
       28
        
         wrapInFlock =

     

       66
       66
       -
           lockfilePath: script:

     

       29
       29
       +
           script:

     

       67
       30
        
           # explainer: https://stackoverflow.com/a/60896531

     

       68
       31
        
           ''

     

       69
       69
       -
             exec {LOCKFD}> ${lockfilePath}

     

       70
       70
       -
             echo "Waiting to acquire lock ${lockfilePath}"

     

       71
       71
       -
             ${pkgs.flock}/bin/flock ''${LOCKFD} || exit 1

     

       72
       72
       -
             echo "Acquired lock ${lockfilePath}"

     

       32
       32
       +
             maxConcurrentRenewals=${toString cfg.maxConcurrentRenewals}

     

       33
       33
       +
       

     

       34
       34
       +
             acquireLock() {

     

       35
       35
       +
               echo "Waiting to acquire lock in ${lockdir}"

     

       36
       36
       +
               while true; do

     

       37
       37
       +
                 for i in $(seq 1 $maxConcurrentRenewals); do

     

       38
       38
       +
                   exec {LOCKFD}> "${lockdir}/$i.lock"

     

       39
       39
       +
                   if ${pkgs.flock}/bin/flock -n ''${LOCKFD}; then

     

       40
       40
       +
                     return 0

     

       41
       41
       +
                   fi

     

       42
       42
       +
                   exec {LOCKFD}>&-

     

       43
       43
       +
                 done

     

       44
       44
       +
                 sleep 1;

     

       45
       45
       +
               done

     

       46
       46
       +
             }

     

       47
       47
       +
       

     

       48
       48
       +
             if [ "$maxConcurrentRenewals" -gt "0" ]; then

     

       49
       49
       +
               acquireLock

     

       50
       50
       +
             fi

     

       73
       51
        
           ''

     

       74
       74
       -
           + script

     

       75
       75
       -
           + "\n"

     

       76
       76
       -
           + ''echo "Releasing lock ${lockfilePath}"  # only released after process exit'';

     

       52
       52
       +
           + script;

     

       77
       53
        
       

     

       78
       54
        
         # There are many services required to make cert renewals work.

     

       79
       55
        
         # They all follow a common structure:

     
···

       160
       136
        
         );

     

       161
       137
        
       

     

       162
       138
        
         # This is defined with lib.mkMerge so that we can separate the config per function.

     

       163
       163
       -
         setupService = lib.mkMerge [

     

       164
       164
       -
           {

     

       165
       165
       -
             description = "Set up the ACME certificate renewal infrastructure";

     

       166
       166
       -
             script = lib.mkBefore ''

     

       167
       167
       -
               ${lib.optionalString cfg.defaults.enableDebugLogs "set -x"}

     

       168
       168
       -
               set -euo pipefail

     

       169
       169
       -
             '';

     

       170
       170
       -
             serviceConfig = commonServiceConfig // {

     

       171
       171
       -
               # This script runs with elevated privileges, denoted by the +

     

       172
       172
       -
               # ExecStartPre is used instead of ExecStart so that the `script` continues to work.

     

       173
       173
       -
               ExecStartPre = "+${lib.getExe privilegedSetupScript}";

     

       139
       139
       +
         setupService = {

     

       140
       140
       +
           description = "Set up the ACME certificate renewal infrastructure";

     

       141
       141
       +
           path = [ pkgs.minica ];

     

       142
       142
       +
       

     

       143
       143
       +
           script = lib.mkBefore ''

     

       144
       144
       +
             ${lib.optionalString cfg.defaults.enableDebugLogs "set -x"}

     

       145
       145
       +
             set -euo pipefail

     

       146
       146
       +
             test -e ca/key.pem || minica \

     

       147
       147
       +
               --ca-key ca/key.pem \

     

       148
       148
       +
               --ca-cert ca/cert.pem \

     

       149
       149
       +
               --domains selfsigned.local

     

       150
       150
       +
           '';

     

       174
       151
        
       

     

       175
       175
       -
               # We don't want this to run every time a renewal happens

     

       176
       176
       -
               RemainAfterExit = true;

     

       152
       152
       +
           serviceConfig = commonServiceConfig // {

     

       153
       153
       +
             # This script runs with elevated privileges, denoted by the +

     

       154
       154
       +
             # ExecStartPre is used instead of ExecStart so that the `script` continues to work.

     

       155
       155
       +
             ExecStartPre = "+${lib.getExe privilegedSetupScript}";

     

       177
       156
        
       

     

       178
       178
       -
               # StateDirectory entries are a cleaner, service-level mechanism

     

       179
       179
       -
               # for dealing with persistent service data

     

       180
       180
       -
               StateDirectory = [

     

       181
       181
       -
                 "acme"

     

       182
       182
       -
                 "acme/.lego"

     

       183
       183
       -
                 "acme/.lego/accounts"

     

       184
       184
       -
               ];

     

       185
       185
       -
               StateDirectoryMode = "0755";

     

       157
       157
       +
             # We don't want this to run every time a renewal happens

     

       158
       158
       +
             RemainAfterExit = true;

     

       186
       159
        
       

     

       187
       187
       -
               # Creates ${lockdir}. Earlier RemainAfterExit=true means

     

       188
       188
       -
               # it does not get deleted immediately.

     

       189
       189
       -
               RuntimeDirectory = "acme";

     

       190
       190
       -
               RuntimeDirectoryMode = "0700";

     

       160
       160
       +
             # StateDirectory entries are a cleaner, service-level mechanism

     

       161
       161
       +
             # for dealing with persistent service data

     

       162
       162
       +
             StateDirectory = [

     

       163
       163
       +
               "acme"

     

       164
       164
       +
               "acme/.lego"

     

       165
       165
       +
               "acme/.lego/accounts"

     

       166
       166
       +
               "acme/.minica"

     

       167
       167
       +
             ];

     

       168
       168
       +
             BindPaths = "/var/lib/acme/.minica:/tmp/ca";

     

       169
       169
       +
             StateDirectoryMode = "0755";

     

       191
       170
        
       

     

       192
       192
       -
               # Generally, we don't write anything that should be group accessible.

     

       193
       193
       -
               # Group varies for most ACME units, and setup files are only used

     

       194
       194
       -
               # under the acme user.

     

       195
       195
       -
               UMask = "0077";

     

       196
       196
       -
             };

     

       197
       197
       -
           }

     

       171
       171
       +
             # Creates ${lockdir}. Earlier RemainAfterExit=true means

     

       172
       172
       +
             # it does not get deleted immediately.

     

       173
       173
       +
             RuntimeDirectory = "acme";

     

       174
       174
       +
             RuntimeDirectoryMode = "0700";

     

       198
       175
        
       

     

       199
       199
       -
           # Avoid race conditions creating the CA for selfsigned certs

     

       200
       200
       -
           (lib.mkIf cfg.preliminarySelfsigned {

     

       201
       201
       -
             path = [ pkgs.minica ];

     

       202
       202
       -
             # Working directory will be /tmp

     

       203
       203
       -
             script = ''

     

       204
       204
       -
               test -e ca/key.pem || minica \

     

       205
       205
       -
                 --ca-key ca/key.pem \

     

       206
       206
       -
                 --ca-cert ca/cert.pem \

     

       207
       207
       -
                 --domains selfsigned.local

     

       208
       208
       -
             '';

     

       209
       209
       -
             serviceConfig = {

     

       210
       210
       -
               StateDirectory = [ "acme/.minica" ];

     

       211
       211
       -
               BindPaths = "/var/lib/acme/.minica:/tmp/ca";

     

       212
       212
       -
             };

     

       213
       213
       -
           })

     

       214
       214
       -
         ];

     

       176
       176
       +
             # Generally, we don't write anything that should be group accessible.

     

       177
       177
       +
             # Group varies for most ACME units, and setup files are only used

     

       178
       178
       +
             # under the acme user.

     

       179
       179
       +
             UMask = "0077";

     

       180
       180
       +
           };

     

       181
       181
       +
         };

     

       215
       182
        
       

     

       216
       183
        
         certToConfig =

     

       217
       184
        
           cert: data:

     
···

       219
       186
        
             acmeServer = data.server;

     

       220
       187
        
             useDns = data.dnsProvider != null;

     

       221
       188
        
             destPath = "/var/lib/acme/${cert}";

     

       222
       222
       -
             selfsignedDeps = lib.optionals (cfg.preliminarySelfsigned) [ "acme-selfsigned-${cert}.service" ];

     

       223
       189
        
       

     

       224
       190
        
             # Minica and lego have a "feature" which replaces * with _. We need

     

       225
       191
        
             # to make this substitution to reference the output files from both programs.

     
···

       339
       305
        
             certificateKey = if data.csrKey != null then "${data.csrKey}" else "certificates/${keyName}.key";

     

       340
       306
        
           in

     

       341
       307
        
           {

     

       342
       342
       -
             inherit accountHash cert selfsignedDeps;

     

       308
       308
       +
             inherit accountHash cert;

     

       343
       309
        
       

     

       344
       310
        
             group = data.group;

     

       345
       311
        
       

     

       346
       312
        
             renewTimer = {

     

       347
       313
        
               description = "Renew ACME Certificate for ${cert}";

     

       348
       314
        
               wantedBy = [ "timers.target" ];

     

       315
       315
       +
               # Avoid triggering certificate renewals accidentally when running s-t-c.

     

       316
       316
       +
               unitConfig."X-OnlyManualStart" = true;

     

       349
       317
        
               timerConfig = {

     

       350
       318
        
                 OnCalendar = data.renewInterval;

     

       351
       351
       -
                 Unit = "acme-${cert}.service";

     

       319
       319
       +
                 Unit = "acme-order-renew-${cert}.service";

     

       352
       320
        
                 Persistent = "yes";

     

       353
       321
        
       

     

       354
       322
        
                 # Allow systemd to pick a convenient time within the day

     
···

       364
       332
        
               };

     

       365
       333
        
             };

     

       366
       334
        
       

     

       367
       367
       -
             selfsignService = lockfileName: {

     

       368
       368
       -
               description = "Generate self-signed certificate for ${cert}";

     

       335
       335
       +
             baseService = {

     

       336
       336
       +
               description = "Ensure certificate for ${cert}";

     

       337
       337
       +
       

     

       338
       338
       +
               wantedBy = [ "multi-user.target" ];

     

       339
       339
       +
       

     

       369
       340
        
               after = [ "acme-setup.service" ];

     

       370
       370
       -
               requires = [ "acme-setup.service" ];

     

       341
       341
       +
       

     

       342
       342
       +
               # Whenever this service starts (on boot, through dependencies, through

     

       343
       343
       +
               # changes) we trigger the acme-order-renew service to give it a chance

     

       344
       344
       +
               # to catch up with the potentially changed config.

     

       345
       345
       +
               wants = [

     

       346
       346
       +
                 "acme-setup.service"

     

       347
       347
       +
                 "acme-order-renew-${cert}.service"

     

       348
       348
       +
               ];

     

       349
       349
       +
               before = [ "acme-order-renew-${cert}.service" ];

     

       350
       350
       +
       

     

       351
       351
       +
               restartTriggers = [

     

       352
       352
       +
                 config.systemd.services."acme-order-renew-${cert}".script

     

       353
       353
       +
               ];

     

       371
       354
        
       

     

       372
       355
        
               path = [ pkgs.minica ];

     

       373
       356
        
       

     

       374
       357
        
               unitConfig = {

     

       375
       375
       -
                 ConditionPathExists = "!/var/lib/acme/${cert}/key.pem";

     

       376
       358
        
                 StartLimitIntervalSec = 0;

     

       377
       359
        
               };

     

       378
       360
        
       

     
···

       380
       362
        
                 Group = data.group;

     

       381
       363
        
                 UMask = "0027";

     

       382
       364
        
       

     

       365
       365
       +
                 RemainAfterExit = true;

     

       366
       366
       +
       

     

       383
       367
        
                 StateDirectory = "acme/${cert}";

     

       384
       368
        
       

     

       385
       369
        
                 BindPaths = [

     

       386
       370
        
                   "/var/lib/acme/.minica:/tmp/ca"

     

       387
       387
       -
                   "/var/lib/acme/${cert}:/tmp/${keyName}"

     

       371
       371
       +
                   "/var/lib/acme/${cert}:/tmp/out"

     

       388
       372
        
                 ];

     

       389
       373
        
               };

     

       390
       374
        
       

     

       391
       375
        
               # Working directory will be /tmp

     

       392
       376
        
               # minica will output to a folder sharing the name of the first domain

     

       393
       377
        
               # in the list, which will be ${data.domain}

     

       394
       394
       -
               script = (if (lockfileName == null) then lib.id else wrapInFlock "${lockdir}${lockfileName}") ''

     

       378
       378
       +
               script = wrapInFlock ''

     

       379
       379
       +
                 set -ex

     

       380
       380
       +
       

     

       381
       381
       +
                 # Regenerate self-signed certificates (in case the SANs change) until we

     

       382
       382
       +
                 # have seen a succesfull ACME certificate at least once.

     

       383
       383
       +
                 if [ -e out/acme-success ]; then

     

       384
       384
       +
                   exit 0

     

       385
       385
       +
                 fi

     

       386
       386
       +
       

     

       395
       387
        
                 minica \

     

       396
       388
        
                   --ca-key ca/key.pem \

     

       397
       389
        
                   --ca-cert ca/cert.pem \

     

       398
       390
        
                   --domains ${lib.escapeShellArg (builtins.concatStringsSep "," ([ data.domain ] ++ extraDomains))}

     

       399
       391
        
       

     

       400
       392
        
                 # Create files to match directory layout for real certificates

     

       401
       401
       -
                 cd '${keyName}'

     

       402
       402
       -
                 cp ../ca/cert.pem chain.pem

     

       403
       403
       -
                 cat cert.pem chain.pem > fullchain.pem

     

       404
       404
       -
                 cat key.pem fullchain.pem > full.pem

     

       393
       393
       +
                 (

     

       394
       394
       +
                   cd '${keyName}'

     

       395
       395
       +
                   cp -vp cert.pem ../out/cert.pem

     

       396
       396
       +
                   cp -vp key.pem ../out/key.pem

     

       397
       397
       +
                 )

     

       398
       398
       +
                 cat out/cert.pem ca/cert.pem > out/fullchain.pem

     

       399
       399
       +
                 cp ca/cert.pem out/chain.pem

     

       400
       400
       +
                 cat out/key.pem out/fullchain.pem > out/full.pem

     

       405
       401
        
       

     

       406
       406
       -
                 # Group might change between runs, re-apply it

     

       407
       407
       -
                 chown '${user}:${data.group}' -- *

     

       402
       402
       +
                 # Fix up the output files to adhere to the group and

     

       403
       403
       +
                 # have consistent permissions. This needs to be kept

     

       404
       404
       +
                 # consistent with the acme-setup script above.

     

       405
       405
       +
                 for fixpath in out certificates; do

     

       406
       406
       +
                   if [ -d "$fixpath" ]; then

     

       407
       407
       +
                     chmod -R u=rwX,g=rX,o= "$fixpath"

     

       408
       408
       +
                     chown -R ${user}:${data.group} "$fixpath"

     

       409
       409
       +
                   fi

     

       410
       410
       +
                 done

     

       408
       411
        
       

     

       409
       409
       -
                 # Default permissions make the files unreadable by group + anon

     

       410
       410
       -
                 # Need to be readable by group

     

       411
       411
       -
                 chmod 640 -- *

     

       412
       412
       +
                 ${lib.optionalString (data.webroot != null) ''

     

       413
       413
       +
                   # Ensure the webroot exists. Fixing group is required in case configuration was changed between runs.

     

       414
       414
       +
                   # Lego will fail if the webroot does not exist at all.

     

       415
       415
       +
                   (

     

       416
       416
       +
                     mkdir -p '${data.webroot}/.well-known/acme-challenge' \

     

       417
       417
       +
                     && chgrp '${data.group}' ${data.webroot}/.well-known/acme-challenge

     

       418
       418
       +
                   ) || (

     

       419
       419
       +
                     echo 'Please ensure ${data.webroot}/.well-known/acme-challenge exists and is writable by acme:${data.group}' \

     

       420
       420
       +
                     && exit 1

     

       421
       421
       +
                   )

     

       422
       422
       +
                 ''}

     

       412
       423
        
               '';

     

       413
       424
        
             };

     

       414
       425
        
       

     

       415
       415
       -
             renewService = lockfileName: {

     

       416
       416
       -
               description = "Renew ACME certificate for ${cert}";

     

       426
       426
       +
             orderRenewService = {

     

       427
       427
       +
               description = "Order (and renew) ACME certificate for ${cert}";

     

       417
       428
        
               after = [

     

       418
       429
        
                 "network.target"

     

       419
       430
        
                 "network-online.target"

     

       420
       431
        
                 "acme-setup.service"

     

       421
       432
        
                 "nss-lookup.target"

     

       422
       422
       -
               ]

     

       423
       423
       -
               ++ selfsignedDeps;

     

       424
       424
       -
               wants = [ "network-online.target" ] ++ selfsignedDeps;

     

       425
       425
       -
               requires = [ "acme-setup.service" ];

     

       426
       426
       -
       

     

       427
       427
       -
               # https://github.com/NixOS/nixpkgs/pull/81371#issuecomment-605526099

     

       428
       428
       -
               wantedBy = lib.optionals (!config.boot.isContainer) [ "multi-user.target" ];

     

       433
       433
       +
                 "acme-${cert}.service"

     

       434
       434
       +
               ];

     

       435
       435
       +
               wants = [

     

       436
       436
       +
                 "network-online.target"

     

       437
       437
       +
                 "acme-setup.service"

     

       438
       438
       +
                 "acme-${cert}.service"

     

       439
       439
       +
               ];

     

       440
       440
       +
               # Ensure that certificates are generated if people use `security.acme.certs`

     

       441
       441
       +
               # without having/declaring other systemd units that depend on the cert.

     

       429
       442
        
       

     

       430
       443
        
               path = with pkgs; [

     

       431
       444
        
                 lego

     
···

       491
       504
        
                     };

     

       492
       505
        
       

     

       493
       506
        
               # Working directory will be /tmp

     

       494
       494
       -
               script = (if (lockfileName == null) then lib.id else wrapInFlock "${lockdir}${lockfileName}") ''

     

       507
       507
       +
               script = wrapInFlock ''

     

       495
       508
        
                 ${lib.optionalString data.enableDebugLogs "set -x"}

     

       496
       509
        
                 set -euo pipefail

     

       497
       510
        
       

     
···

       523
       536
        
                   [[ $expiration_days -gt ${toString data.validMinDays} ]]

     

       524
       537
        
                 }

     

       525
       538
        
       

     

       526
       526
       -
                 ${lib.optionalString (data.webroot != null) ''

     

       527
       527
       -
                   # Ensure the webroot exists. Fixing group is required in case configuration was changed between runs.

     

       528
       528
       -
                   # Lego will fail if the webroot does not exist at all.

     

       529
       529
       -
                   (

     

       530
       530
       -
                     mkdir -p '${data.webroot}/.well-known/acme-challenge' \

     

       531
       531
       -
                     && chgrp '${data.group}' ${data.webroot}/.well-known/acme-challenge

     

       532
       532
       -
                   ) || (

     

       533
       533
       -
                     echo 'Please ensure ${data.webroot}/.well-known/acme-challenge exists and is writable by acme:${data.group}' \

     

       534
       534
       -
                     && exit 1

     

       535
       535
       -
                   )

     

       536
       536
       -
                 ''}

     

       537
       537
       -
       

     

       538
       539
        
                 echo '${domainHash}' > domainhash.txt

     

       539
       540
        
       

     

       540
       540
       -
                 # Check if we can renew.

     

       541
       541
       +
                 # Check if a new order is needed

     

       541
       542
        
                 # We can only renew if the list of domains has not changed.

     

       542
       543
        
                 # We also need an account key. Avoids #190493

     

       543
       544
        
                 if cmp -s domainhash.txt certificates/domainhash.txt && [ -e '${certificateKey}' ] && [ -e 'certificates/${keyName}.crt' ] && [ -n "$(find accounts -name '${data.email}.key')" ]; then

     

       544
       544
       -
       

     

       545
       545
        
                   # Even if a cert is not expired, it may be revoked by the CA.

     

       546
       546
        
                   # Try to renew, and silently fail if the cert is not expired.

     

       547
       547
        
                   # Avoids #85794 and resolves #129838

     
···

       553
       553
        
                       exit 11

     

       554
       554
        
                     fi

     

       555
       555
        
                   fi

     

       556
       556
       -
       

     

       557
       557
       -
                 # Otherwise do a full run

     

       556
       556
       +
                 # Do a full run

     

       558
       557
        
                 elif ! lego ${runOpts}; then

     

       559
       558
        
                   # Produce a nice error for those doing their first nixos-rebuild with these certs

     

       560
       559
        
                   echo Failed to fetch certificates. \

     

       561
       560
        
                     This may mean your DNS records are set up incorrectly. \

     

       562
       562
       -
                     ${lib.optionalString (cfg.preliminarySelfsigned) "Selfsigned certs are in place and dependant services will still start."}

     

       561
       561
       +
                     Self-signed certs are in place and dependant services will still start.

     

       563
       562
        
                   # Exit 10 so that users can potentially amend SuccessExitStatus to ignore this error.

     

       564
       563
        
                   # High number to avoid Systemd reserved codes.

     

       565
       564
        
                   exit 10

     
···

       567
       566
        
       

     

       568
       567
        
                 mv domainhash.txt certificates/

     

       569
       568
        
       

     

       570
       570
       -
                 # Group might change between runs, re-apply it

     

       571
       571
       -
                 chown '${user}:${data.group}' certificates/*

     

       569
       569
       +
                 touch out/acme-success

     

       572
       570
        
       

     

       573
       571
        
                 # Copy all certs to the "real" certs directory

     

       572
       572
       +
                 # lego has only an interesting subset of files available,

     

       573
       573
       +
                 # construct reasonably compatible files that clients can consume

     

       574
       574
       +
                 # as expected.

     

       574
       575
        
                 if ! cmp -s 'certificates/${keyName}.crt' out/fullchain.pem; then

     

       575
       576
        
                   touch out/renewed

     

       576
       577
        
                   echo Installing new certificate

     
···

       581
       582
        
                   cat out/key.pem out/fullchain.pem > out/full.pem

     

       582
       583
        
                 fi

     

       583
       584
        
       

     

       584
       584
       -
                 # By default group will have no access to the cert files.

     

       585
       585
       -
                 # This chmod will fix that.

     

       586
       586
       -
                 chmod 640 out/*

     

       587
       587
       -
       

     

       585
       585
       +
                 # Keep permissions consistent. Needs to be in sync with the other scripts.

     

       586
       586
       +
                 for fixpath in out certificates; do

     

       587
       587
       +
                   if [ -d "$fixpath" ]; then

     

       588
       588
       +
                     chmod -R u=rwX,g=rX,o= "$fixpath"

     

       589
       589
       +
                     chown -R ${user}:${data.group} "$fixpath"

     

       590
       590
       +
                   fi

     

       591
       591
       +
                 done

     

       588
       592
        
                 # Also ensure safer permissions on the account directory.

     

       589
       593
        
                 chmod -R u=rwX,g=,o= accounts/.

     

       590
       594
        
               '';

     
···

       905
       909
        
       

     

       906
       910
        
         options = {

     

       907
       911
        
           security.acme = {

     

       908
       908
       -
             preliminarySelfsigned = lib.mkOption {

     

       909
       909
       -
               type = lib.types.bool;

     

       910
       910
       -
               default = true;

     

       911
       911
       -
               description = ''

     

       912
       912
       -
                 Whether a preliminary self-signed certificate should be generated before

     

       913
       913
       -
                 doing ACME requests. This can be useful when certificates are required in

     

       914
       914
       -
                 a webserver, but ACME needs the webserver to make its requests.

     

       915
       915
       -
       

     

       916
       916
       -
                 With preliminary self-signed certificate the webserver can be started and

     

       917
       917
       -
                 can later reload the correct ACME certificates.

     

       918
       918
       -
               '';

     

       919
       919
       -
             };

     

       920
       920
       -
       

     

       921
       912
        
             acceptTerms = lib.mkOption {

     

       922
       913
        
               type = lib.types.bool;

     

       923
       914
        
               default = false;

     
···

       1003
       994
        
             "ACME Directory is now hardcoded to /var/lib/acme and its permissions are managed by systemd. See https://github.com/NixOS/nixpkgs/issues/53852 for more info."

     

       1004
       995
        
           )

     

       1005
       996
        
           (lib.mkRemovedOptionModule [ "security" "acme" "preDelay" ]

     

       1006
       1006
       -
             "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"

     

       997
       997
       +
             "This option has been removed. If you want to make sure that something executes before certificates are provisioned, add a RequiredBy=acme-\${cert}.service and Before=acme-\${cert}.service to the service you want to execute before the cert renewal"

     

       1007
       998
        
           )

     

       1008
       999
        
           (lib.mkRemovedOptionModule [ "security" "acme" "activationDelay" ]

     

       1009
       1009
       -
             "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"

     

       1000
       1000
       +
             "This option has been removed. If you want to make sure that something executes before certificates are provisioned, add a RequiredBy=acme-\${cert}.service and Before=acme-\${cert}.service to the service you want to execute before the cert renewal"

     

       1001
       1001
       +
           )

     

       1002
       1002
       +
           (lib.mkRemovedOptionModule [ "security" "acme" "preliminarySelfsigned" ]

     

       1003
       1003
       +
             "This option has been removed. Preliminary self-signed certificates are now always generated to simplify the dependency structure."

     

       1010
       1004
        
           )

     

       1011
       1005
        
           (lib.mkChangedOptionModule

     

       1012
       1006
        
             [ "security" "acme" "validMin" ]

     
···

       1161
       1155
        
       

     

       1162
       1156
        
             systemd.services =

     

       1163
       1157
        
               let

     

       1164
       1164
       -
                 renewServiceFunctions = lib.mapAttrs' (

     

       1165
       1165
       -
                   cert: conf: lib.nameValuePair "acme-${cert}" conf.renewService

     

       1158
       1158
       +
                 orderRenewServices = lib.mapAttrs' (

     

       1159
       1159
       +
                   cert: conf: lib.nameValuePair "acme-order-renew-${cert}" conf.orderRenewService

     

       1166
       1160
        
                 ) certConfigs;

     

       1167
       1167
       -
                 renewServices =

     

       1168
       1168
       -
                   if cfg.maxConcurrentRenewals > 0 then

     

       1169
       1169
       -
                     roundRobinApplyAttrs renewServiceFunctions concurrencyLockfiles

     

       1170
       1170
       -
                   else

     

       1171
       1171
       -
                     lib.mapAttrs (_: f: f null) renewServiceFunctions;

     

       1172
       1172
       -
                 selfsignServiceFunctions = lib.mapAttrs' (

     

       1173
       1173
       -
                   cert: conf: lib.nameValuePair "acme-selfsigned-${cert}" conf.selfsignService

     

       1161
       1161
       +
                 baseServices = lib.mapAttrs' (

     

       1162
       1162
       +
                   cert: conf: lib.nameValuePair "acme-${cert}" conf.baseService

     

       1174
       1163
        
                 ) certConfigs;

     

       1175
       1175
       -
                 selfsignServices =

     

       1176
       1176
       -
                   if cfg.maxConcurrentRenewals > 0 then

     

       1177
       1177
       -
                     roundRobinApplyAttrs selfsignServiceFunctions concurrencyLockfiles

     

       1178
       1178
       -
                   else

     

       1179
       1179
       -
                     lib.mapAttrs (_: f: f null) selfsignServiceFunctions;

     

       1180
       1164
        
               in

     

       1181
       1165
        
               {

     

       1182
       1166
        
                 acme-setup = setupService;

     

       1183
       1167
        
               }

     

       1184
       1184
       -
               // renewServices

     

       1185
       1185
       -
               // lib.optionalAttrs cfg.preliminarySelfsigned selfsignServices;

     

       1168
       1168
       +
               // baseServices

     

       1169
       1169
       +
               // orderRenewServices;

     

       1186
       1170
        
       

     

       1187
       1171
        
             systemd.timers = lib.mapAttrs' (

     

       1188
       1188
       -
               cert: conf: lib.nameValuePair "acme-${cert}" conf.renewTimer

     

       1172
       1172
       +
               cert: conf: lib.nameValuePair "acme-renew-${cert}" conf.renewTimer

     

       1189
       1173
        
             ) certConfigs;

     

       1190
       1174
        
       

     

       1191
       1175
        
             systemd.targets =

     

       1192
       1176
        
               let

     

       1193
       1193
       -
                 # Create some targets which can be depended on to be "active" after cert renewals

     

       1194
       1194
       -
                 finishedTargets = lib.mapAttrs' (

     

       1195
       1195
       -
                   cert: conf:

     

       1196
       1196
       -
                   lib.nameValuePair "acme-finished-${cert}" {

     

       1197
       1197
       -
                     wantedBy = [ "default.target" ];

     

       1198
       1198
       -
                     requires = [ "acme-${cert}.service" ];

     

       1199
       1199
       -
                     after = [ "acme-${cert}.service" ];

     

       1200
       1200
       -
                   }

     

       1201
       1201
       -
                 ) certConfigs;

     

       1202
       1202
       -
       

     

       1203
       1177
        
                 # Create targets to limit the number of simultaneous account creations

     

       1204
       1178
        
                 # How it works:

     

       1205
       1179
        
                 # - Pick a "leader" cert service, which will be in charge of creating the account,

     
···

       1214
       1188
        
                   let

     

       1215
       1189
        
                     dnsConfs = builtins.filter (conf: cfg.certs.${conf.cert}.dnsProvider != null) confs;

     

       1216
       1190
        
                     leaderConf = if dnsConfs != [ ] then builtins.head dnsConfs else builtins.head confs;

     

       1217
       1217
       -
                     leader = "acme-${leaderConf.cert}.service";

     

       1218
       1218
       -
                     followers = map (conf: "acme-${conf.cert}.service") (

     

       1191
       1191
       +
                     leader = "acme-order-renew-${leaderConf.cert}.service";

     

       1192
       1192
       +
                     followers = map (conf: "acme-order-renew-${conf.cert}.service") (

     

       1219
       1193
        
                       builtins.filter (conf: conf != leaderConf) confs

     

       1220
       1194
        
                     );

     

       1221
       1195
        
                   in

     
···

       1224
       1198
        
                     before = followers;

     

       1225
       1199
        
                     requires = [ leader ];

     

       1226
       1200
        
                     after = [ leader ];

     

       1201
       1201
       +
                     unitConfig.RefuseManualStart = true;

     

       1227
       1202
        
                   }

     

       1228
       1203
        
                 ) (lib.groupBy (conf: conf.accountHash) (lib.attrValues certConfigs));

     

       1229
       1204
        
               in

     

       1230
       1230
       -
               finishedTargets // accountTargets;

     

       1205
       1205
       +
               accountTargets;

     

       1231
       1206
        
           })

     

       1232
       1207
        
         ];

     

       1233
       1208

+1 -1

nixos/modules/services/networking/doh-server.nix

···

       156
       156
        
               "network.target"

     

       157
       157
        
             ]

     

       158
       158
        
             ++ lib.optional (cfg.useACMEHost != null) "acme-${cfg.useACMEHost}.service";

     

       159
       159
       -
             wants = lib.optional (cfg.useACMEHost != null) "acme-finished-${cfg.useACMEHost}.target";

     

       159
       159
       +
             wants = lib.optional (cfg.useACMEHost != null) "acme-${cfg.useACMEHost}.service";

     

       160
       160
        
             wantedBy = [ "multi-user.target" ];

     

       161
       161
        
             serviceConfig = {

     

       162
       162
        
               AmbientCapabilities = "CAP_NET_BIND_SERVICE";

+7 -10

nixos/modules/services/web-servers/apache-httpd/default.nix

···

       48
       48
        
         ) (filter (hostOpts: hostOpts.enableACME || hostOpts.useACMEHost != null) vhosts);

     

       49
       49
        
       

     

       50
       50
        
         vhostCertNames = unique (map (hostOpts: hostOpts.certName) acmeEnabledVhosts);

     

       51
       51
       -
         dependentCertNames = filter (cert: certs.${cert}.dnsProvider == null) vhostCertNames; # those that might depend on the HTTP server

     

       52
       52
       -
         independentCertNames = filter (cert: certs.${cert}.dnsProvider != null) vhostCertNames; # those that don't depend on the HTTP server

     

       53
       51
        
       

     

       54
       52
        
         mkListenInfo =

     

       55
       53
        
           hostOpts:

     
···

       914
       912
        
           systemd.services.httpd = {

     

       915
       913
        
             description = "Apache HTTPD";

     

       916
       914
        
             wantedBy = [ "multi-user.target" ];

     

       917
       917
       -
             wants = concatLists (map (certName: [ "acme-finished-${certName}.target" ]) vhostCertNames);

     

       915
       915
       +
             wants = concatLists (map (certName: [ "acme-${certName}.service" ]) vhostCertNames);

     

       918
       916
        
             after = [

     

       919
       917
        
               "network.target"

     

       920
       918
        
             ]

     

       921
       921
       -
             ++ map (certName: "acme-selfsigned-${certName}.service") vhostCertNames

     

       922
       922
       -
             ++ map (certName: "acme-${certName}.service") independentCertNames; # avoid loading self-signed key w/ real cert, or vice-versa

     

       923
       923
       -
             before = map (certName: "acme-${certName}.service") dependentCertNames;

     

       919
       919
       +
             # Ensure httpd runs with baseline certificates in place.

     

       920
       920
       +
             ++ map (certName: "acme-${certName}.service") vhostCertNames;

     

       921
       921
       +
             # Ensure httpd runs (with current config) before the actual ACME jobs run

     

       922
       922
       +
             before = map (certName: "acme-order-renew-${certName}.service") vhostCertNames;

     

       924
       923
        
             restartTriggers = [ cfg.configFile ];

     

       925
       924
        
       

     

       926
       925
        
             path = [

     
···

       960
       959
        
       

     

       961
       960
        
           # postRun hooks on cert renew can't be used to restart Apache since renewal

     

       962
       961
        
           # runs as the unprivileged acme user. sslTargets are added to wantedBy + before

     

       963
       963
       -
           # which allows the acme-finished-$cert.target to signify the successful updating

     

       962
       962
       +
           # which allows the acme-order-renew-$cert.service to signify the successful updating

     

       964
       963
        
           # of certs end-to-end.

     

       965
       964
        
           systemd.services.httpd-config-reload =

     

       966
       965
        
             let

     

       967
       967
       -
               sslServices = map (certName: "acme-${certName}.service") vhostCertNames;

     

       968
       968
       -
               sslTargets = map (certName: "acme-finished-${certName}.target") vhostCertNames;

     

       966
       966
       +
               sslServices = map (certName: "acme-order-renew-${certName}.service") vhostCertNames;

     

       969
       967
        
             in

     

       970
       968
        
             mkIf (vhostCertNames != [ ]) {

     

       971
       969
        
               wantedBy = sslServices ++ [ "multi-user.target" ];

     

       972
       970
        
               # Before the finished targets, after the renew services.

     

       973
       971
        
               # This service might be needed for HTTP-01 challenges, but we only want to confirm

     

       974
       972
        
               # certs are updated _after_ config has been reloaded.

     

       975
       975
       -
               before = sslTargets;

     

       976
       973
        
               after = sslServices;

     

       977
       974
        
               restartTriggers = [ cfg.configFile ];

     

       978
       975
        
               # Block reloading if not all certs exist yet.

+4 -9

nixos/modules/services/web-servers/caddy/default.nix

···

       14
       14
        
         virtualHosts = attrValues cfg.virtualHosts;

     

       15
       15
        
         acmeEnabledVhosts = filter (hostOpts: hostOpts.useACMEHost != null) virtualHosts;

     

       16
       16
        
         vhostCertNames = unique (map (hostOpts: hostOpts.useACMEHost) acmeEnabledVhosts);

     

       17
       17
       -
         dependentCertNames = filter (cert: certs.${cert}.dnsProvider == null) vhostCertNames; # those that might depend on the HTTP server

     

       18
       18
       -
         independentCertNames = filter (cert: certs.${cert}.dnsProvider != null) vhostCertNames; # those that don't depend on the HTTP server

     

       19
       17
        
       

     

       20
       18
        
         mkVHostConf =

     

       21
       19
        
           hostOpts:

     

       22
       20
        
           let

     

       23
       23
       -
             sslCertDir = config.security.acme.certs.${hostOpts.useACMEHost}.directory;

     

       21
       21
       +
             sslCertDir = certs.${hostOpts.useACMEHost}.directory;

     

       24
       22
        
           in

     

       25
       23
        
           ''

     

       26
       24
        
             ${hostOpts.hostName} ${concatStringsSep " " hostOpts.serverAliases} {

     
···

       392
       390
        
           ++ map (

     

       393
       391
        
             name:

     

       394
       392
        
             mkCertOwnershipAssertion {

     

       395
       395
       -
               cert = config.security.acme.certs.${name};

     

       393
       393
       +
               cert = certs.${name};

     

       396
       394
        
               groups = config.users.groups;

     

       397
       395
        
               services = [ config.systemd.services.caddy ];

     

       398
       396
        
             }

     
···

       412
       410
        
       

     

       413
       411
        
           systemd.packages = [ cfg.package ];

     

       414
       412
        
           systemd.services.caddy = {

     

       415
       415
       -
             wants = map (certName: "acme-finished-${certName}.target") vhostCertNames;

     

       416
       416
       -
             after =

     

       417
       417
       -
               map (certName: "acme-selfsigned-${certName}.service") vhostCertNames

     

       418
       418
       -
               ++ map (certName: "acme-${certName}.service") independentCertNames; # avoid loading self-signed key w/ real cert, or vice-versa

     

       419
       419
       -
             before = map (certName: "acme-${certName}.service") dependentCertNames;

     

       413
       413
       +
             wants = map (certName: "acme-${certName}.service") vhostCertNames;

     

       414
       414
       +
             after = map (certName: "acme-${certName}.service") vhostCertNames;

     

       420
       415
        
       

     

       421
       416
        
             wantedBy = [ "multi-user.target" ];

     

       422
       417
        
             startLimitIntervalSec = 14400;

+5 -8

nixos/modules/services/web-servers/h2o/default.nix

···

       434
       434
        
           systemd.services.h2o = {

     

       435
       435
        
             description = "H2O HTTP server";

     

       436
       436
        
             wantedBy = [ "multi-user.target" ];

     

       437
       437
       -
             wants = lib.concatLists (map (certName: [ "acme-finished-${certName}.target" ]) acmeCertNames.all);

     

       437
       437
       +
             wants = lib.concatLists (map (certName: [ "acme-${certName}.service" ]) acmeCertNames.all);

     

       438
       438
        
             # Since H2O will be hosting the challenges, H2O must be started

     

       439
       439
       -
             before = builtins.map (certName: "acme-${certName}.service") acmeCertNames.dependent;

     

       439
       439
       +
             before = builtins.map (certName: "acme-order-renew-${certName}.service") acmeCertNames.all;

     

       440
       440
        
             after = [

     

       441
       441
        
               "network.target"

     

       442
       442
        
             ]

     

       443
       443
       -
             ++ builtins.map (certName: "acme-selfsigned-${certName}.service") acmeCertNames.all

     

       444
       444
       -
             ++ builtins.map (certName: "acme-${certName}.service") acmeCertNames.independent; # avoid loading self-signed key w/ real cert, or vice-versa

     

       443
       443
       +
             ++ builtins.map (certName: "acme-${certName}.service") acmeCertNames.all;

     

       445
       444
        
       

     

       446
       445
        
             serviceConfig = {

     

       447
       446
        
               ExecStart = "${h2oExe} --mode 'master'";

     
···

       490
       489
        
       

     

       491
       490
        
           # This service waits for all certificates to be available before reloading

     

       492
       491
        
           # H2O configuration. `tlsTargets` are added to `wantedBy` + `before` which

     

       493
       493
       -
           # allows the `acme-finished-$cert.target` to signify the successful updating

     

       492
       492
       +
           # allows the `acme-order-renew-$cert.service` to signify the successful updating

     

       494
       493
        
           # of certs end-to-end.

     

       495
       494
        
           systemd.services.h2o-config-reload =

     

       496
       495
        
             let

     

       497
       497
       -
               tlsTargets = map (certName: "acme-${certName}.target") acmeCertNames.all;

     

       498
       498
       -
               tlsServices = map (certName: "acme-${certName}.service") acmeCertNames.all;

     

       496
       496
       +
               tlsServices = map (certName: "acme-order-renew-${certName}.service") acmeCertNames.all;

     

       499
       497
        
             in

     

       500
       498
        
             mkIf (acmeCertNames.all != [ ]) {

     

       501
       499
        
               wantedBy = tlsServices ++ [ "multi-user.target" ];

     

       502
       502
       -
               before = tlsTargets;

     

       503
       500
        
               after = tlsServices;

     

       504
       501
        
               unitConfig = {

     

       505
       502
        
                 ConditionPathExists = map (

+12 -17

nixos/modules/services/web-servers/nginx/default.nix

···

       15
       15
        
           vhostConfig: vhostConfig.enableACME || vhostConfig.useACMEHost != null

     

       16
       16
        
         ) vhostsConfigs;

     

       17
       17
        
         vhostCertNames = unique (map (hostOpts: hostOpts.certName) acmeEnabledVhosts);

     

       18
       18
       -
         dependentCertNames = filter (cert: certs.${cert}.dnsProvider == null) vhostCertNames; # those that might depend on the HTTP server

     

       19
       19
       -
         independentCertNames = filter (cert: certs.${cert}.dnsProvider != null) vhostCertNames; # those that don't depend on the HTTP server

     

       20
       18
        
         virtualHosts = mapAttrs (

     

       21
       19
        
           vhostName: vhostConfig:

     

       22
       20
        
           let

     
···

       442
       440
        
                         auth_basic off;

     

       443
       441
        
                         auth_request off;

     

       444
       442
        
                         proxy_pass http://${vhost.acmeFallbackHost};

     

       443
       443
       +
                         proxy_set_header Host $host;

     

       445
       444
        
                       }

     

       446
       445
        
                     ''}

     

       447
       446
        
                   '';

     
···

       1481
       1480
        
           systemd.services.nginx = {

     

       1482
       1481
        
             description = "Nginx Web Server";

     

       1483
       1482
        
             wantedBy = [ "multi-user.target" ];

     

       1484
       1484
       -
             wants = concatLists (map (certName: [ "acme-finished-${certName}.target" ]) vhostCertNames);

     

       1483
       1483
       +
             wants = concatLists (map (certName: [ "acme-${certName}.service" ]) vhostCertNames);

     

       1485
       1484
        
             after = [

     

       1486
       1485
        
               "network.target"

     

       1487
       1486
        
             ]

     

       1488
       1488
       -
             ++ map (certName: "acme-selfsigned-${certName}.service") vhostCertNames

     

       1489
       1489
       -
             ++ map (certName: "acme-${certName}.service") independentCertNames; # avoid loading self-signed key w/ real cert, or vice-versa

     

       1490
       1490
       -
             # Nginx needs to be started in order to be able to request certificates

     

       1491
       1491
       -
             # (it's hosting the acme challenge after all)

     

       1492
       1492
       -
             # This fixes https://github.com/NixOS/nixpkgs/issues/81842

     

       1493
       1493
       -
             before = map (certName: "acme-${certName}.service") dependentCertNames;

     

       1487
       1487
       +
             # Ensure nginx runs with baseline certificates in place.

     

       1488
       1488
       +
             ++ map (certName: "acme-${certName}.service") vhostCertNames;

     

       1489
       1489
       +
             # Ensure nginx runs (with current config) before the actual ACME jobs run

     

       1490
       1490
       +
             before = map (certName: "acme-order-renew-${certName}.service") vhostCertNames;

     

       1494
       1491
        
             stopIfChanged = false;

     

       1495
       1492
        
             preStart = ''

     

       1496
       1493
        
               ${cfg.preStart}

     
···

       1585
       1582
        
           # This service waits for all certificates to be available

     

       1586
       1583
        
           # before reloading nginx configuration.

     

       1587
       1584
        
           # sslTargets are added to wantedBy + before

     

       1588
       1588
       -
           # which allows the acme-finished-$cert.target to signify the successful updating

     

       1585
       1585
       +
           # which allows the acme-order-renew-$cert.service to signify the successful updating

     

       1589
       1586
        
           # of certs end-to-end.

     

       1590
       1587
        
           systemd.services.nginx-config-reload =

     

       1591
       1588
        
             let

     

       1592
       1592
       -
               sslServices = map (certName: "acme-${certName}.service") vhostCertNames;

     

       1593
       1593
       -
               sslTargets = map (certName: "acme-finished-${certName}.target") vhostCertNames;

     

       1589
       1589
       +
               sslOrderRenewServices = map (certName: "acme-order-renew-${certName}.service") vhostCertNames;

     

       1594
       1590
        
             in

     

       1595
       1591
        
             mkIf (cfg.enableReload || vhostCertNames != [ ]) {

     

       1596
       1592
        
               wants = optionals cfg.enableReload [ "nginx.service" ];

     

       1597
       1597
       -
               wantedBy = sslServices ++ [ "multi-user.target" ];

     

       1598
       1598
       -
               # Before the finished targets, after the renew services.

     

       1593
       1593
       +
               wantedBy = sslOrderRenewServices ++ [ "multi-user.target" ];

     

       1594
       1594
       +
               # XXX Before the finished targets, after the renew services.

     

       1599
       1595
        
               # This service might be needed for HTTP-01 challenges, but we only want to confirm

     

       1600
       1596
        
               # certs are updated _after_ config has been reloaded.

     

       1601
       1601
       -
               before = sslTargets;

     

       1602
       1602
       -
               after = sslServices;

     

       1597
       1597
       +
               after = sslOrderRenewServices;

     

       1603
       1598
        
               restartTriggers = optionals cfg.enableReload [ configFile ];

     

       1604
       1599
        
               # Block reloading if not all certs exist yet.

     

       1605
       1600
        
               # Happens when config changes add new vhosts/certs.

     

       1606
       1601
        
               unitConfig = {

     

       1607
       1607
       -
                 ConditionPathExists = optionals (sslServices != [ ]) (

     

       1602
       1602
       +
                 ConditionPathExists = optionals (vhostCertNames != [ ]) (

     

       1608
       1603
        
                   map (certName: certs.${certName}.directory + "/fullchain.pem") vhostCertNames

     

       1609
       1604
        
                 );

     

       1610
       1605
        
                 # Disable rate limiting for this, because it may be triggered quickly a bunch of times

+5 -7

nixos/modules/services/web-servers/pomerium.nix

···

       72
       72
        
               wants = [

     

       73
       73
        
                 "network.target"

     

       74
       74
        
               ]

     

       75
       75
       -
               ++ (optional (cfg.useACMEHost != null) "acme-finished-${cfg.useACMEHost}.target");

     

       75
       75
       +
               ++ (optional (cfg.useACMEHost != null) "acme-${cfg.useACMEHost}.service");

     

       76
       76
        
               after = [

     

       77
       77
        
                 "network.target"

     

       78
       78
        
               ]

     

       79
       79
       -
               ++ (optional (cfg.useACMEHost != null) "acme-finished-${cfg.useACMEHost}.target");

     

       79
       79
       +
               ++ (optional (cfg.useACMEHost != null) "acme-${cfg.useACMEHost}.service");

     

       80
       80
        
               wantedBy = [ "multi-user.target" ];

     

       81
       81
        
               environment = optionalAttrs (cfg.useACMEHost != null) {

     

       82
       82
        
                 CERTIFICATE_FILE = "fullchain.pem";

     
···

       127
       127
        
       

     

       128
       128
        
             # postRun hooks on cert renew can't be used to restart Nginx since renewal

     

       129
       129
        
             # runs as the unprivileged acme user. sslTargets are added to wantedBy + before

     

       130
       130
       -
             # which allows the acme-finished-$cert.target to signify the successful updating

     

       130
       130
       +
             # which allows the acme-order-renew-$cert.target to signify the successful updating

     

       131
       131
        
             # of certs end-to-end.

     

       132
       132
        
             systemd.services.pomerium-config-reload = mkIf (cfg.useACMEHost != null) {

     

       133
       133
        
               # TODO(lukegb): figure out how to make config reloading work with credentials.

     

       134
       134
        
       

     

       135
       135
        
               wantedBy = [

     

       136
       136
       -
                 "acme-finished-${cfg.useACMEHost}.target"

     

       136
       136
       +
                 "acme-order-renew-${cfg.useACMEHost}.service"

     

       137
       137
        
                 "multi-user.target"

     

       138
       138
        
               ];

     

       139
       139
       -
               # Before the finished targets, after the renew services.

     

       140
       140
       -
               before = [ "acme-finished-${cfg.useACMEHost}.target" ];

     

       141
       141
       -
               after = [ "acme-${cfg.useACMEHost}.service" ];

     

       139
       139
       +
               after = [ "acme-order-renew-${cfg.useACMEHost}.service" ];

     

       142
       140
        
               # Block reloading if not all certs exist yet.

     

       143
       141
        
               unitConfig.ConditionPathExists = [

     

       144
       142
        
                 "${config.security.acme.certs.${cfg.useACMEHost}.directory}/fullchain.pem"

+9 -18

nixos/tests/acme/caddy.nix

···

       85
       85
        
             ca_domain = "${nodes.acme.test-support.acme.caDomain}"

     

       86
       86
        
             fqdn = "${nodes.caddy.networking.fqdn}"

     

       87
       87
        
       

     

       88
       88
       +
             with subtest("Boot and start with selfsigned certificates"):

     

       89
       89
       +
                 caddy.start()

     

       90
       90
       +
                 caddy.wait_for_unit("caddy.service")

     

       91
       91
       +
                 check_issuer(caddy, fqdn, "minica")

     

       92
       92
       +
                 # Check that the web server has picked up the selfsigned cert

     

       93
       93
       +
                 check_connection(caddy, fqdn, minica=True)

     

       94
       94
       +
       

     

       88
       95
        
             acme.start()

     

       89
       96
        
             wait_for_running(acme)

     

       90
       97
        
             acme.wait_for_open_port(443)

     

       91
       98
        
       

     

       92
       92
       -
             with subtest("Boot and acquire a new cert"):

     

       93
       93
       -
                 caddy.start()

     

       94
       94
       -
                 wait_for_running(caddy)

     

       95
       95
       -
       

     

       99
       99
       +
             with subtest("Acquire a new cert"):

     

       100
       100
       +
                 caddy.succeed(f"systemctl restart acme-{fqdn}.service")

     

       96
       101
        
                 check_issuer(caddy, fqdn, "pebble")

     

       97
       102
        
                 check_domain(caddy, fqdn, fqdn)

     

       98
       98
       -
       

     

       99
       103
        
                 download_ca_certs(caddy, ca_domain)

     

       100
       100
       -
                 check_connection(caddy, fqdn)

     

       101
       101
       -
       

     

       102
       102
       -
             with subtest("Can run on selfsigned certificates"):

     

       103
       103
       -
                 # Switch to selfsigned first

     

       104
       104
       -
                 caddy.succeed(f"systemctl clean acme-{fqdn}.service --what=state")

     

       105
       105
       -
                 caddy.succeed(f"systemctl start acme-selfsigned-{fqdn}.service")

     

       106
       106
       -
                 check_issuer(caddy, fqdn, "minica")

     

       107
       107
       -
                 caddy.succeed("systemctl restart caddy.service")

     

       108
       108
       -
                 # Check that the web server has picked up the selfsigned cert

     

       109
       109
       -
                 check_connection(caddy, fqdn, minica=True)

     

       110
       110
       -
                 caddy.succeed(f"systemctl start acme-{fqdn}.service")

     

       111
       111
       -
                 # This may fail a couple of times before caddy is restarted

     

       112
       112
       -
                 check_issuer(caddy, fqdn, "pebble")

     

       113
       104
        
                 check_connection(caddy, fqdn)

     

       114
       105
        
       

     

       115
       106
        
             with subtest("security.acme changes reflect on caddy"):

+18 -4

nixos/tests/acme/default.nix

···

       1
       1
        
       { runTest }:

     

       2
       2
       +
       let

     

       3
       3
       +
         domain = "example.test";

     

       4
       4
       +
       in

     

       2
       5
        
       {

     

       3
       6
        
         http01-builtin = runTest ./http01-builtin.nix;

     

       4
       7
        
         dns01 = runTest ./dns01.nix;

     

       5
       8
        
         caddy = runTest ./caddy.nix;

     

       6
       9
        
         nginx = runTest (

     

       7
       10
        
           import ./webserver.nix {

     

       11
       11
       +
             inherit domain;

     

       8
       12
        
             serverName = "nginx";

     

       9
       13
        
             group = "nginx";

     

       10
       14
        
             baseModule = {

     
···

       22
       26
        
                   addSSL = true;

     

       23
       27
        
                   useACMEHost = "proxied.example.test";

     

       24
       28
        
                   acmeFallbackHost = "localhost:8080";

     

       25
       25
       -
                   # lego will refuse the request if the host header is not correct

     

       26
       26
       -
                   extraConfig = ''

     

       27
       27
       -
                     proxy_set_header Host $host;

     

       28
       28
       -
                   '';

     

       29
       29
        
                 };

     

       30
       30
       +
               };

     

       31
       31
       +
               specialisation.nullroot.configuration = {

     

       32
       32
       +
                 services.nginx.virtualHosts."nullroot.${domain}".acmeFallbackHost = "localhost:8081";

     

       30
       33
        
               };

     

       31
       34
        
             };

     

       32
       35
        
           }

     

       33
       36
        
         );

     

       34
       37
        
         httpd = runTest (

     

       35
       38
        
           import ./webserver.nix {

     

       39
       39
       +
             inherit domain;

     

       36
       40
        
             serverName = "httpd";

     

       37
       41
        
             group = "wwwrun";

     

       38
       42
        
             baseModule = {

     
···

       44
       48
        
                   useACMEHost = "proxied.example.test";

     

       45
       49
        
                   locations."/.well-known/acme-challenge" = {

     

       46
       50
        
                     proxyPass = "http://localhost:8080/.well-known/acme-challenge";

     

       51
       51
       +
                     extraConfig = ''

     

       52
       52
       +
                       ProxyPreserveHost On

     

       53
       53
       +
                     '';

     

       54
       54
       +
                   };

     

       55
       55
       +
                 };

     

       56
       56
       +
               };

     

       57
       57
       +
               specialisation.nullroot.configuration = {

     

       58
       58
       +
                 services.httpd.virtualHosts."nullroot.${domain}" = {

     

       59
       59
       +
                   locations."/.well-known/acme-challenge" = {

     

       60
       60
       +
                     proxyPass = "http://localhost:8081/.well-known/acme-challenge";

     

       47
       61
        
                     extraConfig = ''

     

       48
       62
        
                       ProxyPreserveHost On

     

       49
       63
        
                     '';

+68 -7

nixos/tests/acme/http01-builtin.nix

···

       37
       37
        
                 listenHTTP = ":80";

     

       38
       38
        
               };

     

       39
       39
        
       

     

       40
       40
       +
               systemd.targets."renew-triggered" = {

     

       41
       41
       +
                 wantedBy = [ "acme-order-renew-${config.networking.fqdn}.service" ];

     

       42
       42
       +
                 after = [ "acme-order-renew-${config.networking.fqdn}.service" ];

     

       43
       43
       +
                 unitConfig.RefuseManualStart = true;

     

       44
       44
       +
               };

     

       45
       45
       +
       

     

       40
       46
        
               specialisation = {

     

       41
       47
        
                 renew.configuration = {

     

       42
       48
        
                   # Pebble provides 5 year long certs,

     
···

       177
       183
        
                 # old_hash will be used in the preservation tests later

     

       178
       184
        
                 old_hash = hash

     

       179
       185
        
                 builtin.succeed(f"systemctl start acme-{cert}.service")

     

       186
       186
       +
                 builtin.succeed(f"systemctl start acme-order-renew-{cert}.service")

     

       187
       187
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       188
       188
       +
       

     

       180
       189
        
                 hash_after = builtin.succeed(f"sha256sum /var/lib/acme/{cert}/cert.pem")

     

       181
       190
        
                 assert hash == hash_after, "Certificate was unexpectedly changed"

     

       182
       191
        
       

     

       192
       192
       +
                 builtin.succeed("systemctl stop renew-triggered.target")

     

       183
       193
        
                 switch_to(builtin, "renew")

     

       194
       194
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       195
       195
       +
       

     

       184
       196
        
                 check_issuer(builtin, cert, "pebble")

     

       185
       197
        
                 hash_after = builtin.succeed(f"sha256sum /var/lib/acme/{cert}/cert.pem | tee /dev/stderr")

     

       186
       198
        
                 assert hash != hash_after, "Certificate was not renewed"

     

       187
       199
        
       

     

       200
       200
       +
                 check_permissions(builtin, cert, "acme")

     

       201
       201
       +
       

     

       188
       202
        
             with subtest("Handles email change correctly"):

     

       189
       203
        
                 hash = builtin.succeed(f"sha256sum /var/lib/acme/{cert}/cert.pem")

     

       204
       204
       +
       

     

       205
       205
       +
                 builtin.succeed("systemctl stop renew-triggered.target")

     

       190
       206
        
                 switch_to(builtin, "accountchange")

     

       207
       207
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       208
       208
       +
       

     

       191
       209
        
                 check_issuer(builtin, cert, "pebble")

     

       192
       210
        
                 # Check that there are now 2 account directories

     

       193
       211
        
                 builtin.succeed("test $(ls -1 /var/lib/acme/.lego/accounts | tee /dev/stderr | wc -l) -eq 2")

     
···

       202
       220
        
                 # old_hash will be used in the preservation tests later

     

       203
       221
        
                 old_hash = hash_after

     

       204
       222
        
       

     

       223
       223
       +
                 check_permissions(builtin, cert, "acme")

     

       224
       224
       +
       

     

       205
       225
        
             with subtest("Correctly implements OCSP stapling"):

     

       206
       226
        
                 check_stapling(builtin, cert, "${caDomain}", fail=True)

     

       227
       227
       +
       

     

       228
       228
       +
                 builtin.succeed("systemctl stop renew-triggered.target")

     

       207
       229
        
                 switch_to(builtin, "ocsp_stapling")

     

       230
       230
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       231
       231
       +
       

     

       208
       232
        
                 check_stapling(builtin, cert, "${caDomain}")

     

       233
       233
       +
                 check_permissions(builtin, cert, "acme")

     

       209
       234
        
       

     

       210
       235
        
             with subtest("Handles keyType change correctly"):

     

       211
       236
        
                 check_key_bits(builtin, cert, 256)

     

       237
       237
       +
       

     

       238
       238
       +
                 builtin.succeed("systemctl stop renew-triggered.target")

     

       212
       239
        
                 switch_to(builtin, "keytype")

     

       240
       240
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       241
       241
       +
       

     

       213
       242
        
                 check_key_bits(builtin, cert, 384)

     

       214
       243
        
                 # keyType is part of the accountHash, thus a new account will be created

     

       215
       244
        
                 builtin.succeed("test $(ls -1 /var/lib/acme/.lego/accounts | tee /dev/stderr | wc -l) -eq 2")

     

       245
       245
       +
                 check_permissions(builtin, cert, "acme")

     

       216
       246
        
       

     

       217
       247
        
             with subtest("Reuses generated, valid certs from previous configurations"):

     

       218
       248
        
                 # Right now, the hash should not match due to the previous test

     

       219
       249
        
                 hash = builtin.succeed(f"sha256sum /var/lib/acme/{cert}/cert.pem | tee /dev/stderr")

     

       220
       250
        
                 assert hash != old_hash, "Expected certificate to differ"

     

       251
       251
       +
       

     

       252
       252
       +
                 builtin.succeed("systemctl stop renew-triggered.target")

     

       221
       253
        
                 switch_to(builtin, "preservation")

     

       254
       254
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       255
       255
       +
       

     

       222
       256
        
                 hash = builtin.succeed(f"sha256sum /var/lib/acme/{cert}/cert.pem | tee /dev/stderr")

     

       223
       257
        
                 assert hash == old_hash, "Expected certificate to match from older configuration"

     

       258
       258
       +
                 check_permissions(builtin, cert, "acme")

     

       224
       259
        
       

     

       225
       260
        
             with subtest("Add a new cert, extend existing cert domains"):

     

       226
       261
        
                 check_domain(builtin, cert, f"builtin-alt.{domain}", fail=True)

     

       262
       262
       +
       

     

       263
       263
       +
                 builtin.succeed("systemctl stop renew-triggered.target")

     

       227
       264
        
                 switch_to(builtin, "add_cert_and_domain")

     

       265
       265
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       266
       266
       +
       

     

       228
       267
        
                 check_issuer(builtin, cert, "pebble")

     

       229
       268
        
                 check_domain(builtin, cert, f"builtin-alt.{domain}")

     

       230
       269
        
                 check_issuer(builtin, cert2, "pebble")

     

       231
       270
        
                 check_domain(builtin, cert2, cert2)

     

       232
       271
        
                 # There should not be a new account folder created

     

       233
       272
        
                 builtin.succeed("test $(ls -1 /var/lib/acme/.lego/accounts | tee /dev/stderr | wc -l) -eq 2")

     

       273
       273
       +
                 check_permissions(builtin, cert, "acme")

     

       274
       274
       +
                 check_permissions(builtin, cert2, "acme")

     

       234
       275
        
       

     

       235
       276
        
             with subtest("Check account hashing compatibility with pre-24.05 settings"):

     

       236
       236
       -
                 switch_to(builtin, "legacy_account_hash", fail=True)

     

       277
       277
       +
                 builtin.succeed("systemctl stop renew-triggered.target")

     

       278
       278
       +
                 switch_to(builtin, "legacy_account_hash"

     

       279
       279
       +
                 )

     

       280
       280
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       281
       281
       +
       

     

       237
       282
        
                 builtin.succeed(f"stat {legacy_account_dir} > /dev/stderr && rm -rf {legacy_account_dir}")

     

       283
       283
       +
                 check_permissions(builtin, cert, "acme")

     

       238
       284
        
       

     

       239
       239
       -
             with subtest("Ensure Concurrency limits work"):

     

       285
       285
       +
             with subtest("Ensure concurrency limits work"):

     

       286
       286
       +
                 builtin.succeed("systemctl stop renew-triggered.target")

     

       240
       287
        
                 switch_to(builtin, "concurrency")

     

       288
       288
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       289
       289
       +
       

     

       241
       290
        
                 check_issuer(builtin, cert3, "pebble")

     

       242
       291
        
                 check_domain(builtin, cert3, cert3)

     

       292
       292
       +
                 check_permissions(builtin, cert, "acme")

     

       293
       293
       +
       

     

       294
       294
       +
             with subtest("Can renew using a CSR"):

     

       295
       295
       +
                 builtin.succeed(f"systemctl stop acme-{cert}.service")

     

       296
       296
       +
                 builtin.succeed(f"systemctl clean acme-{cert}.service --what=state")

     

       297
       297
       +
       

     

       298
       298
       +
                 builtin.succeed("systemctl stop renew-triggered.target")

     

       299
       299
       +
                 switch_to(builtin, "csr")

     

       300
       300
       +
                 builtin.wait_for_unit("renew-triggered.target")

     

       301
       301
       +
       

     

       302
       302
       +
                 check_issuer(builtin, cert, "pebble")

     

       243
       303
        
       

     

       244
       304
        
             with subtest("Generate self-signed certs"):

     

       305
       305
       +
                 acme.shutdown()

     

       306
       306
       +
       

     

       245
       307
        
                 check_issuer(builtin, cert, "pebble")

     

       308
       308
       +
       

     

       309
       309
       +
                 builtin.succeed(f"systemctl stop acme-{cert}.service")

     

       246
       310
        
                 builtin.succeed(f"systemctl clean acme-{cert}.service --what=state")

     

       247
       247
       -
                 builtin.succeed(f"systemctl start acme-selfsigned-{cert}.service")

     

       311
       311
       +
                 builtin.succeed(f"systemctl start acme-{cert}.service")

     

       312
       312
       +
       

     

       248
       313
        
                 check_issuer(builtin, cert, "minica")

     

       249
       314
        
                 check_domain(builtin, cert, cert)

     

       250
       315
        
       

     

       251
       316
        
             with subtest("Validate permissions (self-signed)"):

     

       252
       317
        
                 check_permissions(builtin, cert, "acme")

     

       253
       318
        
       

     

       254
       254
       -
             with subtest("Can renew using a CSR"):

     

       255
       255
       -
                 builtin.succeed(f"systemctl clean acme-{cert}.service --what=state")

     

       256
       256
       -
                 switch_to(builtin, "csr")

     

       257
       257
       -
                 check_issuer(builtin, cert, "pebble")

     

       258
       319
        
           '';

     

       259
       320
        
       }

+33 -32

nixos/tests/acme/python-utils.py

···

       3
       3
        
       

     

       4
       4
        
       TOTAL_RETRIES = 20

     

       5
       5
        
       

     

       6
       6
       +
       # BackoffTracker provides a robust system for handling test retries

     

       7
       7
       +
       class BackoffTracker:

     

       8
       8
       +
           delay = 1

     

       9
       9
       +
           increment = 1

     

       10
       10
       +
       

     

       11
       11
       +
           def handle_fail(self, retries, message) -> int:

     

       12
       12
       +
               assert retries < TOTAL_RETRIES, message

     

       13
       13
       +
       

     

       14
       14
       +
               print(f"Retrying in {self.delay}s, {retries + 1}/{TOTAL_RETRIES}")

     

       15
       15
       +
               time.sleep(self.delay)

     

       16
       16
       +
       

     

       17
       17
       +
               # Only increment after the first try

     

       18
       18
       +
               if retries == 0:

     

       19
       19
       +
                   self.delay += self.increment

     

       20
       20
       +
                   self.increment *= 2

     

       21
       21
       +
       

     

       22
       22
       +
               return retries + 1

     

       23
       23
       +
       

     

       24
       24
       +
           def protect(self, func):

     

       25
       25
       +
               def wrapper(*args, retries: int = 0, **kwargs):

     

       26
       26
       +
                   try:

     

       27
       27
       +
                       return func(*args, **kwargs)

     

       28
       28
       +
                   except Exception as err:

     

       29
       29
       +
                       retries = self.handle_fail(retries, err.args)

     

       30
       30
       +
                       return wrapper(*args, retries=retries, **kwargs)

     

       31
       31
       +
       

     

       32
       32
       +
               return wrapper

     

       33
       33
       +
       

     

       34
       34
       +
       

     

       35
       35
       +
       backoff = BackoffTracker()

     

       6
       36
        
       

     

       7
       37
        
       def run(node, cmd, fail=False):

     

       8
       38
        
           if fail:

     
···

       39
       69
        
       # and matches the issuer we expect it to be.

     

       40
       70
        
       # It's a good validation to ensure the cert.pem and fullchain.pem

     

       41
       71
        
       # are not still selfsigned after verification

     

       72
       72
       +
       @backoff.protect

     

       42
       73
        
       def check_issuer(node, cert_name, issuer) -> None:

     

       43
       74
        
           for fname in ("cert.pem", "fullchain.pem"):

     

       44
       75
        
               actual_issuer = node.succeed(

     
···

       102
       133
        
               f"test $({stat} /var/lib/acme/{cert_name}/*.pem"

     

       103
       134
        
               f" | tee /dev/stderr | grep -v '640 acme {group}' | wc -l) -eq 0"

     

       104
       135
        
           )

     

       136
       136
       +
           node.execute(f"ls -lahR /var/lib/acme/.lego/{cert_name}/* > /dev/stderr")

     

       105
       137
        
           node.succeed(

     

       106
       138
        
               f"test $({stat} /var/lib/acme/.lego/{cert_name}/*/{cert_name}*"

     

       107
       107
       -
               f" | tee /dev/stderr | grep -v '600 acme {group}' | wc -l) -eq 0"

     

       139
       139
       +
               f" | tee /dev/stderr | grep -v '640 acme {group}' | wc -l) -eq 0"

     

       108
       140
        
           )

     

       109
       141
        
           node.succeed(

     

       110
       142
        
               f"test $({stat} /var/lib/acme/{cert_name}"

     
···

       114
       146
        
               f"test $(find /var/lib/acme/.lego/accounts -type f -exec {stat} {{}} \\;"

     

       115
       147
        
               f" | tee /dev/stderr | grep -v '600 acme {group}' | wc -l) -eq 0"

     

       116
       148
        
           )

     

       117
       117
       -
       

     

       118
       118
       -
       # BackoffTracker provides a robust system for handling test retries

     

       119
       119
       -
       class BackoffTracker:

     

       120
       120
       -
           delay = 1

     

       121
       121
       -
           increment = 1

     

       122
       122
       -
       

     

       123
       123
       -
           def handle_fail(self, retries, message) -> int:

     

       124
       124
       -
               assert retries < TOTAL_RETRIES, message

     

       125
       125
       -
       

     

       126
       126
       -
               print(f"Retrying in {self.delay}s, {retries + 1}/{TOTAL_RETRIES}")

     

       127
       127
       -
               time.sleep(self.delay)

     

       128
       128
       -
       

     

       129
       129
       -
               # Only increment after the first try

     

       130
       130
       -
               if retries == 0:

     

       131
       131
       -
                   self.delay += self.increment

     

       132
       132
       -
                   self.increment *= 2

     

       133
       133
       -
       

     

       134
       134
       -
               return retries + 1

     

       135
       135
       -
       

     

       136
       136
       -
           def protect(self, func):

     

       137
       137
       -
               def wrapper(*args, retries: int = 0, **kwargs):

     

       138
       138
       -
                   try:

     

       139
       139
       -
                       return func(*args, **kwargs)

     

       140
       140
       -
                   except Exception as err:

     

       141
       141
       -
                       retries = self.handle_fail(retries, err.args)

     

       142
       142
       -
                       return wrapper(*args, retries=retries, **kwargs)

     

       143
       143
       -
       

     

       144
       144
       -
               return wrapper

     

       145
       145
       -
       

     

       146
       146
       -
       

     

       147
       147
       -
       backoff = BackoffTracker()

     

       148
       149
        
       

     

       149
       150
        
       

     

       150
       151
        
       @backoff.protect

+67 -22

nixos/tests/acme/webserver.nix

···

       2
       2
        
         serverName,

     

       3
       3
        
         group,

     

       4
       4
        
         baseModule,

     

       5
       5
       -
         domain ? "example.test",

     

       5
       5
       +
         domain,

     

       6
       6
        
       }:

     

       7
       7
        
       {

     

       8
       8
        
         config,

     
···

       18
       18
        
           timeout = 300;

     

       19
       19
        
         };

     

       20
       20
        
       

     

       21
       21
       +
         interactive.sshBackdoor.enable = true;

     

       22
       22
       +
       

     

       21
       23
        
         nodes = {

     

       22
       24
        
           # The fake ACME server which will respond to client requests

     

       23
       25
        
           acme =

     
···

       45
       47
        
                 "certchange.${domain}"

     

       46
       48
        
                 "zeroconf.${domain}"

     

       47
       49
        
                 "zeroconf2.${domain}"

     

       50
       50
       +
                 "zeroconf3.${domain}"

     

       48
       51
        
                 "nullroot.${domain}"

     

       49
       52
        
               ];

     

       50
       53
        
       

     
···

       57
       60
        
               systemd.targets."renew-triggered" = {

     

       58
       61
        
                 wantedBy = [ "${serverName}-config-reload.service" ];

     

       59
       62
        
                 after = [ "${serverName}-config-reload.service" ];

     

       63
       63
       +
                 unitConfig.RefuseManualStart = true;

     

       60
       64
        
               };

     

       61
       65
        
       

     

       62
       66
        
               security.acme.certs."proxied.${domain}" = {

     
···

       101
       105
        
                 # Test that "acmeRoot = null" still results in

     

       102
       106
        
                 # valid cert generation by inheriting defaults.

     

       103
       107
        
                 nullroot.configuration = {

     

       104
       104
       -
                   security.acme.defaults.listenHTTP = ":8080";

     

       108
       108
       +
                   # The default.nix has the server-type dependent config statements

     

       109
       109
       +
                   # to properly set up the proxying. We need a separate port here to

     

       110
       110
       +
                   # avoid hostname issues with the proxy already running on :8080

     

       111
       111
       +
                   security.acme.defaults.listenHTTP = ":8081";

     

       105
       112
        
                   services.${serverName}.virtualHosts."nullroot.${domain}" = {

     

       106
       106
       -
                     onlySSL = true;

     

       113
       113
       +
                     addSSL = true;

     

       107
       114
        
                     enableACME = true;

     

       108
       115
        
                     acmeRoot = null;

     

       109
       116
        
                   };

     

       110
       117
        
                 };

     

       118
       118
       +
       

     

       119
       119
       +
                 # Test that a adding a second virtual host will not trigger

     

       120
       120
       +
                 # other units (account and renewal service for first)

     

       121
       121
       +
                 zeroconf3.configuration = {

     

       122
       122
       +
                   services.${serverName}.virtualHosts = {

     

       123
       123
       +
                     "zeroconf.${domain}" = {

     

       124
       124
       +
                       addSSL = true;

     

       125
       125
       +
                       enableACME = true;

     

       126
       126
       +
                       serverAliases = [ "zeroconf2.${domain}" ];

     

       127
       127
       +
                     };

     

       128
       128
       +
                     "zeroconf3.${domain}" = {

     

       129
       129
       +
                       addSSL = true;

     

       130
       130
       +
                       enableACME = true;

     

       131
       131
       +
                     };

     

       132
       132
       +
                   };

     

       133
       133
       +
                   # We're doing something risky with the combination of the service unit being persistent

     

       134
       134
       +
                   # that could end up that the timers do not trigger properly. Show that timers have the

     

       135
       135
       +
                   # desired effect.

     

       136
       136
       +
                   systemd.timers."acme-renew-zeroconf3.${domain}".timerConfig = {

     

       137
       137
       +
                     OnCalendar = lib.mkForce "*-*-* *:*:0/5";

     

       138
       138
       +
                     AccuracySec = lib.mkForce 0;

     

       139
       139
       +
                     # Skew randomly within the day, per https://letsencrypt.org/docs/integration-guide/.

     

       140
       140
       +
                     RandomizedDelaySec = lib.mkForce 0;

     

       141
       141
       +
                     FixedRandomDelay = lib.mkForce 0;

     

       142
       142
       +
                   };

     

       143
       143
       +
                 };

     

       111
       144
        
               };

     

       112
       145
        
             };

     

       113
       146
        
         };

     
···

       121
       154
        
             ca_domain = "${nodes.acme.test-support.acme.caDomain}"

     

       122
       155
        
             fqdn = f"proxied.{domain}"

     

       123
       156
        
       

     

       157
       157
       +
             webserver.start()

     

       158
       158
       +
             webserver.wait_for_unit("${serverName}.service")

     

       159
       159
       +
       

     

       160
       160
       +
             with subtest("Can run on self-signed certificates"):

     

       161
       161
       +
                 check_issuer(webserver, fqdn, "minica")

     

       162
       162
       +
                 # Check that the web server has picked up the selfsigned cert

     

       163
       163
       +
                 check_connection(webserver, fqdn, minica=True)

     

       164
       164
       +
       

     

       124
       165
        
             acme.start()

     

       125
       166
        
             wait_for_running(acme)

     

       126
       167
        
             acme.wait_for_open_port(443)

     

       127
       168
        
       

     

       128
       169
        
             with subtest("Acquire a cert through a proxied lego"):

     

       129
       129
       -
                 webserver.start()

     

       130
       130
       -
                 webserver.succeed("systemctl is-system-running --wait")

     

       131
       131
       -
                 wait_for_running(webserver)

     

       132
       132
       -
                 download_ca_certs(webserver, ca_domain)

     

       133
       133
       -
                 check_connection(webserver, fqdn)

     

       134
       134
       -
       

     

       135
       135
       -
             with subtest("Can run on selfsigned certificates"):

     

       136
       136
       -
                 # Switch to selfsigned first

     

       137
       137
       -
                 webserver.succeed(f"systemctl clean acme-{fqdn}.service --what=state")

     

       138
       138
       -
                 webserver.succeed(f"systemctl start acme-selfsigned-{fqdn}.service")

     

       139
       139
       -
                 check_issuer(webserver, fqdn, "minica")

     

       140
       140
       -
                 webserver.succeed("systemctl restart ${serverName}-config-reload.service")

     

       141
       141
       -
                 # Check that the web server has picked up the selfsigned cert

     

       142
       142
       -
                 check_connection(webserver, fqdn, minica=True)

     

       143
       143
       -
                 webserver.succeed("systemctl stop renew-triggered.target")

     

       144
       144
       -
                 webserver.succeed(f"systemctl start acme-{fqdn}.service")

     

       145
       145
       -
                 webserver.wait_for_unit("renew-triggered.target")

     

       146
       146
       -
                 check_issuer(webserver, fqdn, "pebble")

     

       147
       147
       -
                 check_connection(webserver, fqdn)

     

       170
       170
       +
               webserver.succeed(f"systemctl start acme-order-renew-{fqdn}.service")

     

       171
       171
       +
               webserver.wait_for_unit("renew-triggered.target")

     

       172
       172
       +
               download_ca_certs(webserver, ca_domain)

     

       173
       173
       +
               check_issuer(webserver, fqdn, "pebble")

     

       174
       174
       +
               check_connection(webserver, fqdn)

     

       148
       175
        
       

     

       149
       176
        
             with subtest("security.acme changes reflect on web server part 1"):

     

       150
       177
        
                 check_connection(webserver, f"certchange.{domain}", fail=True)

     
···

       181
       208
        
                 switch_to(webserver, "nullroot")

     

       182
       209
        
                 webserver.wait_for_unit("renew-triggered.target")

     

       183
       210
        
                 check_connection(webserver, f"nullroot.{domain}")

     

       211
       211
       +
       

     

       212
       212
       +
             with subtest("Ensure that adding a second vhost does not trigger first vhost acme units"):

     

       213
       213
       +
                 switch_to(webserver, "zeroconf")

     

       214
       214
       +
                 webserver.wait_for_unit("renew-triggered.target")

     

       215
       215
       +
                 webserver.succeed("journalctl --cursor-file=/tmp/cursor | grep acme")

     

       216
       216
       +
                 switch_to(webserver, "zeroconf3")

     

       217
       217
       +
                 webserver.wait_for_unit("renew-triggered.target")

     

       218
       218
       +
                 output = webserver.succeed("journalctl --cursor-file=/tmp/cursor | grep acme")

     

       219
       219
       +
                 # The new certificate unit gets triggered:

     

       220
       220
       +
                 t.assertIn(f"acme-zeroconf3.{domain}-start", output)

     

       221
       221
       +
                 # The account generation should not be triggered again:

     

       222
       222
       +
                 t.assertNotIn("acme-account-d590213ed52603e9128d.target", output)

     

       223
       223
       +
                 # The other certificates should also not be triggered:

     

       224
       224
       +
                 t.assertNotIn(f"acme-zeroconf.{domain}-start", output)

     

       225
       225
       +
                 t.assertNotIn(f"acme-proxied.{domain}-start", output)

     

       226
       226
       +
                 # Ensure the timer works, due to our shenanigans with

     

       227
       227
       +
                 # RemainAfterExit=true

     

       228
       228
       +
                 webserver.wait_until_succeeds(f"journalctl --cursor-file=/tmp/cursor | grep 'Starting Order (and renew) ACME certificate for zeroconf3.{domain}...'")

     

       184
       229
        
           '';

     

       185
       230
        
       }

+5 -4

nixos/tests/step-ca.nix

···

       137
       137
        
               caserver.wait_for_unit("step-ca.service")

     

       138
       138
        
               caserver.wait_until_succeeds("journalctl -o cat -u step-ca.service | grep '${pkgs.step-ca.version}'")

     

       139
       139
        
       

     

       140
       140
       -
               caclient.wait_for_unit("acme-finished-caclient.target")

     

       141
       141
       -
               catester.succeed("curl https://caclient/ | grep \"Welcome to nginx!\"")

     

       140
       140
       +
               caclient.wait_for_unit("acme-caclient.service")

     

       141
       141
       +
               # The order is run asynchonously, keep trying.

     

       142
       142
       +
               catester.wait_until_succeeds("curl https://caclient/ | grep \"Welcome to nginx!\"")

     

       142
       143
        
       

     

       143
       144
        
               caclientcaddy.wait_for_unit("caddy.service")

     

       144
       145
        
               # It’s hard to know when Caddy has finished the ACME dance with

     

       145
       146
        
               # step-ca, so we keep trying cURL until success.

     

       146
       147
        
               catester.wait_until_succeeds("curl https://caclientcaddy/ | grep \"Welcome to Caddy!\"")

     

       147
       148
        
       

     

       148
       148
       -
               caclienth2o.wait_for_unit("acme-finished-caclienth2o.target")

     

       149
       149
       +
               caclienth2o.wait_for_unit("acme-caclienth2o.service")

     

       149
       150
        
               caclienth2o.wait_for_unit("h2o.service")

     

       150
       150
       -
               catester.succeed("curl https://caclienth2o/ | grep \"Welcome to H2O!\"")

     

       151
       151
       +
               catester.wait_until_succeeds("curl https://caclienth2o/ | grep \"Welcome to H2O!\"")

     

       151
       152
        
             '';

     

       152
       153
        
         }

     

       153
       154
        
       )