Added upfront_shutdown_wallet_index to support validation of ready_channel

Author: ksedgwic

contrib/remote_hsmd/hsmd.c

@@ -1333,6 +1333,7 @@ static struct io_plan *handle_ready_channel(struct io_conn *conn,
 	u16 funding_txout;
 	u16 local_to_self_delay;
 	u8 *local_shutdown_script;
+	u32 local_shutdown_wallet_index;
 	struct basepoints remote_basepoints;
 	struct pubkey remote_funding_pubkey;
 	u16 remote_to_self_delay;
@@ -1344,6 +1345,7 @@ static struct io_plan *handle_ready_channel(struct io_conn *conn,
 					&channel_value, &push_value, &funding_txid,
 					&funding_txout, &local_to_self_delay,
 					&local_shutdown_script,
+					&local_shutdown_wallet_index,
 					&remote_basepoints,
 					&remote_funding_pubkey,
 					&remote_to_self_delay,
@@ -1361,6 +1363,7 @@ static struct io_plan *handle_ready_channel(struct io_conn *conn,
 		funding_txout,
 		local_to_self_delay,	// locally imposed on counterparty to_self outputs
 		local_shutdown_script,
+		local_shutdown_wallet_index,
 		&remote_basepoints,
 		&remote_funding_pubkey,
 		remote_to_self_delay,	// counterparty imposed on our to_self outputs

contrib/remote_hsmd/proxy.cc

@@ -569,6 +569,7 @@ proxy_stat proxy_handle_ready_channel(
 	u16 funding_txout,
 	u16 holder_to_self_delay,
 	u8 *holder_shutdown_script,
+	u32 holder_shutdown_wallet_index,
 	struct basepoints *counterparty_basepoints,
 	struct pubkey *counterparty_funding_pubkey,
 	u16 counterparty_to_self_delay,
@@ -582,7 +583,9 @@ proxy_stat proxy_handle_ready_channel(
 		"\"is_outbound\":%s, \"channel_value\":%" PRIu64 ", "
 		"\"push_value\":%" PRIu64 ", "
 		"\"funding_txid\":%s, \"funding_txout\":%d, "
-		"\"holder_to_self_delay\":%d, \"holder_shutdown_script\":%s, "
+		"\"holder_to_self_delay\":%d, "
+		"\"holder_shutdown_script\":%s, "
+		"\"holder_shutdown_wallet_index\":%d, "
 		"\"counterparty_basepoints\":%s, "
 		"\"counterparty_funding_pubkey\":%s, "
 		"\"counterparty_to_self_delay\":%d, "
@@ -601,6 +604,7 @@ proxy_stat proxy_handle_ready_channel(
 		holder_to_self_delay,
 		dump_hex(holder_shutdown_script,
 			 tal_count(holder_shutdown_script)).c_str(),
+		holder_shutdown_wallet_index,
 		dump_basepoints(counterparty_basepoints).c_str(),
 		dump_pubkey(counterparty_funding_pubkey).c_str(),
 		counterparty_to_self_delay,
@@ -622,6 +626,8 @@ proxy_stat proxy_handle_ready_channel(
 	req.set_holder_selected_contest_delay(holder_to_self_delay);
 	marshal_script(holder_shutdown_script,
 		       req.mutable_holder_shutdown_script());
+	if (holder_shutdown_wallet_index != UINT32_MAX)
+		req.add_holder_shutdown_key_path(holder_shutdown_wallet_index);
 	marshal_basepoints(counterparty_basepoints, counterparty_funding_pubkey,
 			   req.mutable_counterparty_basepoints());
 	req.set_counterparty_selected_contest_delay(counterparty_to_self_delay);

contrib/remote_hsmd/proxy.hpp

@@ -71,6 +71,7 @@ proxy_stat proxy_handle_ready_channel(
 	u16 funding_txout,
 	u16 local_to_self_delay,
 	u8 *local_shutdown_script,
+	u32 local_shutdown_wallet_index,
 	struct basepoints *remote_basepoints,
 	struct pubkey *remote_funding_pubkey,
 	u16 remote_to_self_delay,

hsmd/hsmd_wire.csv

@@ -63,6 +63,7 @@ msgdata,hsmd_ready_channel,funding_txout,u16,
 msgdata,hsmd_ready_channel,local_to_self_delay,u16,
 msgdata,hsmd_ready_channel,local_shutdown_script_len,u16,
 msgdata,hsmd_ready_channel,local_shutdown_script,u8,local_shutdown_script_len
+msgdata,hsmd_ready_channel,local_shutdown_wallet_index,u32,
 msgdata,hsmd_ready_channel,remote_basepoints,basepoints,
 msgdata,hsmd_ready_channel,remote_funding_pubkey,pubkey,
 msgdata,hsmd_ready_channel,remote_to_self_delay,u16,

hsmd/libhsmd.c

@@ -310,6 +310,7 @@ static u8 *handle_ready_channel(struct hsmd_client *c, const u8 *msg_in)
 	u16 funding_txout;
 	u16 local_to_self_delay;
 	u8 *local_shutdown_script;
+	u32 local_shutdown_wallet_index;
 	struct basepoints remote_basepoints;
 	struct pubkey remote_funding_pubkey;
 	u16 remote_to_self_delay;
@@ -322,6 +323,7 @@ static u8 *handle_ready_channel(struct hsmd_client *c, const u8 *msg_in)
 					&channel_value, &push_value, &funding_txid,
 					&funding_txout, &local_to_self_delay,
 					&local_shutdown_script,
+					&local_shutdown_wallet_index,
 					&remote_basepoints,
 					&remote_funding_pubkey,
 					&remote_to_self_delay,

lightningd/opening_control.c

@@ -683,9 +683,19 @@ openchannel_hook_final(struct openchannel_hook_payload *payload STEALS)
 		uc->got_offer = true;
 	}
 
+	// Determine the wallet index for our upfront_shutdown_script, UINT32_MAX if not found.
+	u32 upfront_shutdown_script_wallet_index = UINT32_MAX;
+	bool is_p2sh;
+	wallet_can_spend(
+		payload->openingd->ld->wallet,
+		our_upfront_shutdown_script,
+		&upfront_shutdown_script_wallet_index,
+		&is_p2sh);
+
 	subd_send_msg(openingd,
 		      take(towire_openingd_got_offer_reply(NULL, errmsg,
-							  our_upfront_shutdown_script)));
+							   our_upfront_shutdown_script,
+							   upfront_shutdown_script_wallet_index)));
 }
 
 static bool
@@ -774,8 +784,9 @@ static void opening_got_offer(struct subd *openingd,
 	/* Tell them they can't open, if we already have open channel. */
 	if (peer_active_channel(uc->peer)) {
 		subd_send_msg(openingd,
-			      take(towire_openingd_got_offer_reply(NULL,
-					  "Already have active channel", NULL)));
+			      take(towire_openingd_got_offer_reply(
+					   NULL, "Already have active channel",
+					   NULL, UINT32_MAX)));
 		return;
 	}
 
@@ -1263,10 +1274,20 @@ static struct command_result *json_fundchannel_start(struct command *cmd,
 		fc->our_upfront_shutdown_script
 			= tal_steal(fc, fc->our_upfront_shutdown_script);
 
+	// Determine the wallet index for our upfront_shutdown_script, UINT32_MAX if not found.
+	u32 upfront_shutdown_script_wallet_index = UINT32_MAX;
+	bool is_p2sh;
+	wallet_can_spend(
+		fc->cmd->ld->wallet,
+		fc->our_upfront_shutdown_script,
+		&upfront_shutdown_script_wallet_index,
+		&is_p2sh);
+
 	msg = towire_openingd_funder_start(NULL,
 					  *amount,
 					  fc->push,
 					  fc->our_upfront_shutdown_script,
+					  upfront_shutdown_script_wallet_index,
 					  *feerate_per_kw,
 					  fc->channel_flags);
 

openingd/openingd.c

@@ -105,6 +105,9 @@ struct state {
 	/* If non-NULL, this is the scriptpubkey we/they *must* close with */
 	u8 *upfront_shutdown_script[NUM_SIDES];
 
+	/* If not UINT32_MAX, the wallet index for the LOCAL script */
+	u32 local_upfront_shutdown_wallet_index;
+
 	/* This is a cluster of fields in open_channel and accept_channel which
 	 * indicate the restrictions each side places on the channel. */
 	struct channel_config localconf, remoteconf;
@@ -541,6 +544,7 @@ static bool funder_finalize_channel_setup(struct state *state,
 				       state->funding_txout,
 				       state->localconf.to_self_delay,
 				       state->upfront_shutdown_script[LOCAL],
+				       state->local_upfront_shutdown_wallet_index,
 				       &state->their_points,
 				       &state->their_funding_pubkey,
 				       state->remoteconf.to_self_delay,
@@ -991,7 +995,8 @@ static u8 *fundee_channel(struct state *state, const u8 *open_channel_msg)
 	/* We don't allocate off tmpctx, because that's freed inside
 	 * opening_negotiate_msg */
 	if (!fromwire_openingd_got_offer_reply(state, msg, &err_reason,
-					      &state->upfront_shutdown_script[LOCAL]))
+					      &state->upfront_shutdown_script[LOCAL],
+					      &state->local_upfront_shutdown_wallet_index))
 		master_badmsg(WIRE_OPENINGD_GOT_OFFER_REPLY, msg);
 
 	/* If they give us a reason to reject, do so. */
@@ -1071,6 +1076,7 @@ static u8 *fundee_channel(struct state *state, const u8 *open_channel_msg)
 				       state->funding_txout,
 				       state->localconf.to_self_delay,
 				       state->upfront_shutdown_script[LOCAL],
+				       state->local_upfront_shutdown_wallet_index,
 				       &theirs,
 				       &their_funding_pubkey,
 				       state->remoteconf.to_self_delay,
@@ -1353,6 +1359,7 @@ static u8 *handle_master_in(struct state *state)
 		if (!fromwire_openingd_funder_start(state, msg, &state->funding,
 						   &state->push_msat,
 						   &state->upfront_shutdown_script[LOCAL],
+						   &state->local_upfront_shutdown_wallet_index,
 						   &state->feerate_per_kw,
 						   &channel_flags))
 			master_badmsg(WIRE_OPENINGD_FUNDER_START, msg);

openingd/openingd_wire.csv

@@ -55,6 +55,7 @@ msgtype,openingd_got_offer_reply,6105
 msgdata,openingd_got_offer_reply,rejection,?wirestring,
 msgdata,openingd_got_offer_reply,shutdown_len,u16,
 msgdata,openingd_got_offer_reply,our_shutdown_scriptpubkey,?u8,shutdown_len
+msgdata,openingd_got_offer_reply,our_shutdown_wallet_index,u32,
 
 #include <common/penalty_base.h>
 # Openingd->master: we've successfully offered channel.
@@ -85,6 +86,7 @@ msgdata,openingd_funder_start,funding_satoshis,amount_sat,
 msgdata,openingd_funder_start,push_msat,amount_msat,
 msgdata,openingd_funder_start,len_upfront,u16,
 msgdata,openingd_funder_start,upfront_shutdown_script,u8,len_upfront
+msgdata,openingd_funder_start,upfront_shutdown_wallet_index,u32,
 msgdata,openingd_funder_start,feerate_per_kw,u32,
 msgdata,openingd_funder_start,channel_flags,u8,
 

tests/test_connection.py

@@ -1501,6 +1501,7 @@ def test_funding_v2_cancel_race(node_factory, bitcoind, executor):
 @pytest.mark.openchannel('v1')
 @pytest.mark.openchannel('v2')
 @unittest.skipIf(TEST_NETWORK != 'regtest', "External wallet support doesn't work with elements yet.")
+@unittest.skipIf(os.getenv('SUBDAEMON') == 'hsmd:remote_hsmd', "remote_hsmd can't handle random external addresses (allowlist)")
 def test_funding_close_upfront(node_factory, bitcoind):
     opts = {'plugin': os.path.join(os.getcwd(), 'tests/plugins/openchannel_hook_accepter.py')}