#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /* Declare opt_add_addr here, because we we call opt_add_addr * and opt_announce_addr vice versa */ static char *opt_add_addr(const char *arg, struct lightningd *ld); /* FIXME: Put into ccan/time. */ #define TIME_FROM_SEC(sec) { { .tv_nsec = 0, .tv_sec = sec } } #define TIME_FROM_MSEC(msec) \ { { .tv_nsec = ((msec) % 1000) * 1000000, .tv_sec = (msec) / 1000 } } static char *opt_set_u64(const char *arg, u64 *u) { char *endp; unsigned long long l; assert(arg != NULL); /* This is how the manpage says to do it. Yech. */ errno = 0; l = strtoull(arg, &endp, 0); if (*endp || !arg[0]) return tal_fmt(NULL, "'%s' is not a number", arg); *u = l; if (errno || *u != l) return tal_fmt(NULL, "'%s' is out of range", arg); return NULL; } static char *opt_set_u32(const char *arg, u32 *u) { char *endp; unsigned long l; assert(arg != NULL); /* This is how the manpage says to do it. Yech. */ errno = 0; l = strtoul(arg, &endp, 0); if (*endp || !arg[0]) return tal_fmt(NULL, "'%s' is not a number", arg); *u = l; if (errno || *u != l) return tal_fmt(NULL, "'%s' is out of range", arg); return NULL; } static char *opt_set_s32(const char *arg, s32 *u) { char *endp; long l; assert(arg != NULL); /* This is how the manpage says to do it. Yech. */ errno = 0; l = strtol(arg, &endp, 0); if (*endp || !arg[0]) return tal_fmt(NULL, "'%s' is not a number", arg); *u = l; if (errno || *u != l) return tal_fmt(NULL, "'%s' is out of range", arg); return NULL; } static char *opt_set_mode(const char *arg, mode_t *m) { char *endp; long l; assert(arg != NULL); /* Ensure length, and starts with 0. */ if (strlen(arg) != 4 || arg[0] != '0') return tal_fmt(NULL, "'%s' is not a file mode", arg); /* strtol, manpage, yech. */ errno = 0; l = strtol(arg, &endp, 8); /* Octal. */ if (errno || *endp) return tal_fmt(NULL, "'%s' is not a file mode", arg); *m = l; /* Range check not needed, previous strlen checks ensures only * 9-bit, which fits mode_t (unless your Unix is seriously borked). */ return NULL; } static char *opt_add_addr_withtype(const char *arg, struct lightningd *ld, enum addr_listen_announce ala, bool wildcard_ok) { char const *err_msg; struct wireaddr_internal wi; assert(arg != NULL); tal_arr_expand(&ld->proposed_listen_announce, ala); if (!parse_wireaddr_internal(arg, &wi, ld->portnum, wildcard_ok, !ld->use_proxy_always, false, &err_msg)) { return tal_fmt(NULL, "Unable to parse address '%s': %s", arg, err_msg); } tal_arr_expand(&ld->proposed_wireaddr, wi); return NULL; } static char *opt_add_announce_addr(const char *arg, struct lightningd *ld) { const struct wireaddr *wn; size_t n = tal_count(ld->proposed_wireaddr); char *err; /* Check for autotor and reroute the call to --addr */ if (strstarts(arg, "autotor:")) return opt_add_addr(arg, ld); /* Check for statictor and reroute the call to --addr */ if (strstarts(arg, "statictor:")) return opt_add_addr(arg, ld); err = opt_add_addr_withtype(arg, ld, ADDR_ANNOUNCE, false); if (err) return err; /* Can't announce anything that's not a normal wireaddr. */ if (ld->proposed_wireaddr[n].itype != ADDR_INTERNAL_WIREADDR) return tal_fmt(NULL, "address '%s' is not announcable", arg); /* gossipd will refuse to announce the second one, sure, but it's * better to check and fail now if they've explicitly asked for it. */ wn = &ld->proposed_wireaddr[n].u.wireaddr; for (size_t i = 0; i < n; i++) { const struct wireaddr *wi; if (ld->proposed_listen_announce[i] != ADDR_ANNOUNCE) continue; assert(ld->proposed_wireaddr[i].itype == ADDR_INTERNAL_WIREADDR); wi = &ld->proposed_wireaddr[i].u.wireaddr; if (wn->type != wi->type) continue; return tal_fmt(NULL, "Cannot announce address %s;" " already have %s which is the same type", type_to_string(tmpctx, struct wireaddr, wn), type_to_string(tmpctx, struct wireaddr, wi)); } return NULL; } static char *opt_add_addr(const char *arg, struct lightningd *ld) { struct wireaddr_internal addr; /* handle in case you used the addr option with an .onion */ if (parse_wireaddr_internal(arg, &addr, 0, true, false, true, NULL)) { if (addr.itype == ADDR_INTERNAL_WIREADDR && ( addr.u.wireaddr.type == ADDR_TYPE_TOR_V2 || addr.u.wireaddr.type == ADDR_TYPE_TOR_V3)) { log_unusual(ld->log, "You used `--addr=%s` option with an .onion address, please use" " `--announce-addr` ! You are lucky in this node live some wizards and" " fairies, we have done this for you and announce, Be as hidden as wished", arg); return opt_add_announce_addr(arg, ld); } } /* the intended call */ return opt_add_addr_withtype(arg, ld, ADDR_LISTEN_AND_ANNOUNCE, true); } static char *opt_subdaemon(const char *arg, struct lightningd *ld) { char *subdaemon; char *sdpath; /* example arg: "hsmd:remote_hsmd" */ size_t colonoff = strcspn(arg, ":"); if (!arg[colonoff]) return tal_fmt(NULL, "argument must contain ':'"); subdaemon = tal_strndup(ld, arg, colonoff); if (!is_subdaemon(subdaemon)) return tal_fmt(NULL, "\"%s\" is not a subdaemon", subdaemon); /* Make the value a tal-child of the subdaemon */ sdpath = tal_strdup(subdaemon, arg + colonoff + 1); /* Remove any preexisting alt subdaemon mapping (and * implicitly, the sdpath). */ tal_free(strmap_del(&ld->alt_subdaemons, subdaemon, NULL)); strmap_add(&ld->alt_subdaemons, subdaemon, sdpath); return NULL; } static char *opt_add_bind_addr(const char *arg, struct lightningd *ld) { struct wireaddr_internal addr; /* handle in case you used the bind option with an .onion */ if (parse_wireaddr_internal(arg, &addr, 0, true, false, true, NULL)) { if (addr.itype == ADDR_INTERNAL_WIREADDR && ( addr.u.wireaddr.type == ADDR_TYPE_TOR_V2 || addr.u.wireaddr.type == ADDR_TYPE_TOR_V3)) { log_unusual(ld->log, "You used `--bind-addr=%s` option with an .onion address," " You are lucky in this node live some wizards and" " fairies, we have done this for you and don't announce, Be as hidden as wished", arg); return NULL; } } /* the intended call */ return opt_add_addr_withtype(arg, ld, ADDR_LISTEN, true); } static void opt_show_u64(char buf[OPT_SHOW_LEN], const u64 *u) { snprintf(buf, OPT_SHOW_LEN, "%"PRIu64, *u); } static void opt_show_u32(char buf[OPT_SHOW_LEN], const u32 *u) { snprintf(buf, OPT_SHOW_LEN, "%"PRIu32, *u); } static void opt_show_s32(char buf[OPT_SHOW_LEN], const s32 *u) { snprintf(buf, OPT_SHOW_LEN, "%"PRIi32, *u); } static void opt_show_mode(char buf[OPT_SHOW_LEN], const mode_t *m) { snprintf(buf, OPT_SHOW_LEN, "\"%04o\"", (int) *m); } static char *opt_set_rgb(const char *arg, struct lightningd *ld) { assert(arg != NULL); ld->rgb = tal_free(ld->rgb); /* BOLT #7: * * - Note: the first byte of `rgb_color` is the red value, the second * byte is the green value, and the last byte is the blue value. */ ld->rgb = tal_hexdata(ld, arg, strlen(arg)); if (!ld->rgb || tal_count(ld->rgb) != 3) return tal_fmt(NULL, "rgb '%s' is not six hex digits", arg); return NULL; } static char *opt_set_alias(const char *arg, struct lightningd *ld) { assert(arg != NULL); ld->alias = tal_free(ld->alias); /* BOLT #7: * * * [`32*byte`:`alias`] *... * - MUST set `alias` to a valid UTF-8 string, with any * `alias` trailing-bytes equal to 0. */ if (strlen(arg) > 32) return tal_fmt(NULL, "Alias '%s' is over 32 characters", arg); ld->alias = tal_arrz(ld, u8, 33); strncpy((char*)ld->alias, arg, 32); return NULL; } static char *opt_set_offline(struct lightningd *ld) { ld->reconnect = false; ld->listen = false; return NULL; } static char *opt_add_proxy_addr(const char *arg, struct lightningd *ld) { bool needed_dns = false; tal_free(ld->proxyaddr); /* We use a tal_arr here, so we can marshal it to gossipd */ ld->proxyaddr = tal_arr(ld, struct wireaddr, 1); if (!parse_wireaddr(arg, ld->proxyaddr, 9050, ld->use_proxy_always ? &needed_dns : NULL, NULL)) { return tal_fmt(NULL, "Unable to parse Tor proxy address '%s' %s", arg, needed_dns ? " (needed dns)" : ""); } return NULL; } static char *opt_add_plugin(const char *arg, struct lightningd *ld) { plugin_register(ld->plugins, arg); return NULL; } static char *opt_disable_plugin(const char *arg, struct lightningd *ld) { if (plugin_remove(ld->plugins, arg)) return NULL; return tal_fmt(NULL, "Could not find plugin %s", arg); } static char *opt_add_plugin_dir(const char *arg, struct lightningd *ld) { return add_plugin_dir(ld->plugins, arg, false); } static char *opt_clear_plugins(struct lightningd *ld) { clear_plugins(ld->plugins); return NULL; } /* Prompt the user to enter a password, from which will be derived the key used * for `hsm_secret` encryption. * The algorithm used to derive the key is Argon2(id), to which libsodium * defaults. However argon2id-specific constants are used in case someone runs it * with a libsodium version which default constants differs (typically <1.0.9). */ static char *opt_set_hsm_password(struct lightningd *ld) { struct termios current_term, temp_term; char *passwd = NULL; size_t passwd_size = 0; u8 salt[16] = "c-lightning\0\0\0\0\0"; ld->encrypted_hsm = true; ld->config.keypass = tal(NULL, struct secret); /* Don't swap the encryption key ! */ if (sodium_mlock(ld->config.keypass->data, sizeof(ld->config.keypass->data)) != 0) return "Could not lock hsm_secret encryption key memory."; /* Get the password from stdin, but don't echo it. */ if (tcgetattr(fileno(stdin), ¤t_term) != 0) return "Could not get current terminal options."; temp_term = current_term; temp_term.c_lflag &= ~ECHO; if (tcsetattr(fileno(stdin), TCSAFLUSH, &temp_term) != 0) return "Could not disable password echoing."; printf("The hsm_secret is encrypted with a password. In order to " "decrypt it and start the node you must provide the password.\n"); printf("Enter hsm_secret password: "); /* If we don't flush we might end up being buffered and we might seem * to hang while we wait for the password. */ fflush(stdout); if (getline(&passwd, &passwd_size, stdin) < 0) return "Could not read password from stdin."; if (passwd[strlen(passwd) - 1] == '\n') passwd[strlen(passwd) - 1] = '\0'; if (tcsetattr(fileno(stdin), TCSAFLUSH, ¤t_term) != 0) return "Could not restore terminal options."; printf("\n"); /* Derive the key from the password. */ if (strlen(passwd) < crypto_pwhash_argon2id_PASSWD_MIN) return "Password too short to be able to derive a key from it."; if (strlen(passwd) > crypto_pwhash_argon2id_PASSWD_MAX) return "Password too long to be able to derive a key from it."; if (crypto_pwhash(ld->config.keypass->data, sizeof(ld->config.keypass->data), passwd, strlen(passwd), salt, /* INTERACTIVE needs 64 MiB of RAM, MODERATE needs 256, * and SENSITIVE needs 1024. */ crypto_pwhash_argon2id_OPSLIMIT_MODERATE, crypto_pwhash_argon2id_MEMLIMIT_MODERATE, crypto_pwhash_ALG_ARGON2ID13) != 0) return "Could not derive a key from the password."; free(passwd); return NULL; } #if DEVELOPER static char *opt_subprocess_debug(const char *optarg, struct lightningd *ld) { ld->dev_debug_subprocess = optarg; return NULL; } static char *opt_force_privkey(const char *optarg, struct lightningd *ld) { tal_free(ld->dev_force_privkey); ld->dev_force_privkey = tal(ld, struct privkey); if (!hex_decode(optarg, strlen(optarg), ld->dev_force_privkey, sizeof(*ld->dev_force_privkey))) return tal_fmt(NULL, "Unable to parse privkey '%s'", optarg); return NULL; } static char *opt_force_bip32_seed(const char *optarg, struct lightningd *ld) { tal_free(ld->dev_force_bip32_seed); ld->dev_force_bip32_seed = tal(ld, struct secret); if (!hex_decode(optarg, strlen(optarg), ld->dev_force_bip32_seed, sizeof(*ld->dev_force_bip32_seed))) return tal_fmt(NULL, "Unable to parse secret '%s'", optarg); return NULL; } static char *opt_force_tmp_channel_id(const char *optarg, struct lightningd *ld) { tal_free(ld->dev_force_tmp_channel_id); ld->dev_force_tmp_channel_id = tal(ld, struct channel_id); if (!hex_decode(optarg, strlen(optarg), ld->dev_force_tmp_channel_id, sizeof(*ld->dev_force_tmp_channel_id))) return tal_fmt(NULL, "Unable to parse channel id '%s'", optarg); return NULL; } static char *opt_force_channel_secrets(const char *optarg, struct lightningd *ld) { char **strs; tal_free(ld->dev_force_channel_secrets); tal_free(ld->dev_force_channel_secrets_shaseed); ld->dev_force_channel_secrets = tal(ld, struct secrets); ld->dev_force_channel_secrets_shaseed = tal(ld, struct sha256); strs = tal_strsplit(tmpctx, optarg, "/", STR_EMPTY_OK); if (tal_count(strs) != 7) /* Last is NULL */ return "Expected 6 hex secrets separated by /"; if (!hex_decode(strs[0], strlen(strs[0]), &ld->dev_force_channel_secrets->funding_privkey, sizeof(ld->dev_force_channel_secrets->funding_privkey)) || !hex_decode(strs[1], strlen(strs[1]), &ld->dev_force_channel_secrets->revocation_basepoint_secret, sizeof(ld->dev_force_channel_secrets->revocation_basepoint_secret)) || !hex_decode(strs[2], strlen(strs[2]), &ld->dev_force_channel_secrets->payment_basepoint_secret, sizeof(ld->dev_force_channel_secrets->payment_basepoint_secret)) || !hex_decode(strs[3], strlen(strs[3]), &ld->dev_force_channel_secrets->delayed_payment_basepoint_secret, sizeof(ld->dev_force_channel_secrets->delayed_payment_basepoint_secret)) || !hex_decode(strs[4], strlen(strs[4]), &ld->dev_force_channel_secrets->htlc_basepoint_secret, sizeof(ld->dev_force_channel_secrets->htlc_basepoint_secret)) || !hex_decode(strs[5], strlen(strs[5]), ld->dev_force_channel_secrets_shaseed, sizeof(*ld->dev_force_channel_secrets_shaseed))) return "Expected 6 hex secrets separated by /"; return NULL; } static void dev_register_opts(struct lightningd *ld) { /* We might want to debug plugins, which are started before normal * option parsing */ opt_register_early_arg("--dev-debugger=", opt_subprocess_debug, NULL, ld, "Invoke gdb at start of "); opt_register_noarg("--dev-no-reconnect", opt_set_invbool, &ld->reconnect, "Disable automatic reconnect-attempts by this node, but accept incoming"); opt_register_noarg("--dev-fail-on-subdaemon-fail", opt_set_bool, &ld->dev_subdaemon_fail, opt_hidden); opt_register_arg("--dev-disconnect=", opt_subd_dev_disconnect, NULL, ld, "File containing disconnection points"); opt_register_noarg("--dev-allow-localhost", opt_set_bool, &ld->dev_allow_localhost, "Announce and allow announcments for localhost address"); opt_register_arg("--dev-bitcoind-poll", opt_set_u32, opt_show_u32, &ld->topology->poll_seconds, "Time between polling for new transactions"); opt_register_arg("--dev-max-fee-multiplier", opt_set_u32, opt_show_u32, &ld->config.max_fee_multiplier, "Allow the fee proposed by the remote end to be up to " "multiplier times higher than our own. Small values " "will cause channels to be closed more often due to " "fee fluctuations, large values may result in large " "fees."); opt_register_noarg("--dev-fast-gossip", opt_set_bool, &ld->dev_fast_gossip, "Make gossip broadcast 1 second, etc"); opt_register_noarg("--dev-fast-gossip-prune", opt_set_bool, &ld->dev_fast_gossip_prune, "Make gossip pruning 30 seconds"); opt_register_arg("--dev-gossip-time", opt_set_u32, opt_show_u32, &ld->dev_gossip_time, "UNIX time to override gossipd to use."); opt_register_arg("--dev-force-privkey", opt_force_privkey, NULL, ld, "Force HSM to use this as node private key"); opt_register_arg("--dev-force-bip32-seed", opt_force_bip32_seed, NULL, ld, "Force HSM to use this as bip32 seed"); opt_register_arg("--dev-force-channel-secrets", opt_force_channel_secrets, NULL, ld, "Force HSM to use these for all per-channel secrets"); opt_register_arg("--dev-max-funding-unconfirmed-blocks", opt_set_u32, opt_show_u32, &ld->max_funding_unconfirmed, "Maximum number of blocks we wait for a channel " "funding transaction to confirm, if we are the " "fundee."); opt_register_arg("--dev-force-tmp-channel-id", opt_force_tmp_channel_id, NULL, ld, "Force the temporary channel id, instead of random"); opt_register_noarg("--dev-no-htlc-timeout", opt_set_bool, &ld->dev_no_htlc_timeout, "Don't kill channeld if HTLCs not confirmed within 30 seconds"); opt_register_noarg("--dev-fail-process-onionpacket", opt_set_bool, &dev_fail_process_onionpacket, "Force all processing of onion packets to fail"); } #endif /* DEVELOPER */ static const struct config testnet_config = { /* 6 blocks to catch cheating attempts. */ .locktime_blocks = 6, /* They can have up to 14 days, maximumu value that lnd will ask for by default. */ /* FIXME Convince lnd to use more reasonable defaults... */ .locktime_max = 14 * 24 * 6, /* We're fairly trusting, under normal circumstances. */ .anchor_confirms = 1, /* Testnet fees are crazy, allow infinite feerange. */ .commitment_fee_min_percent = 0, .commitment_fee_max_percent = 0, /* We offer to pay 5 times 2-block fee */ .commitment_fee_percent = 500, /* Testnet blockspace is free. */ .max_concurrent_htlcs = 483, /* Be aggressive on testnet. */ .cltv_expiry_delta = 6, .cltv_final = 10, /* Send commit 10msec after receiving; almost immediately. */ .commit_time_ms = 10, /* Allow dust payments */ .fee_base = 1, /* Take 0.001% */ .fee_per_satoshi = 10, /* Testnet sucks */ .ignore_fee_limits = true, /* Rescan 5 hours of blocks on testnet, it's reorg happy */ .rescan = 30, /* Fees may be in the range our_fee - 10*our_fee */ .max_fee_multiplier = 10, .use_dns = true, /* Sets min_effective_htlc_capacity - at 1000$/BTC this is 10ct */ .min_capacity_sat = 10000, .use_v3_autotor = true, }; /* aka. "Dude, where's my coins?" */ static const struct config mainnet_config = { /* ~one day to catch cheating attempts. */ .locktime_blocks = 6 * 24, /* They can have up to 14 days, maximumu value that lnd will ask for by default. */ /* FIXME Convince lnd to use more reasonable defaults... */ .locktime_max = 14 * 24 * 6, /* We're fairly trusting, under normal circumstances. */ .anchor_confirms = 3, /* Insist between 2 and 20 times the 2-block fee. */ .commitment_fee_min_percent = 200, .commitment_fee_max_percent = 2000, /* We offer to pay 5 times 2-block fee */ .commitment_fee_percent = 500, /* While up to 483 htlcs are possible we do 30 by default (as eclair does) to save blockspace */ .max_concurrent_htlcs = 30, /* BOLT #2: * * 1. the `cltv_expiry_delta` for channels, `3R+2G+2S`: if in doubt, a * `cltv_expiry_delta` of 12 is reasonable (R=2, G=1, S=2) */ /* R = 2, G = 1, S = 3 */ .cltv_expiry_delta = 14, /* BOLT #2: * * 4. the minimum `cltv_expiry` accepted for terminal payments: the * worst case for the terminal node C is `2R+G+S` blocks */ .cltv_final = 10, /* Send commit 10msec after receiving; almost immediately. */ .commit_time_ms = 10, /* Discourage dust payments */ .fee_base = 1000, /* Take 0.001% */ .fee_per_satoshi = 10, /* Mainnet should have more stable fees */ .ignore_fee_limits = false, /* Rescan 2.5 hours of blocks on startup, it's not so reorg happy */ .rescan = 15, /* Fees may be in the range our_fee - 10*our_fee */ .max_fee_multiplier = 10, .use_dns = true, /* Sets min_effective_htlc_capacity - at 1000$/BTC this is 10ct */ .min_capacity_sat = 10000, /* Allow to define the default behavior of tor services calls*/ .use_v3_autotor = true, }; static void check_config(struct lightningd *ld) { /* We do this by ensuring it's less than the minimum we would accept. */ if (ld->config.commitment_fee_max_percent != 0 && ld->config.commitment_fee_max_percent < ld->config.commitment_fee_min_percent) fatal("Commitment fee invalid min-max %u-%u", ld->config.commitment_fee_min_percent, ld->config.commitment_fee_max_percent); /* BOLT #2: * * The receiving node MUST fail the channel if: *... * - `max_accepted_htlcs` is greater than 483. */ if (ld->config.max_concurrent_htlcs < 1 || ld->config.max_concurrent_htlcs > 483) fatal("--max-concurrent-htlcs value must be between 1 and 483 it is: %u", ld->config.max_concurrent_htlcs); if (ld->config.anchor_confirms == 0) fatal("anchor-confirms must be greater than zero"); if (ld->use_proxy_always && !ld->proxyaddr) fatal("--always-use-proxy needs --proxy"); } static char *test_subdaemons_and_exit(struct lightningd *ld) { test_subdaemons(ld); exit(0); return NULL; } static char *list_features_and_exit(struct lightningd *ld) { const char **features = list_supported_features(ld); for (size_t i = 0; i < tal_count(features); i++) printf("%s\n", features[i]); exit(0); } static char *opt_lightningd_usage(struct lightningd *ld) { char *extra = tal_fmt(NULL, "\nA bitcoin lightning daemon (default " "values shown for network: %s).", chainparams->network_name); opt_usage_and_exit(extra); tal_free(extra); return NULL; } static char *opt_start_daemon(struct lightningd *ld) { int fds[2]; int exitcode, pid; /* Already a daemon? OK. */ if (ld->daemon_parent_fd != -1) return NULL; if (pipe(fds) != 0) err(1, "Creating pipe to talk to --daemon"); pid = fork(); if (pid == -1) err(1, "Fork failed for --daemon"); if (pid == 0) { /* Child returns, continues as normal. */ close(fds[0]); ld->daemon_parent_fd = fds[1]; return NULL; } /* OK, we are the parent. We exit with status told to us by * child. */ close(fds[1]); if (read(fds[0], &exitcode, sizeof(exitcode)) == sizeof(exitcode)) _exit(exitcode); /* It died before writing exitcode (presumably 0), so we grab it */ waitpid(pid, &exitcode, 0); if (WIFEXITED(exitcode)) _exit(WEXITSTATUS(exitcode)); errx(1, "Died with signal %u", WTERMSIG(exitcode)); } static void register_opts(struct lightningd *ld) { /* This happens before plugins started */ opt_register_early_noarg("--test-daemons-only", test_subdaemons_and_exit, ld, opt_hidden); /* Register plugins as an early args, so we can initialize them and have * them register more command line options */ opt_register_early_arg("--plugin", opt_add_plugin, NULL, ld, "Add a plugin to be run (can be used multiple times)"); opt_register_early_arg("--plugin-dir", opt_add_plugin_dir, NULL, ld, "Add a directory to load plugins from (can be used multiple times)"); opt_register_early_noarg("--clear-plugins", opt_clear_plugins, ld, "Remove all plugins added before this option"); opt_register_early_arg("--disable-plugin", opt_disable_plugin, NULL, ld, "Disable a particular plugin by filename/name"); /* Early, as it suppresses DNS lookups from cmdline too. */ opt_register_early_arg("--always-use-proxy", opt_set_bool_arg, opt_show_bool, &ld->use_proxy_always, "Use the proxy always"); /* This immediately makes is a daemon. */ opt_register_early_noarg("--daemon", opt_start_daemon, ld, "Run in the background, suppress stdout/stderr"); opt_register_early_arg("--wallet", opt_set_talstr, NULL, &ld->wallet_dsn, "Location of the wallet database."); opt_register_noarg("--help|-h", opt_lightningd_usage, ld, "Print this message."); opt_register_arg("--bitcoin-datadir", opt_set_talstr, NULL, &ld->topology->bitcoind->datadir, "-datadir arg for bitcoin-cli"); opt_register_arg("--rgb", opt_set_rgb, NULL, ld, "RRGGBB hex color for node"); opt_register_arg("--alias", opt_set_alias, NULL, ld, "Up to 32-byte alias for node"); opt_register_arg("--bitcoin-cli", opt_set_talstr, NULL, &ld->topology->bitcoind->cli, "bitcoin-cli pathname"); opt_register_arg("--bitcoin-rpcuser", opt_set_talstr, NULL, &ld->topology->bitcoind->rpcuser, "bitcoind RPC username"); opt_register_arg("--bitcoin-rpcpassword", opt_set_talstr, NULL, &ld->topology->bitcoind->rpcpass, "bitcoind RPC password"); opt_register_arg("--bitcoin-rpcconnect", opt_set_talstr, NULL, &ld->topology->bitcoind->rpcconnect, "bitcoind RPC host to connect to"); opt_register_arg("--bitcoin-rpcport", opt_set_talstr, NULL, &ld->topology->bitcoind->rpcport, "bitcoind RPC port"); opt_register_arg("--bitcoin-retry-timeout", opt_set_u64, opt_show_u64, &ld->topology->bitcoind->retry_timeout, "how long to keep trying to contact bitcoind " "before fatally exiting"); opt_register_arg("--pid-file=", opt_set_talstr, opt_show_charp, &ld->pidfile, "Specify pid file"); opt_register_arg("--ignore-fee-limits", opt_set_bool_arg, opt_show_bool, &ld->config.ignore_fee_limits, "(DANGEROUS) allow peer to set any feerate"); opt_register_arg("--watchtime-blocks", opt_set_u32, opt_show_u32, &ld->config.locktime_blocks, "Blocks before peer can unilaterally spend funds"); opt_register_arg("--max-locktime-blocks", opt_set_u32, opt_show_u32, &ld->config.locktime_max, "Maximum blocks funds may be locked for"); opt_register_arg("--funding-confirms", opt_set_u32, opt_show_u32, &ld->config.anchor_confirms, "Confirmations required for funding transaction"); opt_register_arg("--commit-fee-min=", opt_set_u32, opt_show_u32, &ld->config.commitment_fee_min_percent, "Minimum percentage of fee to accept for commitment"); opt_register_arg("--commit-fee-max=", opt_set_u32, opt_show_u32, &ld->config.commitment_fee_max_percent, "Maximum percentage of fee to accept for commitment (0 for unlimited)"); opt_register_arg("--commit-fee=", opt_set_u32, opt_show_u32, &ld->config.commitment_fee_percent, "Percentage of fee to request for their commitment"); opt_register_arg("--cltv-delta", opt_set_u32, opt_show_u32, &ld->config.cltv_expiry_delta, "Number of blocks for cltv_expiry_delta"); opt_register_arg("--cltv-final", opt_set_u32, opt_show_u32, &ld->config.cltv_final, "Number of blocks for final cltv_expiry"); opt_register_arg("--commit-time=", opt_set_u32, opt_show_u32, &ld->config.commit_time_ms, "Time after changes before sending out COMMIT"); opt_register_arg("--fee-base", opt_set_u32, opt_show_u32, &ld->config.fee_base, "Millisatoshi minimum to charge for HTLC"); opt_register_arg("--rescan", opt_set_s32, opt_show_s32, &ld->config.rescan, "Number of blocks to rescan from the current head, or " "absolute blockheight if negative"); opt_register_arg("--fee-per-satoshi", opt_set_u32, opt_show_u32, &ld->config.fee_per_satoshi, "Microsatoshi fee for every satoshi in HTLC"); opt_register_arg("--max-concurrent-htlcs", opt_set_u32, opt_show_u32, &ld->config.max_concurrent_htlcs, "Number of HTLCs one channel can handle concurrently. Should be between 1 and 483"); opt_register_arg("--min-capacity-sat", opt_set_u64, opt_show_u64, &ld->config.min_capacity_sat, "Minimum capacity in satoshis for accepting channels"); opt_register_arg("--addr", opt_add_addr, NULL, ld, "Set an IP address (v4 or v6) to listen on and announce to the network for incoming connections"); opt_register_arg("--bind-addr", opt_add_bind_addr, NULL, ld, "Set an IP address (v4 or v6) to listen on, but not announce"); opt_register_arg("--announce-addr", opt_add_announce_addr, NULL, ld, "Set an IP address (v4 or v6) or .onion v2/v3 to announce, but not listen on"); opt_register_noarg("--offline", opt_set_offline, ld, "Start in offline-mode (do not automatically reconnect and do not accept incoming connections)"); opt_register_arg("--autolisten", opt_set_bool_arg, opt_show_bool, &ld->autolisten, "If true, listen on default port and announce if it seems to be a public interface"); opt_register_arg("--proxy", opt_add_proxy_addr, NULL, ld,"Set a socks v5 proxy IP address and port"); opt_register_arg("--tor-service-password", opt_set_talstr, NULL, &ld->tor_service_password, "Set a Tor hidden service password"); opt_register_noarg("--disable-dns", opt_set_invbool, &ld->config.use_dns, "Disable DNS lookups of peers"); opt_register_noarg("--enable-autotor-v2-mode", opt_set_invbool, &ld->config.use_v3_autotor, "Try to get a v2 onion address from the Tor service call, default is v3"); opt_register_noarg("--encrypted-hsm", opt_set_hsm_password, ld, "Set the password to encrypt hsm_secret with. If no password is passed through command line, " "you will be prompted to enter it."); opt_register_arg("--rpc-file-mode", &opt_set_mode, &opt_show_mode, &ld->rpc_filemode, "Set the file mode (permissions) for the " "JSON-RPC socket"); opt_register_arg("--subdaemon", opt_subdaemon, NULL, ld, "Arg specified as SUBDAEMON:PATH. " "Specifies an alternate subdaemon binary. " "If the supplied path is relative the subdaemon " "binary is found in the working directory. " "This option may be specified multiple times. " "For example, " "--subdaemon=hsmd:remote_signer " "would use a hypothetical remote signing subdaemon."); opt_register_logging(ld); opt_register_version(); #if DEVELOPER dev_register_opts(ld); #endif } /* We are in ld->config_netdir when this is run! */ static void promote_missing_files(struct lightningd *ld) { #ifdef COMPAT_V073 DIR *d_from; struct dirent *d; struct stat st; /* If hsm_secret already exists, we assume we're ugpraded */ if (stat("hsm_secret", &st) == 0) return; if (errno != ENOENT) err(1, "Looking for hsm_secret in lightning dir"); /* If hsm doesn't exist in basedir, we've nothing to upgrade. */ if (stat(path_join(tmpctx, ld->config_basedir, "hsm_secret"), &st) != 0) return; d_from = opendir(ld->config_basedir); if (!d_from) err(1, "Opening %s", ld->config_basedir); while ((d = readdir(d_from)) != NULL) { const char *fullname; /* Ignore this directory and upper one, and leave * config and pid files */ if (streq(d->d_name, ".") || streq(d->d_name, "..") || streq(d->d_name, "config") || strends(d->d_name, ".pid")) continue; fullname = path_join(tmpctx, ld->config_basedir, d->d_name); /* Simply remove rpc file: if they use --rpc-file to place it * here explicitly it will get recreated, but moving it would * be confusing as it would be unused. */ if (streq(d->d_name, "lightning-rpc")) { if (unlink(fullname) != 0) log_unusual(ld->log, "Could not unlink %s: %s", fullname, strerror(errno)); continue; } /* Ignore any directories. */ if (lstat(fullname, &st) != 0) errx(1, "Could not stat %s", fullname); if ((st.st_mode & S_IFMT) == S_IFDIR) continue; /* Check we don't overwrite something in this dir! */ if (lstat(d->d_name, &st) != -1) errx(1, "Refusing to overwrite %s into %s/", fullname, ld->config_netdir); log_unusual(ld->log, "Moving %s into %s/", d->d_name, ld->config_netdir); if (rename(fullname, d->d_name) != 0) err(1, "Could not move %s/%s to %s", ld->config_basedir, d->d_name, ld->config_netdir); } closedir(d_from); #endif /* COMPAT_V073 */ } /* Names stolen from https://github.com/ternus/nsaproductgenerator/blob/master/nsa.js */ static const char *codename_adjective[] = { "LOUD", "RED", "BLUE", "GREEN", "YELLOW", "IRATE", "ANGRY", "PEEVED", "HAPPY", "SLIMY", "SLEEPY", "JUNIOR", "SLICKER", "UNITED", "SOMBER", "BIZARRE", "ODD", "WEIRD", "WRONG", "LATENT", "CHILLY", "STRANGE", "LOUD", "SILENT", "HOPPING", "ORANGE", "VIOLET", "VIOLENT", "LIGHTNING" }; static const char *codename_noun[] = { "WHISPER", "FELONY", "MOON", "SUCKER", "PENGUIN", "WAFFLE", "MAESTRO", "NIGHT", "TRINITY", "DEITY", "MONKEY", "ARK", "SQUIRREL", "IRON", "BOUNCE", "FARM", "CHEF", "TROUGH", "NET", "TRAWL", "GLEE", "WATER", "SPORK", "PLOW", "FEED", "SOUFFLE", "ROUTE", "BAGEL", "MONTANA", "ANALYST", "AUTO", "WATCH", "PHOTO", "YARD", "SOURCE", "MONKEY", "SEAGULL", "TOLL", "SPAWN", "GOPHER", "CHIPMUNK", "SET", "CALENDAR", "ARTIST", "CHASER", "SCAN", "TOTE", "BEAM", "ENTOURAGE", "GENESIS", "WALK", "SPATULA", "RAGE", "FIRE", "MASTER" }; void setup_color_and_alias(struct lightningd *ld) { if (!ld->rgb) /* You can't get much red by default */ ld->rgb = tal_dup_arr(ld, u8, ld->id.k, 3, 0); if (!ld->alias) { u64 adjective, noun; char *name; memcpy(&adjective, ld->id.k+3, sizeof(adjective)); memcpy(&noun, ld->id.k+3+sizeof(adjective), sizeof(noun)); noun %= ARRAY_SIZE(codename_noun); adjective %= ARRAY_SIZE(codename_adjective); /* Only use 32 characters */ name = tal_fmt(ld, "%s%s", codename_adjective[adjective], codename_noun[noun]); #if DEVELOPER assert(strlen(name) < 32); int taillen = 31 - strlen(name); if (taillen > strlen(version())) taillen = strlen(version()); /* Fit as much of end of version() as possible */ tal_append_fmt(&name, "-%s", version() + strlen(version()) - taillen); #endif assert(strlen(name) <= 32); ld->alias = tal_arrz(ld, u8, 33); strcpy((char*)ld->alias, name); tal_free(name); } } void handle_early_opts(struct lightningd *ld, int argc, char *argv[]) { /* Make ccan/opt use tal for allocations */ setup_option_allocators(); /*~ List features immediately, before doing anything interesting */ opt_register_early_noarg("--list-features-only", list_features_and_exit, ld, opt_hidden); /*~ This does enough parsing to get us the base configuration options */ initial_config_opts(ld, argc, argv, &ld->config_filename, &ld->config_basedir, &ld->config_netdir, &ld->rpc_filename); /* Copy in default config, to be modified by further options */ if (chainparams->testnet) ld->config = testnet_config; else ld->config = mainnet_config; /* Now we can initialize wallet_dsn */ ld->wallet_dsn = tal_fmt(ld, "sqlite3://%s/lightningd.sqlite3", ld->config_netdir); /* Set default PID file name to be per-network (in base dir) */ ld->pidfile = path_join(ld, ld->config_basedir, tal_fmt(tmpctx, "lightningd-%s.pid", chainparams->network_name)); /*~ Move into config dir: this eases path manipulation and also * gives plugins a good place to store their stuff. */ if (chdir(ld->config_netdir) != 0) { log_unusual(ld->log, "Creating configuration directory %s", ld->config_netdir); /* We assume home dir exists, so only create two. */ if (mkdir(ld->config_basedir, 0700) != 0 && errno != EEXIST) fatal("Could not make directory %s: %s", ld->config_basedir, strerror(errno)); if (mkdir(ld->config_netdir, 0700) != 0) fatal("Could not make directory %s: %s", ld->config_netdir, strerror(errno)); if (chdir(ld->config_netdir) != 0) fatal("Could not change directory %s: %s", ld->config_netdir, strerror(errno)); } /*~ We move files from old locations on first upgrade. */ promote_missing_files(ld); /*~ The ccan/opt code requires registration then parsing; we * mimic this API here, even though they're on separate lines.*/ register_opts(ld); /* Now look inside config file(s), but only handle the early * options (testnet, plugins etc), others may be added on-demand */ parse_config_files(ld->config_filename, ld->config_basedir, true); /* Early cmdline options now override config file options. */ opt_early_parse_incomplete(argc, argv, opt_log_stderr_exit); /* Finalize the logging subsystem now. */ logging_options_parsed(ld->log_book); } void handle_opts(struct lightningd *ld, int argc, char *argv[]) { /* Now look for config file, but only handle non-early * options, early ones have been parsed in * handle_early_opts */ parse_config_files(ld->config_filename, ld->config_basedir, false); /* Now parse cmdline, which overrides config. */ opt_parse(&argc, argv, opt_log_stderr_exit); if (argc != 1) errx(1, "no arguments accepted"); /* We keep a separate variable rather than overriding use_proxy_always, * so listconfigs shows the correct thing. */ if (tal_count(ld->proposed_wireaddr) != 0 && all_tor_addresses(ld->proposed_wireaddr)) { ld->pure_tor_setup = true; if (!ld->proxyaddr) log_info(ld->log, "Pure Tor setup with no --proxy:" " you won't be able to make connections out"); } check_config(ld); } /* FIXME: This is a hack! Expose somehow in ccan/opt.*/ /* Returns string after first '-'. */ static const char *first_name(const char *names, unsigned *len) { *len = strcspn(names + 1, "|= "); return names + 1; } static const char *next_name(const char *names, unsigned *len) { names += *len; if (names[0] == ' ' || names[0] == '=' || names[0] == '\0') return NULL; return first_name(names + 1, len); } static void json_add_opt_addrs(struct json_stream *response, const char *name0, const struct wireaddr_internal *wireaddrs, const enum addr_listen_announce *listen_announce, enum addr_listen_announce ala) { for (size_t i = 0; i < tal_count(wireaddrs); i++) { if (listen_announce[i] != ala) continue; json_add_string(response, name0, fmt_wireaddr_internal(name0, wireaddrs+i)); } } struct json_add_opt_alt_subdaemon_args { const char *name0; struct json_stream *response; }; static bool json_add_opt_alt_subdaemon(const char *member, const char *value, struct json_add_opt_alt_subdaemon_args *argp) { json_add_string(argp->response, argp->name0, tal_fmt(argp->name0, "%s:%s", member, value)); return true; } static void json_add_opt_subdaemons(struct json_stream *response, const char *name0, alt_subdaemon_map *alt_subdaemons) { struct json_add_opt_alt_subdaemon_args args; args.name0 = name0; args.response = response; strmap_iterate(alt_subdaemons, json_add_opt_alt_subdaemon, &args); } static void add_config(struct lightningd *ld, struct json_stream *response, const struct opt_table *opt, const char *name, size_t len) { char *name0 = tal_strndup(tmpctx, name, len); const char *answer = NULL; char buf[OPT_SHOW_LEN + sizeof("...")]; if (opt->type & OPT_NOARG) { if (opt->desc == opt_hidden) { /* Ignore hidden options (deprecated) */ } else if (opt->cb == (void *)opt_usage_and_exit || opt->cb == (void *)version_and_exit || is_restricted_ignored(opt->cb) || opt->cb == (void *)opt_lightningd_usage || opt->cb == (void *)test_subdaemons_and_exit /* FIXME: we can't recover this. */ || opt->cb == (void *)opt_clear_plugins) { /* These are not important */ } else if (opt->cb == (void *)opt_set_bool) { const bool *b = opt->u.carg; answer = tal_fmt(name0, "%s", *b ? "true" : "false"); } else if (opt->cb == (void *)opt_set_invbool) { const bool *b = opt->u.carg; answer = tal_fmt(name0, "%s", !*b ? "true" : "false"); } else if (opt->cb == (void *)opt_set_offline) { answer = tal_fmt(name0, "%s", (!ld->reconnect && !ld->listen) ? "true" : "false"); } else if (opt->cb == (void *)opt_start_daemon) { answer = tal_fmt(name0, "%s", ld->daemon_parent_fd == -1 ? "false" : "true"); } else if (opt->cb == (void *)opt_set_hsm_password) { json_add_bool(response, "encrypted-hsm", ld->encrypted_hsm); } else { /* Insert more decodes here! */ assert(!"A noarg option was added but was not handled"); } } else if (opt->type & OPT_HASARG) { if (opt->desc == opt_hidden) { /* Ignore hidden options (deprecated) */ } else if (opt->show) { strcpy(buf + OPT_SHOW_LEN, "..."); opt->show(buf, opt->u.carg); if (streq(buf, "true") || streq(buf, "false") || strspn(buf, "0123456789.") == strlen(buf)) { /* Let pure numbers and true/false through as * literals. */ json_add_literal(response, name0, buf, strlen(buf)); return; } /* opt_show_charp surrounds with "", strip them */ if (strstarts(buf, "\"")) { char *end = strrchr(buf, '"'); memmove(end, end + 1, strlen(end)); answer = buf + 1; } else answer = buf; } else if (opt->cb_arg == (void *)opt_set_talstr || opt->cb_arg == (void *)opt_set_charp || is_restricted_print_if_nonnull(opt->cb_arg)) { const char *arg = *(char **)opt->u.carg; if (arg) answer = tal_fmt(name0, "%s", arg); } else if (opt->cb_arg == (void *)opt_set_rgb) { if (ld->rgb) answer = tal_hexstr(name0, ld->rgb, 3); } else if (opt->cb_arg == (void *)opt_set_alias) { answer = (const char *)ld->alias; } else if (opt->cb_arg == (void *)arg_log_to_file) { answer = ld->logfile; } else if (opt->cb_arg == (void *)opt_add_addr) { json_add_opt_addrs(response, name0, ld->proposed_wireaddr, ld->proposed_listen_announce, ADDR_LISTEN_AND_ANNOUNCE); return; } else if (opt->cb_arg == (void *)opt_add_bind_addr) { json_add_opt_addrs(response, name0, ld->proposed_wireaddr, ld->proposed_listen_announce, ADDR_LISTEN); return; } else if (opt->cb_arg == (void *)opt_add_announce_addr) { json_add_opt_addrs(response, name0, ld->proposed_wireaddr, ld->proposed_listen_announce, ADDR_ANNOUNCE); return; } else if (opt->cb_arg == (void *)opt_subdaemon) { json_add_opt_subdaemons(response, name0, &ld->alt_subdaemons); return; } else if (opt->cb_arg == (void *)opt_add_proxy_addr) { if (ld->proxyaddr) answer = fmt_wireaddr(name0, ld->proxyaddr); } else if (opt->cb_arg == (void *)opt_add_plugin) { json_add_opt_plugins(response, ld->plugins); } else if (opt->cb_arg == (void *)opt_log_level) { json_add_opt_log_levels(response, ld->log); } else if (opt->cb_arg == (void *)opt_add_plugin_dir || opt->cb_arg == (void *)opt_disable_plugin || opt->cb_arg == (void *)plugin_opt_set) { /* FIXME: We actually treat it as if they specified * --plugin for each one, so ignore these */ #if DEVELOPER } else if (strstarts(name, "dev-")) { /* Ignore dev settings */ #endif } else { /* Insert more decodes here! */ abort(); } } if (answer) { struct json_escape *esc = json_escape(NULL, answer); json_add_escaped_string(response, name0, take(esc)); } } static struct command_result *json_listconfigs(struct command *cmd, const char *buffer, const jsmntok_t *obj UNNEEDED, const jsmntok_t *params) { size_t i; struct json_stream *response = NULL; const jsmntok_t *configtok; if (!param(cmd, buffer, params, p_opt("config", param_tok, &configtok), NULL)) return command_param_failed(); if (!configtok) { response = json_stream_success(cmd); json_add_string(response, "# version", version()); } for (i = 0; i < opt_count; i++) { unsigned int len; const char *name; /* FIXME: Print out comment somehow? */ if (opt_table[i].type == OPT_SUBTABLE) continue; for (name = first_name(opt_table[i].names, &len); name; name = next_name(name, &len)) { /* Skips over first -, so just need to look for one */ if (name[0] != '-') continue; if (configtok && !memeq(buffer + configtok->start, configtok->end - configtok->start, name + 1, len - 1)) continue; if (!response) response = json_stream_success(cmd); add_config(cmd->ld, response, &opt_table[i], name+1, len-1); } } if (configtok && !response) { return command_fail(cmd, JSONRPC2_INVALID_PARAMS, "Unknown config option '%.*s'", json_tok_full_len(configtok), json_tok_full(buffer, configtok)); } return command_success(cmd, response); } static const struct json_command listconfigs_command = { "listconfigs", "utility", json_listconfigs, "List all configuration options, or with [config], just that one.", .verbose = "listconfigs [config]\n" "Outputs an object, with each field a config options\n" "(Option names which start with # are comments)\n" "With [config], object only has that field" }; AUTODATA(json_command, &listconfigs_command);