commit 1a3b9e1bd2c4e61fdc4ae13ed830f0758fa1c02e · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       623
       623
        
         ./services/search/hound.nix

     

       624
       624
        
         ./services/search/kibana.nix

     

       625
       625
        
         ./services/search/solr.nix

     

       626
       626
       +
         ./services/security/certmgr.nix

     

       626
       627
        
         ./services/security/cfssl.nix

     

       627
       628
        
         ./services/security/clamav.nix

     

       628
       629
        
         ./services/security/fail2ban.nix

+194

nixos/modules/services/security/certmgr.nix

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
         cfg = config.services.certmgr;

     

       7
       7
       +
       

     

       8
       8
       +
         specs = mapAttrsToList (n: v: rec {

     

       9
       9
       +
           name = n + ".json";

     

       10
       10
       +
           path = if isAttrs v then pkgs.writeText name (builtins.toJSON v) else v;

     

       11
       11
       +
         }) cfg.specs;

     

       12
       12
       +
       

     

       13
       13
       +
         allSpecs = pkgs.linkFarm "certmgr.d" specs;

     

       14
       14
       +
       

     

       15
       15
       +
         certmgrYaml = pkgs.writeText "certmgr.yaml" (builtins.toJSON {

     

       16
       16
       +
           dir = allSpecs;

     

       17
       17
       +
           default_remote = cfg.defaultRemote;

     

       18
       18
       +
           svcmgr = cfg.svcManager;

     

       19
       19
       +
           before = cfg.validMin;

     

       20
       20
       +
           interval = cfg.renewInterval;

     

       21
       21
       +
           inherit (cfg) metricsPort metricsAddress;

     

       22
       22
       +
         });

     

       23
       23
       +
       

     

       24
       24
       +
         specPaths = map dirOf (concatMap (spec:

     

       25
       25
       +
           if isAttrs spec then

     

       26
       26
       +
             collect isString (filterAttrsRecursive (n: v: isAttrs v || n == "path") spec)

     

       27
       27
       +
           else

     

       28
       28
       +
             [ spec ]

     

       29
       29
       +
         ) (attrValues cfg.specs));

     

       30
       30
       +
       

     

       31
       31
       +
         preStart = ''

     

       32
       32
       +
           ${concatStringsSep " \\\n" (["mkdir -p"] ++ map escapeShellArg specPaths)}

     

       33
       33
       +
           ${pkgs.certmgr}/bin/certmgr -f ${certmgrYaml} check

     

       34
       34
       +
         '';

     

       35
       35
       +
       in

     

       36
       36
       +
       {

     

       37
       37
       +
         options.services.certmgr = {

     

       38
       38
       +
           enable = mkEnableOption "certmgr";

     

       39
       39
       +
       

     

       40
       40
       +
           defaultRemote = mkOption {

     

       41
       41
       +
             type = types.str;

     

       42
       42
       +
             default = "127.0.0.1:8888";

     

       43
       43
       +
             description = "The default CA host:port to use.";

     

       44
       44
       +
           };

     

       45
       45
       +
       

     

       46
       46
       +
           validMin = mkOption {

     

       47
       47
       +
             default = "72h";

     

       48
       48
       +
             type = types.str;

     

       49
       49
       +
             description = "The interval before a certificate expires to start attempting to renew it.";

     

       50
       50
       +
           };

     

       51
       51
       +
       

     

       52
       52
       +
           renewInterval = mkOption {

     

       53
       53
       +
             default = "30m";

     

       54
       54
       +
             type = types.str;

     

       55
       55
       +
             description = "How often to check certificate expirations and how often to update the cert_next_expires metric.";

     

       56
       56
       +
           };

     

       57
       57
       +
       

     

       58
       58
       +
           metricsAddress = mkOption {

     

       59
       59
       +
             default = "127.0.0.1";

     

       60
       60
       +
             type = types.str;

     

       61
       61
       +
             description = "The address for the Prometheus HTTP endpoint.";

     

       62
       62
       +
           };

     

       63
       63
       +
       

     

       64
       64
       +
           metricsPort = mkOption {

     

       65
       65
       +
             default = 9488;

     

       66
       66
       +
             type = types.ints.u16;

     

       67
       67
       +
             description = "The port for the Prometheus HTTP endpoint.";

     

       68
       68
       +
           };

     

       69
       69
       +
       

     

       70
       70
       +
           specs = mkOption {

     

       71
       71
       +
             default = {};

     

       72
       72
       +
             example = literalExample ''

     

       73
       73
       +
             {

     

       74
       74
       +
               exampleCert =

     

       75
       75
       +
               let

     

       76
       76
       +
                 domain = "example.com";

     

       77
       77
       +
                 secret = name: "/var/lib/secrets/''${name}.pem";

     

       78
       78
       +
               in {

     

       79
       79
       +
                 service = "nginx";

     

       80
       80
       +
                 action = "reload";

     

       81
       81
       +
                 authority = {

     

       82
       82
       +
                   file.path = secret "ca";

     

       83
       83
       +
                 };

     

       84
       84
       +
                 certificate = {

     

       85
       85
       +
                   path = secret domain;

     

       86
       86
       +
                 };

     

       87
       87
       +
                 private_key = {

     

       88
       88
       +
                   owner = "root";

     

       89
       89
       +
                   group = "root";

     

       90
       90
       +
                   mode = "0600";

     

       91
       91
       +
                   path = secret "''${domain}-key";

     

       92
       92
       +
                 };

     

       93
       93
       +
                 request = {

     

       94
       94
       +
                   CN = domain;

     

       95
       95
       +
                   hosts = [ "mail.''${domain}" "www.''${domain}" ];

     

       96
       96
       +
                   key = {

     

       97
       97
       +
                     algo = "rsa";

     

       98
       98
       +
                     size = 2048;

     

       99
       99
       +
                   };

     

       100
       100
       +
                   names = {

     

       101
       101
       +
                     O = "Example Organization";

     

       102
       102
       +
                     C = "USA";

     

       103
       103
       +
                   };

     

       104
       104
       +
                 };

     

       105
       105
       +
               };

     

       106
       106
       +
               otherCert = "/var/certmgr/specs/other-cert.json";

     

       107
       107
       +
             }

     

       108
       108
       +
             '';

     

       109
       109
       +
             type = with types; attrsOf (either (submodule {

     

       110
       110
       +
               options = {

     

       111
       111
       +
                 service = mkOption {

     

       112
       112
       +
                   type = nullOr str;

     

       113
       113
       +
                   default = null;

     

       114
       114
       +
                   description = "The service on which to perform &lt;action&gt; after fetching.";

     

       115
       115
       +
                 };

     

       116
       116
       +
       

     

       117
       117
       +
                 action = mkOption {

     

       118
       118
       +
                   type = addCheck str (x: cfg.svcManager == "command" || elem x ["restart" "reload" "nop"]);

     

       119
       119
       +
                   default = "nop";

     

       120
       120
       +
                   description = "The action to take after fetching.";

     

       121
       121
       +
                 };

     

       122
       122
       +
       

     

       123
       123
       +
                 # These ought all to be specified according to certmgr spec def.

     

       124
       124
       +
                 authority = mkOption {

     

       125
       125
       +
                   type = attrs;

     

       126
       126
       +
                   description = "certmgr spec authority object.";

     

       127
       127
       +
                 };

     

       128
       128
       +
       

     

       129
       129
       +
                 certificate = mkOption {

     

       130
       130
       +
                   type = nullOr attrs;

     

       131
       131
       +
                   description = "certmgr spec certificate object.";

     

       132
       132
       +
                 };

     

       133
       133
       +
       

     

       134
       134
       +
                 private_key = mkOption {

     

       135
       135
       +
                   type = nullOr attrs;

     

       136
       136
       +
                   description = "certmgr spec private_key object.";

     

       137
       137
       +
                 };

     

       138
       138
       +
       

     

       139
       139
       +
                 request = mkOption {

     

       140
       140
       +
                   type = nullOr attrs;

     

       141
       141
       +
                   description = "certmgr spec request object.";

     

       142
       142
       +
                 };

     

       143
       143
       +
               };

     

       144
       144
       +
           }) path);

     

       145
       145
       +
             description = ''

     

       146
       146
       +
               Certificate specs as described by:

     

       147
       147
       +
               <link xlink:href="https://github.com/cloudflare/certmgr#certificate-specs" />

     

       148
       148
       +
               These will be added to the Nix store, so they will be world readable.

     

       149
       149
       +
             '';

     

       150
       150
       +
           };

     

       151
       151
       +
       

     

       152
       152
       +
           svcManager = mkOption {

     

       153
       153
       +
             default = "systemd";

     

       154
       154
       +
             type = types.enum [ "circus" "command" "dummy" "openrc" "systemd" "sysv" ];

     

       155
       155
       +
             description = ''

     

       156
       156
       +
               This specifies the service manager to use for restarting or reloading services.

     

       157
       157
       +
               See: <link xlink:href="https://github.com/cloudflare/certmgr#certmgryaml" />.

     

       158
       158
       +
               For how to use the "command" service manager in particular,

     

       159
       159
       +
               see: <link xlink:href="https://github.com/cloudflare/certmgr#command-svcmgr-and-how-to-use-it" />.

     

       160
       160
       +
             '';

     

       161
       161
       +
           };

     

       162
       162
       +
       

     

       163
       163
       +
         };

     

       164
       164
       +
       

     

       165
       165
       +
         config = mkIf cfg.enable {

     

       166
       166
       +
           assertions = [

     

       167
       167
       +
             {

     

       168
       168
       +
               assertion = cfg.specs != {};

     

       169
       169
       +
               message = "Certmgr specs cannot be empty.";

     

       170
       170
       +
             }

     

       171
       171
       +
             {

     

       172
       172
       +
               assertion = !any (hasAttrByPath [ "authority" "auth_key" ]) (attrValues cfg.specs);

     

       173
       173
       +
               message = ''

     

       174
       174
       +
                 Inline services.certmgr.specs are added to the Nix store rendering them world readable.

     

       175
       175
       +
                 Specify paths as specs, if you want to use include auth_key - or use the auth_key_file option."

     

       176
       176
       +
               '';

     

       177
       177
       +
             }

     

       178
       178
       +
           ];

     

       179
       179
       +
       

     

       180
       180
       +
           systemd.services.certmgr = {

     

       181
       181
       +
             description = "certmgr";

     

       182
       182
       +
             path = mkIf (cfg.svcManager == "command") [ pkgs.bash ];

     

       183
       183
       +
             after = [ "network-online.target" ];

     

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

     

       185
       185
       +
             inherit preStart;

     

       186
       186
       +
       

     

       187
       187
       +
             serviceConfig = {

     

       188
       188
       +
               Restart = "always";

     

       189
       189
       +
               RestartSec = "10s";

     

       190
       190
       +
               ExecStart = "${pkgs.certmgr}/bin/certmgr -f ${certmgrYaml}";

     

       191
       191
       +
             };

     

       192
       192
       +
           };

     

       193
       193
       +
         };

     

       194
       194
       +
       }

nixos/release.nix

···

       256
       256
        
         tests.buildbot = callTest tests/buildbot.nix {};

     

       257
       257
        
         tests.cadvisor = callTestOnMatchingSystems ["x86_64-linux"] tests/cadvisor.nix {};

     

       258
       258
        
         tests.ceph = callTestOnMatchingSystems ["x86_64-linux"] tests/ceph.nix {};

     

       259
       259
       +
         tests.certmgr = callSubTests tests/certmgr.nix {};

     

       259
       260
        
         tests.cfssl = callTestOnMatchingSystems ["x86_64-linux"] tests/cfssl.nix {};

     

       260
       261
        
         tests.chromium = (callSubTestsOnMatchingSystems ["x86_64-linux"] tests/chromium.nix {}).stable or {};

     

       261
       262
        
         tests.cjdns = callTest tests/cjdns.nix {};

+148

nixos/tests/certmgr.nix

···

       1
       1
       +
       { system ? builtins.currentSystem }:

     

       2
       2
       +
       

     

       3
       3
       +
       with import ../lib/testing.nix { inherit system; };

     

       4
       4
       +
       let

     

       5
       5
       +
         mkSpec = { host, service ? null, action }: {

     

       6
       6
       +
           inherit action;

     

       7
       7
       +
           authority = {

     

       8
       8
       +
             file = {

     

       9
       9
       +
               group = "nobody";

     

       10
       10
       +
               owner = "nobody";

     

       11
       11
       +
               path = "/tmp/${host}-ca.pem";

     

       12
       12
       +
             };

     

       13
       13
       +
             label = "www_ca";

     

       14
       14
       +
             profile = "three-month";

     

       15
       15
       +
             remote = "localhost:8888";

     

       16
       16
       +
           };

     

       17
       17
       +
           certificate = {

     

       18
       18
       +
             group = "nobody";

     

       19
       19
       +
             owner = "nobody";

     

       20
       20
       +
             path = "/tmp/${host}-cert.pem";

     

       21
       21
       +
           };

     

       22
       22
       +
           private_key = {

     

       23
       23
       +
             group = "nobody";

     

       24
       24
       +
             mode = "0600";

     

       25
       25
       +
             owner = "nobody";

     

       26
       26
       +
             path = "/tmp/${host}-key.pem";

     

       27
       27
       +
           };

     

       28
       28
       +
           request = {

     

       29
       29
       +
             CN = host;

     

       30
       30
       +
             hosts = [ host "www.${host}" ];

     

       31
       31
       +
             key = {

     

       32
       32
       +
               algo = "rsa";

     

       33
       33
       +
               size = 2048;

     

       34
       34
       +
             };

     

       35
       35
       +
             names = [

     

       36
       36
       +
               {

     

       37
       37
       +
                 C = "US";

     

       38
       38
       +
                 L = "San Francisco";

     

       39
       39
       +
                 O = "Example, LLC";

     

       40
       40
       +
                 ST = "CA";

     

       41
       41
       +
               }

     

       42
       42
       +
             ];

     

       43
       43
       +
           };

     

       44
       44
       +
           inherit service;

     

       45
       45
       +
         };

     

       46
       46
       +
       

     

       47
       47
       +
         mkCertmgrTest = { svcManager, specs, testScript }: makeTest {

     

       48
       48
       +
           name = "certmgr-" + svcManager;

     

       49
       49
       +
           nodes = {

     

       50
       50
       +
             machine = { config, lib, pkgs, ... }: {

     

       51
       51
       +
               networking.firewall.allowedTCPPorts = with config.services; [ cfssl.port certmgr.metricsPort ];

     

       52
       52
       +
               networking.extraHosts = "127.0.0.1 imp.example.org decl.example.org";

     

       53
       53
       +
       

     

       54
       54
       +
               services.cfssl.enable = true;

     

       55
       55
       +
               systemd.services.cfssl.after = [ "cfssl-init.service" "networking.target" ];

     

       56
       56
       +
       

     

       57
       57
       +
               systemd.services.cfssl-init = {

     

       58
       58
       +
                 description = "Initialize the cfssl CA";

     

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

     

       60
       60
       +
                 serviceConfig = {

     

       61
       61
       +
                   User             = "cfssl";

     

       62
       62
       +
                   Type             = "oneshot";

     

       63
       63
       +
                   WorkingDirectory = config.services.cfssl.dataDir;

     

       64
       64
       +
                 };

     

       65
       65
       +
                 script = ''

     

       66
       66
       +
                   ${pkgs.cfssl}/bin/cfssl genkey -initca ${pkgs.writeText "ca.json" (builtins.toJSON {

     

       67
       67
       +
                     hosts = [ "ca.example.com" ];

     

       68
       68
       +
                     key = {

     

       69
       69
       +
                       algo = "rsa"; size = 4096; };

     

       70
       70
       +
                       names = [

     

       71
       71
       +
                         {

     

       72
       72
       +
                           C = "US";

     

       73
       73
       +
                           L = "San Francisco";

     

       74
       74
       +
                           O = "Internet Widgets, LLC";

     

       75
       75
       +
                           OU = "Certificate Authority";

     

       76
       76
       +
                           ST = "California";

     

       77
       77
       +
                         }

     

       78
       78
       +
                       ];

     

       79
       79
       +
                   })} | ${pkgs.cfssl}/bin/cfssljson -bare ca

     

       80
       80
       +
                 '';

     

       81
       81
       +
               };

     

       82
       82
       +
       

     

       83
       83
       +
               services.nginx = {

     

       84
       84
       +
                 enable = true;

     

       85
       85
       +
                 virtualHosts = lib.mkMerge (map (host: {

     

       86
       86
       +
                   ${host} = {

     

       87
       87
       +
                     sslCertificate = "/tmp/${host}-cert.pem";

     

       88
       88
       +
                     sslCertificateKey = "/tmp/${host}-key.pem";

     

       89
       89
       +
                     extraConfig = ''

     

       90
       90
       +
                       ssl_protocols TLSv1 TLSv1.1 TLSv1.2;

     

       91
       91
       +
                     '';

     

       92
       92
       +
                     onlySSL = true;

     

       93
       93
       +
                     serverName = host;

     

       94
       94
       +
                     root = pkgs.writeTextDir "index.html" "It works!";

     

       95
       95
       +
                   };

     

       96
       96
       +
                 }) [ "imp.example.org" "decl.example.org" ]);

     

       97
       97
       +
               };

     

       98
       98
       +
       

     

       99
       99
       +
               systemd.services.nginx.wantedBy = lib.mkForce [];

     

       100
       100
       +
       

     

       101
       101
       +
               systemd.services.certmgr.after = [ "cfssl.service" ];

     

       102
       102
       +
               services.certmgr = {

     

       103
       103
       +
                 enable = true;

     

       104
       104
       +
                 inherit svcManager;

     

       105
       105
       +
                 inherit specs;

     

       106
       106
       +
               };

     

       107
       107
       +
       

     

       108
       108
       +
             };

     

       109
       109
       +
           };

     

       110
       110
       +
           inherit testScript;

     

       111
       111
       +
         };

     

       112
       112
       +
       in

     

       113
       113
       +
       {

     

       114
       114
       +
         systemd = mkCertmgrTest {

     

       115
       115
       +
           svcManager = "systemd";

     

       116
       116
       +
           specs = {

     

       117
       117
       +
             decl = mkSpec { host = "decl.example.org"; service = "nginx"; action ="restart"; };

     

       118
       118
       +
             imp = toString (pkgs.writeText "test.json" (builtins.toJSON (

     

       119
       119
       +
               mkSpec { host = "imp.example.org"; service = "nginx"; action = "restart"; }

     

       120
       120
       +
             )));

     

       121
       121
       +
           };

     

       122
       122
       +
           testScript = ''

     

       123
       123
       +
             $machine->waitForUnit('cfssl.service');

     

       124
       124
       +
             $machine->waitUntilSucceeds('ls /tmp/decl.example.org-ca.pem');

     

       125
       125
       +
             $machine->waitUntilSucceeds('ls /tmp/decl.example.org-key.pem');

     

       126
       126
       +
             $machine->waitUntilSucceeds('ls /tmp/decl.example.org-cert.pem');

     

       127
       127
       +
             $machine->waitUntilSucceeds('ls /tmp/imp.example.org-ca.pem');

     

       128
       128
       +
             $machine->waitUntilSucceeds('ls /tmp/imp.example.org-key.pem');

     

       129
       129
       +
             $machine->waitUntilSucceeds('ls /tmp/imp.example.org-cert.pem');

     

       130
       130
       +
             $machine->waitForUnit('nginx.service');

     

       131
       131
       +
             $machine->succeed('[ "1" -lt "$(journalctl -u nginx | grep "Starting Nginx" | wc -l)" ]');

     

       132
       132
       +
             $machine->succeed('curl --cacert /tmp/imp.example.org-ca.pem https://imp.example.org');

     

       133
       133
       +
             $machine->succeed('curl --cacert /tmp/decl.example.org-ca.pem https://decl.example.org');

     

       134
       134
       +
           '';

     

       135
       135
       +
         };

     

       136
       136
       +
       

     

       137
       137
       +
         command = mkCertmgrTest {

     

       138
       138
       +
           svcManager = "command";

     

       139
       139
       +
           specs = {

     

       140
       140
       +
             test = mkSpec { host = "command.example.org"; action = "touch /tmp/command.executed"; };

     

       141
       141
       +
           };

     

       142
       142
       +
           testScript = ''

     

       143
       143
       +
             $machine->waitForUnit('cfssl.service');

     

       144
       144
       +
             $machine->waitUntilSucceeds('stat /tmp/command.executed');

     

       145
       145
       +
           '';

     

       146
       146
       +
         };

     

       147
       147
       +
       

     

       148
       148
       +
       }