commit 725a756dbb9bc1713e6b77bcff810b4721decd87 · pyrox.dev/nixpkgs

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

···

       88
       88
        
       

     

       89
       89
        
       - [Readeck](https://readeck.org/), a read-it later web-application. Available as [services.readeck](#opt-services.readeck.enable).

     

       90
       90
        
       

     

       91
       91
       +
       - [EasyTier](https://github.com/EasyTier/EasyTier), a decentralized VPN solution. Available as [services.easytier](#opt-services.easytier.enable).

     

       92
       92
       +
       

     

       91
       93
        
       - [Traccar](https://www.traccar.org/), a modern GPS Tracking Platform. Available as [services.traccar](#opt-services.traccar.enable).

     

       92
       94
        
       

     

       93
       95
        
       - [Schroot](https://codeberg.org/shelter/reschroot), a lightweight virtualisation tool. Securely enter a chroot and run a command or login shell. Available as [programs.schroot](#opt-programs.schroot.enable).

nixos/modules/module-list.nix

···

       1115
       1115
        
         ./services/networking/dnsproxy.nix

     

       1116
       1116
        
         ./services/networking/doh-proxy-rust.nix

     

       1117
       1117
        
         ./services/networking/doh-server.nix

     

       1118
       1118
       +
         ./services/networking/easytier.nix

     

       1118
       1119
        
         ./services/networking/ejabberd.nix

     

       1119
       1120
        
         ./services/networking/envoy.nix

     

       1120
       1121
        
         ./services/networking/epmd.nix

+292

nixos/modules/services/networking/easytier.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       with lib;

     

       9
       9
       +
       let

     

       10
       10
       +
         cfg = config.services.easytier;

     

       11
       11
       +
         settingsFormat = pkgs.formats.toml { };

     

       12
       12
       +
       

     

       13
       13
       +
         genFinalSettings =

     

       14
       14
       +
           inst:

     

       15
       15
       +
           attrsets.filterAttrsRecursive (_: v: v != { }) (

     

       16
       16
       +
             attrsets.filterAttrsRecursive (_: v: v != null) (

     

       17
       17
       +
               {

     

       18
       18
       +
                 inherit (inst.settings)

     

       19
       19
       +
                   instance_name

     

       20
       20
       +
                   hostname

     

       21
       21
       +
                   ipv4

     

       22
       22
       +
                   dhcp

     

       23
       23
       +
                   listeners

     

       24
       24
       +
                   ;

     

       25
       25
       +
                 network_identity = {

     

       26
       26
       +
                   inherit (inst.settings) network_name network_secret;

     

       27
       27
       +
                 };

     

       28
       28
       +
                 peer = map (p: { uri = p; }) inst.settings.peers;

     

       29
       29
       +
               }

     

       30
       30
       +
               // inst.extraSettings

     

       31
       31
       +
             )

     

       32
       32
       +
           );

     

       33
       33
       +
       

     

       34
       34
       +
         genConfigFile =

     

       35
       35
       +
           name: inst:

     

       36
       36
       +
           if inst.configFile == null then

     

       37
       37
       +
             settingsFormat.generate "easytier-${name}.toml" (genFinalSettings inst)

     

       38
       38
       +
           else

     

       39
       39
       +
             inst.configFile;

     

       40
       40
       +
       

     

       41
       41
       +
         activeInsts = filterAttrs (_: inst: inst.enable) cfg.instances;

     

       42
       42
       +
       

     

       43
       43
       +
         settingsModule = name: {

     

       44
       44
       +
           options = {

     

       45
       45
       +
             instance_name = mkOption {

     

       46
       46
       +
               type = types.str;

     

       47
       47
       +
               default = name;

     

       48
       48
       +
               description = "Identify different instances on same host";

     

       49
       49
       +
             };

     

       50
       50
       +
       

     

       51
       51
       +
             hostname = mkOption {

     

       52
       52
       +
               type = with types; nullOr str;

     

       53
       53
       +
               default = null;

     

       54
       54
       +
               description = "Hostname shown in peer list and web console.";

     

       55
       55
       +
             };

     

       56
       56
       +
       

     

       57
       57
       +
             network_name = mkOption {

     

       58
       58
       +
               type = with types; nullOr str;

     

       59
       59
       +
               default = null;

     

       60
       60
       +
               description = "EasyTier network name.";

     

       61
       61
       +
             };

     

       62
       62
       +
       

     

       63
       63
       +
             network_secret = mkOption {

     

       64
       64
       +
               type = with types; nullOr str;

     

       65
       65
       +
               default = null;

     

       66
       66
       +
               description = ''

     

       67
       67
       +
                 EasyTier network credential used for verification and

     

       68
       68
       +
                 encryption. It can also be set in environmentFile.

     

       69
       69
       +
               '';

     

       70
       70
       +
             };

     

       71
       71
       +
       

     

       72
       72
       +
             ipv4 = mkOption {

     

       73
       73
       +
               type = with types; nullOr str;

     

       74
       74
       +
               default = null;

     

       75
       75
       +
               description = ''

     

       76
       76
       +
                 IPv4 cidr address of this peer in the virtual network. If

     

       77
       77
       +
                 empty, this peer will only forward packets and no TUN device

     

       78
       78
       +
                 will be created.

     

       79
       79
       +
               '';

     

       80
       80
       +
               example = "10.144.144.1/24";

     

       81
       81
       +
             };

     

       82
       82
       +
       

     

       83
       83
       +
             dhcp = mkOption {

     

       84
       84
       +
               type = types.bool;

     

       85
       85
       +
               default = false;

     

       86
       86
       +
               description = ''

     

       87
       87
       +
                 Automatically determine the IPv4 address of this peer based on

     

       88
       88
       +
                 existing peers on network.

     

       89
       89
       +
               '';

     

       90
       90
       +
             };

     

       91
       91
       +
       

     

       92
       92
       +
             listeners = mkOption {

     

       93
       93
       +
               type = with types; listOf str;

     

       94
       94
       +
               default = [

     

       95
       95
       +
                 "tcp://0.0.0.0:11010"

     

       96
       96
       +
                 "udp://0.0.0.0:11010"

     

       97
       97
       +
               ];

     

       98
       98
       +
               description = ''

     

       99
       99
       +
                 Listener addresses to accept connections from other peers.

     

       100
       100
       +
                 Valid format is: `<proto>://<addr>:<port>`, where the protocol

     

       101
       101
       +
                 can be `tcp`, `udp`, `ring`, `wg`, `ws`, `wss`.

     

       102
       102
       +
               '';

     

       103
       103
       +
             };

     

       104
       104
       +
       

     

       105
       105
       +
             peers = mkOption {

     

       106
       106
       +
               type = with types; listOf str;

     

       107
       107
       +
               default = [ ];

     

       108
       108
       +
               description = ''

     

       109
       109
       +
                 Peers to connect initially. Valid format is: `<proto>://<addr>:<port>`.

     

       110
       110
       +
               '';

     

       111
       111
       +
               example = [

     

       112
       112
       +
                 "tcp://example.com:11010"

     

       113
       113
       +
               ];

     

       114
       114
       +
             };

     

       115
       115
       +
           };

     

       116
       116
       +
         };

     

       117
       117
       +
       

     

       118
       118
       +
         instanceModule =

     

       119
       119
       +
           { name, ... }:

     

       120
       120
       +
           {

     

       121
       121
       +
             options = {

     

       122
       122
       +
               enable = mkOption {

     

       123
       123
       +
                 type = types.bool;

     

       124
       124
       +
                 default = true;

     

       125
       125
       +
                 description = "Enable the instance.";

     

       126
       126
       +
               };

     

       127
       127
       +
       

     

       128
       128
       +
               configServer = mkOption {

     

       129
       129
       +
                 type = with types; nullOr str;

     

       130
       130
       +
                 default = null;

     

       131
       131
       +
                 description = ''

     

       132
       132
       +
                   Configure the instance from config server. When this option

     

       133
       133
       +
                   set, any other settings for configuring the instance manually

     

       134
       134
       +
                   except `hostname` will be ignored. Valid formats are:

     

       135
       135
       +
       

     

       136
       136
       +
                   - full uri for custom server: `udp://example.com:22020/<token>`

     

       137
       137
       +
                   - username only for official server: `<token>`

     

       138
       138
       +
                 '';

     

       139
       139
       +
                 example = "udp://example.com:22020/myusername";

     

       140
       140
       +
               };

     

       141
       141
       +
       

     

       142
       142
       +
               configFile = mkOption {

     

       143
       143
       +
                 type = with types; nullOr path;

     

       144
       144
       +
                 default = null;

     

       145
       145
       +
                 description = ''

     

       146
       146
       +
                   Path to easytier config file. Setting this option will

     

       147
       147
       +
                   override `settings` and `extraSettings` of this instance.

     

       148
       148
       +
                 '';

     

       149
       149
       +
               };

     

       150
       150
       +
       

     

       151
       151
       +
               environmentFiles = mkOption {

     

       152
       152
       +
                 type = with types; listOf path;

     

       153
       153
       +
                 default = [ ];

     

       154
       154
       +
                 description = ''

     

       155
       155
       +
                   Environment files for this instance. All command-line args

     

       156
       156
       +
                   have corresponding environment variables.

     

       157
       157
       +
                 '';

     

       158
       158
       +
                 example = literalExpression ''

     

       159
       159
       +
                   [

     

       160
       160
       +
                     /path/to/.env

     

       161
       161
       +
                     /path/to/.env.secret

     

       162
       162
       +
                   ]

     

       163
       163
       +
                 '';

     

       164
       164
       +
               };

     

       165
       165
       +
       

     

       166
       166
       +
               settings = mkOption {

     

       167
       167
       +
                 type = types.submodule (settingsModule name);

     

       168
       168
       +
                 default = { };

     

       169
       169
       +
                 description = ''

     

       170
       170
       +
                   Settings to generate {file}`easytier-${name}.toml`

     

       171
       171
       +
                 '';

     

       172
       172
       +
               };

     

       173
       173
       +
       

     

       174
       174
       +
               extraSettings = mkOption {

     

       175
       175
       +
                 type = settingsFormat.type;

     

       176
       176
       +
                 default = { };

     

       177
       177
       +
                 description = ''

     

       178
       178
       +
                   Extra settings to add to {file}`easytier-${name}.toml`.

     

       179
       179
       +
                 '';

     

       180
       180
       +
               };

     

       181
       181
       +
       

     

       182
       182
       +
               extraArgs = mkOption {

     

       183
       183
       +
                 type = with types; listOf str;

     

       184
       184
       +
                 default = [ ];

     

       185
       185
       +
                 description = ''

     

       186
       186
       +
                   Extra args append to the easytier command-line.

     

       187
       187
       +
                 '';

     

       188
       188
       +
               };

     

       189
       189
       +
             };

     

       190
       190
       +
           };

     

       191
       191
       +
       

     

       192
       192
       +
       in

     

       193
       193
       +
       {

     

       194
       194
       +
         options.services.easytier = {

     

       195
       195
       +
           enable = mkEnableOption "EasyTier daemon";

     

       196
       196
       +
       

     

       197
       197
       +
           package = mkPackageOption pkgs "easytier" { };

     

       198
       198
       +
       

     

       199
       199
       +
           allowSystemForward = mkEnableOption ''

     

       200
       200
       +
             Allow the system to forward packets from easytier. Useful when

     

       201
       201
       +
             `proxy_forward_by_system` enabled.

     

       202
       202
       +
           '';

     

       203
       203
       +
       

     

       204
       204
       +
           instances = mkOption {

     

       205
       205
       +
             description = ''

     

       206
       206
       +
               EasyTier instances.

     

       207
       207
       +
             '';

     

       208
       208
       +
             type = types.attrsOf (types.submodule instanceModule);

     

       209
       209
       +
             default = { };

     

       210
       210
       +
             example = {

     

       211
       211
       +
               settings = {

     

       212
       212
       +
                 network_name = "easytier";

     

       213
       213
       +
                 network_secret = "easytier";

     

       214
       214
       +
                 ipv4 = "10.144.144.1/24";

     

       215
       215
       +
                 peers = [

     

       216
       216
       +
                   "tcp://public.easytier.cn:11010"

     

       217
       217
       +
                   "wss://example.com:443"

     

       218
       218
       +
                 ];

     

       219
       219
       +
               };

     

       220
       220
       +
               extraSettings = {

     

       221
       221
       +
                 flags.dev_name = "tun1";

     

       222
       222
       +
               };

     

       223
       223
       +
             };

     

       224
       224
       +
           };

     

       225
       225
       +
         };

     

       226
       226
       +
       

     

       227
       227
       +
         config = mkIf cfg.enable {

     

       228
       228
       +
           environment.systemPackages = [ cfg.package ];

     

       229
       229
       +
       

     

       230
       230
       +
           systemd.services = mapAttrs' (

     

       231
       231
       +
             name: inst:

     

       232
       232
       +
             let

     

       233
       233
       +
               configFile = genConfigFile name inst;

     

       234
       234
       +
             in

     

       235
       235
       +
             nameValuePair "easytier-${name}" {

     

       236
       236
       +
               description = "EasyTier Daemon - ${name}";

     

       237
       237
       +
               wants = [

     

       238
       238
       +
                 "network-online.target"

     

       239
       239
       +
                 "nss-lookup.target"

     

       240
       240
       +
               ];

     

       241
       241
       +
               after = [

     

       242
       242
       +
                 "network-online.target"

     

       243
       243
       +
                 "nss-lookup.target"

     

       244
       244
       +
               ];

     

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

     

       246
       246
       +
               path = with pkgs; [

     

       247
       247
       +
                 cfg.package

     

       248
       248
       +
                 iproute2

     

       249
       249
       +
                 bash

     

       250
       250
       +
               ];

     

       251
       251
       +
               restartTriggers = inst.environmentFiles ++ (optionals (inst.configServer == null) [ configFile ]);

     

       252
       252
       +
               serviceConfig = {

     

       253
       253
       +
                 Type = "simple";

     

       254
       254
       +
                 Restart = "on-failure";

     

       255
       255
       +
                 EnvironmentFile = inst.environmentFiles;

     

       256
       256
       +
                 StateDirectory = "easytier/easytier-${name}";

     

       257
       257
       +
                 StateDirectoryMode = "0700";

     

       258
       258
       +
                 WorkingDirectory = "/var/lib/easytier/easytier-${name}";

     

       259
       259
       +
                 ExecStart = escapeShellArgs (

     

       260
       260
       +
                   [

     

       261
       261
       +
                     "${cfg.package}/bin/easytier-core"

     

       262
       262
       +
                   ]

     

       263
       263
       +
                   ++ optionals (inst.configServer != null) (

     

       264
       264
       +
                     [

     

       265
       265
       +
                       "-w"

     

       266
       266
       +
                       "${inst.configServer}"

     

       267
       267
       +
                     ]

     

       268
       268
       +
                     ++ (optionals (inst.settings.hostname != null) [

     

       269
       269
       +
                       "--hostname"

     

       270
       270
       +
                       "${inst.settings.hostname}"

     

       271
       271
       +
                     ])

     

       272
       272
       +
                   )

     

       273
       273
       +
                   ++ optionals (inst.configServer == null) [

     

       274
       274
       +
                     "-c"

     

       275
       275
       +
                     "${configFile}"

     

       276
       276
       +
                   ]

     

       277
       277
       +
                   ++ inst.extraArgs

     

       278
       278
       +
                 );

     

       279
       279
       +
               };

     

       280
       280
       +
             }

     

       281
       281
       +
           ) activeInsts;

     

       282
       282
       +
       

     

       283
       283
       +
           boot.kernel.sysctl = mkIf cfg.allowSystemForward {

     

       284
       284
       +
             "net.ipv4.conf.all.forwarding" = mkOverride 97 true;

     

       285
       285
       +
             "net.ipv6.conf.all.forwarding" = mkOverride 97 true;

     

       286
       286
       +
           };

     

       287
       287
       +
         };

     

       288
       288
       +
       

     

       289
       289
       +
         meta.maintainers = with maintainers; [

     

       290
       290
       +
           ltrump

     

       291
       291
       +
         ];

     

       292
       292
       +
       }

nixos/tests/all-tests.nix

···

       433
       433
        
         fscrypt = runTest ./fscrypt.nix;

     

       434
       434
        
         fastnetmon-advanced = runTest ./fastnetmon-advanced.nix;

     

       435
       435
        
         lauti = runTest ./lauti.nix;

     

       436
       436
       +
         easytier = handleTest ./easytier.nix { };

     

       436
       437
        
         ejabberd = runTest ./xmpp/ejabberd.nix;

     

       437
       438
        
         elk = handleTestOn [ "x86_64-linux" ] ./elk.nix { };

     

       438
       439
        
         emacs-daemon = runTest ./emacs-daemon.nix;

+121

nixos/tests/easytier.nix

···

       1
       1
       +
       import ./make-test-python.nix (

     

       2
       2
       +
         { lib, ... }:

     

       3
       3
       +
         {

     

       4
       4
       +
           name = "easytier";

     

       5
       5
       +
           meta.maintainers = with lib.maintainers; [ ltrump ];

     

       6
       6
       +
       

     

       7
       7
       +
           nodes =

     

       8
       8
       +
             let

     

       9
       9
       +
               genPeer =

     

       10
       10
       +
                 hostConfig: settings:

     

       11
       11
       +
                 lib.mkMerge [

     

       12
       12
       +
                   {

     

       13
       13
       +
                     services.easytier = {

     

       14
       14
       +
                       enable = true;

     

       15
       15
       +
                       instances.default = {

     

       16
       16
       +
                         settings = {

     

       17
       17
       +
                           network_name = "easytier_test";

     

       18
       18
       +
                           network_secret = "easytier_test_secret";

     

       19
       19
       +
                         } // settings;

     

       20
       20
       +
                       };

     

       21
       21
       +
                     };

     

       22
       22
       +
       

     

       23
       23
       +
                     networking.useDHCP = false;

     

       24
       24
       +
                     networking.firewall.allowedTCPPorts = [

     

       25
       25
       +
                       11010

     

       26
       26
       +
                       11011

     

       27
       27
       +
                     ];

     

       28
       28
       +
                     networking.firewall.allowedUDPPorts = [

     

       29
       29
       +
                       11010

     

       30
       30
       +
                       11011

     

       31
       31
       +
                     ];

     

       32
       32
       +
                   }

     

       33
       33
       +
                   hostConfig

     

       34
       34
       +
                 ];

     

       35
       35
       +
             in

     

       36
       36
       +
             {

     

       37
       37
       +
               relay =

     

       38
       38
       +
                 genPeer

     

       39
       39
       +
                   {

     

       40
       40
       +
                     virtualisation.vlans = [

     

       41
       41
       +
                       1

     

       42
       42
       +
                       2

     

       43
       43
       +
                     ];

     

       44
       44
       +
       

     

       45
       45
       +
                     networking.interfaces.eth1.ipv4.addresses = [

     

       46
       46
       +
                       {

     

       47
       47
       +
                         address = "192.168.1.11";

     

       48
       48
       +
                         prefixLength = 24;

     

       49
       49
       +
                       }

     

       50
       50
       +
                     ];

     

       51
       51
       +
       

     

       52
       52
       +
                     networking.interfaces.eth2.ipv4.addresses = [

     

       53
       53
       +
                       {

     

       54
       54
       +
                         address = "192.168.2.11";

     

       55
       55
       +
                         prefixLength = 24;

     

       56
       56
       +
                       }

     

       57
       57
       +
                     ];

     

       58
       58
       +
                   }

     

       59
       59
       +
                   {

     

       60
       60
       +
                     ipv4 = "10.144.144.1";

     

       61
       61
       +
                     listeners = [

     

       62
       62
       +
                       "tcp://0.0.0.0:11010"

     

       63
       63
       +
                       "wss://0.0.0.0:11011"

     

       64
       64
       +
                     ];

     

       65
       65
       +
                   };

     

       66
       66
       +
       

     

       67
       67
       +
               peer1 =

     

       68
       68
       +
                 genPeer

     

       69
       69
       +
                   {

     

       70
       70
       +
                     virtualisation.vlans = [ 1 ];

     

       71
       71
       +
                   }

     

       72
       72
       +
                   {

     

       73
       73
       +
                     ipv4 = "10.144.144.2";

     

       74
       74
       +
                     peers = [ "tcp://192.168.1.11:11010" ];

     

       75
       75
       +
                   };

     

       76
       76
       +
       

     

       77
       77
       +
               peer2 =

     

       78
       78
       +
                 genPeer

     

       79
       79
       +
                   {

     

       80
       80
       +
                     virtualisation.vlans = [ 2 ];

     

       81
       81
       +
                   }

     

       82
       82
       +
                   {

     

       83
       83
       +
                     ipv4 = "10.144.144.3";

     

       84
       84
       +
                     peers = [ "wss://192.168.2.11:11011" ];

     

       85
       85
       +
                   };

     

       86
       86
       +
             };

     

       87
       87
       +
       

     

       88
       88
       +
           testScript = ''

     

       89
       89
       +
             start_all()

     

       90
       90
       +
       

     

       91
       91
       +
             relay.wait_for_unit("easytier-default.service")

     

       92
       92
       +
             peer1.wait_for_unit("easytier-default.service")

     

       93
       93
       +
             peer2.wait_for_unit("easytier-default.service")

     

       94
       94
       +
       

     

       95
       95
       +
             # relay is accessible by the other hosts

     

       96
       96
       +
             peer1.succeed("ping -c5 192.168.1.11")

     

       97
       97
       +
             peer2.succeed("ping -c5 192.168.2.11")

     

       98
       98
       +
       

     

       99
       99
       +
             # The other hosts are in separate vlans

     

       100
       100
       +
             peer1.fail("ping -c5 192.168.2.11")

     

       101
       101
       +
             peer2.fail("ping -c5 192.168.1.11")

     

       102
       102
       +
       

     

       103
       103
       +
             # Each host can ping themselves through EasyTier

     

       104
       104
       +
             relay.succeed("ping -c5 10.144.144.1")

     

       105
       105
       +
             peer1.succeed("ping -c5 10.144.144.2")

     

       106
       106
       +
             peer2.succeed("ping -c5 10.144.144.3")

     

       107
       107
       +
       

     

       108
       108
       +
             # Relay is accessible by the other hosts through EasyTier

     

       109
       109
       +
             peer1.succeed("ping -c5 10.144.144.1")

     

       110
       110
       +
             peer2.succeed("ping -c5 10.144.144.1")

     

       111
       111
       +
       

     

       112
       112
       +
             # Relay can access the other hosts through EasyTier

     

       113
       113
       +
             relay.succeed("ping -c5 10.144.144.2")

     

       114
       114
       +
             relay.succeed("ping -c5 10.144.144.3")

     

       115
       115
       +
       

     

       116
       116
       +
             # The other hosts in separate vlans can access each other through EasyTier

     

       117
       117
       +
             peer1.succeed("ping -c5 10.144.144.3")

     

       118
       118
       +
             peer2.succeed("ping -c5 10.144.144.2")

     

       119
       119
       +
           '';

     

       120
       120
       +
         }

     

       121
       121
       +
       )

+5 -1

pkgs/by-name/ea/easytier/package.nix

···

       4
       4
        
         fetchFromGitHub,

     

       5
       5
        
         rustPlatform,

     

       6
       6
        
         protobuf,

     

       7
       7
       +
         nixosTests,

     

       7
       8
        
         nix-update-script,

     

       8
       9
        
         withQuic ? false, # with QUIC protocol support

     

       9
       10
        
       }:

     
···

       33
       34
        
       

     

       34
       35
        
         doCheck = false; # tests failed due to heavy rely on network

     

       35
       36
        
       

     

       36
       36
       -
         passthru.updateScript = nix-update-script { };

     

       37
       37
       +
         passthru = {

     

       38
       38
       +
           tests = { inherit (nixosTests) easytier; };

     

       39
       39
       +
           updateScript = nix-update-script { };

     

       40
       40
       +
         };

     

       37
       41
        
       

     

       38
       42
        
         meta = {

     

       39
       43
        
           homepage = "https://github.com/EasyTier/EasyTier";