commit 1002ce25a07e2ff5448a19b4f06be9372aaf4659 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       767
       767
        
         ./services/networking/namecoind.nix

     

       768
       768
        
         ./services/networking/nar-serve.nix

     

       769
       769
        
         ./services/networking/nat.nix

     

       770
       770
       +
         ./services/networking/nats.nix

     

       770
       771
        
         ./services/networking/ndppd.nix

     

       771
       772
        
         ./services/networking/nebula.nix

     

       772
       773
        
         ./services/networking/networkmanager.nix

+159

nixos/modules/services/networking/nats.nix

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
       

     

       7
       7
       +
         cfg = config.services.nats;

     

       8
       8
       +
       

     

       9
       9
       +
         format = pkgs.formats.json { };

     

       10
       10
       +
       

     

       11
       11
       +
         configFile = format.generate "nats.conf" cfg.settings;

     

       12
       12
       +
       

     

       13
       13
       +
       in {

     

       14
       14
       +
       

     

       15
       15
       +
         ### Interface

     

       16
       16
       +
       

     

       17
       17
       +
         options = {

     

       18
       18
       +
           services.nats = {

     

       19
       19
       +
             enable = mkEnableOption "NATS messaging system";

     

       20
       20
       +
       

     

       21
       21
       +
             user = mkOption {

     

       22
       22
       +
               type = types.str;

     

       23
       23
       +
               default = "nats";

     

       24
       24
       +
               description = "User account under which NATS runs.";

     

       25
       25
       +
             };

     

       26
       26
       +
       

     

       27
       27
       +
             group = mkOption {

     

       28
       28
       +
               type = types.str;

     

       29
       29
       +
               default = "nats";

     

       30
       30
       +
               description = "Group under which NATS runs.";

     

       31
       31
       +
             };

     

       32
       32
       +
       

     

       33
       33
       +
             serverName = mkOption {

     

       34
       34
       +
               default = "nats";

     

       35
       35
       +
               example = "n1-c3";

     

       36
       36
       +
               type = types.str;

     

       37
       37
       +
               description = ''

     

       38
       38
       +
                 Name of the NATS server, must be unique if clustered.

     

       39
       39
       +
               '';

     

       40
       40
       +
             };

     

       41
       41
       +
       

     

       42
       42
       +
             jetstream = mkEnableOption "JetStream";

     

       43
       43
       +
       

     

       44
       44
       +
             port = mkOption {

     

       45
       45
       +
               default = 4222;

     

       46
       46
       +
               example = 4222;

     

       47
       47
       +
               type = types.port;

     

       48
       48
       +
               description = ''

     

       49
       49
       +
                 Port on which to listen.

     

       50
       50
       +
               '';

     

       51
       51
       +
             };

     

       52
       52
       +
       

     

       53
       53
       +
             dataDir = mkOption {

     

       54
       54
       +
               default = "/var/lib/nats";

     

       55
       55
       +
               type = types.path;

     

       56
       56
       +
               description = ''

     

       57
       57
       +
                 The NATS data directory. Only used if JetStream is enabled, for

     

       58
       58
       +
                 storing stream metadata and messages.

     

       59
       59
       +
       

     

       60
       60
       +
                 If left as the default value this directory will automatically be

     

       61
       61
       +
                 created before the NATS server starts, otherwise the sysadmin is

     

       62
       62
       +
                 responsible for ensuring the directory exists with appropriate

     

       63
       63
       +
                 ownership and permissions.

     

       64
       64
       +
               '';

     

       65
       65
       +
             };

     

       66
       66
       +
       

     

       67
       67
       +
             settings = mkOption {

     

       68
       68
       +
               default = { };

     

       69
       69
       +
               type = format.type;

     

       70
       70
       +
               example = literalExample ''

     

       71
       71
       +
                 {

     

       72
       72
       +
                   jetstream = {

     

       73
       73
       +
                     max_mem = "1G";

     

       74
       74
       +
                     max_file = "10G";

     

       75
       75
       +
                   };

     

       76
       76
       +
                 };

     

       77
       77
       +
               '';

     

       78
       78
       +
               description = ''

     

       79
       79
       +
                 Declarative NATS configuration. See the

     

       80
       80
       +
                 <link xlink:href="https://docs.nats.io/nats-server/configuration">

     

       81
       81
       +
                 NATS documentation</link> for a list of options.

     

       82
       82
       +
               '';

     

       83
       83
       +
             };

     

       84
       84
       +
           };

     

       85
       85
       +
         };

     

       86
       86
       +
       

     

       87
       87
       +
         ### Implementation

     

       88
       88
       +
       

     

       89
       89
       +
         config = mkIf cfg.enable {

     

       90
       90
       +
           services.nats.settings = {

     

       91
       91
       +
             server_name = cfg.serverName;

     

       92
       92
       +
             port = cfg.port;

     

       93
       93
       +
             jetstream = optionalAttrs cfg.jetstream { store_dir = cfg.dataDir; };

     

       94
       94
       +
           };

     

       95
       95
       +
       

     

       96
       96
       +
           systemd.services.nats = {

     

       97
       97
       +
             description = "NATS messaging system";

     

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

     

       99
       99
       +
             after = [ "network.target" ];

     

       100
       100
       +
       

     

       101
       101
       +
             serviceConfig = mkMerge [

     

       102
       102
       +
               (mkIf (cfg.dataDir == "/var/lib/nats") {

     

       103
       103
       +
                 StateDirectory = "nats";

     

       104
       104
       +
                 StateDirectoryMode = "0750";

     

       105
       105
       +
               })

     

       106
       106
       +
               {

     

       107
       107
       +
                 Type = "simple";

     

       108
       108
       +
                 ExecStart = "${pkgs.nats-server}/bin/nats-server -c ${configFile}";

     

       109
       109
       +
                 ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID";

     

       110
       110
       +
                 ExecStop = "${pkgs.coreutils}/bin/kill -SIGINT $MAINPID";

     

       111
       111
       +
                 Restart = "on-failure";

     

       112
       112
       +
       

     

       113
       113
       +
                 User = cfg.user;

     

       114
       114
       +
                 Group = cfg.group;

     

       115
       115
       +
       

     

       116
       116
       +
                 # Hardening

     

       117
       117
       +
                 CapabilityBoundingSet = "";

     

       118
       118
       +
                 LimitNOFILE = 800000; # JetStream requires 2 FDs open per stream.

     

       119
       119
       +
                 LockPersonality = true;

     

       120
       120
       +
                 MemoryDenyWriteExecute = true;

     

       121
       121
       +
                 NoNewPrivileges = true;

     

       122
       122
       +
                 PrivateDevices = true;

     

       123
       123
       +
                 PrivateTmp = true;

     

       124
       124
       +
                 PrivateUsers = true;

     

       125
       125
       +
                 ProcSubset = "pid";

     

       126
       126
       +
                 ProtectClock = true;

     

       127
       127
       +
                 ProtectControlGroups = true;

     

       128
       128
       +
                 ProtectHome = true;

     

       129
       129
       +
                 ProtectHostname = true;

     

       130
       130
       +
                 ProtectKernelLogs = true;

     

       131
       131
       +
                 ProtectKernelModules = true;

     

       132
       132
       +
                 ProtectKernelTunables = true;

     

       133
       133
       +
                 ProtectProc = "invisible";

     

       134
       134
       +
                 ProtectSystem = "strict";

     

       135
       135
       +
                 ReadOnlyPaths = [ ];

     

       136
       136
       +
                 ReadWritePaths = [ cfg.dataDir ];

     

       137
       137
       +
                 RestrictAddressFamilies = [ "AF_INET" "AF_INET6" ];

     

       138
       138
       +
                 RestrictNamespaces = true;

     

       139
       139
       +
                 RestrictRealtime = true;

     

       140
       140
       +
                 RestrictSUIDSGID = true;

     

       141
       141
       +
                 SystemCallFilter = [ "@system-service" "~@privileged" "~@resources" ];

     

       142
       142
       +
                 UMask = "0077";

     

       143
       143
       +
               }

     

       144
       144
       +
             ];

     

       145
       145
       +
           };

     

       146
       146
       +
       

     

       147
       147
       +
           users.users = mkIf (cfg.user == "nats") {

     

       148
       148
       +
             nats = {

     

       149
       149
       +
               description = "NATS daemon user";

     

       150
       150
       +
               isSystemUser = true;

     

       151
       151
       +
               group = cfg.group;

     

       152
       152
       +
               home = cfg.dataDir;

     

       153
       153
       +
             };

     

       154
       154
       +
           };

     

       155
       155
       +
       

     

       156
       156
       +
           users.groups = mkIf (cfg.group == "nats") { nats = { }; };

     

       157
       157
       +
         };

     

       158
       158
       +
       

     

       159
       159
       +
       }

nixos/tests/all-tests.nix

···

       283
       283
        
         nat.firewall = handleTest ./nat.nix { withFirewall = true; };

     

       284
       284
        
         nat.firewall-conntrack = handleTest ./nat.nix { withFirewall = true; withConntrackHelpers = true; };

     

       285
       285
        
         nat.standalone = handleTest ./nat.nix { withFirewall = false; };

     

       286
       286
       +
         nats = handleTest ./nats.nix {};

     

       286
       287
        
         navidrome = handleTest ./navidrome.nix {};

     

       287
       288
        
         ncdns = handleTest ./ncdns.nix {};

     

       288
       289
        
         ndppd = handleTest ./ndppd.nix {};

+65

nixos/tests/nats.nix

···

       1
       1
       +
       let

     

       2
       2
       +
       

     

       3
       3
       +
         port = 4222;

     

       4
       4
       +
         username = "client";

     

       5
       5
       +
         password = "password";

     

       6
       6
       +
         topic = "foo.bar";

     

       7
       7
       +
       

     

       8
       8
       +
       in import ./make-test-python.nix ({ pkgs, lib, ... }: {

     

       9
       9
       +
         name = "nats";

     

       10
       10
       +
         meta = with pkgs.lib; { maintainers = with maintainers; [ c0deaddict ]; };

     

       11
       11
       +
       

     

       12
       12
       +
         nodes = let

     

       13
       13
       +
           client = { pkgs, ... }: {

     

       14
       14
       +
             environment.systemPackages = with pkgs; [ natscli ];

     

       15
       15
       +
           };

     

       16
       16
       +
         in {

     

       17
       17
       +
           server = { pkgs, ... }: {

     

       18
       18
       +
             networking.firewall.allowedTCPPorts = [ port ];

     

       19
       19
       +
             services.nats = {

     

       20
       20
       +
               inherit port;

     

       21
       21
       +
               enable = true;

     

       22
       22
       +
               settings = {

     

       23
       23
       +
                 authorization = {

     

       24
       24
       +
                   users = [{

     

       25
       25
       +
                     user = username;

     

       26
       26
       +
                     inherit password;

     

       27
       27
       +
                   }];

     

       28
       28
       +
                 };

     

       29
       29
       +
               };

     

       30
       30
       +
             };

     

       31
       31
       +
           };

     

       32
       32
       +
       

     

       33
       33
       +
           client1 = client;

     

       34
       34
       +
           client2 = client;

     

       35
       35
       +
         };

     

       36
       36
       +
       

     

       37
       37
       +
         testScript = let file = "/tmp/msg";

     

       38
       38
       +
         in ''

     

       39
       39
       +
           def nats_cmd(*args):

     

       40
       40
       +
               return (

     

       41
       41
       +
                   "nats "

     

       42
       42
       +
                   "--server=nats://server:${toString port} "

     

       43
       43
       +
                   "--user=${username} "

     

       44
       44
       +
                   "--password=${password} "

     

       45
       45
       +
                   "{}"

     

       46
       46
       +
               ).format(" ".join(args))

     

       47
       47
       +
       

     

       48
       48
       +
           start_all()

     

       49
       49
       +
           server.wait_for_unit("nats.service")

     

       50
       50
       +
       

     

       51
       51
       +
           client1.fail("test -f ${file}")

     

       52
       52
       +
       

     

       53
       53
       +
           # Subscribe on topic on client1 and echo messages to file.

     

       54
       54
       +
           client1.execute("({} | tee ${file} &)".format(nats_cmd("sub", "--raw", "${topic}")))

     

       55
       55
       +
       

     

       56
       56
       +
           # Give client1 some time to subscribe.

     

       57
       57
       +
           client1.execute("sleep 2")

     

       58
       58
       +
       

     

       59
       59
       +
           # Publish message on client2.

     

       60
       60
       +
           client2.execute(nats_cmd("pub", "${topic}", "hello"))

     

       61
       61
       +
       

     

       62
       62
       +
           # Check if message has been received.

     

       63
       63
       +
           client1.succeed("grep -q hello ${file}")

     

       64
       64
       +
         '';

     

       65
       65
       +
       })