989a16c3753758e7c749e79128e0d2de4dde73ea
[rust-lightning] / lightning / src / util / enforcing_trait_impls.rs
1 use ln::chan_utils::{HTLCOutputInCommitment, TxCreationKeys, ChannelPublicKeys, LocalCommitmentTransaction};
2 use ln::channelmanager::PaymentPreimage;
3 use ln::msgs;
4 use chain::keysinterface::{ChannelKeys, InMemoryChannelKeys};
5
6 use std::cmp;
7 use std::sync::{Mutex, Arc};
8
9 use bitcoin::blockdata::transaction::Transaction;
10
11 use secp256k1;
12 use secp256k1::key::{SecretKey, PublicKey};
13 use secp256k1::{Secp256k1, Signature};
14 use util::ser::{Writeable, Writer, Readable};
15 use std::io::Error;
16 use ln::msgs::DecodeError;
17
18 /// Enforces some rules on ChannelKeys calls. Eventually we will probably want to expose a variant
19 /// of this which would essentially be what you'd want to run on a hardware wallet.
20 #[derive(Clone)]
21 pub struct EnforcingChannelKeys {
22         pub inner: InMemoryChannelKeys,
23         commitment_number_obscure_and_last: Arc<Mutex<(Option<u64>, u64)>>,
24 }
25
26 impl EnforcingChannelKeys {
27         pub fn new(inner: InMemoryChannelKeys) -> Self {
28                 Self {
29                         inner,
30                         commitment_number_obscure_and_last: Arc::new(Mutex::new((None, 0))),
31                 }
32         }
33 }
34
35 impl EnforcingChannelKeys {
36         fn check_keys<T: secp256k1::Signing + secp256k1::Verification>(&self, secp_ctx: &Secp256k1<T>,
37                                                                        keys: &TxCreationKeys) {
38                 let revocation_base = PublicKey::from_secret_key(secp_ctx, &self.inner.revocation_base_key());
39                 let payment_base = PublicKey::from_secret_key(secp_ctx, &self.inner.payment_base_key());
40                 let htlc_base = PublicKey::from_secret_key(secp_ctx, &self.inner.htlc_base_key());
41
42                 let remote_points = self.inner.remote_channel_pubkeys.as_ref().unwrap();
43
44                 let keys_expected = TxCreationKeys::new(secp_ctx,
45                                                         &keys.per_commitment_point,
46                                                         &remote_points.delayed_payment_basepoint,
47                                                         &remote_points.htlc_basepoint,
48                                                         &revocation_base,
49                                                         &payment_base,
50                                                         &htlc_base).unwrap();
51                 if keys != &keys_expected { panic!("derived different per-tx keys") }
52         }
53 }
54
55 impl ChannelKeys for EnforcingChannelKeys {
56         fn funding_key(&self) -> &SecretKey { self.inner.funding_key() }
57         fn revocation_base_key(&self) -> &SecretKey { self.inner.revocation_base_key() }
58         fn payment_base_key(&self) -> &SecretKey { self.inner.payment_base_key() }
59         fn delayed_payment_base_key(&self) -> &SecretKey { self.inner.delayed_payment_base_key() }
60         fn htlc_base_key(&self) -> &SecretKey { self.inner.htlc_base_key() }
61         fn commitment_seed(&self) -> &[u8; 32] { self.inner.commitment_seed() }
62         fn pubkeys<'a>(&'a self) -> &'a ChannelPublicKeys { self.inner.pubkeys() }
63
64         fn sign_remote_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, feerate_per_kw: u64, commitment_tx: &Transaction, keys: &TxCreationKeys, htlcs: &[&HTLCOutputInCommitment], to_self_delay: u16, secp_ctx: &Secp256k1<T>) -> Result<(Signature, Vec<Signature>), ()> {
65                 if commitment_tx.input.len() != 1 { panic!("lightning commitment transactions have a single input"); }
66                 self.check_keys(secp_ctx, keys);
67                 let obscured_commitment_transaction_number = (commitment_tx.lock_time & 0xffffff) as u64 | ((commitment_tx.input[0].sequence as u64 & 0xffffff) << 3*8);
68
69                 {
70                         let mut commitment_data = self.commitment_number_obscure_and_last.lock().unwrap();
71                         if commitment_data.0.is_none() {
72                                 commitment_data.0 = Some(obscured_commitment_transaction_number ^ commitment_data.1);
73                         }
74                         let commitment_number = obscured_commitment_transaction_number ^ commitment_data.0.unwrap();
75                         assert!(commitment_number == commitment_data.1 || commitment_number == commitment_data.1 + 1);
76                         commitment_data.1 = cmp::max(commitment_number, commitment_data.1)
77                 }
78
79                 Ok(self.inner.sign_remote_commitment(feerate_per_kw, commitment_tx, keys, htlcs, to_self_delay, secp_ctx).unwrap())
80         }
81
82         fn sign_local_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, local_commitment_tx: &LocalCommitmentTransaction, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
83                 self.inner.sign_local_commitment(local_commitment_tx, secp_ctx)
84         }
85
86         #[cfg(test)]
87         fn unsafe_sign_local_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, local_commitment_tx: &LocalCommitmentTransaction, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
88                 self.inner.unsafe_sign_local_commitment(local_commitment_tx, secp_ctx)
89         }
90
91         fn sign_htlc_transaction<T: secp256k1::Signing>(&self, local_commitment_tx: &mut LocalCommitmentTransaction, htlc_index: u32, preimage: Option<PaymentPreimage>, local_csv: u16, secp_ctx: &Secp256k1<T>) {
92                 self.inner.sign_htlc_transaction(local_commitment_tx, htlc_index, preimage, local_csv, secp_ctx);
93         }
94
95         fn sign_closing_transaction<T: secp256k1::Signing>(&self, closing_tx: &Transaction, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
96                 Ok(self.inner.sign_closing_transaction(closing_tx, secp_ctx).unwrap())
97         }
98
99         fn sign_channel_announcement<T: secp256k1::Signing>(&self, msg: &msgs::UnsignedChannelAnnouncement, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
100                 self.inner.sign_channel_announcement(msg, secp_ctx)
101         }
102
103         fn set_remote_channel_pubkeys(&mut self, channel_pubkeys: &ChannelPublicKeys) {
104                 self.inner.set_remote_channel_pubkeys(channel_pubkeys)
105         }
106 }
107
108 impl Writeable for EnforcingChannelKeys {
109         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
110                 self.inner.write(writer)?;
111                 let (obscure, last) = *self.commitment_number_obscure_and_last.lock().unwrap();
112                 obscure.write(writer)?;
113                 last.write(writer)?;
114                 Ok(())
115         }
116 }
117
118 impl Readable for EnforcingChannelKeys {
119         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
120                 let inner = Readable::read(reader)?;
121                 let obscure_and_last = Readable::read(reader)?;
122                 Ok(EnforcingChannelKeys {
123                         inner: inner,
124                         commitment_number_obscure_and_last: Arc::new(Mutex::new(obscure_and_last))
125                 })
126         }
127 }