Skip to content

Commit b41c2fb

Browse files
matchacactusmatchacactus
committed
Add commit_upfront_shutdown_pubkey to ChannelHandshakeConfig
1 parent 89cbb6d commit b41c2fb

File tree

4 files changed

+55
-27
lines changed

4 files changed

+55
-27
lines changed

‎lightning/src/ln/chanmon_update_fail_tests.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -2461,7 +2461,7 @@ fn test_temporary_error_during_shutdown() {
24612461
// Test that temporary failures when updating the monitor's shutdown script delay cooperative
24622462
// close.
24632463
let mut config = test_default_channel_config();
2464-
config.channel_options.commit_upfront_shutdown_pubkey = false;
2464+
config.own_channel_config.commit_upfront_shutdown_pubkey = false;
24652465

24662466
let chanmon_cfgs = create_chanmon_cfgs(2);
24672467
let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
@@ -2516,7 +2516,7 @@ fn test_permanent_error_during_sending_shutdown() {
25162516
// Test that permanent failures when updating the monitor's shutdown script result in a force
25172517
// close when initiating a cooperative close.
25182518
let mut config = test_default_channel_config();
2519-
config.channel_options.commit_upfront_shutdown_pubkey = false;
2519+
config.own_channel_config.commit_upfront_shutdown_pubkey = false;
25202520

25212521
let chanmon_cfgs = create_chanmon_cfgs(2);
25222522
let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
@@ -2537,7 +2537,7 @@ fn test_permanent_error_during_handling_shutdown() {
25372537
// Test that permanent failures when updating the monitor's shutdown script result in a force
25382538
// close when handling a cooperative close.
25392539
let mut config = test_default_channel_config();
2540-
config.channel_options.commit_upfront_shutdown_pubkey = false;
2540+
config.own_channel_config.commit_upfront_shutdown_pubkey = false;
25412541

25422542
let chanmon_cfgs = create_chanmon_cfgs(2);
25432543
let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);

‎lightning/src/ln/channel.rs

+28-5
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,7 @@ pub(super) struct Channel<Signer: Sign> {
425425
pub(crate) config: ChannelConfig,
426426
#[cfg(not(any(test, feature = "_test_utils")))]
427427
config: ChannelConfig,
428+
commit_upfront_shutdown_pubkey: bool,
428429

429430
user_id: u64,
430431

@@ -751,7 +752,7 @@ impl<Signer: Sign> Channel<Signer> {
751752
let mut secp_ctx = Secp256k1::new();
752753
secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
753754

754-
let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
755+
let shutdown_scriptpubkey = if config.own_channel_config.commit_upfront_shutdown_pubkey {
755756
Some(keys_provider.get_shutdown_scriptpubkey())
756757
} else { None };
757758

@@ -764,6 +765,7 @@ impl<Signer: Sign> Channel<Signer> {
764765
Ok(Channel {
765766
user_id,
766767
config: config.channel_options.clone(),
768+
commit_upfront_shutdown_pubkey: config.own_channel_config.commit_upfront_shutdown_pubkey.clone(),
767769

768770
channel_id: keys_provider.get_secure_random_bytes(),
769771
channel_state: ChannelState::OurInitSent as u32,
@@ -1046,7 +1048,7 @@ impl<Signer: Sign> Channel<Signer> {
10461048
}
10471049
} else { None };
10481050

1049-
let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
1051+
let shutdown_scriptpubkey = if config.own_channel_config.commit_upfront_shutdown_pubkey {
10501052
Some(keys_provider.get_shutdown_scriptpubkey())
10511053
} else { None };
10521054

@@ -1061,8 +1063,9 @@ impl<Signer: Sign> Channel<Signer> {
10611063

10621064
let chan = Channel {
10631065
user_id,
1064-
config: local_config,
10651066

1067+
config: local_config,
1068+
commit_upfront_shutdown_pubkey: config.own_channel_config.commit_upfront_shutdown_pubkey,
10661069
channel_id: msg.temporary_channel_id,
10671070
channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
10681071
secp_ctx,
@@ -5191,7 +5194,7 @@ impl<Signer: Sign> Writeable for Channel<Signer> {
51915194
self.config.forwarding_fee_proportional_millionths.write(writer)?;
51925195
self.config.cltv_expiry_delta.write(writer)?;
51935196
self.config.announced_channel.write(writer)?;
5194-
self.config.commit_upfront_shutdown_pubkey.write(writer)?;
5197+
self.commit_upfront_shutdown_pubkey.write(writer)?;
51955198

51965199
self.channel_id.write(writer)?;
51975200
(self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
@@ -5434,6 +5437,7 @@ impl<Signer: Sign> Writeable for Channel<Signer> {
54345437
(9, self.target_closing_feerate_sats_per_kw, option),
54355438
(11, self.monitor_pending_finalized_fulfills, vec_type),
54365439
(13, self.channel_creation_height, required),
5440+
(15, self.commit_upfront_shutdown_pubkey, required),
54375441
});
54385442

54395443
Ok(())
@@ -5455,7 +5459,7 @@ impl<'a, Signer: Sign, K: Deref> ReadableArgs<(&'a K, u32)> for Channel<Signer>
54555459
config.as_mut().unwrap().forwarding_fee_proportional_millionths = Readable::read(reader)?;
54565460
config.as_mut().unwrap().cltv_expiry_delta = Readable::read(reader)?;
54575461
config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
5458-
config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
5462+
config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Some(Readable::read(reader)?);
54595463
} else {
54605464
// Read the 8 bytes of backwards-compatibility ChannelConfig data.
54615465
let mut _val: u64 = Readable::read(reader)?;
@@ -5675,6 +5679,7 @@ impl<'a, Signer: Sign, K: Deref> ReadableArgs<(&'a K, u32)> for Channel<Signer>
56755679
// only, so we default to that if none was written.
56765680
let mut channel_type = Some(ChannelTypeFeatures::only_static_remote_key());
56775681
let mut channel_creation_height = Some(serialized_height);
5682+
let mut commit_upfront_shutdown_pubkey = None;
56785683
read_tlv_fields!(reader, {
56795684
(0, announcement_sigs, option),
56805685
(1, minimum_depth, option),
@@ -5687,6 +5692,7 @@ impl<'a, Signer: Sign, K: Deref> ReadableArgs<(&'a K, u32)> for Channel<Signer>
56875692
(9, target_closing_feerate_sats_per_kw, option),
56885693
(11, monitor_pending_finalized_fulfills, vec_type),
56895694
(13, channel_creation_height, option),
5695+
(15, commit_upfront_shutdown_pubkey, option),
56905696
});
56915697

56925698
let chan_features = channel_type.as_ref().unwrap();
@@ -5701,13 +5707,30 @@ impl<'a, Signer: Sign, K: Deref> ReadableArgs<(&'a K, u32)> for Channel<Signer>
57015707
return Err(DecodeError::InvalidValue);
57025708
}
57035709

5710+
if commit_upfront_shutdown_pubkey.is_none() {
5711+
// commit_upfront_shutdown_pubkey has moved around a good bit, in version 1
5712+
// serialization, it was written out as a part of the explicit field list of the
5713+
// `ChannelConfig`. Then, it was written out as a field in the `ChannelConfig` itself.
5714+
// Now, it is written out explicitly as its own TLV (as the field has moved to
5715+
// `ChannelHandshakeConfig`).
5716+
// Thus, if its not in a TLV, we here pull it from the `ChannelConfig`, and if we can't
5717+
// find it at all, fail.
5718+
let legacy_commit_upfront_shutdown_pubkey = config.as_ref().unwrap().commit_upfront_shutdown_pubkey;
5719+
if let Some(val) = legacy_commit_upfront_shutdown_pubkey {
5720+
commit_upfront_shutdown_pubkey = Some(val);
5721+
} else {
5722+
return Err(DecodeError::InvalidValue);
5723+
}
5724+
}
5725+
57045726
let mut secp_ctx = Secp256k1::new();
57055727
secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
57065728

57075729
Ok(Channel {
57085730
user_id,
57095731

57105732
config: config.unwrap(),
5733+
commit_upfront_shutdown_pubkey: commit_upfront_shutdown_pubkey.unwrap(),
57115734
channel_id,
57125735
channel_state,
57135736
secp_ctx,

‎lightning/src/ln/shutdown_tests.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ fn test_upfront_shutdown_script() {
404404
let mut config = UserConfig::default();
405405
config.channel_options.announced_channel = true;
406406
config.peer_channel_config_limits.force_announced_channel_preference = false;
407-
config.channel_options.commit_upfront_shutdown_pubkey = false;
407+
config.own_channel_config.commit_upfront_shutdown_pubkey = false;
408408
let user_cfgs = [None, Some(config), None];
409409
let chanmon_cfgs = create_chanmon_cfgs(3);
410410
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
@@ -569,7 +569,7 @@ fn test_segwit_v0_shutdown_script() {
569569
let mut config = UserConfig::default();
570570
config.channel_options.announced_channel = true;
571571
config.peer_channel_config_limits.force_announced_channel_preference = false;
572-
config.channel_options.commit_upfront_shutdown_pubkey = false;
572+
config.own_channel_config.commit_upfront_shutdown_pubkey = false;
573573
let user_cfgs = [None, Some(config), None];
574574
let chanmon_cfgs = create_chanmon_cfgs(3);
575575
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
@@ -604,7 +604,7 @@ fn test_anysegwit_shutdown_script() {
604604
let mut config = UserConfig::default();
605605
config.channel_options.announced_channel = true;
606606
config.peer_channel_config_limits.force_announced_channel_preference = false;
607-
config.channel_options.commit_upfront_shutdown_pubkey = false;
607+
config.own_channel_config.commit_upfront_shutdown_pubkey = false;
608608
let user_cfgs = [None, Some(config), None];
609609
let chanmon_cfgs = create_chanmon_cfgs(3);
610610
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
@@ -639,7 +639,7 @@ fn test_unsupported_anysegwit_shutdown_script() {
639639
let mut config = UserConfig::default();
640640
config.channel_options.announced_channel = true;
641641
config.peer_channel_config_limits.force_announced_channel_preference = false;
642-
config.channel_options.commit_upfront_shutdown_pubkey = false;
642+
config.own_channel_config.commit_upfront_shutdown_pubkey = false;
643643
let user_cfgs = [None, Some(config), None];
644644
let chanmon_cfgs = create_chanmon_cfgs(3);
645645
let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
@@ -681,7 +681,7 @@ fn test_invalid_shutdown_script() {
681681
let mut config = UserConfig::default();
682682
config.channel_options.announced_channel = true;
683683
config.peer_channel_config_limits.force_announced_channel_preference = false;
684-
config.channel_options.commit_upfront_shutdown_pubkey = false;
684+
config.own_channel_config.commit_upfront_shutdown_pubkey = false;
685685
let user_cfgs = [None, Some(config), None];
686686
let chanmon_cfgs = create_chanmon_cfgs(3);
687687
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);

‎lightning/src/util/config.rs

+19-14
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,20 @@ pub struct ChannelHandshakeConfig {
4747
/// Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
4848
/// by the protocol.
4949
pub our_htlc_minimum_msat: u64,
50+
/// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
51+
/// supports it, they will then enforce the mutual-close output to us matches what we provided
52+
/// at intialization, preventing us from closing to an alternate pubkey.
53+
///
54+
/// This is set to true by default to provide a slight increase in security, though ultimately
55+
/// any attacker who is able to take control of a channel can just as easily send the funds via
56+
/// lightning payments, so we never require that our counterparties support this option.
57+
///
58+
/// This cannot be changed after a channel has been initialized.
59+
///
60+
/// The upfront key committed is provided from [`KeysInterface::get_shutdown_pubkey`]
61+
///
62+
/// Default value: true.
63+
pub commit_upfront_shutdown_pubkey: bool
5064
}
5165

5266
impl Default for ChannelHandshakeConfig {
@@ -55,6 +69,7 @@ impl Default for ChannelHandshakeConfig {
5569
minimum_depth: 6,
5670
our_to_self_delay: BREAKDOWN_TIMEOUT,
5771
our_htlc_minimum_msat: 1,
72+
commit_upfront_shutdown_pubkey: true
5873
}
5974
}
6075
}
@@ -195,18 +210,8 @@ pub struct ChannelConfig {
195210
///
196211
/// Default value: false.
197212
pub announced_channel: bool,
198-
/// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
199-
/// supports it, they will then enforce the mutual-close output to us matches what we provided
200-
/// at intialization, preventing us from closing to an alternate pubkey.
201-
///
202-
/// This is set to true by default to provide a slight increase in security, though ultimately
203-
/// any attacker who is able to take control of a channel can just as easily send the funds via
204-
/// lightning payments, so we never require that our counterparties support this option.
205-
///
206-
/// This cannot be changed after a channel has been initialized.
207-
///
208-
/// Default value: true.
209-
pub commit_upfront_shutdown_pubkey: bool,
213+
/// This value is moved to ChannelHandshakeConfig, optional here for old serialiization
214+
pub(crate) commit_upfront_shutdown_pubkey: Option<bool>,
210215
/// Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
211216
/// small to claim on-chain.
212217
///
@@ -256,7 +261,7 @@ impl Default for ChannelConfig {
256261
forwarding_fee_base_msat: 1000,
257262
cltv_expiry_delta: 6 * 12, // 6 blocks/hour * 12 hours
258263
announced_channel: false,
259-
commit_upfront_shutdown_pubkey: true,
264+
commit_upfront_shutdown_pubkey: None,
260265
max_dust_htlc_exposure_msat: 5_000_000,
261266
force_close_avoidance_max_fee_satoshis: 1000,
262267
}
@@ -269,7 +274,7 @@ impl_writeable_tlv_based!(ChannelConfig, {
269274
(2, cltv_expiry_delta, required),
270275
(3, force_close_avoidance_max_fee_satoshis, (default_value, 1000)),
271276
(4, announced_channel, required),
272-
(6, commit_upfront_shutdown_pubkey, required),
277+
(6, commit_upfront_shutdown_pubkey, option),
273278
(8, forwarding_fee_base_msat, required),
274279
});
275280

0 commit comments

Comments
 (0)