commit eb01e02bd5c96acf9e95044012452b7a1b56be70 · pyrox.dev/nixpkgs

+31

nixos/modules/services/networking/dsnet.md

···

       1
       1
       +
       # dsnet {#module-services-dsnet}

     

       2
       2
       +
       

     

       3
       3
       +
       dsnet is a CLI tool to manage a centralised wireguard server. It allows easy

     

       4
       4
       +
       generation of client configuration, handling key generation, IP allocation etc.

     

       5
       5
       +
       

     

       6
       6
       +
       It keeps its own configuration at `/etc/dsnetconfig.json`, which is more of a

     

       7
       7
       +
       database. It contains key material too.

     

       8
       8
       +
       

     

       9
       9
       +
       The way this module works is to patch this database with whatever is configured

     

       10
       10
       +
       in the nix service instantiation. This happens automatically when required.

     

       11
       11
       +
       

     

       12
       12
       +
       This way it is possible to decide what to let dnset manage and what parts you

     

       13
       13
       +
       want to keep declaratively.

     

       14
       14
       +
       

     

       15
       15
       +
       ```

     

       16
       16
       +
       services.dsnet = {

     

       17
       17
       +
         enable = true;

     

       18
       18
       +
         settings = {

     

       19
       19
       +
           ExternalHostname = "vpn.example.com";

     

       20
       20
       +
           Network = "10.171.90.0/24";

     

       21
       21
       +
           Network6 = "";

     

       22
       22
       +
           IP = "10.171.90.1";

     

       23
       23
       +
           IP6 = "";

     

       24
       24
       +
           DNS = "10.171.90.1";

     

       25
       25
       +
           Networks = [ "0.0.0.0/0" ];

     

       26
       26
       +
         };

     

       27
       27
       +
       

     

       28
       28
       +
       ```

     

       29
       29
       +
       

     

       30
       30
       +
       

     

       31
       31
       +
       See <https://github.com/naggie/dsnet> for more information.

+184

nixos/modules/services/networking/dsnet.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         cfg = config.services.dsnet;

     

       10
       10
       +
         settingsFormat = pkgs.formats.json { };

     

       11
       11
       +
         patchFile = settingsFormat.generate "dsnet-patch.json" cfg.settings;

     

       12
       12
       +
       in

     

       13
       13
       +
       {

     

       14
       14
       +
         options.services.dsnet = {

     

       15
       15
       +
           enable = lib.mkEnableOption "dsnet, a centralised Wireguard VPN manager";

     

       16
       16
       +
       

     

       17
       17
       +
           package = lib.mkPackageOption pkgs "dsnet" { };

     

       18
       18
       +
       

     

       19
       19
       +
           settings = lib.mkOption {

     

       20
       20
       +
             type = lib.types.submodule {

     

       21
       21
       +
       

     

       22
       22
       +
               freeformType = settingsFormat.type;

     

       23
       23
       +
       

     

       24
       24
       +
               options = {

     

       25
       25
       +
                 ExternalHostname = lib.mkOption {

     

       26
       26
       +
                   type = lib.types.nullOr lib.types.str;

     

       27
       27
       +
                   default = null;

     

       28
       28
       +
                   example = "vpn.example.com";

     

       29
       29
       +
                   description = ''

     

       30
       30
       +
                     The hostname that clients should use to connect to this server.

     

       31
       31
       +
                     This is used to generate the client configuration files.

     

       32
       32
       +
       

     

       33
       33
       +
                     This is preferred over ExternalIP, as it allows for IPv4 and

     

       34
       34
       +
                     IPv6, as well as enabling the ability tp change IP.

     

       35
       35
       +
                   '';

     

       36
       36
       +
                 };

     

       37
       37
       +
       

     

       38
       38
       +
                 ExternalIP = lib.mkOption {

     

       39
       39
       +
                   type = lib.types.nullOr lib.types.str;

     

       40
       40
       +
                   default = null;

     

       41
       41
       +
                   example = "192.0.2.1";

     

       42
       42
       +
                   description = ''

     

       43
       43
       +
                     The external IP address of the server. This is used to generate

     

       44
       44
       +
                     the client configuration files for when an ExternalHostname is not set.

     

       45
       45
       +
       

     

       46
       46
       +
                     Leaving this empty will cause dsnet to use the IP address of

     

       47
       47
       +
                     what looks like the WAN interface.

     

       48
       48
       +
                   '';

     

       49
       49
       +
                 };

     

       50
       50
       +
       

     

       51
       51
       +
                 ExternalIP6 = lib.mkOption {

     

       52
       52
       +
                   type = lib.types.nullOr lib.types.str;

     

       53
       53
       +
                   default = null;

     

       54
       54
       +
                   example = "2001:db8::1";

     

       55
       55
       +
                   description = ''

     

       56
       56
       +
                     The external IPv6 address of the server. This is used to generate

     

       57
       57
       +
                     the client configuration files for when an ExternalHostname is

     

       58
       58
       +
                     not set. Used in preference to ExternalIP.

     

       59
       59
       +
       

     

       60
       60
       +
                     Leaving this empty will cause dsnet to use the IP address of

     

       61
       61
       +
                     what looks like the WAN interface.

     

       62
       62
       +
                   '';

     

       63
       63
       +
                 };

     

       64
       64
       +
       

     

       65
       65
       +
                 Network = lib.mkOption {

     

       66
       66
       +
                   type = lib.types.nullOr lib.types.str;

     

       67
       67
       +
                   default = null;

     

       68
       68
       +
                   example = "172.18.0.0/24";

     

       69
       69
       +
                   description = ''

     

       70
       70
       +
                     The IPv4 network that the server will use to allocate IPs on the network.

     

       71
       71
       +
                     Leave this empty to let dsnet choose a network.

     

       72
       72
       +
                   '';

     

       73
       73
       +
                 };

     

       74
       74
       +
       

     

       75
       75
       +
                 Network6 = lib.mkOption {

     

       76
       76
       +
                   type = lib.types.nullOr lib.types.str;

     

       77
       77
       +
                   default = null;

     

       78
       78
       +
                   example = "2001:db8::1/64";

     

       79
       79
       +
                   description = ''

     

       80
       80
       +
                     The IPv6 network that the server will use to allocate IPs on the

     

       81
       81
       +
                     network.

     

       82
       82
       +
                     Leave this empty to let dsnet choose a network.

     

       83
       83
       +
                   '';

     

       84
       84
       +
                 };

     

       85
       85
       +
       

     

       86
       86
       +
                 IP = lib.mkOption {

     

       87
       87
       +
                   type = lib.types.nullOr lib.types.str;

     

       88
       88
       +
                   default = null;

     

       89
       89
       +
                   example = "172.18.0.1";

     

       90
       90
       +
                   description = ''

     

       91
       91
       +
                     The IPv4 address that the server will use on the network.

     

       92
       92
       +
                     Leave this empty to let dsnet choose an address.

     

       93
       93
       +
                   '';

     

       94
       94
       +
                 };

     

       95
       95
       +
       

     

       96
       96
       +
                 IP6 = lib.mkOption {

     

       97
       97
       +
                   type = lib.types.nullOr lib.types.str;

     

       98
       98
       +
                   default = null;

     

       99
       99
       +
                   example = "2001:db8::1";

     

       100
       100
       +
                   description = ''

     

       101
       101
       +
                     The IPv6 address that the server will use on the network

     

       102
       102
       +
                     Leave this empty to let dsnet choose an address.

     

       103
       103
       +
                   '';

     

       104
       104
       +
                 };

     

       105
       105
       +
       

     

       106
       106
       +
                 Networks = lib.mkOption {

     

       107
       107
       +
                   type = lib.types.nullOr (lib.types.listOf lib.types.str);

     

       108
       108
       +
                   default = null;

     

       109
       109
       +
                   example = [

     

       110
       110
       +
                     "0.0.0.0/0"

     

       111
       111
       +
                     "192.168.0.0/24"

     

       112
       112
       +
                   ];

     

       113
       113
       +
                   description = ''

     

       114
       114
       +
                     The CIDR networks that should route through this server. Clients

     

       115
       115
       +
                     will be configured to route traffic for these networks through

     

       116
       116
       +
                     the server peer.

     

       117
       117
       +
                   '';

     

       118
       118
       +
                 };

     

       119
       119
       +
               };

     

       120
       120
       +
             };

     

       121
       121
       +
       

     

       122
       122
       +
             default = { };

     

       123
       123
       +
             description = ''

     

       124
       124
       +
               The settings to use for dsnet. This will be converted to a JSON

     

       125
       125
       +
               object that will be passed to dsnet as a patch, using the patch

     

       126
       126
       +
               command when the service is started. See the dsnet documentation for

     

       127
       127
       +
               more information on the additional options.

     

       128
       128
       +
       

     

       129
       129
       +
               Note that the resulting /etc/dsnetconfg.json is more of a database

     

       130
       130
       +
               than it is a configuration file. It is therefore recommended that

     

       131
       131
       +
               system specific values are configured here, rather than the full

     

       132
       132
       +
               configuration including peers.

     

       133
       133
       +
       

     

       134
       134
       +
               Peers may be managed via the dsnet add/remove commands, negating the

     

       135
       135
       +
               need to manage key material and cumbersom configuration with nix. If

     

       136
       136
       +
               you want peer configuration in nix, you may as well use the regular

     

       137
       137
       +
               wireguard module.

     

       138
       138
       +
             '';

     

       139
       139
       +
             example = {

     

       140
       140
       +
               ExternalHostname = "vpn.example.com";

     

       141
       141
       +
               ExternalIP = "127.0.0.1";

     

       142
       142
       +
               ExternalIP6 = "";

     

       143
       143
       +
               ListenPort = 51820;

     

       144
       144
       +
               Network = "10.3.148.0/22";

     

       145
       145
       +
               Network6 = "";

     

       146
       146
       +
               IP = "10.3.148.1";

     

       147
       147
       +
               IP6 = "";

     

       148
       148
       +
               DNS = "8.8.8.8";

     

       149
       149
       +
               Networks = [ "0.0.0.0/0" ];

     

       150
       150
       +
             };

     

       151
       151
       +
           };

     

       152
       152
       +
         };

     

       153
       153
       +
       

     

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

     

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

     

       156
       156
       +
       

     

       157
       157
       +
           systemd.services.dsnet = {

     

       158
       158
       +
             description = "dsnet VPN Management";

     

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

     

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

     

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

     

       162
       162
       +
             preStart = ''

     

       163
       163
       +
               test ! -f /etc/dsnetconfig.json && ${lib.getExe cfg.package} init

     

       164
       164
       +
               ${lib.getExe cfg.package} patch < ${patchFile}

     

       165
       165
       +
             '';

     

       166
       166
       +
             serviceConfig = {

     

       167
       167
       +
               ExecStart = "${lib.getExe cfg.package} up";

     

       168
       168
       +
               ExecStop = "${lib.getExe cfg.package} down";

     

       169
       169
       +
               Type = "oneshot";

     

       170
       170
       +
               # consider the service to be active after process exits, so it can be

     

       171
       171
       +
               # reloaded

     

       172
       172
       +
               RemainAfterExit = true;

     

       173
       173
       +
             };

     

       174
       174
       +
       

     

       175
       175
       +
             reload = ''

     

       176
       176
       +
               ${lib.getExe cfg.package} patch < ${patchFile}

     

       177
       177
       +
               ${lib.getExe cfg.package} sync < ${patchFile}

     

       178
       178
       +
             '';

     

       179
       179
       +
       

     

       180
       180
       +
             # reload _instead_ of restarting on change

     

       181
       181
       +
             reloadIfChanged = true;

     

       182
       182
       +
           };

     

       183
       183
       +
         };

     

       184
       184
       +
       }

+47

pkgs/by-name/ds/dsnet/package.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         stdenv,

     

       4
       4
       +
         fetchFromGitHub,

     

       5
       5
       +
         buildGoModule,

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       buildGoModule (finalAttrs: {

     

       9
       9
       +
         pname = "dsnet";

     

       10
       10
       +
         version = "0.8.1";

     

       11
       11
       +
       

     

       12
       12
       +
         src = fetchFromGitHub {

     

       13
       13
       +
           owner = "naggie";

     

       14
       14
       +
           repo = "dsnet";

     

       15
       15
       +
           tag = "v${finalAttrs.version}";

     

       16
       16
       +
           hash = "sha256-CKDtILZMWFeSU5nTSguM2fi0BCFdvR2LqELIZ6LYOMk=";

     

       17
       17
       +
         };

     

       18
       18
       +
         vendorHash = "sha256-Q2Ipj9yZ+/GUBEmDvgwFLLww7EXnbvdvj/shGQnh1G8=";

     

       19
       19
       +
       

     

       20
       20
       +
         subPackages = [ "cmd" ];

     

       21
       21
       +
       

     

       22
       22
       +
         postInstall = ''

     

       23
       23
       +
           mv $out/bin/cmd $out/bin/dsnet

     

       24
       24
       +
         '';

     

       25
       25
       +
       

     

       26
       26
       +
         # The ldflags reduce the executable size by stripping some debug stuff.

     

       27
       27
       +
         # The other variables are set so that the output of dsnet version shows the

     

       28
       28
       +
         # git ref and the release version from github.

     

       29
       29
       +
         # Ref <https://github.com/NixOS/nixpkgs/pull/87383#discussion_r432097657>

     

       30
       30
       +
         ldflags = [

     

       31
       31
       +
           "-w"

     

       32
       32
       +
           "-s"

     

       33
       33
       +
           "-X github.com/naggie/dsnet.VERSION=${finalAttrs.src.tag}"

     

       34
       34
       +
           "-X github.com/naggie/dsnet.GIT_COMMIT=${finalAttrs.src.tag}"

     

       35
       35
       +
         ];

     

       36
       36
       +
       

     

       37
       37
       +
         meta = {

     

       38
       38
       +
           description = "Fast command to manage a centralised Wireguard VPN";

     

       39
       39
       +
           homepage = "https://github.com/naggie/dsnet";

     

       40
       40
       +
           changelog = "https://github.com/naggie/dsnet/releases/tag/${finalAttrs.src.tag}";

     

       41
       41
       +
           license = lib.licenses.mit;

     

       42
       42
       +
           platforms = lib.platforms.linux;

     

       43
       43
       +
           maintainers = [ lib.maintainers.naggie ];

     

       44
       44
       +
           mainProgram = "dsnet";

     

       45
       45
       +
         };

     

       46
       46
       +
       

     

       47
       47
       +
       })