]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/util/scid_utils.rs
Merge pull request #1842 from jkczyz/2022-11-channel-monitor-docs
[rust-lightning] / lightning / src / util / scid_utils.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 /// Maximum block height that can be used in a `short_channel_id`. This
11 /// value is based on the 3-bytes available for block height.
12 pub const MAX_SCID_BLOCK: u64 = 0x00ffffff;
13
14 /// Maximum transaction index that can be used in a `short_channel_id`.
15 /// This value is based on the 3-bytes available for tx index.
16 pub const MAX_SCID_TX_INDEX: u64 = 0x00ffffff;
17
18 /// Maximum vout index that can be used in a `short_channel_id`. This
19 /// value is based on the 2-bytes available for the vout index.
20 pub const MAX_SCID_VOUT_INDEX: u64 = 0xffff;
21
22 /// A `short_channel_id` construction error
23 #[derive(Debug, PartialEq, Eq)]
24 pub enum ShortChannelIdError {
25         BlockOverflow,
26         TxIndexOverflow,
27         VoutIndexOverflow,
28 }
29
30 /// Extracts the block height (most significant 3-bytes) from the `short_channel_id`
31 pub fn block_from_scid(short_channel_id: &u64) -> u32 {
32         return (short_channel_id >> 40) as u32;
33 }
34
35 /// Extracts the tx index (bytes [2..4]) from the `short_channel_id`
36 pub fn tx_index_from_scid(short_channel_id: &u64) -> u32 {
37         return ((short_channel_id >> 16) & MAX_SCID_TX_INDEX) as u32;
38 }
39
40 /// Extracts the vout (bytes [0..2]) from the `short_channel_id`
41 pub fn vout_from_scid(short_channel_id: &u64) -> u16 {
42         return ((short_channel_id) & MAX_SCID_VOUT_INDEX) as u16;
43 }
44
45 /// Constructs a `short_channel_id` using the components pieces. Results in an error
46 /// if the block height, tx index, or vout index overflow the maximum sizes.
47 pub fn scid_from_parts(block: u64, tx_index: u64, vout_index: u64) -> Result<u64, ShortChannelIdError> {
48         if block > MAX_SCID_BLOCK {
49                 return Err(ShortChannelIdError::BlockOverflow);
50         }
51
52         if tx_index > MAX_SCID_TX_INDEX {
53                 return Err(ShortChannelIdError::TxIndexOverflow);
54         }
55
56         if vout_index > MAX_SCID_VOUT_INDEX {
57                 return Err(ShortChannelIdError::VoutIndexOverflow);
58         }
59
60         Ok((block << 40) | (tx_index << 16) | vout_index)
61 }
62
63 /// LDK has multiple reasons to generate fake short channel ids:
64 /// 1) outbound SCID aliases we use for private channels
65 /// 2) phantom node payments, to get an scid for the phantom node's phantom channel
66 pub(crate) mod fake_scid {
67         use bitcoin::hash_types::BlockHash;
68         use bitcoin::hashes::hex::FromHex;
69         use crate::chain::keysinterface::{Sign, KeysInterface};
70         use crate::util::chacha20::ChaCha20;
71         use crate::util::scid_utils;
72
73         use core::convert::TryInto;
74         use core::ops::Deref;
75
76         const TEST_SEGWIT_ACTIVATION_HEIGHT: u32 = 1;
77         const MAINNET_SEGWIT_ACTIVATION_HEIGHT: u32 = 481_824;
78         const MAX_TX_INDEX: u32 = 2_500;
79         const MAX_NAMESPACES: u8 = 8; // We allocate 3 bits for the namespace identifier.
80         const NAMESPACE_ID_BITMASK: u8 = 0b111;
81
82         const BLOCKS_PER_MONTH: u32 = 144 /* blocks per day */ * 30 /* days per month */;
83         pub(crate) const MAX_SCID_BLOCKS_FROM_NOW: u32 = BLOCKS_PER_MONTH;
84
85
86         /// Fake scids are divided into namespaces, with each namespace having its own identifier between
87         /// [0..7]. This allows us to identify what namespace a fake scid corresponds to upon HTLC
88         /// receipt, and handle the HTLC accordingly. The namespace identifier is encrypted when encoded
89         /// into the fake scid.
90         #[derive(Copy, Clone)]
91         pub(crate) enum Namespace {
92                 Phantom,
93                 OutboundAlias,
94         }
95
96         impl Namespace {
97                 /// We generate "realistic-looking" random scids here, meaning the scid's block height is
98                 /// between segwit activation and the current best known height, and the tx index and output
99                 /// index are also selected from a "reasonable" range. We add this logic because it makes it
100                 /// non-obvious at a glance that the scid is fake, e.g. if it appears in invoice route hints.
101                 pub(crate) fn get_fake_scid<Signer: Sign, K: Deref>(&self, highest_seen_blockheight: u32, genesis_hash: &BlockHash, fake_scid_rand_bytes: &[u8; 32], keys_manager: &K) -> u64
102                         where K::Target: KeysInterface<Signer = Signer>,
103                 {
104                         // Ensure we haven't created a namespace that doesn't fit into the 3 bits we've allocated for
105                         // namespaces.
106                         assert!((*self as u8) < MAX_NAMESPACES);
107                         let rand_bytes = keys_manager.get_secure_random_bytes();
108
109                         let segwit_activation_height = segwit_activation_height(genesis_hash);
110                         let mut blocks_since_segwit_activation = highest_seen_blockheight.saturating_sub(segwit_activation_height);
111
112                         // We want to ensure that this fake channel won't conflict with any transactions we haven't
113                         // seen yet, in case `highest_seen_blockheight` is updated before we get full information
114                         // about transactions confirmed in the given block.
115                         blocks_since_segwit_activation = blocks_since_segwit_activation.saturating_sub(MAX_SCID_BLOCKS_FROM_NOW);
116
117                         let rand_for_height = u32::from_be_bytes(rand_bytes[..4].try_into().unwrap());
118                         let fake_scid_height = segwit_activation_height + rand_for_height % (blocks_since_segwit_activation + 1);
119
120                         let rand_for_tx_index = u32::from_be_bytes(rand_bytes[4..8].try_into().unwrap());
121                         let fake_scid_tx_index = rand_for_tx_index % MAX_TX_INDEX;
122
123                         // Put the scid in the given namespace.
124                         let fake_scid_vout = self.get_encrypted_vout(fake_scid_height, fake_scid_tx_index, fake_scid_rand_bytes);
125                         scid_utils::scid_from_parts(fake_scid_height as u64, fake_scid_tx_index as u64, fake_scid_vout as u64).unwrap()
126                 }
127
128                 /// We want to ensure that a 3rd party can't identify a payment as belong to a given
129                 /// `Namespace`. Therefore, we encrypt it using a random bytes provided by `ChannelManager`.
130                 fn get_encrypted_vout(&self, block_height: u32, tx_index: u32, fake_scid_rand_bytes: &[u8; 32]) -> u8 {
131                         let mut salt = [0 as u8; 8];
132                         let block_height_bytes = block_height.to_be_bytes();
133                         salt[0..4].copy_from_slice(&block_height_bytes);
134                         let tx_index_bytes = tx_index.to_be_bytes();
135                         salt[4..8].copy_from_slice(&tx_index_bytes);
136
137                         let mut chacha = ChaCha20::new(fake_scid_rand_bytes, &salt);
138                         let mut vout_byte = [*self as u8];
139                         chacha.process_in_place(&mut vout_byte);
140                         vout_byte[0] & NAMESPACE_ID_BITMASK
141                 }
142         }
143
144         fn segwit_activation_height(genesis: &BlockHash) -> u32 {
145                 const MAINNET_GENESIS_STR: &'static str = "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f";
146                 if BlockHash::from_hex(MAINNET_GENESIS_STR).unwrap() == *genesis {
147                         MAINNET_SEGWIT_ACTIVATION_HEIGHT
148                 } else {
149                         TEST_SEGWIT_ACTIVATION_HEIGHT
150                 }
151         }
152
153         /// Returns whether the given fake scid falls into the given namespace.
154         pub fn is_valid_phantom(fake_scid_rand_bytes: &[u8; 32], scid: u64, genesis_hash: &BlockHash) -> bool {
155                 let block_height = scid_utils::block_from_scid(&scid);
156                 let tx_index = scid_utils::tx_index_from_scid(&scid);
157                 let namespace = Namespace::Phantom;
158                 let valid_vout = namespace.get_encrypted_vout(block_height, tx_index, fake_scid_rand_bytes);
159                 block_height >= segwit_activation_height(genesis_hash)
160                         && valid_vout == scid_utils::vout_from_scid(&scid) as u8
161         }
162
163         #[cfg(test)]
164         mod tests {
165                 use bitcoin::blockdata::constants::genesis_block;
166                 use bitcoin::network::constants::Network;
167                 use crate::util::scid_utils::fake_scid::{is_valid_phantom, MAINNET_SEGWIT_ACTIVATION_HEIGHT, MAX_TX_INDEX, MAX_NAMESPACES, Namespace, NAMESPACE_ID_BITMASK, segwit_activation_height, TEST_SEGWIT_ACTIVATION_HEIGHT};
168                 use crate::util::scid_utils;
169                 use crate::util::test_utils;
170                 use crate::sync::Arc;
171
172                 #[test]
173                 fn namespace_identifier_is_within_range() {
174                         let phantom_namespace = Namespace::Phantom;
175                         assert!((phantom_namespace as u8) < MAX_NAMESPACES);
176                         assert!((phantom_namespace as u8) <= NAMESPACE_ID_BITMASK);
177                 }
178
179                 #[test]
180                 fn test_segwit_activation_height() {
181                         let mainnet_genesis = genesis_block(Network::Bitcoin).header.block_hash();
182                         assert_eq!(segwit_activation_height(&mainnet_genesis), MAINNET_SEGWIT_ACTIVATION_HEIGHT);
183
184                         let testnet_genesis = genesis_block(Network::Testnet).header.block_hash();
185                         assert_eq!(segwit_activation_height(&testnet_genesis), TEST_SEGWIT_ACTIVATION_HEIGHT);
186
187                         let signet_genesis = genesis_block(Network::Signet).header.block_hash();
188                         assert_eq!(segwit_activation_height(&signet_genesis), TEST_SEGWIT_ACTIVATION_HEIGHT);
189
190                         let regtest_genesis = genesis_block(Network::Regtest).header.block_hash();
191                         assert_eq!(segwit_activation_height(&regtest_genesis), TEST_SEGWIT_ACTIVATION_HEIGHT);
192                 }
193
194                 #[test]
195                 fn test_is_valid_phantom() {
196                         let namespace = Namespace::Phantom;
197                         let fake_scid_rand_bytes = [0; 32];
198                         let testnet_genesis = genesis_block(Network::Testnet).header.block_hash();
199                         let valid_encrypted_vout = namespace.get_encrypted_vout(0, 0, &fake_scid_rand_bytes);
200                         let valid_fake_scid = scid_utils::scid_from_parts(1, 0, valid_encrypted_vout as u64).unwrap();
201                         assert!(is_valid_phantom(&fake_scid_rand_bytes, valid_fake_scid, &testnet_genesis));
202                         let invalid_fake_scid = scid_utils::scid_from_parts(1, 0, 12).unwrap();
203                         assert!(!is_valid_phantom(&fake_scid_rand_bytes, invalid_fake_scid, &testnet_genesis));
204                 }
205
206                 #[test]
207                 fn test_get_fake_scid() {
208                         let mainnet_genesis = genesis_block(Network::Bitcoin).header.block_hash();
209                         let seed = [0; 32];
210                         let fake_scid_rand_bytes = [1; 32];
211                         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet));
212                         let namespace = Namespace::Phantom;
213                         let fake_scid = namespace.get_fake_scid(500_000, &mainnet_genesis, &fake_scid_rand_bytes, &keys_manager);
214
215                         let fake_height = scid_utils::block_from_scid(&fake_scid);
216                         assert!(fake_height >= MAINNET_SEGWIT_ACTIVATION_HEIGHT);
217                         assert!(fake_height <= 500_000);
218
219                         let fake_tx_index = scid_utils::tx_index_from_scid(&fake_scid);
220                         assert!(fake_tx_index <= MAX_TX_INDEX);
221
222                         let fake_vout = scid_utils::vout_from_scid(&fake_scid);
223                         assert!(fake_vout < MAX_NAMESPACES as u16);
224                 }
225         }
226 }
227
228 #[cfg(test)]
229 mod tests {
230         use super::*;
231
232         #[test]
233         fn test_block_from_scid() {
234                 assert_eq!(block_from_scid(&0x000000_000000_0000), 0);
235                 assert_eq!(block_from_scid(&0x000001_000000_0000), 1);
236                 assert_eq!(block_from_scid(&0x000001_ffffff_ffff), 1);
237                 assert_eq!(block_from_scid(&0x800000_ffffff_ffff), 0x800000);
238                 assert_eq!(block_from_scid(&0xffffff_ffffff_ffff), 0xffffff);
239         }
240
241         #[test]
242         fn test_tx_index_from_scid() {
243                 assert_eq!(tx_index_from_scid(&0x000000_000000_0000), 0);
244                 assert_eq!(tx_index_from_scid(&0x000000_000001_0000), 1);
245                 assert_eq!(tx_index_from_scid(&0xffffff_000001_ffff), 1);
246                 assert_eq!(tx_index_from_scid(&0xffffff_800000_ffff), 0x800000);
247                 assert_eq!(tx_index_from_scid(&0xffffff_ffffff_ffff), 0xffffff);
248         }
249
250         #[test]
251         fn test_vout_from_scid() {
252                 assert_eq!(vout_from_scid(&0x000000_000000_0000), 0);
253                 assert_eq!(vout_from_scid(&0x000000_000000_0001), 1);
254                 assert_eq!(vout_from_scid(&0xffffff_ffffff_0001), 1);
255                 assert_eq!(vout_from_scid(&0xffffff_ffffff_8000), 0x8000);
256                 assert_eq!(vout_from_scid(&0xffffff_ffffff_ffff), 0xffff);
257         }
258
259         #[test]
260         fn test_scid_from_parts() {
261                 assert_eq!(scid_from_parts(0x00000000, 0x00000000, 0x0000).unwrap(), 0x000000_000000_0000);
262                 assert_eq!(scid_from_parts(0x00000001, 0x00000002, 0x0003).unwrap(), 0x000001_000002_0003);
263                 assert_eq!(scid_from_parts(0x00111111, 0x00222222, 0x3333).unwrap(), 0x111111_222222_3333);
264                 assert_eq!(scid_from_parts(0x00ffffff, 0x00ffffff, 0xffff).unwrap(), 0xffffff_ffffff_ffff);
265                 assert_eq!(scid_from_parts(0x01ffffff, 0x00000000, 0x0000).err().unwrap(), ShortChannelIdError::BlockOverflow);
266                 assert_eq!(scid_from_parts(0x00000000, 0x01ffffff, 0x0000).err().unwrap(), ShortChannelIdError::TxIndexOverflow);
267                 assert_eq!(scid_from_parts(0x00000000, 0x00000000, 0x010000).err().unwrap(), ShortChannelIdError::VoutIndexOverflow);
268         }
269 }