commit cadf4cfc8307b5df7f8a1ac72b5c166d14fcf55f · pyrox.dev/nixpkgs

nixos/doc/manual/redirects.json

···

       2
       2
        
         "book-nixos-manual": [

     

       3
       3
        
           "index.html#book-nixos-manual"

     

       4
       4
        
         ],

     

       5
       5
       +
         "module-services-anubis": [

     

       6
       6
       +
           "index.html#module-services-anubis"

     

       7
       7
       +
         ],

     

       8
       8
       +
         "module-services-anubis-configuration": [

     

       9
       9
       +
           "index.html#module-services-anubis-configuration"

     

       10
       10
       +
         ],

     

       11
       11
       +
         "module-services-anubis-quickstart": [

     

       12
       12
       +
           "index.html#module-services-anubis-quickstart"

     

       13
       13
       +
         ],

     

       5
       14
        
         "module-services-crab-hole": [

     

       6
       15
        
           "index.html#module-services-crab-hole"

     

       7
       16
        
         ],

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

···

       168
       168
        
       

     

       169
       169
        
       - [PDS](https://github.com/bluesky-social/pds), Personal Data Server for [bsky](https://bsky.social/). Available as [services.pds](option.html#opt-services.pds).

     

       170
       170
        
       

     

       171
       171
       +
       - [Anubis](https://github.com/TecharoHQ/anubis), a scraper defense software. Available as [services.anubis](options.html#opt-services.anubis).

     

       172
       172
       +
       

     

       171
       173
        
       - [synapse-auto-compressor](https://github.com/matrix-org/rust-synapse-compress-state?tab=readme-ov-file#automated-tool-synapse_auto_compressor), a rust-based matrix-synapse state compressor for postgresql. Available as [services.synapse-auto-compressor](#opt-services.synapse-auto-compressor.enable).

     

       172
       174
        
       

     

       173
       175
        
       - [mqtt-exporter](https://github.com/kpetremann/mqtt-exporter/), a Prometheus exporter for exposing messages from MQTT. Available as [services.prometheus.exporters.mqtt](#opt-services.prometheus.exporters.mqtt.enable).

nixos/modules/module-list.nix

···

       1038
       1038
        
         ./services/networking/adguardhome.nix

     

       1039
       1039
        
         ./services/networking/alice-lg.nix

     

       1040
       1040
        
         ./services/networking/amuled.nix

     

       1041
       1041
       +
         ./services/networking/anubis.nix

     

       1041
       1042
        
         ./services/networking/aria2.nix

     

       1042
       1043
        
         ./services/networking/asterisk.nix

     

       1043
       1044
        
         ./services/networking/atftpd.nix

+61

nixos/modules/services/networking/anubis.md

···

       1
       1
       +
       # Anubis {#module-services-anubis}

     

       2
       2
       +
       

     

       3
       3
       +
       [Anubis](https://anubis.techaro.lol) is a scraper defense software that blocks AI scrapers. It is designed to sit

     

       4
       4
       +
       between a reverse proxy and the service to be protected.

     

       5
       5
       +
       

     

       6
       6
       +
       ## Quickstart {#module-services-anubis-quickstart}

     

       7
       7
       +
       

     

       8
       8
       +
       This module is designed to use Unix domain sockets as the socket paths can be automatically configured for multiple

     

       9
       9
       +
       instances, but TCP sockets are also supported.

     

       10
       10
       +
       

     

       11
       11
       +
       A minimal configuration with [nginx](#opt-services.nginx.enable) may look like the following:

     

       12
       12
       +
       

     

       13
       13
       +
       ```nix

     

       14
       14
       +
       { config, ... }: {

     

       15
       15
       +
         services.anubis.instances.default.settings.TARGET = "http://localhost:8000";

     

       16
       16
       +
       

     

       17
       17
       +
         # required due to unix socket permissions

     

       18
       18
       +
         users.users.nginx.extraGroups = [ config.users.groups.anubis.name ];

     

       19
       19
       +
         services.nginx.virtualHosts."example.com" = {

     

       20
       20
       +
           locations = {

     

       21
       21
       +
             "/".proxyPass = "http://unix:${config.services.anubis.instances.default.settings.BIND}";

     

       22
       22
       +
           };

     

       23
       23
       +
         };

     

       24
       24
       +
       }

     

       25
       25
       +
       ```

     

       26
       26
       +
       

     

       27
       27
       +
       If Unix domain sockets are not needed or desired, this module supports operating with only TCP sockets.

     

       28
       28
       +
       

     

       29
       29
       +
       ```nix

     

       30
       30
       +
       {

     

       31
       31
       +
         services.anubis = {

     

       32
       32
       +
           instances.default = {

     

       33
       33
       +
             settings = {

     

       34
       34
       +
               TARGET = "http://localhost:8080";

     

       35
       35
       +
               BIND = ":9000";

     

       36
       36
       +
               BIND_NETWORK = "tcp";

     

       37
       37
       +
               METRICS_BIND = "127.0.0.1:9001";

     

       38
       38
       +
               METRICS_BIND_NETWORK = "tcp";

     

       39
       39
       +
             };

     

       40
       40
       +
           };

     

       41
       41
       +
         };

     

       42
       42
       +
       }

     

       43
       43
       +
       ```

     

       44
       44
       +
       

     

       45
       45
       +
       ## Configuration {#module-services-anubis-configuration}

     

       46
       46
       +
       

     

       47
       47
       +
       It is possible to configure default settings for all instances of Anubis, via {option}`services.anubis.defaultOptions`.

     

       48
       48
       +
       

     

       49
       49
       +
       ```nix

     

       50
       50
       +
       {

     

       51
       51
       +
         services.anubis.defaultOptions = {

     

       52
       52
       +
           botPolicy = { dnsbl = false; };

     

       53
       53
       +
           settings.DIFFICULTY = 3;

     

       54
       54
       +
         };

     

       55
       55
       +
       }

     

       56
       56
       +
       ```

     

       57
       57
       +
       

     

       58
       58
       +
       Note that at the moment, a custom bot policy is not merged with the baked-in one. That means to only override a setting

     

       59
       59
       +
       like `dnsbl`, copying the entire bot policy is required. Check

     

       60
       60
       +
       [the upstream repository](https://github.com/TecharoHQ/anubis/blob/1509b06cb921aff842e71fbb6636646be6ed5b46/cmd/anubis/botPolicies.json)

     

       61
       61
       +
       for the policy.

+314

nixos/modules/services/networking/anubis.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         inherit (lib) types;

     

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

     

       10
       10
       +
       

     

       11
       11
       +
         cfg = config.services.anubis;

     

       12
       12
       +
         enabledInstances = lib.filterAttrs (_: conf: conf.enable) cfg.instances;

     

       13
       13
       +
         instanceName = name: if name == "" then "anubis" else "anubis-${name}";

     

       14
       14
       +
       

     

       15
       15
       +
         commonSubmodule =

     

       16
       16
       +
           isDefault:

     

       17
       17
       +
           let

     

       18
       18
       +
             mkDefaultOption =

     

       19
       19
       +
               path: opts:

     

       20
       20
       +
               lib.mkOption (

     

       21
       21
       +
                 opts

     

       22
       22
       +
                 // lib.optionalAttrs (!isDefault && opts ? default) {

     

       23
       23
       +
                   default =

     

       24
       24
       +
                     lib.attrByPath (lib.splitString "." path)

     

       25
       25
       +
                       (throw "This is a bug in the Anubis module. Please report this as an issue.")

     

       26
       26
       +
                       cfg.defaultOptions;

     

       27
       27
       +
                   defaultText = lib.literalExpression "config.services.anubis.defaultOptions.${path}";

     

       28
       28
       +
                 }

     

       29
       29
       +
               );

     

       30
       30
       +
           in

     

       31
       31
       +
           { name, ... }:

     

       32
       32
       +
           {

     

       33
       33
       +
             options = {

     

       34
       34
       +
               enable = lib.mkEnableOption "this instance of Anubis" // {

     

       35
       35
       +
                 default = true;

     

       36
       36
       +
               };

     

       37
       37
       +
               user = mkDefaultOption "user" {

     

       38
       38
       +
                 default = "anubis";

     

       39
       39
       +
                 description = ''

     

       40
       40
       +
                   The user under which Anubis is run.

     

       41
       41
       +
       

     

       42
       42
       +
                   This module utilizes systemd's DynamicUser feature. See the corresponding section in

     

       43
       43
       +
                   {manpage}`systemd.exec(5)` for more details.

     

       44
       44
       +
                 '';

     

       45
       45
       +
                 type = types.str;

     

       46
       46
       +
               };

     

       47
       47
       +
               group = mkDefaultOption "group" {

     

       48
       48
       +
                 default = "anubis";

     

       49
       49
       +
                 description = ''

     

       50
       50
       +
                   The group under which Anubis is run.

     

       51
       51
       +
       

     

       52
       52
       +
                   This module utilizes systemd's DynamicUser feature. See the corresponding section in

     

       53
       53
       +
                   {manpage}`systemd.exec(5)` for more details.

     

       54
       54
       +
                 '';

     

       55
       55
       +
                 type = types.str;

     

       56
       56
       +
               };

     

       57
       57
       +
       

     

       58
       58
       +
               botPolicy = lib.mkOption {

     

       59
       59
       +
                 default = null;

     

       60
       60
       +
                 description = ''

     

       61
       61
       +
                   Anubis policy configuration in Nix syntax. Set to `null` to use the baked-in policy which should be

     

       62
       62
       +
                   sufficient for most use-cases.

     

       63
       63
       +
       

     

       64
       64
       +
                   This option has no effect if `settings.POLICY_FNAME` is set to a different value, which is useful for

     

       65
       65
       +
                   importing an existing configuration.

     

       66
       66
       +
       

     

       67
       67
       +
                   See [the documentation](https://anubis.techaro.lol/docs/admin/policies) for details.

     

       68
       68
       +
                 '';

     

       69
       69
       +
                 type = types.nullOr jsonFormat.type;

     

       70
       70
       +
               };

     

       71
       71
       +
       

     

       72
       72
       +
               extraFlags = mkDefaultOption "extraFlags" {

     

       73
       73
       +
                 default = [ ];

     

       74
       74
       +
                 description = "A list of extra flags to be passed to Anubis.";

     

       75
       75
       +
                 example = [ "-metrics-bind \"\"" ];

     

       76
       76
       +
                 type = types.listOf types.str;

     

       77
       77
       +
               };

     

       78
       78
       +
       

     

       79
       79
       +
               settings = lib.mkOption {

     

       80
       80
       +
                 default = { };

     

       81
       81
       +
                 description = ''

     

       82
       82
       +
                   Freeform configuration via environment variables for Anubis.

     

       83
       83
       +
       

     

       84
       84
       +
                   See [the documentation](https://anubis.techaro.lol/docs/admin/installation) for a complete list of

     

       85
       85
       +
                   available environment variables.

     

       86
       86
       +
                 '';

     

       87
       87
       +
                 type = types.submodule [

     

       88
       88
       +
                   {

     

       89
       89
       +
                     freeformType =

     

       90
       90
       +
                       with types;

     

       91
       91
       +
                       attrsOf (

     

       92
       92
       +
                         nullOr (oneOf [

     

       93
       93
       +
                           str

     

       94
       94
       +
                           int

     

       95
       95
       +
                           bool

     

       96
       96
       +
                         ])

     

       97
       97
       +
                       );

     

       98
       98
       +
       

     

       99
       99
       +
                     options = {

     

       100
       100
       +
                       # BIND and METRICS_BIND are defined in instance specific options, since global defaults don't make sense

     

       101
       101
       +
                       BIND_NETWORK = mkDefaultOption "settings.BIND_NETWORK" {

     

       102
       102
       +
                         default = "unix";

     

       103
       103
       +
                         description = ''

     

       104
       104
       +
                           The network family that Anubis should bind to.

     

       105
       105
       +
       

     

       106
       106
       +
                           Accepts anything supported by Go's [`net.Listen`](https://pkg.go.dev/net#Listen).

     

       107
       107
       +
       

     

       108
       108
       +
                           Common values are `tcp` and `unix`.

     

       109
       109
       +
                         '';

     

       110
       110
       +
                         example = "tcp";

     

       111
       111
       +
                         type = types.str;

     

       112
       112
       +
                       };

     

       113
       113
       +
                       METRICS_BIND_NETWORK = mkDefaultOption "settings.METRICS_BIND_NETWORK" {

     

       114
       114
       +
                         default = "unix";

     

       115
       115
       +
                         description = ''

     

       116
       116
       +
                           The network family that the metrics server should bind to.

     

       117
       117
       +
       

     

       118
       118
       +
                           Accepts anything supported by Go's [`net.Listen`](https://pkg.go.dev/net#Listen).

     

       119
       119
       +
       

     

       120
       120
       +
                           Common values are `tcp` and `unix`.

     

       121
       121
       +
                         '';

     

       122
       122
       +
                         example = "tcp";

     

       123
       123
       +
                         type = types.str;

     

       124
       124
       +
                       };

     

       125
       125
       +
                       SOCKET_MODE = mkDefaultOption "settings.SOCKET_MODE" {

     

       126
       126
       +
                         default = "0770";

     

       127
       127
       +
                         description = "The permissions on the Unix domain sockets created.";

     

       128
       128
       +
                         example = "0700";

     

       129
       129
       +
                         type = types.str;

     

       130
       130
       +
                       };

     

       131
       131
       +
                       DIFFICULTY = mkDefaultOption "settings.DIFFICULTY" {

     

       132
       132
       +
                         default = 4;

     

       133
       133
       +
                         description = ''

     

       134
       134
       +
                           The difficulty required for clients to solve the challenge.

     

       135
       135
       +
       

     

       136
       136
       +
                           Currently, this means the amount of leading zeros in a successful response.

     

       137
       137
       +
                         '';

     

       138
       138
       +
                         type = types.int;

     

       139
       139
       +
                         example = 5;

     

       140
       140
       +
                       };

     

       141
       141
       +
                       SERVE_ROBOTS_TXT = mkDefaultOption "settings.SERVE_ROBOTS_TXT" {

     

       142
       142
       +
                         default = false;

     

       143
       143
       +
                         description = ''

     

       144
       144
       +
                           Whether to serve a default robots.txt that denies access to common AI bots by name and all other

     

       145
       145
       +
                           bots by wildcard.

     

       146
       146
       +
                         '';

     

       147
       147
       +
                         type = types.bool;

     

       148
       148
       +
                       };

     

       149
       149
       +
       

     

       150
       150
       +
                       # generated by default

     

       151
       151
       +
                       POLICY_FNAME = mkDefaultOption "settings.POLICY_FNAME" {

     

       152
       152
       +
                         default = null;

     

       153
       153
       +
                         description = ''

     

       154
       154
       +
                           The bot policy file to use. Leave this as `null` to respect the value set in

     

       155
       155
       +
                           {option}`services.anubis.instances.<name>.botPolicy`.

     

       156
       156
       +
                         '';

     

       157
       157
       +
                         type = types.nullOr types.path;

     

       158
       158
       +
                       };

     

       159
       159
       +
                     };

     

       160
       160
       +
                   }

     

       161
       161
       +
                   (lib.optionalAttrs (!isDefault) (instanceSpecificOptions name))

     

       162
       162
       +
                 ];

     

       163
       163
       +
               };

     

       164
       164
       +
             };

     

       165
       165
       +
           };

     

       166
       166
       +
       

     

       167
       167
       +
         instanceSpecificOptions = name: {

     

       168
       168
       +
           options = {

     

       169
       169
       +
             # see other options above

     

       170
       170
       +
             BIND = lib.mkOption {

     

       171
       171
       +
               default = "/run/anubis/${instanceName name}.sock";

     

       172
       172
       +
               description = ''

     

       173
       173
       +
                 The address that Anubis listens to. See Go's [`net.Listen`](https://pkg.go.dev/net#Listen) for syntax.

     

       174
       174
       +
       

     

       175
       175
       +
                 Defaults to Unix domain sockets. To use TCP sockets, set this to a TCP address and `BIND_NETWORK` to `"tcp"`.

     

       176
       176
       +
               '';

     

       177
       177
       +
               example = ":8080";

     

       178
       178
       +
               type = types.str;

     

       179
       179
       +
             };

     

       180
       180
       +
             METRICS_BIND = lib.mkOption {

     

       181
       181
       +
               default = "/run/anubis/${instanceName name}-metrics.sock";

     

       182
       182
       +
               description = ''

     

       183
       183
       +
                 The address Anubis' metrics server listens to. See Go's [`net.Listen`](https://pkg.go.dev/net#Listen) for

     

       184
       184
       +
                 syntax.

     

       185
       185
       +
       

     

       186
       186
       +
                 The metrics server is enabled by default and may be disabled. However, due to implementation details, this is

     

       187
       187
       +
                 only possible by setting a command line flag. See {option}`services.anubis.defaultOptions.extraFlags` for an

     

       188
       188
       +
                 example.

     

       189
       189
       +
       

     

       190
       190
       +
                 Defaults to Unix domain sockets. To use TCP sockets, set this to a TCP address and `METRICS_BIND_NETWORK` to

     

       191
       191
       +
                 `"tcp"`.

     

       192
       192
       +
               '';

     

       193
       193
       +
               example = "127.0.0.1:8081";

     

       194
       194
       +
               type = types.str;

     

       195
       195
       +
             };

     

       196
       196
       +
             TARGET = lib.mkOption {

     

       197
       197
       +
               description = ''

     

       198
       198
       +
                 The reverse proxy target that Anubis is protecting. This is a required option.

     

       199
       199
       +
       

     

       200
       200
       +
                 The usage of Unix domain sockets is supported by the following syntax: `unix:///path/to/socket.sock`.

     

       201
       201
       +
               '';

     

       202
       202
       +
               example = "http://127.0.0.1:8000";

     

       203
       203
       +
               type = types.str;

     

       204
       204
       +
             };

     

       205
       205
       +
           };

     

       206
       206
       +
         };

     

       207
       207
       +
       in

     

       208
       208
       +
       {

     

       209
       209
       +
         options.services.anubis = {

     

       210
       210
       +
           package = lib.mkPackageOption pkgs "anubis" { };

     

       211
       211
       +
       

     

       212
       212
       +
           defaultOptions = lib.mkOption {

     

       213
       213
       +
             default = { };

     

       214
       214
       +
             description = "Default options for all instances of Anubis.";

     

       215
       215
       +
             type = types.submodule (commonSubmodule true);

     

       216
       216
       +
           };

     

       217
       217
       +
       

     

       218
       218
       +
           instances = lib.mkOption {

     

       219
       219
       +
             default = { };

     

       220
       220
       +
             description = ''

     

       221
       221
       +
               An attribute set of Anubis instances.

     

       222
       222
       +
       

     

       223
       223
       +
               The attribute name may be an empty string, in which case the `-<name>` suffix is not added to the service name

     

       224
       224
       +
               and socket paths.

     

       225
       225
       +
             '';

     

       226
       226
       +
             type = types.attrsOf (types.submodule (commonSubmodule false));

     

       227
       227
       +
           };

     

       228
       228
       +
         };

     

       229
       229
       +
       

     

       230
       230
       +
         config = lib.mkIf (enabledInstances != { }) {

     

       231
       231
       +
           users.users = lib.mkIf (cfg.defaultOptions.user == "anubis") {

     

       232
       232
       +
             anubis = {

     

       233
       233
       +
               isSystemUser = true;

     

       234
       234
       +
               group = cfg.defaultOptions.group;

     

       235
       235
       +
             };

     

       236
       236
       +
           };

     

       237
       237
       +
       

     

       238
       238
       +
           users.groups = lib.mkIf (cfg.defaultOptions.group == "anubis") {

     

       239
       239
       +
             anubis = { };

     

       240
       240
       +
           };

     

       241
       241
       +
       

     

       242
       242
       +
           systemd.services = lib.mapAttrs' (

     

       243
       243
       +
             name: instance:

     

       244
       244
       +
             lib.nameValuePair "${instanceName name}" {

     

       245
       245
       +
               description = "Anubis (${if name == "" then "default" else name} instance)";

     

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

     

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

     

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

     

       249
       249
       +
       

     

       250
       250
       +
               environment = lib.mapAttrs (lib.const (lib.generators.mkValueStringDefault { })) (

     

       251
       251
       +
                 lib.filterAttrs (_: v: v != null) instance.settings

     

       252
       252
       +
               );

     

       253
       253
       +
       

     

       254
       254
       +
               serviceConfig = {

     

       255
       255
       +
                 User = instance.user;

     

       256
       256
       +
                 Group = instance.group;

     

       257
       257
       +
                 DynamicUser = true;

     

       258
       258
       +
       

     

       259
       259
       +
                 ExecStart = lib.concatStringsSep " " (

     

       260
       260
       +
                   (lib.singleton (lib.getExe cfg.package)) ++ instance.extraFlags

     

       261
       261
       +
                 );

     

       262
       262
       +
                 RuntimeDirectory =

     

       263
       263
       +
                   if

     

       264
       264
       +
                     lib.any (lib.hasPrefix "/run/anubis") (

     

       265
       265
       +
                       with instance.settings;

     

       266
       266
       +
                       [

     

       267
       267
       +
                         BIND

     

       268
       268
       +
                         METRICS_BIND

     

       269
       269
       +
                       ]

     

       270
       270
       +
                     )

     

       271
       271
       +
                   then

     

       272
       272
       +
                     "anubis"

     

       273
       273
       +
                   else

     

       274
       274
       +
                     null;

     

       275
       275
       +
       

     

       276
       276
       +
                 # hardening

     

       277
       277
       +
                 NoNewPrivileges = true;

     

       278
       278
       +
                 CapabilityBoundingSet = null;

     

       279
       279
       +
                 SystemCallFilter = [

     

       280
       280
       +
                   "@system-service"

     

       281
       281
       +
                   "~@privileged"

     

       282
       282
       +
                 ];

     

       283
       283
       +
                 SystemCallArchitectures = "native";

     

       284
       284
       +
                 MemoryDenyWriteExecute = true;

     

       285
       285
       +
       

     

       286
       286
       +
                 PrivateUsers = true;

     

       287
       287
       +
                 PrivateTmp = true;

     

       288
       288
       +
                 PrivateDevices = true;

     

       289
       289
       +
                 ProtectHome = true;

     

       290
       290
       +
                 ProtectClock = true;

     

       291
       291
       +
                 ProtectHostname = true;

     

       292
       292
       +
                 ProtectKernelLogs = true;

     

       293
       293
       +
                 ProtectKernelModules = true;

     

       294
       294
       +
                 ProtectKernelTunables = true;

     

       295
       295
       +
                 ProtectProc = "invisible";

     

       296
       296
       +
                 ProtectSystem = "strict";

     

       297
       297
       +
                 ProtectControlGroups = "strict";

     

       298
       298
       +
                 LockPersonality = true;

     

       299
       299
       +
                 RestrictRealtime = true;

     

       300
       300
       +
                 RestrictSUIDSGID = true;

     

       301
       301
       +
                 RestrictNamespaces = true;

     

       302
       302
       +
                 RestrictAddressFamilies = [

     

       303
       303
       +
                   "AF_UNIX"

     

       304
       304
       +
                   "AF_INET"

     

       305
       305
       +
                   "AF_INET6"

     

       306
       306
       +
                 ];

     

       307
       307
       +
               };

     

       308
       308
       +
             }

     

       309
       309
       +
           ) enabledInstances;

     

       310
       310
       +
         };

     

       311
       311
       +
       

     

       312
       312
       +
         meta.maintainers = with lib.maintainers; [ soopyc ];

     

       313
       313
       +
         meta.doc = ./anubis.md;

     

       314
       314
       +
       }

nixos/tests/all-tests.nix

···

       174
       174
        
         amd-sev = runTest ./amd-sev.nix;

     

       175
       175
        
         angie-api = runTest ./angie-api.nix;

     

       176
       176
        
         anki-sync-server = runTest ./anki-sync-server.nix;

     

       177
       177
       +
         anubis = runTest ./anubis.nix;

     

       177
       178
        
         anuko-time-tracker = runTest ./anuko-time-tracker.nix;

     

       178
       179
        
         apcupsd = runTest ./apcupsd.nix;

     

       179
       180
        
         apfs = runTest ./apfs.nix;

+98

nixos/tests/anubis.nix

···

       1
       1
       +
       { lib, ... }:

     

       2
       2
       +
       {

     

       3
       3
       +
         name = "anubis";

     

       4
       4
       +
         meta.maintainers = [ lib.maintainers.soopyc ];

     

       5
       5
       +
       

     

       6
       6
       +
         nodes.machine =

     

       7
       7
       +
           {

     

       8
       8
       +
             config,

     

       9
       9
       +
             pkgs,

     

       10
       10
       +
             ...

     

       11
       11
       +
           }:

     

       12
       12
       +
           {

     

       13
       13
       +
             services.anubis.instances = {

     

       14
       14
       +
               "".settings.TARGET = "http://localhost:8080";

     

       15
       15
       +
       

     

       16
       16
       +
               "tcp" = {

     

       17
       17
       +
                 user = "anubis-tcp";

     

       18
       18
       +
                 group = "anubis-tcp";

     

       19
       19
       +
                 settings = {

     

       20
       20
       +
                   TARGET = "http://localhost:8080";

     

       21
       21
       +
                   BIND = ":9000";

     

       22
       22
       +
                   BIND_NETWORK = "tcp";

     

       23
       23
       +
                   METRICS_BIND = ":9001";

     

       24
       24
       +
                   METRICS_BIND_NETWORK = "tcp";

     

       25
       25
       +
                 };

     

       26
       26
       +
               };

     

       27
       27
       +
       

     

       28
       28
       +
               "unix-upstream" = {

     

       29
       29
       +
                 group = "nginx";

     

       30
       30
       +
                 settings.TARGET = "unix:///run/nginx/nginx.sock";

     

       31
       31
       +
               };

     

       32
       32
       +
             };

     

       33
       33
       +
       

     

       34
       34
       +
             # support

     

       35
       35
       +
             users.users.nginx.extraGroups = [ config.users.groups.anubis.name ];

     

       36
       36
       +
             services.nginx = {

     

       37
       37
       +
               enable = true;

     

       38
       38
       +
               recommendedProxySettings = true;

     

       39
       39
       +
               virtualHosts."basic.localhost".locations = {

     

       40
       40
       +
                 "/".proxyPass = "http://unix:${config.services.anubis.instances."".settings.BIND}";

     

       41
       41
       +
                 "/metrics".proxyPass = "http://unix:${config.services.anubis.instances."".settings.METRICS_BIND}";

     

       42
       42
       +
               };

     

       43
       43
       +
       

     

       44
       44
       +
               virtualHosts."tcp.localhost".locations = {

     

       45
       45
       +
                 "/".proxyPass = "http://localhost:9000";

     

       46
       46
       +
                 "/metrics".proxyPass = "http://localhost:9001";

     

       47
       47
       +
               };

     

       48
       48
       +
       

     

       49
       49
       +
               virtualHosts."unix.localhost".locations = {

     

       50
       50
       +
                 "/".proxyPass = "http://unix:${config.services.anubis.instances.unix-upstream.settings.BIND}";

     

       51
       51
       +
               };

     

       52
       52
       +
       

     

       53
       53
       +
               # emulate an upstream with nginx, listening on tcp and unix sockets.

     

       54
       54
       +
               virtualHosts."upstream.localhost" = {

     

       55
       55
       +
                 default = true; # make nginx match this vhost for `localhost`

     

       56
       56
       +
                 listen = [

     

       57
       57
       +
                   { addr = "unix:/run/nginx/nginx.sock"; }

     

       58
       58
       +
                   {

     

       59
       59
       +
                     addr = "localhost";

     

       60
       60
       +
                     port = 8080;

     

       61
       61
       +
                   }

     

       62
       62
       +
                 ];

     

       63
       63
       +
                 locations."/" = {

     

       64
       64
       +
                   tryFiles = "$uri $uri/index.html =404";

     

       65
       65
       +
                   root = pkgs.runCommand "anubis-test-upstream" { } ''

     

       66
       66
       +
                     mkdir $out

     

       67
       67
       +
                     echo "it works" >> $out/index.html

     

       68
       68
       +
                   '';

     

       69
       69
       +
                 };

     

       70
       70
       +
               };

     

       71
       71
       +
             };

     

       72
       72
       +
           };

     

       73
       73
       +
       

     

       74
       74
       +
         testScript = ''

     

       75
       75
       +
           for unit in ["nginx", "anubis", "anubis-tcp", "anubis-unix-upstream"]:

     

       76
       76
       +
             machine.wait_for_unit(unit + ".service")

     

       77
       77
       +
       

     

       78
       78
       +
           for port in [9000, 9001]:

     

       79
       79
       +
             machine.wait_for_open_port(port)

     

       80
       80
       +
       

     

       81
       81
       +
           for instance in ["anubis", "anubis-unix-upstream"]:

     

       82
       82
       +
             machine.wait_for_open_unix_socket(f"/run/anubis/{instance}.sock")

     

       83
       83
       +
             machine.wait_for_open_unix_socket(f"/run/anubis/{instance}-metrics.sock")

     

       84
       84
       +
       

     

       85
       85
       +
           # Default unix socket mode

     

       86
       86
       +
           machine.succeed('curl -f http://basic.localhost | grep "it works"')

     

       87
       87
       +
           machine.succeed('curl -f http://basic.localhost -H "User-Agent: Mozilla" | grep anubis')

     

       88
       88
       +
           machine.succeed('curl -f http://basic.localhost/metrics | grep anubis_challenges_issued')

     

       89
       89
       +
           machine.succeed('curl -f -X POST http://basic.localhost/.within.website/x/cmd/anubis/api/make-challenge | grep challenge')

     

       90
       90
       +
       

     

       91
       91
       +
           # TCP mode

     

       92
       92
       +
           machine.succeed('curl -f http://tcp.localhost -H "User-Agent: Mozilla" | grep anubis')

     

       93
       93
       +
           machine.succeed('curl -f http://tcp.localhost/metrics | grep anubis_challenges_issued')

     

       94
       94
       +
       

     

       95
       95
       +
           # Upstream is a unix socket mode

     

       96
       96
       +
           machine.succeed('curl -f http://unix.localhost/index.html | grep "it works"')

     

       97
       97
       +
         '';

     

       98
       98
       +
       }