commit 03b3a97679653cc0caef6347f5cb42379678aa3a · pyrox.dev/nixpkgs

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

···

       44
       44
        
       

     

       45
       45
        
       - [postfix-tlspol](https://github.com/Zuplu/postfix-tlspol), MTA-STS and DANE resolver and TLS policy server for Postfix. Available as [services.postfix-tlspol](#opt-services.postfix-tlspol.enable).

     

       46
       46
        
       

     

       47
       47
       +
       - [Newt](https://github.com/fosrl/newt), a fully user space WireGuard tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. Available as [services.newt](options.html#opt-services.newt.enable).

     

       48
       48
       +
       

     

       47
       49
        
       - [Szurubooru](https://github.com/rr-/szurubooru), an image board engine inspired by services such as Danbooru, dedicated for small and medium communities. Available as [services.szurubooru](#opt-services.szurubooru.enable).

     

       48
       50
        
       

     

       49
       51
        
       - The [Neat IP Address Planner](https://spritelink.github.io/NIPAP/) (NIPAP) can now be enabled through [services.nipap.enable](#opt-services.nipap.enable).

nixos/modules/module-list.nix

···

       1246
       1246
        
         ./services/networking/netclient.nix

     

       1247
       1247
        
         ./services/networking/networkd-dispatcher.nix

     

       1248
       1248
        
         ./services/networking/networkmanager.nix

     

       1249
       1249
       +
         ./services/networking/newt.nix

     

       1249
       1250
        
         ./services/networking/nextdns.nix

     

       1250
       1251
        
         ./services/networking/nftables.nix

     

       1251
       1252
        
         ./services/networking/nghttpx/default.nix

+165

nixos/modules/services/networking/newt.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.services.newt;

     

       9
       9
       +
       in

     

       10
       10
       +
       {

     

       11
       11
       +
         options = {

     

       12
       12
       +
           services.newt = {

     

       13
       13
       +
             enable = lib.mkEnableOption "Newt, user space tunnel client for Pangolin";

     

       14
       14
       +
             # needs to be changed when newt-go changes to fosrl-newt

     

       15
       15
       +
             package = lib.mkPackageOption pkgs "newt-go" { };

     

       16
       16
       +
       

     

       17
       17
       +
             id = lib.mkOption {

     

       18
       18
       +
               type = with lib.types; nullOr str;

     

       19
       19
       +
               default = null;

     

       20
       20
       +
               description = ''

     

       21
       21
       +
                 The Newt Id that will be used to communicate to Pangolin. This is generated on site creation in the dashboard.

     

       22
       22
       +
               '';

     

       23
       23
       +
             };

     

       24
       24
       +
             endpoint = lib.mkOption {

     

       25
       25
       +
               type = with lib.types; nullOr str;

     

       26
       26
       +
               default = null;

     

       27
       27
       +
               description = ''

     

       28
       28
       +
                 The endpoint where both Gerbil and Pangolin reside in order to connect to the websocket. The url of your Pangolin dashboard.

     

       29
       29
       +
               '';

     

       30
       30
       +
             };

     

       31
       31
       +
             logLevel = lib.mkOption {

     

       32
       32
       +
               type = lib.types.enum [

     

       33
       33
       +
                 "DEBUG"

     

       34
       34
       +
                 "INFO"

     

       35
       35
       +
                 "WARN"

     

       36
       36
       +
                 "ERROR"

     

       37
       37
       +
                 "FATAL"

     

       38
       38
       +
               ];

     

       39
       39
       +
               default = "INFO";

     

       40
       40
       +
               description = "The log level to use.";

     

       41
       41
       +
             };

     

       42
       42
       +
             # provide path to file to keep secrets out of the nix store

     

       43
       43
       +
             environmentFile = lib.mkOption {

     

       44
       44
       +
               type = with lib.types; nullOr path;

     

       45
       45
       +
               default = null;

     

       46
       46
       +
               description = ''

     

       47
       47
       +
                 Path to a file containing sensitive environment variables for Newt. See https://docs.fossorial.io/Newt/overview#cli-args

     

       48
       48
       +
                 These will overwrite anything defined in the config.

     

       49
       49
       +
                 The file should contain environment-variable assignments like:

     

       50
       50
       +
                 NEWT_ID=2ix2t8xk22ubpfy

     

       51
       51
       +
                 NEWT_SECRET=nnisrfsdfc7prqsp9ewo1dvtvci50j5uiqotez00dgap0ii2

     

       52
       52
       +
               '';

     

       53
       53
       +
             };

     

       54
       54
       +
           };

     

       55
       55
       +
         };

     

       56
       56
       +
       

     

       57
       57
       +
         config = lib.mkIf cfg.enable {

     

       58
       58
       +
       

     

       59
       59
       +
           assertions = [

     

       60
       60
       +
             {

     

       61
       61
       +
               assertion = cfg.environmentFile != null;

     

       62
       62
       +
               message = "services.newt.environmentFile must be provided when Newt is enabled.";

     

       63
       63
       +
             }

     

       64
       64
       +
           ];

     

       65
       65
       +
       

     

       66
       66
       +
           systemd.services.newt = {

     

       67
       67
       +
             description = "Newt, user space tunnel client for Pangolin";

     

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

     

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

     

       70
       70
       +
       

     

       71
       71
       +
             environment = {

     

       72
       72
       +
               HOME = "/var/lib/private/newt";

     

       73
       73
       +
             };

     

       74
       74
       +
             # the flag values will all be overwritten if also defined in the env file

     

       75
       75
       +
             script = "

     

       76
       76
       +
               exec ${lib.getExe pkgs.newt-go} \\\n

     

       77
       77
       +
               ${lib.optionalString (

     

       78
       78
       +
                       !isNull cfg.id

     

       79
       79
       +
                     ) "--id ${cfg.id} \\\n"}

     

       80
       80
       +
               ${lib.optionalString (

     

       81
       81
       +
                       !isNull cfg.endpoint

     

       82
       82
       +
                     ) "--endpoint ${cfg.endpoint} \\\n"}

     

       83
       83
       +
               --log-level ${cfg.logLevel}

     

       84
       84
       +
             ";

     

       85
       85
       +
             serviceConfig = {

     

       86
       86
       +
               DynamicUser = true;

     

       87
       87
       +
               StateDirectory = "newt";

     

       88
       88
       +
               StateDirectoryMode = "0700";

     

       89
       89
       +
               Restart = "always";

     

       90
       90
       +
               RestartSec = "10s";

     

       91
       91
       +
               EnvironmentFile = cfg.environmentFile;

     

       92
       92
       +
               # hardening

     

       93
       93
       +
               ProtectSystem = "strict";

     

       94
       94
       +
               ProtectHome = true;

     

       95
       95
       +
               PrivateTmp = "disconnected";

     

       96
       96
       +
               PrivateDevices = true;

     

       97
       97
       +
               PrivateUsers = true;

     

       98
       98
       +
               PrivateMounts = true;

     

       99
       99
       +
               ProtectKernelTunables = true;

     

       100
       100
       +
               ProtectKernelModules = true;

     

       101
       101
       +
               ProtectKernelLogs = true;

     

       102
       102
       +
               ProtectControlGroups = true;

     

       103
       103
       +
               LockPersonality = true;

     

       104
       104
       +
               RestrictRealtime = true;

     

       105
       105
       +
               ProtectClock = true;

     

       106
       106
       +
               ProtectProc = "noaccess";

     

       107
       107
       +
               ProtectHostname = true;

     

       108
       108
       +
               RemoveIPC = true;

     

       109
       109
       +
               NoNewPrivileges = true;

     

       110
       110
       +
               RestrictSUIDSGID = true;

     

       111
       111
       +
               MemoryDenyWriteExecute = true;

     

       112
       112
       +
               SystemCallArchitectures = "native";

     

       113
       113
       +
               UMask = "0077";

     

       114
       114
       +
               RestrictAddressFamilies = [

     

       115
       115
       +
                 "AF_INET"

     

       116
       116
       +
                 "AF_INET6"

     

       117
       117
       +
                 "AF_NETLINK"

     

       118
       118
       +
                 "AF_UNIX"

     

       119
       119
       +
               ];

     

       120
       120
       +
               CapabilityBoundingSet = [

     

       121
       121
       +
                 "~CAP_BLOCK_SUSPEND"

     

       122
       122
       +
                 "~CAP_BPF"

     

       123
       123
       +
                 "~CAP_CHOWN"

     

       124
       124
       +
                 "~CAP_MKNOD"

     

       125
       125
       +
                 "~CAP_NET_RAW"

     

       126
       126
       +
                 "~CAP_PERFMON"

     

       127
       127
       +
                 "~CAP_SYS_BOOT"

     

       128
       128
       +
                 "~CAP_SYS_CHROOT"

     

       129
       129
       +
                 "~CAP_SYS_MODULE"

     

       130
       130
       +
                 "~CAP_SYS_NICE"

     

       131
       131
       +
                 "~CAP_SYS_PACCT"

     

       132
       132
       +
                 "~CAP_SYS_PTRACE"

     

       133
       133
       +
                 "~CAP_SYS_TIME"

     

       134
       134
       +
                 "~CAP_SYS_TTY_CONFIG"

     

       135
       135
       +
                 "~CAP_SYSLOG"

     

       136
       136
       +
                 "~CAP_WAKE_ALARM"

     

       137
       137
       +
               ];

     

       138
       138
       +
               SystemCallFilter = [

     

       139
       139
       +
                 "~@aio:EPERM"

     

       140
       140
       +
                 "~@chown:EPERM"

     

       141
       141
       +
                 "~@clock:EPERM"

     

       142
       142
       +
                 "~@cpu-emulation:EPERM"

     

       143
       143
       +
                 "~@debug:EPERM"

     

       144
       144
       +
                 "~@keyring:EPERM"

     

       145
       145
       +
                 "~@memlock:EPERM"

     

       146
       146
       +
                 "~@module:EPERM"

     

       147
       147
       +
                 "~@mount:EPERM"

     

       148
       148
       +
                 "~@obsolete:EPERM"

     

       149
       149
       +
                 "~@pkey:EPERM"

     

       150
       150
       +
                 "~@privileged:EPERM"

     

       151
       151
       +
                 "~@raw-io:EPERM"

     

       152
       152
       +
                 "~@reboot:EPERM"

     

       153
       153
       +
                 "~@resources:EPERM"

     

       154
       154
       +
                 "~@sandbox:EPERM"

     

       155
       155
       +
                 "~@setuid:EPERM"

     

       156
       156
       +
                 "~@swap:EPERM"

     

       157
       157
       +
                 "~@sync:EPERM"

     

       158
       158
       +
                 "~@timer:EPERM"

     

       159
       159
       +
               ];

     

       160
       160
       +
             };

     

       161
       161
       +
           };

     

       162
       162
       +
         };

     

       163
       163
       +
       

     

       164
       164
       +
         meta.maintainers = with lib.maintainers; [ jackr ];

     

       165
       165
       +
       }