Fix CLN service startup failure by trimming spaces in config parameters

Signed-off-by: Max Rantil <[email protected]>

ccan/ccan/tal/str/str.c

@@ -11,6 +11,7 @@
 #include <unistd.h>
 #include <stdio.h>
 #include <ccan/str/str.h>
+#include <stdbool.h>
 
 char *tal_strdup_(const tal_t *ctx, const char *p, const char *label)
 {
@@ -35,6 +36,37 @@ char *tal_strndup_(const tal_t *ctx, const char *p, size_t n, const char *label)
 	return ret;
 }
 
+bool trim_resize_str(char **ctxp) {
+	if (ctxp == NULL || *ctxp == NULL) {
+		return false;
+	}
+
+	char *str = *ctxp;
+	size_t len = strlen(str);
+
+	size_t start = 0;
+	while (start < len && isspace((unsigned char)str[start])) {
+		start++;
+	}
+
+	size_t end = len;
+	while (end > start && isspace((unsigned char)str[end - 1])) {
+		end--;
+	}
+
+	if (start > 0 || end < len) {
+		if (!tal_resize(ctxp, end - start + 1)) {
+			fprintf(stderr, "Failed to resize memory for trimmed string\n");
+			return false;
+		}
+		if (start > 0)
+			memmove(str, str + start, end - start);
+		str[end - start] = '\0';
+	}
+
+	return true;
+}
+
 char *tal_fmt_(const tal_t *ctx, const char *label, const char *fmt, ...)
 {
 	va_list ap;

ccan/ccan/tal/str/str.h

@@ -32,6 +32,16 @@ char *tal_strdup_(const tal_t *ctx, const char *p TAKES, const char *label);
 char *tal_strndup_(const tal_t *ctx, const char *p TAKES, size_t n,
 		   const char *label);
 
+/**
+ * trim_resize_str - Trim leading and trailing whitespace from a string and resize using tal.
+ * @ctxp: Pointer to a pointer of a tal allocated string.
+ *
+ * Returns:
+ *   - true if the string was modified and resized successfully or if no modification was needed.
+ *   - false if the input was NULL or if an error occurred during the resizing process.
+ */
+bool trim_resize_str(char **ctxp);
+
 /**
  * tal_fmt - allocate a formatted string
  * @ctx: NULL, or tal allocated object to be parent.

common/configdir.c

@@ -75,6 +75,11 @@ static struct configvar **gather_file_configvars(const tal_t *ctx,
 	/* Break into lines. */
 	lines = tal_strsplit(contents, contents, "\r\n", STR_EMPTY_OK);
 	for (size_t i = 0; i < tal_count(lines) - 1; i++) {
+		/* Trim and resize whitespace from the start and end of each line */
+		if (!trim_resize_str(&lines[i])) {
+			err(1, "Failed to trim and resize line %zu: \"%s\" in file %s", i, lines[i], filename);
+		}
+
 		/* Comments & blank lines*/
 		if (strstarts(lines[i], "#") || streq(lines[i], ""))
 			continue;

common/test/run-whitespaces-config.c

@@ -0,0 +1,188 @@
+#include "config.h"
+#include <ccan/ccan/tal/str/str.h>
+#include <common/setup.h>
+#include <assert.h>
+#include <stdio.h>
+#include "../bolt12.c"
+
+/* AUTOGENERATED MOCKS START */
+/* Generated stub for amount_asset_is_main */
+bool amount_asset_is_main(struct amount_asset *asset UNNEEDED)
+{ fprintf(stderr, "amount_asset_is_main called!\n"); abort(); }
+/* Generated stub for amount_asset_to_sat */
+struct amount_sat amount_asset_to_sat(struct amount_asset *asset UNNEEDED)
+{ fprintf(stderr, "amount_asset_to_sat called!\n"); abort(); }
+/* Generated stub for amount_feerate */
+ bool amount_feerate(u32 *feerate UNNEEDED, struct amount_sat fee UNNEEDED, size_t weight UNNEEDED)
+{ fprintf(stderr, "amount_feerate called!\n"); abort(); }
+/* Generated stub for amount_sat */
+struct amount_sat amount_sat(u64 satoshis UNNEEDED)
+{ fprintf(stderr, "amount_sat called!\n"); abort(); }
+/* Generated stub for amount_sat_add */
+ bool amount_sat_add(struct amount_sat *val UNNEEDED,
+				       struct amount_sat a UNNEEDED,
+				       struct amount_sat b UNNEEDED)
+{ fprintf(stderr, "amount_sat_add called!\n"); abort(); }
+/* Generated stub for amount_sat_eq */
+bool amount_sat_eq(struct amount_sat a UNNEEDED, struct amount_sat b UNNEEDED)
+{ fprintf(stderr, "amount_sat_eq called!\n"); abort(); }
+/* Generated stub for amount_sat_greater_eq */
+bool amount_sat_greater_eq(struct amount_sat a UNNEEDED, struct amount_sat b UNNEEDED)
+{ fprintf(stderr, "amount_sat_greater_eq called!\n"); abort(); }
+/* Generated stub for amount_sat_sub */
+ bool amount_sat_sub(struct amount_sat *val UNNEEDED,
+				       struct amount_sat a UNNEEDED,
+				       struct amount_sat b UNNEEDED)
+{ fprintf(stderr, "amount_sat_sub called!\n"); abort(); }
+/* Generated stub for amount_sat_to_asset */
+struct amount_asset amount_sat_to_asset(struct amount_sat *sat UNNEEDED, const u8 *asset UNNEEDED)
+{ fprintf(stderr, "amount_sat_to_asset called!\n"); abort(); }
+/* Generated stub for amount_tx_fee */
+struct amount_sat amount_tx_fee(u32 fee_per_kw UNNEEDED, size_t weight UNNEEDED)
+{ fprintf(stderr, "amount_tx_fee called!\n"); abort(); }
+/* Generated stub for features_unsupported */
+int features_unsupported(const struct feature_set *our_features UNNEEDED,
+			 const u8 *their_features UNNEEDED,
+			 enum feature_place p UNNEEDED)
+{ fprintf(stderr, "features_unsupported called!\n"); abort(); }
+/* Generated stub for from_bech32_charset */
+bool from_bech32_charset(const tal_t *ctx UNNEEDED,
+			 const char *bech32 UNNEEDED, size_t bech32_len UNNEEDED,
+			 char **hrp UNNEEDED, u8 **data UNNEEDED)
+{ fprintf(stderr, "from_bech32_charset called!\n"); abort(); }
+/* Generated stub for fromwire */
+const u8 *fromwire(const u8 **cursor UNNEEDED, size_t *max UNNEEDED, void *copy UNNEEDED, size_t n UNNEEDED)
+{ fprintf(stderr, "fromwire called!\n"); abort(); }
+/* Generated stub for fromwire_bigsize */
+bigsize_t fromwire_bigsize(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_bigsize called!\n"); abort(); }
+/* Generated stub for fromwire_bool */
+bool fromwire_bool(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_bool called!\n"); abort(); }
+/* Generated stub for fromwire_fail */
+void *fromwire_fail(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_fail called!\n"); abort(); }
+/* Generated stub for fromwire_pad */
+void fromwire_pad(const u8 **cursor UNNEEDED, size_t *max UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "fromwire_pad called!\n"); abort(); }
+/* Generated stub for fromwire_secp256k1_ecdsa_signature */
+void fromwire_secp256k1_ecdsa_signature(const u8 **cursor UNNEEDED, size_t *max UNNEEDED,
+					secp256k1_ecdsa_signature *signature UNNEEDED)
+{ fprintf(stderr, "fromwire_secp256k1_ecdsa_signature called!\n"); abort(); }
+/* Generated stub for fromwire_sha256 */
+void fromwire_sha256(const u8 **cursor UNNEEDED, size_t *max UNNEEDED, struct sha256 *sha256 UNNEEDED)
+{ fprintf(stderr, "fromwire_sha256 called!\n"); abort(); }
+/* Generated stub for fromwire_tal_arrn */
+u8 *fromwire_tal_arrn(const tal_t *ctx UNNEEDED,
+		       const u8 **cursor UNNEEDED, size_t *max UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "fromwire_tal_arrn called!\n"); abort(); }
+/* Generated stub for fromwire_tlv_invoice */
+struct tlv_invoice *fromwire_tlv_invoice(const tal_t *ctx UNNEEDED,
+						  const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_tlv_invoice called!\n"); abort(); }
+/* Generated stub for fromwire_tlv_invoice_request */
+struct tlv_invoice_request *fromwire_tlv_invoice_request(const tal_t *ctx UNNEEDED,
+						  const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_tlv_invoice_request called!\n"); abort(); }
+/* Generated stub for fromwire_tlv_offer */
+struct tlv_offer *fromwire_tlv_offer(const tal_t *ctx UNNEEDED,
+						  const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_tlv_offer called!\n"); abort(); }
+/* Generated stub for fromwire_u32 */
+u32 fromwire_u32(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_u32 called!\n"); abort(); }
+/* Generated stub for fromwire_u64 */
+u64 fromwire_u64(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_u64 called!\n"); abort(); }
+/* Generated stub for fromwire_u8 */
+u8 fromwire_u8(const u8 **cursor UNNEEDED, size_t *max UNNEEDED)
+{ fprintf(stderr, "fromwire_u8 called!\n"); abort(); }
+/* Generated stub for fromwire_u8_array */
+void fromwire_u8_array(const u8 **cursor UNNEEDED, size_t *max UNNEEDED, u8 *arr UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "fromwire_u8_array called!\n"); abort(); }
+/* Generated stub for merkle_tlv */
+void merkle_tlv(const struct tlv_field *fields UNNEEDED, struct sha256 *merkle UNNEEDED)
+{ fprintf(stderr, "merkle_tlv called!\n"); abort(); }
+/* Generated stub for sighash_from_merkle */
+void sighash_from_merkle(const char *messagename UNNEEDED,
+			 const char *fieldname UNNEEDED,
+			 const struct sha256 *merkle UNNEEDED,
+			 struct sha256 *sighash UNNEEDED)
+{ fprintf(stderr, "sighash_from_merkle called!\n"); abort(); }
+/* Generated stub for to_bech32_charset */
+char *to_bech32_charset(const tal_t *ctx UNNEEDED,
+			const char *hrp UNNEEDED, const u8 *data UNNEEDED)
+{ fprintf(stderr, "to_bech32_charset called!\n"); abort(); }
+/* Generated stub for towire */
+void towire(u8 **pptr UNNEEDED, const void *data UNNEEDED, size_t len UNNEEDED)
+{ fprintf(stderr, "towire called!\n"); abort(); }
+/* Generated stub for towire_bool */
+void towire_bool(u8 **pptr UNNEEDED, bool v UNNEEDED)
+{ fprintf(stderr, "towire_bool called!\n"); abort(); }
+/* Generated stub for towire_secp256k1_ecdsa_signature */
+void towire_secp256k1_ecdsa_signature(u8 **pptr UNNEEDED,
+			      const secp256k1_ecdsa_signature *signature UNNEEDED)
+{ fprintf(stderr, "towire_secp256k1_ecdsa_signature called!\n"); abort(); }
+/* Generated stub for towire_sha256 */
+void towire_sha256(u8 **pptr UNNEEDED, const struct sha256 *sha256 UNNEEDED)
+{ fprintf(stderr, "towire_sha256 called!\n"); abort(); }
+/* Generated stub for towire_tlv_invoice */
+void towire_tlv_invoice(u8 **pptr UNNEEDED, const struct tlv_invoice *record UNNEEDED)
+{ fprintf(stderr, "towire_tlv_invoice called!\n"); abort(); }
+/* Generated stub for towire_tlv_invoice_request */
+void towire_tlv_invoice_request(u8 **pptr UNNEEDED, const struct tlv_invoice_request *record UNNEEDED)
+{ fprintf(stderr, "towire_tlv_invoice_request called!\n"); abort(); }
+/* Generated stub for towire_tlv_offer */
+void towire_tlv_offer(u8 **pptr UNNEEDED, const struct tlv_offer *record UNNEEDED)
+{ fprintf(stderr, "towire_tlv_offer called!\n"); abort(); }
+/* Generated stub for towire_u32 */
+void towire_u32(u8 **pptr UNNEEDED, u32 v UNNEEDED)
+{ fprintf(stderr, "towire_u32 called!\n"); abort(); }
+/* Generated stub for towire_u64 */
+void towire_u64(u8 **pptr UNNEEDED, u64 v UNNEEDED)
+{ fprintf(stderr, "towire_u64 called!\n"); abort(); }
+/* Generated stub for towire_u8 */
+void towire_u8(u8 **pptr UNNEEDED, u8 v UNNEEDED)
+{ fprintf(stderr, "towire_u8 called!\n"); abort(); }
+/* Generated stub for towire_u8_array */
+void towire_u8_array(u8 **pptr UNNEEDED, const u8 *arr UNNEEDED, size_t num UNNEEDED)
+{ fprintf(stderr, "towire_u8_array called!\n"); abort(); }
+/* AUTOGENERATED MOCKS END */
+
+static void test_trim_resize_str(void)
+{
+    char *str1 = tal_strdup(NULL, "  hello  ");
+    char *str2 = tal_strdup(NULL, "world");
+    char *str3 = tal_strdup(NULL, "   ");
+    char *str4 = tal_strdup(NULL, "  trimmed string   ");
+    char *str5 = NULL; // Test NULL input
+
+    assert(trim_resize_str(&str1));
+    assert(strcmp(str1, "hello") == 0);
+
+    assert(trim_resize_str(&str2));
+    assert(strcmp(str2, "world") == 0);
+
+    assert(trim_resize_str(&str3));
+    assert(strcmp(str3, "") == 0);
+
+    assert(trim_resize_str(&str4));
+    assert(strcmp(str4, "trimmed string") == 0);
+
+    assert(!trim_resize_str(&str5)); // Expect false for NULL input
+
+    tal_free(str1);
+    tal_free(str2);
+    tal_free(str3);
+    tal_free(str4);
+}
+
+int main(int argc, char *argv[])
+{
+    common_setup(argv[0]);
+
+    test_trim_resize_str();
+
+    common_shutdown();
+    return 0;
+}

contrib/startup_regtest.sh

@@ -196,7 +196,7 @@ start_nodes() {
 		funder-min-their-funding=10000
 		funder-per-channel-max=100000
 		funder-fuzz-percent=0
-funder-lease-requests-only=false
+		funder-lease-requests-only=false
 		lease-fee-base-sat=2sat
 		lease-fee-basis=50
 		invoices-onchain-fallback

tests/test_misc.py

@@ -3767,6 +3767,29 @@ def test_fast_shutdown(node_factory):
         break
 
 
+def test_config_whitespace(node_factory):
+    l1 = node_factory.get_node()
+    configfile = os.path.join(l1.daemon.opts.get("lightning-dir"), TEST_NETWORK, 'config')
+
+    l1.stop()
+
+    with open(configfile, "a") as f:
+        f.write("\n\n# Test whitespace\n")
+        f.write("log-level=debug\n")
+        f.write("funder-policy-mod=100             \n")
+        f.write("    funder-min-their-funding=10000\n")
+        f.write("  allow-deprecated-apis=false     \n")
+        f.write("    \n")
+        f.write("\n\n")
+
+    l1.start()
+
+    # Verify config file is trimmed
+    with open(configfile, "r") as f:
+        lines = f.readlines()
+        assert all(line == line.strip() + '\n' for line in lines if line), "Config file should not contain leading or trailing whitespaces"
+
+
 def test_setconfig(node_factory, bitcoind):
     l1, l2 = node_factory.line_graph(2, fundchannel=False)
     configfile = os.path.join(l2.daemon.opts.get("lightning-dir"), TEST_NETWORK, 'config')