diff --git a/src/blockdata/transaction.rs b/src/blockdata/transaction.rs index f1952022..045e0aba 100644 --- a/src/blockdata/transaction.rs +++ b/src/blockdata/transaction.rs @@ -333,10 +333,10 @@ impl Transaction { let sighash_type : u32 = sighash_type.into(); assert!(input_index < self.input.len()); // Panic on OOB - let (sighash, anyone_can_pay) = SigHashType::from_u32_consensus(sighash_type).split_anyonecanpay_flag(); + let (sighash, anyone_can_pay) = EcdsaSigHashType::from_u32_consensus(sighash_type).split_anyonecanpay_flag(); // Special-case sighash_single bug because this is easy enough. - if sighash == SigHashType::Single && input_index >= self.output.len() { + if sighash == EcdsaSigHashType::Single && input_index >= self.output.len() { writer.write_all(&[1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, @@ -365,22 +365,22 @@ impl Transaction { tx.input.push(TxIn { previous_output: input.previous_output, script_sig: if n == input_index { script_pubkey.clone() } else { Script::new() }, - sequence: if n != input_index && (sighash == SigHashType::Single || sighash == SigHashType::None) { 0 } else { input.sequence }, + sequence: if n != input_index && (sighash == EcdsaSigHashType::Single || sighash == EcdsaSigHashType::None) { 0 } else { input.sequence }, witness: vec![], }); } } // ..then all outputs tx.output = match sighash { - SigHashType::All => self.output.clone(), - SigHashType::Single => { + EcdsaSigHashType::All => self.output.clone(), + EcdsaSigHashType::Single => { let output_iter = self.output.iter() .take(input_index + 1) // sign all outputs up to and including this one, but erase .enumerate() // all of them except for this one .map(|(n, out)| if n == input_index { out.clone() } else { TxOut::default() }); output_iter.collect() } - SigHashType::None => vec![], + EcdsaSigHashType::None => vec![], _ => unreachable!() }; // hash the result @@ -673,10 +673,15 @@ impl fmt::Display for NonStandardSigHashType { #[cfg_attr(docsrs, doc(cfg(feature = "std")))] impl error::Error for NonStandardSigHashType {} +/// Legacy Hashtype of an input's signature +#[deprecated(since="0.28.0", note="Please use [`EcdsaSigHashType`] instead")] +pub type SigHashType = EcdsaSigHashType; + /// Hashtype of an input's signature, encoded in the last byte of the signature /// Fixed values so they can be casted as integer types for encoding +/// See also [`crate::SchnorrSigHashType`] #[derive(PartialEq, Eq, Debug, Copy, Clone)] -pub enum SigHashType { +pub enum EcdsaSigHashType { /// 0x1: Sign all outputs All = 0x01, /// 0x2: Sign no outputs --- anyone can choose the destination @@ -693,54 +698,54 @@ pub enum SigHashType { /// 0x83: Sign one output and only this input (see `Single` for what "one output" means) SinglePlusAnyoneCanPay = 0x83 } -serde_string_impl!(SigHashType, "a SigHashType data"); +serde_string_impl!(EcdsaSigHashType, "a EcdsaSigHashType data"); -impl fmt::Display for SigHashType { +impl fmt::Display for EcdsaSigHashType { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let s = match self { - SigHashType::All => "SIGHASH_ALL", - SigHashType::None => "SIGHASH_NONE", - SigHashType::Single => "SIGHASH_SINGLE", - SigHashType::AllPlusAnyoneCanPay => "SIGHASH_ALL|SIGHASH_ANYONECANPAY", - SigHashType::NonePlusAnyoneCanPay => "SIGHASH_NONE|SIGHASH_ANYONECANPAY", - SigHashType::SinglePlusAnyoneCanPay => "SIGHASH_SINGLE|SIGHASH_ANYONECANPAY", + EcdsaSigHashType::All => "SIGHASH_ALL", + EcdsaSigHashType::None => "SIGHASH_NONE", + EcdsaSigHashType::Single => "SIGHASH_SINGLE", + EcdsaSigHashType::AllPlusAnyoneCanPay => "SIGHASH_ALL|SIGHASH_ANYONECANPAY", + EcdsaSigHashType::NonePlusAnyoneCanPay => "SIGHASH_NONE|SIGHASH_ANYONECANPAY", + EcdsaSigHashType::SinglePlusAnyoneCanPay => "SIGHASH_SINGLE|SIGHASH_ANYONECANPAY", }; f.write_str(s) } } -impl str::FromStr for SigHashType { +impl str::FromStr for EcdsaSigHashType { type Err = String; fn from_str(s: &str) -> Result { match s.as_ref() { - "SIGHASH_ALL" => Ok(SigHashType::All), - "SIGHASH_NONE" => Ok(SigHashType::None), - "SIGHASH_SINGLE" => Ok(SigHashType::Single), - "SIGHASH_ALL|SIGHASH_ANYONECANPAY" => Ok(SigHashType::AllPlusAnyoneCanPay), - "SIGHASH_NONE|SIGHASH_ANYONECANPAY" => Ok(SigHashType::NonePlusAnyoneCanPay), - "SIGHASH_SINGLE|SIGHASH_ANYONECANPAY" => Ok(SigHashType::SinglePlusAnyoneCanPay), + "SIGHASH_ALL" => Ok(EcdsaSigHashType::All), + "SIGHASH_NONE" => Ok(EcdsaSigHashType::None), + "SIGHASH_SINGLE" => Ok(EcdsaSigHashType::Single), + "SIGHASH_ALL|SIGHASH_ANYONECANPAY" => Ok(EcdsaSigHashType::AllPlusAnyoneCanPay), + "SIGHASH_NONE|SIGHASH_ANYONECANPAY" => Ok(EcdsaSigHashType::NonePlusAnyoneCanPay), + "SIGHASH_SINGLE|SIGHASH_ANYONECANPAY" => Ok(EcdsaSigHashType::SinglePlusAnyoneCanPay), _ => Err("can't recognize SIGHASH string".to_string()) } } } -impl SigHashType { +impl EcdsaSigHashType { /// Break the sighash flag into the "real" sighash flag and the ANYONECANPAY boolean - pub(crate) fn split_anyonecanpay_flag(self) -> (SigHashType, bool) { + pub(crate) fn split_anyonecanpay_flag(self) -> (EcdsaSigHashType, bool) { match self { - SigHashType::All => (SigHashType::All, false), - SigHashType::None => (SigHashType::None, false), - SigHashType::Single => (SigHashType::Single, false), - SigHashType::AllPlusAnyoneCanPay => (SigHashType::All, true), - SigHashType::NonePlusAnyoneCanPay => (SigHashType::None, true), - SigHashType::SinglePlusAnyoneCanPay => (SigHashType::Single, true) + EcdsaSigHashType::All => (EcdsaSigHashType::All, false), + EcdsaSigHashType::None => (EcdsaSigHashType::None, false), + EcdsaSigHashType::Single => (EcdsaSigHashType::Single, false), + EcdsaSigHashType::AllPlusAnyoneCanPay => (EcdsaSigHashType::All, true), + EcdsaSigHashType::NonePlusAnyoneCanPay => (EcdsaSigHashType::None, true), + EcdsaSigHashType::SinglePlusAnyoneCanPay => (EcdsaSigHashType::Single, true) } } /// Reads a 4-byte uint32 as a sighash type. #[deprecated(since="0.26.1", note="please use `from_u32_consensus` or `from_u32_standard` instead")] - pub fn from_u32(n: u32) -> SigHashType { + pub fn from_u32(n: u32) -> EcdsaSigHashType { Self::from_u32_consensus(n) } @@ -748,7 +753,7 @@ impl SigHashType { /// /// **Note**: this replicates consensus behaviour, for current standardness rules correctness /// you probably want [Self::from_u32_standard]. - pub fn from_u32_consensus(n: u32) -> SigHashType { + pub fn from_u32_consensus(n: u32) -> EcdsaSigHashType { // In Bitcoin Core, the SignatureHash function will mask the (int32) value with // 0x1f to (apparently) deactivate ACP when checking for SINGLE and NONE bits. // We however want to be matching also against on ACP-masked ALL, SINGLE, and NONE. @@ -756,29 +761,29 @@ impl SigHashType { let mask = 0x1f | 0x80; match n & mask { // "real" sighashes - 0x01 => SigHashType::All, - 0x02 => SigHashType::None, - 0x03 => SigHashType::Single, - 0x81 => SigHashType::AllPlusAnyoneCanPay, - 0x82 => SigHashType::NonePlusAnyoneCanPay, - 0x83 => SigHashType::SinglePlusAnyoneCanPay, + 0x01 => EcdsaSigHashType::All, + 0x02 => EcdsaSigHashType::None, + 0x03 => EcdsaSigHashType::Single, + 0x81 => EcdsaSigHashType::AllPlusAnyoneCanPay, + 0x82 => EcdsaSigHashType::NonePlusAnyoneCanPay, + 0x83 => EcdsaSigHashType::SinglePlusAnyoneCanPay, // catchalls - x if x & 0x80 == 0x80 => SigHashType::AllPlusAnyoneCanPay, - _ => SigHashType::All + x if x & 0x80 == 0x80 => EcdsaSigHashType::AllPlusAnyoneCanPay, + _ => EcdsaSigHashType::All } } /// Read a 4-byte uint32 as a standard sighash type, returning an error if the type /// is non standard. - pub fn from_u32_standard(n: u32) -> Result { + pub fn from_u32_standard(n: u32) -> Result { match n { // Standard sighashes, see https://github.com/bitcoin/bitcoin/blob/b805dbb0b9c90dadef0424e5b3bf86ac308e103e/src/script/interpreter.cpp#L189-L198 - 0x01 => Ok(SigHashType::All), - 0x02 => Ok(SigHashType::None), - 0x03 => Ok(SigHashType::Single), - 0x81 => Ok(SigHashType::AllPlusAnyoneCanPay), - 0x82 => Ok(SigHashType::NonePlusAnyoneCanPay), - 0x83 => Ok(SigHashType::SinglePlusAnyoneCanPay), + 0x01 => Ok(EcdsaSigHashType::All), + 0x02 => Ok(EcdsaSigHashType::None), + 0x03 => Ok(EcdsaSigHashType::Single), + 0x81 => Ok(EcdsaSigHashType::AllPlusAnyoneCanPay), + 0x82 => Ok(EcdsaSigHashType::NonePlusAnyoneCanPay), + 0x83 => Ok(EcdsaSigHashType::SinglePlusAnyoneCanPay), _ => Err(NonStandardSigHashType) } } @@ -787,8 +792,8 @@ impl SigHashType { pub fn as_u32(self) -> u32 { self as u32 } } -impl From for u32 { - fn from(t: SigHashType) -> u32 { +impl From for u32 { + fn from(t: EcdsaSigHashType) -> u32 { t.as_u32() } } @@ -807,7 +812,7 @@ mod tests { use hashes::hex::FromHex; use hash_types::*; - use SigHashType; + use super::EcdsaSigHashType; use util::sighash::SigHashCache; #[test] @@ -1088,15 +1093,15 @@ mod tests { #[test] fn test_sighashtype_fromstr_display() { - let sighashtypes = vec![("SIGHASH_ALL", SigHashType::All), - ("SIGHASH_NONE", SigHashType::None), - ("SIGHASH_SINGLE", SigHashType::Single), - ("SIGHASH_ALL|SIGHASH_ANYONECANPAY", SigHashType::AllPlusAnyoneCanPay), - ("SIGHASH_NONE|SIGHASH_ANYONECANPAY", SigHashType::NonePlusAnyoneCanPay), - ("SIGHASH_SINGLE|SIGHASH_ANYONECANPAY", SigHashType::SinglePlusAnyoneCanPay)]; + let sighashtypes = vec![("SIGHASH_ALL", EcdsaSigHashType::All), + ("SIGHASH_NONE", EcdsaSigHashType::None), + ("SIGHASH_SINGLE", EcdsaSigHashType::Single), + ("SIGHASH_ALL|SIGHASH_ANYONECANPAY", EcdsaSigHashType::AllPlusAnyoneCanPay), + ("SIGHASH_NONE|SIGHASH_ANYONECANPAY", EcdsaSigHashType::NonePlusAnyoneCanPay), + ("SIGHASH_SINGLE|SIGHASH_ANYONECANPAY", EcdsaSigHashType::SinglePlusAnyoneCanPay)]; for (s, sht) in sighashtypes { assert_eq!(sht.to_string(), s); - assert_eq!(SigHashType::from_str(s).unwrap(), sht); + assert_eq!(EcdsaSigHashType::from_str(s).unwrap(), sht); } let sht_mistakes = vec![ "SIGHASH_ALL | SIGHASH_ANYONECANPAY", @@ -1111,7 +1116,7 @@ mod tests { "SigHash_NONE", ]; for s in sht_mistakes { - assert_eq!(SigHashType::from_str(s).unwrap_err(), "can't recognize SIGHASH string"); + assert_eq!(EcdsaSigHashType::from_str(s).unwrap_err(), "can't recognize SIGHASH string"); } } @@ -1120,10 +1125,10 @@ mod tests { fn test_sighashtype_standard() { let nonstandard_hashtype = 0x04; // This type is not well defined, by consensus it becomes ALL - assert_eq!(SigHashType::from_u32(nonstandard_hashtype), SigHashType::All); - assert_eq!(SigHashType::from_u32_consensus(nonstandard_hashtype), SigHashType::All); + assert_eq!(EcdsaSigHashType::from_u32(nonstandard_hashtype), EcdsaSigHashType::All); + assert_eq!(EcdsaSigHashType::from_u32_consensus(nonstandard_hashtype), EcdsaSigHashType::All); // But it's policy-invalid to use it! - assert_eq!(SigHashType::from_u32_standard(nonstandard_hashtype), Err(NonStandardSigHashType)); + assert_eq!(EcdsaSigHashType::from_u32_standard(nonstandard_hashtype), Err(NonStandardSigHashType)); } // These test vectors were stolen from libbtc, which is Copyright 2014 Jonas Schnelli MIT diff --git a/src/lib.rs b/src/lib.rs index 11bde770..8502c6b3 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -123,7 +123,7 @@ pub use blockdata::transaction::Transaction; pub use blockdata::transaction::TxIn; pub use blockdata::transaction::TxOut; pub use blockdata::transaction::OutPoint; -pub use blockdata::transaction::SigHashType; +pub use blockdata::transaction::EcdsaSigHashType; pub use consensus::encode::VarInt; pub use network::constants::Network; pub use util::Error; @@ -133,9 +133,10 @@ pub use util::amount::Amount; pub use util::amount::Denomination; pub use util::amount::SignedAmount; pub use util::merkleblock::MerkleBlock; +pub use util::sighash::SchnorrSigHashType; -pub use util::ecdsa; -pub use util::schnorr; +pub use util::ecdsa::{self, EcdsaSig, EcdsaSigError}; +pub use util::schnorr::{self, SchnorrSig, SchnorrSigError}; #[deprecated(since = "0.26.1", note = "Please use `ecdsa::PrivateKey` instead")] pub use util::ecdsa::PrivateKey; #[deprecated(since = "0.26.1", note = "Please use `ecdsa::PublicKey` instead")] diff --git a/src/util/bip143.rs b/src/util/bip143.rs index 979174fb..a00da490 100644 --- a/src/util/bip143.rs +++ b/src/util/bip143.rs @@ -22,7 +22,7 @@ use hashes::Hash; use hash_types::SigHash; use blockdata::script::Script; -use blockdata::transaction::{Transaction, TxIn, SigHashType}; +use blockdata::transaction::{Transaction, TxIn, EcdsaSigHashType}; use consensus::{encode, Encodable}; use prelude::*; @@ -131,7 +131,7 @@ impl> SigHashCache { input_index: usize, script_code: &Script, value: u64, - sighash_type: SigHashType, + sighash_type: EcdsaSigHashType, ) -> Result<(), encode::Error> { self.cache .segwit_encode_signing_data_to(writer, input_index, script_code, value, sighash_type.into()) @@ -146,7 +146,7 @@ impl> SigHashCache { input_index: usize, script_code: &Script, value: u64, - sighash_type: SigHashType + sighash_type: EcdsaSigHashType ) -> SigHash { let mut enc = SigHash::engine(); self.encode_signing_data_to(&mut enc, input_index, script_code, value, sighash_type) @@ -165,7 +165,7 @@ impl> SigHashCache { /// panics if `input_index` is out of bounds with respect of the number of inputs /// /// ``` - /// use bitcoin::blockdata::transaction::{Transaction, SigHashType}; + /// use bitcoin::blockdata::transaction::{Transaction, EcdsaSigHashType}; /// use bitcoin::util::bip143::SigHashCache; /// use bitcoin::Script; /// @@ -175,7 +175,7 @@ impl> SigHashCache { /// let mut sig_hasher = SigHashCache::new(&mut tx_to_sign); /// for inp in 0..input_count { /// let prevout_script = Script::new(); - /// let _sighash = sig_hasher.signature_hash(inp, &prevout_script, 42, SigHashType::All); + /// let _sighash = sig_hasher.signature_hash(inp, &prevout_script, 42, EcdsaSigHashType::All); /// // ... sign the sighash /// sig_hasher.access_witness(inp).push(Vec::new()); /// } @@ -212,7 +212,7 @@ mod tests { let raw_expected = SigHash::from_hex(expected_result).unwrap(); let expected_result = SigHash::from_slice(&raw_expected[..]).unwrap(); let mut cache = SigHashCache::new(&tx); - let sighash_type = SigHashType::from_u32_consensus(hash_type); + let sighash_type = EcdsaSigHashType::from_u32_consensus(hash_type); let actual_result = cache.signature_hash(input_index, &script, value, sighash_type); assert_eq!(actual_result, expected_result); } diff --git a/src/util/ecdsa.rs b/src/util/ecdsa.rs index 33e3685d..f1333225 100644 --- a/src/util/ecdsa.rs +++ b/src/util/ecdsa.rs @@ -29,6 +29,8 @@ use hashes::{Hash, hash160}; use hash_types::{PubkeyHash, WPubkeyHash}; use util::base58; use util::key::Error; +use blockdata::transaction::EcdsaSigHashType; + /// A Bitcoin ECDSA public key #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] @@ -413,6 +415,72 @@ impl<'de> ::serde::Deserialize<'de> for PublicKey { } } +/// An ECDSA signature with the corresponding hash type. +#[derive(Debug, Copy, Clone, PartialEq, Eq)] +pub struct EcdsaSig { + /// The underlying ECDSA Signature + pub sig: secp256k1::Signature, + /// The corresponding hash type + pub hash_ty: EcdsaSigHashType, +} + +impl EcdsaSig { + + /// Deserialize from slice + pub fn from_slice(sl: &[u8]) -> Result { + let (hash_ty, sig) = sl.split_last() + .ok_or(EcdsaSigError::EmptySignature)?; + let hash_ty = EcdsaSigHashType::from_u32_standard(*hash_ty as u32) + .map_err(|_| EcdsaSigError::NonStandardSigHashType(*hash_ty))?; + let sig = secp256k1::Signature::from_der(sig) + .map_err(EcdsaSigError::Secp256k1)?; + Ok(EcdsaSig { sig, hash_ty }) + } + + /// Serialize EcdsaSig + pub fn to_vec(&self) -> Vec { + // TODO: add support to serialize to a writer to SerializedSig + let mut ser_sig = self.sig.serialize_der().to_vec(); + ser_sig.push(self.hash_ty.as_u32() as u8); + ser_sig + } +} + +/// A key-related error. +#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)] +pub enum EcdsaSigError { + /// Base58 encoding error + NonStandardSigHashType(u8), + /// Empty Signature + EmptySignature, + /// secp256k1-related error + Secp256k1(secp256k1::Error), +} + + +impl fmt::Display for EcdsaSigError { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + match *self { + EcdsaSigError::NonStandardSigHashType(hash_ty) => + write!(f, "Non standard signature hash type {}", hash_ty), + EcdsaSigError::Secp256k1(ref e) => + write!(f, "Invalid Ecdsa signature: {}", e), + EcdsaSigError::EmptySignature => + write!(f, "Empty ECDSA signature"), + } + } +} + +#[cfg(feature = "std")] +#[cfg_attr(docsrs, doc(cfg(feature = "std")))] +impl ::std::error::Error for EcdsaSigError {} + +impl From for EcdsaSigError { + fn from(e: secp256k1::Error) -> EcdsaSigError { + EcdsaSigError::Secp256k1(e) + } +} + #[cfg(test)] mod tests { use io; diff --git a/src/util/psbt/map/input.rs b/src/util/psbt/map/input.rs index 04b0c6e4..2eca6d0c 100644 --- a/src/util/psbt/map/input.rs +++ b/src/util/psbt/map/input.rs @@ -17,7 +17,7 @@ use prelude::*; use io; use blockdata::script::Script; -use blockdata::transaction::{SigHashType, Transaction, TxOut}; +use blockdata::transaction::{EcdsaSigHashType, Transaction, TxOut}; use consensus::encode; use util::bip32::KeySource; use hashes::{self, hash160, ripemd160, sha256, sha256d}; @@ -76,7 +76,7 @@ pub struct Input { pub partial_sigs: BTreeMap>, /// The sighash type to be used for this input. Signatures for this input /// must use the sighash type. - pub sighash_type: Option, + pub sighash_type: Option, /// The redeem script for this input. pub redeem_script: Option