]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/sign/ecdsa.rs
Merge pull request #2868 from orbitalturtle/export-send-onion-path
[rust-lightning] / lightning / src / sign / ecdsa.rs
1 //! Defines ECDSA-specific signer types.
2
3 use bitcoin::blockdata::transaction::Transaction;
4
5 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
6 use bitcoin::secp256k1::ecdsa::Signature;
7 use bitcoin::secp256k1;
8
9 use crate::util::ser::Writeable;
10 use crate::ln::PaymentPreimage;
11 use crate::ln::chan_utils::{HTLCOutputInCommitment, HolderCommitmentTransaction, CommitmentTransaction, ClosingTransaction};
12 use crate::ln::msgs::UnsignedChannelAnnouncement;
13
14 use crate::prelude::*;
15 use crate::sign::{ChannelSigner, HTLCDescriptor};
16
17 /// A trait to sign Lightning channel transactions as described in
18 /// [BOLT 3](https://github.com/lightning/bolts/blob/master/03-transactions.md).
19 ///
20 /// Signing services could be implemented on a hardware wallet and should implement signing
21 /// policies in order to be secure. Please refer to the [VLS Policy
22 /// Controls](https://gitlab.com/lightning-signer/validating-lightning-signer/-/blob/main/docs/policy-controls.md)
23 /// for an example of such policies.
24 pub trait EcdsaChannelSigner: ChannelSigner {
25         /// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
26         ///
27         /// Note that if signing fails or is rejected, the channel will be force-closed.
28         ///
29         /// Policy checks should be implemented in this function, including checking the amount
30         /// sent to us and checking the HTLCs.
31         ///
32         /// The preimages of outbound and inbound HTLCs that were fulfilled since the last commitment
33         /// are provided. A validating signer should ensure that an outbound HTLC output is removed
34         /// only when the matching preimage is provided and after the corresponding inbound HTLC has
35         /// been removed for forwarded payments.
36         ///
37         /// Note that all the relevant preimages will be provided, but there may also be additional
38         /// irrelevant or duplicate preimages.
39         //
40         // TODO: Document the things someone using this interface should enforce before signing.
41         fn sign_counterparty_commitment(&self, commitment_tx: &CommitmentTransaction,
42                 inbound_htlc_preimages: Vec<PaymentPreimage>,
43                 outbound_htlc_preimages: Vec<PaymentPreimage>, secp_ctx: &Secp256k1<secp256k1::All>,
44         ) -> Result<(Signature, Vec<Signature>), ()>;
45         /// Creates a signature for a holder's commitment transaction.
46         ///
47         /// This will be called
48         /// - with a non-revoked `commitment_tx`.
49         /// - with the latest `commitment_tx` when we initiate a force-close.
50         ///
51         /// This may be called multiple times for the same transaction.
52         ///
53         /// An external signer implementation should check that the commitment has not been revoked.
54         //
55         // TODO: Document the things someone using this interface should enforce before signing.
56         fn sign_holder_commitment(&self, commitment_tx: &HolderCommitmentTransaction,
57                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
58         /// Same as [`sign_holder_commitment`], but exists only for tests to get access to holder
59         /// commitment transactions which will be broadcasted later, after the channel has moved on to a
60         /// newer state. Thus, needs its own method as [`sign_holder_commitment`] may enforce that we
61         /// only ever get called once.
62         #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
63         fn unsafe_sign_holder_commitment(&self, commitment_tx: &HolderCommitmentTransaction,
64                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
65         /// Create a signature for the given input in a transaction spending an HTLC transaction output
66         /// or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
67         ///
68         /// A justice transaction may claim multiple outputs at the same time if timelocks are
69         /// similar, but only a signature for the input at index `input` should be signed for here.
70         /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
71         /// to an upcoming timelock expiration.
72         ///
73         /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
74         ///
75         /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
76         /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
77         /// not allow the spending of any funds by itself (you need our holder `revocation_secret` to do
78         /// so).
79         fn sign_justice_revoked_output(&self, justice_tx: &Transaction, input: usize, amount: u64,
80                 per_commitment_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>
81         ) -> Result<Signature, ()>;
82         /// Create a signature for the given input in a transaction spending a commitment transaction
83         /// HTLC output when our counterparty broadcasts an old state.
84         ///
85         /// A justice transaction may claim multiple outputs at the same time if timelocks are
86         /// similar, but only a signature for the input at index `input` should be signed for here.
87         /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
88         /// to an upcoming timelock expiration.
89         ///
90         /// `amount` is the value of the output spent by this input, committed to in the BIP 143
91         /// signature.
92         ///
93         /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
94         /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
95         /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
96         /// so).
97         ///
98         /// `htlc` holds HTLC elements (hash, timelock), thus changing the format of the witness script
99         /// (which is committed to in the BIP 143 signatures).
100         fn sign_justice_revoked_htlc(&self, justice_tx: &Transaction, input: usize, amount: u64,
101                 per_commitment_key: &SecretKey, htlc: &HTLCOutputInCommitment,
102                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
103         /// Computes the signature for a commitment transaction's HTLC output used as an input within
104         /// `htlc_tx`, which spends the commitment transaction at index `input`. The signature returned
105         /// must be be computed using [`EcdsaSighashType::All`].
106         ///
107         /// Note that this may be called for HTLCs in the penultimate commitment transaction if a
108         /// [`ChannelMonitor`] [replica](https://github.com/lightningdevkit/rust-lightning/blob/main/GLOSSARY.md#monitor-replicas)
109         /// broadcasts it before receiving the update for the latest commitment transaction.
110         ///
111         /// [`EcdsaSighashType::All`]: bitcoin::sighash::EcdsaSighashType::All
112         /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
113         fn sign_holder_htlc_transaction(&self, htlc_tx: &Transaction, input: usize,
114                 htlc_descriptor: &HTLCDescriptor, secp_ctx: &Secp256k1<secp256k1::All>
115         ) -> Result<Signature, ()>;
116         /// Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
117         /// transaction, either offered or received.
118         ///
119         /// Such a transaction may claim multiples offered outputs at same time if we know the
120         /// preimage for each when we create it, but only the input at index `input` should be
121         /// signed for here. It may be called multiple times for same output(s) if a fee-bump is
122         /// needed with regards to an upcoming timelock expiration.
123         ///
124         /// `witness_script` is either an offered or received script as defined in BOLT3 for HTLC
125         /// outputs.
126         ///
127         /// `amount` is value of the output spent by this input, committed to in the BIP 143 signature.
128         ///
129         /// `per_commitment_point` is the dynamic point corresponding to the channel state
130         /// detected onchain. It has been generated by our counterparty and is used to derive
131         /// channel state keys, which are then included in the witness script and committed to in the
132         /// BIP 143 signature.
133         fn sign_counterparty_htlc_transaction(&self, htlc_tx: &Transaction, input: usize, amount: u64,
134                 per_commitment_point: &PublicKey, htlc: &HTLCOutputInCommitment,
135                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
136         /// Create a signature for a (proposed) closing transaction.
137         ///
138         /// Note that, due to rounding, there may be one "missing" satoshi, and either party may have
139         /// chosen to forgo their output as dust.
140         fn sign_closing_transaction(&self, closing_tx: &ClosingTransaction,
141                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
142         /// Computes the signature for a commitment transaction's anchor output used as an
143         /// input within `anchor_tx`, which spends the commitment transaction, at index `input`.
144         fn sign_holder_anchor_input(
145                 &self, anchor_tx: &Transaction, input: usize, secp_ctx: &Secp256k1<secp256k1::All>,
146         ) -> Result<Signature, ()>;
147         /// Signs a channel announcement message with our funding key proving it comes from one of the
148         /// channel participants.
149         ///
150         /// Channel announcements also require a signature from each node's network key. Our node
151         /// signature is computed through [`NodeSigner::sign_gossip_message`].
152         ///
153         /// Note that if this fails or is rejected, the channel will not be publicly announced and
154         /// our counterparty may (though likely will not) close the channel on us for violating the
155         /// protocol.
156         ///
157         /// [`NodeSigner::sign_gossip_message`]: crate::sign::NodeSigner::sign_gossip_message
158         fn sign_channel_announcement_with_funding_key(
159                 &self, msg: &UnsignedChannelAnnouncement, secp_ctx: &Secp256k1<secp256k1::All>
160         ) -> Result<Signature, ()>;
161 }
162
163 /// A writeable signer.
164 ///
165 /// There will always be two instances of a signer per channel, one occupied by the
166 /// [`ChannelManager`] and another by the channel's [`ChannelMonitor`].
167 ///
168 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
169 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
170 pub trait WriteableEcdsaChannelSigner: EcdsaChannelSigner + Writeable {}