From f569227410f5a5f9f9c88b3a1d06956901105795 Mon Sep 17 00:00:00 2001 From: nixbitcoin Date: Mon, 8 Nov 2021 11:43:14 +0000 Subject: [PATCH] rtl: add module --- examples/configuration.nix | 18 +++ modules/default.nix | 1 + modules/modules.nix | 1 + modules/netns-isolation.nix | 13 ++ modules/nodeinfo.nix | 1 + modules/onion-services.nix | 3 + modules/presets/enable-tor.nix | 4 +- modules/rtl.nix | 255 +++++++++++++++++++++++++++++++++ 8 files changed, 295 insertions(+), 1 deletion(-) create mode 100644 modules/rtl.nix diff --git a/examples/configuration.nix b/examples/configuration.nix index c1117bb..03dd1ba 100644 --- a/examples/configuration.nix +++ b/examples/configuration.nix @@ -84,6 +84,24 @@ # This will allow you to recover off-chain funds, by force-closing channels. # scp bitcoin-node:/var/lib/lnd/chain/bitcoin/mainnet/channel.backup ./backups/lnd/ + ### RIDE THE LIGHTNING + # Set this to enable RTL, a web interface for lnd and clightning. + # services.rtl.enable = true; + # + # Set this to add a clightning node interface. + # Automatically enables clightning. + # services.rtl.nodes.clightning = true; + # + # Set this to add a lnd node interface. + # Automatically enables lnd. + # services.rtl.nodes.lnd = true; + # + # You can enable both nodes simultaneously. + # + # Set this option to enable swaps with lightning-loop. + # Automatically enables lightning-loop. + # services.rtl.loop = true; + ### SPARK WALLET # Set this to enable spark-wallet, a minimalistic wallet GUI for # c-lightning, accessible over the web or through mobile and desktop apps. diff --git a/modules/default.nix b/modules/default.nix index 388cacd..6cef1ed 100644 --- a/modules/default.nix +++ b/modules/default.nix @@ -6,6 +6,7 @@ electrs = ./electrs.nix; liquid = ./liquid.nix; presets.secure-node = ./presets/secure-node.nix; + rtl = ./rtl.nix; spark-wallet = ./spark-wallet.nix; recurring-donations = ./recurring-donations.nix; lnd = ./lnd.nix; diff --git a/modules/modules.nix b/modules/modules.nix index 97c263a..428eff8 100644 --- a/modules/modules.nix +++ b/modules/modules.nix @@ -12,6 +12,7 @@ ./bitcoind.nix ./clightning.nix ./clightning-plugins + ./rtl.nix ./spark-wallet.nix ./lnd.nix ./lnd-rest-onion-service.nix # Requires onion-addresses.nix diff --git a/modules/netns-isolation.nix b/modules/netns-isolation.nix index a2dc63f..b857e6e 100644 --- a/modules/netns-isolation.nix +++ b/modules/netns-isolation.nix @@ -274,6 +274,12 @@ in { id = 28; connections = [ "lnd" "electrs" ]; }; + rtl = { + id = 29; + connections = [] + ++ optional (config.services.rtl.nodes.lnd) "lnd" + ++ optional config.services.rtl.loop "lightning-loop"; + }; }; services.bitcoind = { @@ -324,6 +330,13 @@ in { services.joinmarket-ob-watcher.address = netns.joinmarket-ob-watcher.address; services.lightning-pool.rpcAddress = netns.lightning-pool.address; + + services.rtl.address = netns.rtl.address; + systemd.services.cl-rest = { + serviceConfig.NetworkNamespacePath = "/var/run/netns/nb-rtl"; + requires = [ "netns-rtl.service" ] ; + after = [ "netns-rtl.service" ]; + }; } ]); } diff --git a/modules/nodeinfo.nix b/modules/nodeinfo.nix index ec683d5..bafd38d 100644 --- a/modules/nodeinfo.nix +++ b/modules/nodeinfo.nix @@ -31,6 +31,7 @@ let btcpayserver = mkInfo ""; liquidd = mkInfo ""; joinmarket-ob-watcher = mkInfo ""; + rtl = mkInfo ""; # Only add sshd when it has an onion service sshd = name: cfg: mkIfOnionPort "sshd" (onionPort: '' add_service("sshd", """set_onion_address(info, "sshd", ${onionPort})""") diff --git a/modules/onion-services.nix b/modules/onion-services.nix index 655f579..7aa3cfa 100644 --- a/modules/onion-services.nix +++ b/modules/onion-services.nix @@ -117,6 +117,9 @@ in { joinmarket-ob-watcher = { externalPort = 80; }; + rtl = { + externalPort = 80; + }; }; } ]; diff --git a/modules/presets/enable-tor.nix b/modules/presets/enable-tor.nix index 0eb9042..583c6c1 100644 --- a/modules/presets/enable-tor.nix +++ b/modules/presets/enable-tor.nix @@ -1,4 +1,4 @@ -{ lib, ... }: +{ lib, config, ... }: let defaultTrue = lib.mkDefault true; in { @@ -21,6 +21,7 @@ in { spark-wallet.enforceTor = true; recurring-donations.enforceTor = true; lightning-pool.enforceTor = true; + rtl.enforceTor = true; }; # Add onion services for incoming connections @@ -30,5 +31,6 @@ in { electrs.enable = defaultTrue; spark-wallet.enable = defaultTrue; joinmarket-ob-watcher.enable = defaultTrue; + rtl.enable = defaultTrue; }; } diff --git a/modules/rtl.nix b/modules/rtl.nix new file mode 100644 index 0000000..70797f1 --- /dev/null +++ b/modules/rtl.nix @@ -0,0 +1,255 @@ +{ config, lib, pkgs, ... }: + +with lib; +let + options.services.rtl = { + enable = mkEnableOption "rtl"; + address = mkOption { + type = types.str; + default = "127.0.0.1"; + description = "HTTP server address."; + }; + port = mkOption { + type = types.port; + default = 3000; + description = "HTTP server port."; + }; + dataDir = mkOption { + type = types.path; + default = "/var/lib/rtl"; + description = "The data directory for RTL."; + }; + nodes = { + clightning = mkOption { + type = types.bool; + default = false; + description = "Add a node interface for clightning."; + }; + lnd = mkOption { + type = types.bool; + default = false; + description = "Add a node interface for lnd."; + }; + reverseOrder = mkOption { + type = types.bool; + default = false; + description = '' + Reverse the order of nodes shown in the UI. + By default, clightning is shown before lnd. + ''; + }; + }; + loop = mkOption { + type = types.bool; + default = false; + description = "Whether to enable swaps with lightning-loop."; + }; + nightTheme = mkOption { + type = types.bool; + default = false; + description = "Enable the Night UI Theme."; + }; + cl-rest = { + enable = mkOption { + type = types.bool; + default = cfg.nodes.clightning; + description = "Enable c-lightning-REST server."; + }; + address = mkOption { + readOnly = true; + default = "0.0.0.0"; + description = '' + Rest server address. + Not configurable. The server always listens on all interfaces: + https://github.com/Ride-The-Lightning/c-lightning-REST/issues/84 + ''; + }; + port = mkOption { + type = types.port; + default = 3001; + description = "REST server port."; + }; + docPort = mkOption { + type = types.port; + default = 4001; + description = "Swagger API documentation server port."; + }; + }; + user = mkOption { + type = types.str; + default = "rtl"; + description = "The user as which to run RTL."; + }; + group = mkOption { + type = types.str; + default = cfg.user; + description = "The group as which to run RTL."; + }; + inherit (nbLib) enforceTor; + }; + + cfg = config.services.rtl; + nbLib = config.nix-bitcoin.lib; + secretsDir = config.nix-bitcoin.secretsDir; + + node = { isLnd, index }: '' + { + "index": ${toString index}, + "lnNode": "Node", + "lnImplementation": "${if isLnd then "LND" else "CLT"}", + "Authentication": { + ${optionalString (isLnd && cfg.loop) + ''"swapMacaroonPath": "${lightning-loop.dataDir}/${bitcoind.network}",'' + } + "macaroonPath": "${if isLnd + then "${cfg.dataDir}/macaroons" + else "${cl-rest.dataDir}/certs" + }" + }, + "Settings": { + "userPersona": "OPERATOR", + "themeMode": "${if cfg.nightTheme then "NIGHT" else "DAY"}", + "themeColor": "PURPLE", + ${optionalString isLnd + ''"channelBackupPath": "${cfg.dataDir}/backup/lnd",'' + } + "logLevel": "INFO", + "fiatConversion": false, + ${optionalString (isLnd && cfg.loop) + ''"swapServerUrl": "https://${nbLib.addressWithPort lightning-loop.restAddress lightning-loop.restPort}",'' + } + "lnServerUrl": "https://${ + if isLnd + then nbLib.addressWithPort lnd.restAddress lnd.restPort + else nbLib.addressWithPort cfg.cl-rest.address cfg.cl-rest.port + }" + } + } + ''; + + nodes' = optional cfg.nodes.clightning (node { isLnd = false; index = 1; }) ++ + optional cfg.nodes.lnd (node { isLnd = true; index = 2; }); + + nodes = if cfg.nodes.reverseOrder then reverseList nodes' else nodes'; + + configFile = builtins.toFile "config" '' + { + "multiPass": "@multiPass@", + "host": "${cfg.address}", + "port": "${toString cfg.port}", + "SSO": { + "rtlSSO": 0 + }, + "nodes": [ + ${builtins.concatStringsSep ",\n" nodes} + ] + } + ''; + + cl-rest = { + configFile = builtins.toFile "config" '' + { + "PORT": ${toString cfg.cl-rest.port}, + "DOCPORT": ${toString cfg.cl-rest.docPort}, + "LNRPCPATH": "${clightning.dataDir}/${bitcoind.makeNetworkName "bitcoin" "regtest"}/lightning-rpc", + "PROTOCOL": "https", + "EXECMODE": "production", + "RPCCOMMANDS": ["*"] + } + ''; + # serviceConfig.StateDirectory + dataDir = "/var/lib/cl-rest"; + }; + + inherit (config.services) + bitcoind + lnd + clightning + lightning-loop; +in { + inherit options; + + config = mkIf cfg.enable { + assertions = [ + { assertion = cfg.nodes.clightning || cfg.nodes.lnd; + message = '' + RTL: At least one of `nodes.lnd` or `nodes.clightning` must be `true`. + ''; + } + ]; + + services.lnd.enable = mkIf cfg.nodes.lnd true; + services.lightning-loop.enable = mkIf cfg.loop true; + services.clightning.enable = mkIf cfg.nodes.clightning true; + + systemd.tmpfiles.rules = [ + "d '${cfg.dataDir}' 0770 ${cfg.user} ${cfg.group} - -" + ]; + + systemd.services.rtl = rec { + wantedBy = [ "multi-user.target" ]; + requires = optional cfg.nodes.clightning "cl-rest.service" ++ + optional cfg.nodes.lnd "lnd.service"; + after = requires; + environment.RTL_CONFIG_PATH = cfg.dataDir; + serviceConfig = nbLib.defaultHardening // { + ExecStartPre = [ + (nbLib.script "rtl-setup-config" '' + <${configFile} sed "s|@multiPass@|$(cat ${secretsDir}/rtl-password)|" \ + > '${cfg.dataDir}/RTL-Config.json' + '') + ] ++ optional cfg.nodes.lnd + (nbLib.rootScript "rtl-copy-macaroon" '' + install -D -o ${cfg.user} -g ${cfg.group} ${lnd.networkDir}/admin.macaroon \ + '${cfg.dataDir}/macaroons/admin.macaroon' + ''); + ExecStart = "${pkgs.nodejs}/bin/node ${config.nix-bitcoin.pkgs.rtl}/lib/node_modules/rtl/rtl"; + # Show "rtl" instead of "node" in the journal + SyslogIdentifier = "rtl"; + User = cfg.user; + Restart = "on-failure"; + RestartSec = "10s"; + ReadWritePaths = cfg.dataDir; + } // nbLib.allowedIPAddresses cfg.enforceTor + // nbLib.nodejs; + }; + + systemd.services.cl-rest = mkIf cfg.cl-rest.enable { + wantedBy = [ "multi-user.target" ]; + requires = [ "clightning.service" ]; + after = [ "clightning.service" ]; + path = [ pkgs.openssl ]; + preStart = '' + ln -sfn ${cl-rest.configFile} cl-rest-config.json + ''; + environment.CL_REST_STATE_DIR = cl-rest.dataDir; + serviceConfig = nbLib.defaultHardening // { + StateDirectory = "cl-rest"; + # cl-rest reads the config file from the working directory + WorkingDirectory = cl-rest.dataDir; + ExecStart = "${pkgs.nodejs}/bin/node ${config.nix-bitcoin.pkgs.cl-rest}/lib/node_modules/c-lightning-rest/cl-rest"; + # Show "cl-rest" instead of "node" in the journal + SyslogIdentifier = "cl-rest"; + User = cfg.user; + Restart = "on-failure"; + RestartSec = "10s"; + } // nbLib.allowLocalIPAddresses + // nbLib.nodejs; + }; + + users.users.${cfg.user} = { + isSystemUser = true; + group = cfg.group; + extraGroups = + # Enable clightning RPC access for cl-rest + optional cfg.cl-rest.enable clightning.group ++ + optional cfg.loop lnd.group; + }; + users.groups.${cfg.group} = {}; + + nix-bitcoin.secrets.rtl-password.user = cfg.user; + nix-bitcoin.generateSecretsCmds.rtl = '' + makePasswordSecret rtl-password + ''; + }; +}