mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-06-10 01:53:09 +09:00
649 lines
24 KiB
Nix
649 lines
24 KiB
Nix
{
|
|
config,
|
|
lib,
|
|
pkgs,
|
|
...
|
|
}:
|
|
let
|
|
inherit (lib)
|
|
attrValues
|
|
concatLists
|
|
concatStringsSep
|
|
escapeShellArgs
|
|
filterAttrs
|
|
getExe
|
|
literalExpression
|
|
maintainers
|
|
makeBinPath
|
|
mapAttrs'
|
|
mapAttrsToList
|
|
mkAliasOptionModule
|
|
mkDefault
|
|
mkIf
|
|
mkMerge
|
|
mkOption
|
|
mkOptionDefault
|
|
mkPackageOption
|
|
nameValuePair
|
|
optional
|
|
optionalAttrs
|
|
optionalString
|
|
toShellVars
|
|
versionAtLeast
|
|
versionOlder
|
|
;
|
|
|
|
inherit (lib.types)
|
|
attrsOf
|
|
bool
|
|
enum
|
|
nullOr
|
|
package
|
|
path
|
|
port
|
|
str
|
|
submodule
|
|
;
|
|
|
|
inherit (config.boot) kernelPackages;
|
|
inherit (config.boot.kernelPackages) kernel;
|
|
|
|
cfg = config.services.netbird;
|
|
|
|
toClientList = fn: map fn (attrValues cfg.clients);
|
|
toClientAttrs = fn: mapAttrs' (_: fn) cfg.clients;
|
|
|
|
hardenedClients = filterAttrs (_: client: client.hardened) cfg.clients;
|
|
toHardenedClientList = fn: map fn (attrValues hardenedClients);
|
|
toHardenedClientAttrs = fn: mapAttrs' (_: fn) hardenedClients;
|
|
|
|
mkBinName =
|
|
client: name:
|
|
if client.bin.suffix == "" || client.bin.suffix == "netbird" then
|
|
name
|
|
else
|
|
"${name}-${client.bin.suffix}";
|
|
|
|
nixosConfig = config;
|
|
in
|
|
{
|
|
meta.maintainers = with maintainers; [
|
|
nazarewk
|
|
];
|
|
meta.doc = ./netbird.md;
|
|
|
|
imports = [
|
|
(mkAliasOptionModule [ "services" "netbird" "tunnels" ] [ "services" "netbird" "clients" ])
|
|
];
|
|
|
|
options.services.netbird = {
|
|
enable = mkOption {
|
|
type = bool;
|
|
default = false;
|
|
description = ''
|
|
Enables backwards compatible Netbird client service.
|
|
|
|
This is strictly equivalent to:
|
|
|
|
```nix
|
|
services.netbird.clients.default = {
|
|
port = 51820;
|
|
name = "netbird";
|
|
systemd.name = "netbird";
|
|
interface = "wt0";
|
|
hardened = false;
|
|
};
|
|
```
|
|
'';
|
|
};
|
|
package = mkPackageOption pkgs "netbird" { };
|
|
|
|
ui.enable = mkOption {
|
|
type = bool;
|
|
default = config.services.displayManager.sessionPackages != [ ] || config.services.xserver.enable;
|
|
defaultText = literalExpression ''
|
|
config.services.displayManager.sessionPackages != [ ] || config.services.xserver.enable
|
|
'';
|
|
description = ''
|
|
Controls presence `netbird-ui` wrappers, defaults to presence of graphical sessions.
|
|
'';
|
|
};
|
|
ui.package = mkPackageOption pkgs "netbird-ui" { };
|
|
|
|
clients = mkOption {
|
|
type = attrsOf (
|
|
submodule (
|
|
{ name, config, ... }:
|
|
let
|
|
client = config;
|
|
in
|
|
{
|
|
options = {
|
|
port = mkOption {
|
|
type = port;
|
|
example = literalExpression "51820";
|
|
description = ''
|
|
Port the Netbird client listens on.
|
|
'';
|
|
};
|
|
|
|
name = mkOption {
|
|
type = str;
|
|
default = name;
|
|
description = ''
|
|
Primary name for use (as a suffix) in:
|
|
- systemd service name,
|
|
- hardened user name and group,
|
|
- [systemd `*Directory=`](https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html#RuntimeDirectory=) names,
|
|
- desktop application identification,
|
|
'';
|
|
};
|
|
|
|
dns-resolver.address = mkOption {
|
|
type = nullOr str;
|
|
default = null;
|
|
example = "127.0.0.123";
|
|
description = ''
|
|
An explicit address that Netbird will serve `*.netbird.cloud.` (usually) entries on.
|
|
|
|
Netbird serves DNS on it's own (dynamic) client address by default.
|
|
'';
|
|
};
|
|
|
|
dns-resolver.port = mkOption {
|
|
type = port;
|
|
default = 53;
|
|
description = ''
|
|
A port to serve DNS entries on when `dns-resolver.address` is enabled.
|
|
'';
|
|
};
|
|
|
|
interface = mkOption {
|
|
type = str;
|
|
default = "nb-${client.name}";
|
|
description = ''
|
|
Name of the network interface managed by this client.
|
|
'';
|
|
apply =
|
|
iface:
|
|
lib.throwIfNot (
|
|
builtins.stringLength iface <= 15
|
|
) "Network interface name must be 15 characters or less" iface;
|
|
};
|
|
|
|
environment = mkOption {
|
|
type = attrsOf str;
|
|
defaultText = literalExpression ''
|
|
{
|
|
NB_STATE_DIR = client.dir.state;
|
|
NB_CONFIG = "''${client.dir.state}/config.json";
|
|
NB_DAEMON_ADDR = "unix://''${client.dir.runtime}/sock";
|
|
NB_INTERFACE_NAME = client.interface;
|
|
NB_LOG_FILE = mkOptionDefault "console";
|
|
NB_LOG_LEVEL = client.logLevel;
|
|
NB_SERVICE = client.service.name;
|
|
NB_WIREGUARD_PORT = toString client.port;
|
|
} // optionalAttrs (client.dns-resolver.address != null) {
|
|
NB_DNS_RESOLVER_ADDRESS = "''${client.dns-resolver.address}:''${builtins.toString client.dns-resolver.port}";
|
|
}
|
|
'';
|
|
description = ''
|
|
Environment for the netbird service, used to pass configuration options.
|
|
'';
|
|
};
|
|
|
|
autoStart = mkOption {
|
|
type = bool;
|
|
default = true;
|
|
description = ''
|
|
Start the service with the system.
|
|
|
|
As of 2024-02-13 it is not possible to start a Netbird client daemon without immediately
|
|
connecting to the network, but it is [planned for a near future](https://github.com/netbirdio/netbird/projects/2#card-91718018).
|
|
'';
|
|
};
|
|
|
|
openFirewall = mkOption {
|
|
type = bool;
|
|
default = true;
|
|
description = ''
|
|
Opens up firewall `port` for communication between Netbird peers directly over LAN or public IP,
|
|
without using (internet-hosted) TURN servers as intermediaries.
|
|
'';
|
|
};
|
|
|
|
hardened = mkOption {
|
|
type = bool;
|
|
default = true;
|
|
description = ''
|
|
Hardened service:
|
|
- runs as a dedicated user with minimal set of permissions (see caveats),
|
|
- restricts daemon configuration socket access to dedicated user group
|
|
(you can grant access to it with `users.users."<user>".extraGroups = [ ${client.user.group} ]`),
|
|
|
|
Even though the local system resources access is restricted:
|
|
- `CAP_NET_RAW`, `CAP_NET_ADMIN` and `CAP_BPF` still give unlimited network manipulation possibilites,
|
|
- older kernels don't have `CAP_BPF` and use `CAP_SYS_ADMIN` instead,
|
|
|
|
Known security features that are not (yet) integrated into the module:
|
|
- 2024-02-14: `rosenpass` is an experimental feature configurable solely
|
|
through `--enable-rosenpass` flag on the `netbird up` command,
|
|
see [the docs](https://docs.netbird.io/how-to/enable-post-quantum-cryptography)
|
|
'';
|
|
};
|
|
|
|
logLevel = mkOption {
|
|
type = enum [
|
|
# logrus loglevels
|
|
"panic"
|
|
"fatal"
|
|
"error"
|
|
"warn"
|
|
"warning"
|
|
"info"
|
|
"debug"
|
|
"trace"
|
|
];
|
|
default = "info";
|
|
description = "Log level of the Netbird daemon.";
|
|
};
|
|
|
|
ui.enable = mkOption {
|
|
type = bool;
|
|
default = nixosConfig.services.netbird.ui.enable;
|
|
defaultText = literalExpression ''client.ui.enable'';
|
|
description = ''
|
|
Controls presence of `netbird-ui` wrapper for this Netbird client.
|
|
'';
|
|
};
|
|
|
|
wrapper = mkOption {
|
|
type = package;
|
|
internal = true;
|
|
default =
|
|
let
|
|
makeWrapperArgs = concatLists (
|
|
mapAttrsToList (key: value: [
|
|
"--set-default"
|
|
key
|
|
value
|
|
]) client.environment
|
|
);
|
|
mkBin = mkBinName client;
|
|
in
|
|
pkgs.stdenv.mkDerivation {
|
|
name = "${cfg.package.name}-wrapper-${client.name}";
|
|
meta.mainProgram = mkBin "netbird";
|
|
nativeBuildInputs = with pkgs; [ makeWrapper ];
|
|
phases = [ "installPhase" ];
|
|
installPhase = concatStringsSep "\n" [
|
|
''
|
|
mkdir -p "$out/bin"
|
|
makeWrapper ${lib.getExe cfg.package} "$out/bin/${mkBin "netbird"}" \
|
|
${escapeShellArgs makeWrapperArgs}
|
|
''
|
|
(optionalString cfg.ui.enable ''
|
|
# netbird-ui doesn't support envvars
|
|
makeWrapper ${lib.getExe cfg.ui.package} "$out/bin/${mkBin "netbird-ui"}" \
|
|
--add-flags '--daemon-addr=${client.environment.NB_DAEMON_ADDR}'
|
|
|
|
mkdir -p "$out/share/applications"
|
|
substitute ${cfg.ui.package}/share/applications/netbird.desktop \
|
|
"$out/share/applications/${mkBin "netbird"}.desktop" \
|
|
--replace-fail 'Name=Netbird' "Name=Netbird @ ${client.service.name}" \
|
|
--replace-fail '${lib.getExe cfg.ui.package}' "$out/bin/${mkBin "netbird-ui"}"
|
|
'')
|
|
];
|
|
};
|
|
};
|
|
|
|
# see https://github.com/netbirdio/netbird/blob/88747e3e0191abc64f1e8c7ecc65e5e50a1527fd/client/internal/config.go#L49-L82
|
|
config = mkOption {
|
|
type = (pkgs.formats.json { }).type;
|
|
defaultText = literalExpression ''
|
|
{
|
|
DisableAutoConnect = !client.autoStart;
|
|
WgIface = client.interface;
|
|
WgPort = client.port;
|
|
} // optionalAttrs (client.dns-resolver.address != null) {
|
|
CustomDNSAddress = "''${client.dns-resolver.address}:''${builtins.toString client.dns-resolver.port}";
|
|
}
|
|
'';
|
|
description = ''
|
|
Additional configuration that exists before the first start and
|
|
later overrides the existing values in `config.json`.
|
|
|
|
It is mostly helpful to manage configuration ignored/not yet implemented
|
|
outside of `netbird up` invocation.
|
|
|
|
WARNING: this is not an upstream feature, it could break in the future
|
|
(by having lower priority) after upstream implements an equivalent.
|
|
|
|
It is implemented as a `preStart` script which overrides `config.json`
|
|
with content of `/etc/${client.dir.baseName}/config.d/*.json` files.
|
|
This option manages specifically `50-nixos.json` file.
|
|
|
|
Consult [the source code](https://github.com/netbirdio/netbird/blob/88747e3e0191abc64f1e8c7ecc65e5e50a1527fd/client/internal/config.go#L49-L82)
|
|
or inspect existing file for a complete list of available configurations.
|
|
'';
|
|
};
|
|
|
|
suffixedName = mkOption {
|
|
type = str;
|
|
default = if client.name != "netbird" then "netbird-${client.name}" else client.name;
|
|
description = ''
|
|
A systemd service name to use (without `.service` suffix).
|
|
'';
|
|
};
|
|
dir.baseName = mkOption {
|
|
type = str;
|
|
default = client.suffixedName;
|
|
description = ''
|
|
A systemd service name to use (without `.service` suffix).
|
|
'';
|
|
};
|
|
dir.state = mkOption {
|
|
type = path;
|
|
default = "/var/lib/${client.dir.baseName}";
|
|
description = ''
|
|
A state directory used by Netbird client to store `config.json`, `state.json` & `resolv.conf`.
|
|
'';
|
|
};
|
|
dir.runtime = mkOption {
|
|
type = path;
|
|
default = "/var/run/${client.dir.baseName}";
|
|
description = ''
|
|
A runtime directory used by Netbird client.
|
|
'';
|
|
};
|
|
service.name = mkOption {
|
|
type = str;
|
|
default = client.suffixedName;
|
|
description = ''
|
|
A systemd service name to use (without `.service` suffix).
|
|
'';
|
|
};
|
|
user.name = mkOption {
|
|
type = str;
|
|
default = client.suffixedName;
|
|
description = ''
|
|
A system user name for this client instance.
|
|
'';
|
|
};
|
|
user.group = mkOption {
|
|
type = str;
|
|
default = client.suffixedName;
|
|
description = ''
|
|
A system group name for this client instance.
|
|
'';
|
|
};
|
|
bin.suffix = mkOption {
|
|
type = str;
|
|
default = if client.name != "netbird" then client.name else "";
|
|
description = ''
|
|
A system group name for this client instance.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config.environment =
|
|
{
|
|
NB_STATE_DIR = client.dir.state;
|
|
NB_CONFIG = "${client.dir.state}/config.json";
|
|
NB_DAEMON_ADDR = "unix://${client.dir.runtime}/sock";
|
|
NB_INTERFACE_NAME = client.interface;
|
|
NB_LOG_FILE = mkOptionDefault "console";
|
|
NB_LOG_LEVEL = client.logLevel;
|
|
NB_SERVICE = client.service.name;
|
|
NB_WIREGUARD_PORT = toString client.port;
|
|
}
|
|
// optionalAttrs (client.dns-resolver.address != null) {
|
|
NB_DNS_RESOLVER_ADDRESS = "${client.dns-resolver.address}:${builtins.toString client.dns-resolver.port}";
|
|
};
|
|
|
|
config.config =
|
|
{
|
|
DisableAutoConnect = !client.autoStart;
|
|
WgIface = client.interface;
|
|
WgPort = client.port;
|
|
}
|
|
// optionalAttrs (client.dns-resolver.address != null) {
|
|
CustomDNSAddress = "${client.dns-resolver.address}:${builtins.toString client.dns-resolver.port}";
|
|
};
|
|
}
|
|
)
|
|
);
|
|
default = { };
|
|
description = ''
|
|
Attribute set of Netbird client daemons, by default each one will:
|
|
|
|
1. be manageable using dedicated tooling:
|
|
- `netbird-<name>` script,
|
|
- `Netbird - netbird-<name>` graphical interface when appropriate (see `ui.enable`),
|
|
2. run as a `netbird-<name>.service`,
|
|
3. listen for incoming remote connections on the port `51820` (`openFirewall` by default),
|
|
4. manage the `netbird-<name>` wireguard interface,
|
|
5. use the `/var/lib/netbird-<name>/config.json` configuration file,
|
|
6. override `/var/lib/netbird-<name>/config.json` with values from `/etc/netbird-<name>/config.d/*.json`,
|
|
7. (`hardened`) be locally manageable by `netbird-<name>` system group,
|
|
|
|
With following caveats:
|
|
|
|
- multiple daemons will interfere with each other's DNS resolution of `netbird.cloud`, but
|
|
should remain fully operational otherwise.
|
|
Setting up custom (non-conflicting) DNS zone is currently possible only when self-hosting.
|
|
'';
|
|
example = lib.literalExpression ''
|
|
{
|
|
services.netbird.clients.wt0.port = 51820;
|
|
services.netbird.clients.personal.port = 51821;
|
|
services.netbird.clients.work1.port = 51822;
|
|
}
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = mkMerge [
|
|
(mkIf cfg.enable {
|
|
services.netbird.clients.default = {
|
|
port = mkDefault 51820;
|
|
interface = mkDefault "wt0";
|
|
name = mkDefault "netbird";
|
|
hardened = mkDefault false;
|
|
};
|
|
})
|
|
{
|
|
boot.extraModulePackages = optional (
|
|
cfg.clients != { } && (versionOlder kernel.version "5.6")
|
|
) kernelPackages.wireguard;
|
|
|
|
environment.systemPackages = toClientList (client: client.wrapper)
|
|
# omitted due to https://github.com/netbirdio/netbird/issues/1562
|
|
#++ optional (cfg.clients != { }) cfg.package
|
|
# omitted due to https://github.com/netbirdio/netbird/issues/1581
|
|
#++ optional (cfg.clients != { } && cfg.ui.enable) cfg.ui.package
|
|
;
|
|
|
|
networking.dhcpcd.denyInterfaces = toClientList (client: client.interface);
|
|
networking.networkmanager.unmanaged = toClientList (client: "interface-name:${client.interface}");
|
|
|
|
networking.firewall.allowedUDPPorts = concatLists (
|
|
toClientList (client: optional client.openFirewall client.port)
|
|
);
|
|
|
|
systemd.network.networks = mkIf config.networking.useNetworkd (
|
|
toClientAttrs (
|
|
client:
|
|
nameValuePair "50-netbird-${client.interface}" {
|
|
matchConfig = {
|
|
Name = client.interface;
|
|
};
|
|
linkConfig = {
|
|
Unmanaged = true;
|
|
ActivationPolicy = "manual";
|
|
};
|
|
}
|
|
)
|
|
);
|
|
|
|
environment.etc = toClientAttrs (
|
|
client:
|
|
nameValuePair "${client.dir.baseName}/config.d/50-nixos.json" {
|
|
text = builtins.toJSON client.config;
|
|
mode = "0444";
|
|
}
|
|
);
|
|
|
|
systemd.services = toClientAttrs (
|
|
client:
|
|
nameValuePair client.service.name {
|
|
description = "A WireGuard-based mesh network that connects your devices into a single private network";
|
|
|
|
documentation = [ "https://netbird.io/docs/" ];
|
|
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
path = optional (!config.services.resolved.enable) pkgs.openresolv;
|
|
|
|
serviceConfig = {
|
|
ExecStart = "${getExe client.wrapper} service run";
|
|
Restart = "always";
|
|
|
|
RuntimeDirectory = client.dir.baseName;
|
|
RuntimeDirectoryMode = mkDefault "0755";
|
|
ConfigurationDirectory = client.dir.baseName;
|
|
StateDirectory = client.dir.baseName;
|
|
StateDirectoryMode = "0700";
|
|
|
|
WorkingDirectory = client.dir.state;
|
|
};
|
|
|
|
unitConfig = {
|
|
StartLimitInterval = 5;
|
|
StartLimitBurst = 10;
|
|
};
|
|
|
|
stopIfChanged = false;
|
|
}
|
|
);
|
|
}
|
|
# Hardening section
|
|
(mkIf (hardenedClients != { }) {
|
|
users.groups = toHardenedClientAttrs (client: nameValuePair client.user.group { });
|
|
users.users = toHardenedClientAttrs (
|
|
client:
|
|
nameValuePair client.user.name {
|
|
isSystemUser = true;
|
|
home = client.dir.state;
|
|
group = client.user.group;
|
|
}
|
|
);
|
|
|
|
systemd.services = toHardenedClientAttrs (
|
|
client:
|
|
nameValuePair client.service.name (
|
|
mkIf client.hardened {
|
|
serviceConfig = {
|
|
RuntimeDirectoryMode = "0750";
|
|
|
|
User = client.user.name;
|
|
Group = client.user.group;
|
|
|
|
# settings implied by DynamicUser=true, without actually using it,
|
|
# see https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html#DynamicUser=
|
|
RemoveIPC = true;
|
|
PrivateTmp = true;
|
|
ProtectSystem = "strict";
|
|
ProtectHome = "yes";
|
|
|
|
AmbientCapabilities =
|
|
[
|
|
# see https://man7.org/linux/man-pages/man7/capabilities.7.html
|
|
# see https://docs.netbird.io/how-to/installation#running-net-bird-in-docker
|
|
#
|
|
# seems to work fine without CAP_SYS_ADMIN and CAP_SYS_RESOURCE
|
|
# CAP_NET_BIND_SERVICE could be added to allow binding on low ports, but is not required,
|
|
# see https://github.com/netbirdio/netbird/pull/1513
|
|
|
|
# failed creating tunnel interface wt-priv: [operation not permitted
|
|
"CAP_NET_ADMIN"
|
|
# failed to pull up wgInterface [wt-priv]: failed to create ipv4 raw socket: socket: operation not permitted
|
|
"CAP_NET_RAW"
|
|
]
|
|
# required for eBPF filter, used to be subset of CAP_SYS_ADMIN
|
|
++ optional (versionAtLeast kernel.version "5.8") "CAP_BPF"
|
|
++ optional (versionOlder kernel.version "5.8") "CAP_SYS_ADMIN"
|
|
++ optional (
|
|
client.dns-resolver.address != null && client.dns-resolver.port < 1024
|
|
) "CAP_NET_BIND_SERVICE";
|
|
};
|
|
}
|
|
)
|
|
);
|
|
|
|
# see https://github.com/systemd/systemd/blob/17f3e91e8107b2b29fe25755651b230bbc81a514/src/resolve/org.freedesktop.resolve1.policy#L43-L43
|
|
# see all actions used at https://github.com/netbirdio/netbird/blob/13e7198046a0d73a9cd91bf8e063fafb3d41885c/client/internal/dns/systemd_linux.go#L29-L32
|
|
security.polkit.extraConfig = mkIf config.services.resolved.enable ''
|
|
// systemd-resolved access for Netbird clients
|
|
polkit.addRule(function(action, subject) {
|
|
var actions = [
|
|
"org.freedesktop.resolve1.revert",
|
|
"org.freedesktop.resolve1.set-default-route",
|
|
"org.freedesktop.resolve1.set-dns-servers",
|
|
"org.freedesktop.resolve1.set-domains",
|
|
];
|
|
var users = ${builtins.toJSON (toHardenedClientList (client: client.user.name))};
|
|
|
|
if (actions.indexOf(action.id) >= 0 && users.indexOf(subject.user) >= 0 ) {
|
|
return polkit.Result.YES;
|
|
}
|
|
});
|
|
'';
|
|
})
|
|
# migration & temporary fixups section
|
|
{
|
|
systemd.services = toClientAttrs (
|
|
client:
|
|
nameValuePair client.service.name {
|
|
preStart = ''
|
|
set -eEuo pipefail
|
|
${optionalString (client.logLevel == "trace" || client.logLevel == "debug") "set -x"}
|
|
|
|
PATH="${
|
|
makeBinPath (
|
|
with pkgs;
|
|
[
|
|
coreutils
|
|
jq
|
|
diffutils
|
|
]
|
|
)
|
|
}:$PATH"
|
|
export ${toShellVars client.environment}
|
|
|
|
# merge /etc/${client.dir.baseName}/config.d' into "$NB_CONFIG"
|
|
{
|
|
test -e "$NB_CONFIG" || echo -n '{}' > "$NB_CONFIG"
|
|
|
|
# merge config.d with "$NB_CONFIG" into "$NB_CONFIG.new"
|
|
jq -sS 'reduce .[] as $i ({}; . * $i)' \
|
|
"$NB_CONFIG" \
|
|
/etc/${client.dir.baseName}/config.d/*.json \
|
|
> "$NB_CONFIG.new"
|
|
|
|
echo "Comparing $NB_CONFIG with $NB_CONFIG.new ..."
|
|
if ! diff <(jq -S <"$NB_CONFIG") "$NB_CONFIG.new" ; then
|
|
echo "Updating $NB_CONFIG ..."
|
|
mv "$NB_CONFIG.new" "$NB_CONFIG"
|
|
else
|
|
echo "Files are the same, not doing anything."
|
|
rm "$NB_CONFIG.new"
|
|
fi
|
|
}
|
|
'';
|
|
}
|
|
);
|
|
}
|
|
];
|
|
}
|