nixos/nebula: add basic module

1 files changed, 187 insertions, 0 deletions

diff --git a/nixos/modules/services/networking/nebula.nix b/nixos/modules/services/networking/nebula.nix
new file mode 100644
index 00000000000..84eda281c85
--- /dev/null
+++ b/nixos/modules/services/networking/nebula.nix
@@ -0,0 +1,187 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.services.nebula;
+  nebulaDesc = "Nebula VPN service";
+
+in
+{
+  # Interface
+
+  options.services.nebula = {
+    enable = mkEnableOption nebulaDesc;
+
+    package = mkOption {
+      type = types.package;
+      default = pkgs.nebula;
+      defaultText = "pkgs.nebula";
+      description = "Nebula derivation to use.";
+    };
+
+    ca = mkOption {
+      type = types.path;
+      description = "Path to the certificate authority certificate.";
+      example = "/etc/nebula/ca.crt";
+    };
+
+    cert = mkOption {
+      type = types.path;
+      description = "Path to the host certificate.";
+      example = "/etc/nebula/host.crt";
+    };
+
+    key = mkOption {
+      type = types.path;
+      description = "Path to the host key.";
+      example = "/etc/nebula/host.key";
+    };
+
+    staticHostMap = mkOption {
+      type = types.attrsOf (types.listOf (types.str));
+      default = {};
+      description = ''
+        The static host map defines a set of hosts with fixed IP addresses on the internet (or any network).
+        A host can have multiple fixed IP addresses defined here, and nebula will try each when establishing a tunnel.
+      '';
+      example = literalExample ''
+        { "192.168.100.1" = [ "100.64.22.11:4242" ]; }
+      '';
+    };
+
+    isLighthouse = mkOption {
+      type = types.bool;
+      default = false;
+      description = "Whether this node is a lighthouse.";
+    };
+
+    lighthouses = mkOption {
+      type = types.listOf types.str;
+      default = [];
+      description = ''
+        List of IPs of lighthouse hosts this node should report to and query from. This should be empty on lighthouse
+        nodes. The IPs should be the lighthouse's Nebula IPs, not their external IPs.
+      '';
+      example = ''[ "192.168.100.1" ]'';
+    };
+
+    listen.host = mkOption {
+      type = types.str;
+      default = "0.0.0.0";
+      description = "IP address to listen on.";
+    };
+
+    listen.port = mkOption {
+      type = types.port;
+      default = 4242;
+      description = "Port number to listen on.";
+    };
+
+    punch = mkOption {
+      type = types.bool;
+      default = true;
+      description = ''
+        Continues to punch inbound/outbound at a regular interval to avoid expiration of firewall nat mappings.
+      '';
+    };
+
+    tun.disable = mkOption {
+      type = types.bool;
+      default = false;
+      description = ''
+        When tun is disabled, a lighthouse can be started without a local tun interface (and therefore without root).
+      '';
+    };
+
+    tun.device = mkOption {
+      type = types.str;
+      default = "nebula1";
+      description = "Name of the tun device.";
+    };
+
+    firewall.outbound = mkOption {
+      type = types.listOf types.attrs;
+      default = [];
+      description = "Firewall rules for outbound traffic.";
+      example = ''[ { port = "any"; proto = "any"; host = "any"; } ]'';
+    };
+
+    firewall.inbound = mkOption {
+      type = types.listOf types.attrs;
+      default = [];
+      description = "Firewall rules for inbound traffic.";
+      example = ''[ { port = "any"; proto = "any"; host = "any"; } ]'';
+    };
+
+    extraConfig = mkOption {
+      type = types.attrs;
+      default = {};
+      description = "Extra configuration added to the Nebula config file.";
+      example = literalExample ''
+        {
+          lighthouse.dns = {
+            host = "0.0.0.0";
+            port = 53;
+          };
+        }
+      '';
+    };
+  };
+
+  # Implementation
+
+  config =
+    let
+      # Convert the options to an attrset.
+      optionConfigSet = {
+        pki = { ca = cfg.ca; cert = cfg.cert; key = cfg.key; };
+        static_host_map = cfg.staticHostMap;
+        lighthouse = { am_lighthouse = cfg.isLighthouse; hosts = cfg.lighthouses; };
+        listen = { host = cfg.listen.host; port = cfg.listen.port; };
+        punchy = { punch = cfg.punch; };
+        tun = { disabled = cfg.tun.disable; dev = cfg.tun.device; };
+        firewall = { inbound = cfg.firewall.inbound; outbound = cfg.firewall.outbound; };
+      };
+
+      # Merge in the extraconfig attrset.
+      mergedConfigSet = lib.recursiveUpdate optionConfigSet cfg.extraConfig;
+
+      # Dump the config to JSON. Because Nebula reads YAML and YAML is a superset of JSON, this works.
+      nebulaConfig = pkgs.writeTextFile { name = "nebula-config.yml"; text = (builtins.toJSON mergedConfigSet); };
+
+      # The service needs to launch as root to access the tun device, if it's enabled.
+      serviceUser = if cfg.tun.disable then "nebula" else "root";
+      serviceGroup = if cfg.tun.disable then "nebula" else "root";
+
+    in mkIf cfg.enable {
+      # Create systemd service for Nebula.
+      systemd.services.nebula = {
+        description = nebulaDesc;
+        after = [ "network.target" ];
+        before = [ "sshd.service" ];
+        wantedBy = [ "multi-user.target" ];
+        serviceConfig = {
+          Type = "simple";
+          Restart = "always";
+          User = serviceUser;
+          Group = serviceGroup;
+          ExecStart = "${cfg.package}/bin/nebula -config ${nebulaConfig}";
+        };
+      };
+
+      # Open the chosen port for UDP.
+      networking.firewall.allowedUDPPorts = [ cfg.listen.port ];
+
+      # Create the service user and its group.
+      users.users."nebula" = {
+        name = "nebula";
+        group = "nebula";
+        description = "Nebula service user";
+        isSystemUser = true;
+        packages = [ cfg.package ];
+      };
+      users.groups."nebula" = {};
+    };
+}