Skip to content

Commit 5eb93c0

Browse files
author
ChallengeDev210
committed
Cleanup/Dedup psbt (De)Serialization code
1 parent ce8e58c commit 5eb93c0

File tree

3 files changed

+44
-51
lines changed

3 files changed

+44
-51
lines changed

‎src/util/ecdsa.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
1919
use prelude::*;
2020
use core::str::FromStr;
21-
use core::fmt;
21+
use core::{fmt, iter};
2222
use hashes::hex::{self, FromHex};
2323
use blockdata::transaction::NonStandardSigHashType;
2424
use secp256k1;
@@ -57,9 +57,10 @@ impl EcdsaSig {
5757
/// Serialize EcdsaSig
5858
pub fn to_vec(&self) -> Vec<u8> {
5959
// TODO: add support to serialize to a writer to SerializedSig
60-
let mut ser_sig = self.sig.serialize_der().to_vec();
61-
ser_sig.push(self.hash_ty.as_u32() as u8);
62-
ser_sig
60+
self.sig.serialize_der()
61+
.iter().map(|x| *x)
62+
.chain(iter::once(self.hash_ty as u8))
63+
.collect()
6364
}
6465
}
6566

‎src/util/psbt/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -822,7 +822,7 @@ mod tests {
822822
let err = hex_psbt!("70736274ff010071020000000127744ababf3027fe0d6cf23a96eee2efb188ef52301954585883e69b6624b2420000000000ffffffff02787c01000000000016001483a7e34bd99ff03a4962ef8a1a101bb295461ece606b042a010000001600147ac369df1b20e033d6116623957b0ac49f3c52e8000000000001012b00f2052a010000002251205a2c2cf5b52cf31f83ad2e8da63ff03183ecd8f609c7510ae8a48e03910a075701172102fe349064c98d6e2a853fa3c9b12bd8b304a19c195c60efa7ee2393046d3fa232000000").unwrap_err();
823823
assert_eq!(err.to_string(), "parse failed: Invalid xonly public key");
824824
let err = hex_psbt!("70736274ff010071020000000127744ababf3027fe0d6cf23a96eee2efb188ef52301954585883e69b6624b2420000000000ffffffff02787c01000000000016001483a7e34bd99ff03a4962ef8a1a101bb295461ece606b042a010000001600147ac369df1b20e033d6116623957b0ac49f3c52e8000000000001012b00f2052a010000002251205a2c2cf5b52cf31f83ad2e8da63ff03183ecd8f609c7510ae8a48e03910a0757011342173bb3d36c074afb716fec6307a069a2e450b995f3c82785945ab8df0e24260dcd703b0cbf34de399184a9481ac2b3586db6601f026a77f7e4938481bc34751701aa000000").unwrap_err();
825-
assert_eq!(err.to_string(), "parse failed: Invalid Schnorr signature len");
825+
assert_eq!(err.to_string(), "parse failed: Invalid Schnorr signature length");
826826
let err = hex_psbt!("70736274ff010071020000000127744ababf3027fe0d6cf23a96eee2efb188ef52301954585883e69b6624b2420000000000ffffffff02787c01000000000016001483a7e34bd99ff03a4962ef8a1a101bb295461ece606b042a010000001600147ac369df1b20e033d6116623957b0ac49f3c52e8000000000001012b00f2052a010000002251205a2c2cf5b52cf31f83ad2e8da63ff03183ecd8f609c7510ae8a48e03910a0757221602fe349064c98d6e2a853fa3c9b12bd8b304a19c195c60efa7ee2393046d3fa2321900772b2da75600008001000080000000800100000000000000000000").unwrap_err();
827827
assert_eq!(err.to_string(), "parse failed: Invalid xonly public key");
828828
let err = hex_psbt!("70736274ff01007d020000000127744ababf3027fe0d6cf23a96eee2efb188ef52301954585883e69b6624b2420000000000ffffffff02887b0100000000001600142382871c7e8421a00093f754d91281e675874b9f606b042a010000002251205a2c2cf5b52cf31f83ad2e8da63ff03183ecd8f609c7510ae8a48e03910a0757000000000001012b00f2052a010000002251205a2c2cf5b52cf31f83ad2e8da63ff03183ecd8f609c7510ae8a48e03910a0757000001052102fe349064c98d6e2a853fa3c9b12bd8b304a19c195c60efa7ee2393046d3fa23200").unwrap_err();
@@ -832,9 +832,9 @@ mod tests {
832832
let err = hex_psbt!("70736274ff01005e02000000019bd48765230bf9a72e662001f972556e54f0c6f97feb56bcb5600d817f6995260100000000ffffffff0148e6052a01000000225120030da4fce4f7db28c2cb2951631e003713856597fe963882cb500e68112cca63000000000001012b00f2052a01000000225120c2247efbfd92ac47f6f40b8d42d169175a19fa9fa10e4a25d7f35eb4dd85b6924214022cb13ac68248de806aa6a3659cf3c03eb6821d09c8114a4e868febde865bb6d2cd970e15f53fc0c82f950fd560ffa919b76172be017368a89913af074f400b094089756aa3739ccc689ec0fcf3a360be32cc0b59b16e93a1e8bb4605726b2ca7a3ff706c4176649632b2cc68e1f912b8a578e3719ce7710885c7a966f49bcd43cb0000").unwrap_err();
833833
assert_eq!(err.to_string(), "PSBT error: Hash Parse Error: bad slice length 33 (expected 32)");
834834
let err = hex_psbt!("70736274ff01005e02000000019bd48765230bf9a72e662001f972556e54f0c6f97feb56bcb5600d817f6995260100000000ffffffff0148e6052a01000000225120030da4fce4f7db28c2cb2951631e003713856597fe963882cb500e68112cca63000000000001012b00f2052a01000000225120c2247efbfd92ac47f6f40b8d42d169175a19fa9fa10e4a25d7f35eb4dd85b69241142cb13ac68248de806aa6a3659cf3c03eb6821d09c8114a4e868febde865bb6d2cd970e15f53fc0c82f950fd560ffa919b76172be017368a89913af074f400b094289756aa3739ccc689ec0fcf3a360be32cc0b59b16e93a1e8bb4605726b2ca7a3ff706c4176649632b2cc68e1f912b8a578e3719ce7710885c7a966f49bcd43cb01010000").unwrap_err();
835-
assert_eq!(err.to_string(), "parse failed: Invalid Schnorr signature len");
835+
assert_eq!(err.to_string(), "parse failed: Invalid Schnorr signature length");
836836
let err = hex_psbt!("70736274ff01005e02000000019bd48765230bf9a72e662001f972556e54f0c6f97feb56bcb5600d817f6995260100000000ffffffff0148e6052a01000000225120030da4fce4f7db28c2cb2951631e003713856597fe963882cb500e68112cca63000000000001012b00f2052a01000000225120c2247efbfd92ac47f6f40b8d42d169175a19fa9fa10e4a25d7f35eb4dd85b69241142cb13ac68248de806aa6a3659cf3c03eb6821d09c8114a4e868febde865bb6d2cd970e15f53fc0c82f950fd560ffa919b76172be017368a89913af074f400b093989756aa3739ccc689ec0fcf3a360be32cc0b59b16e93a1e8bb4605726b2ca7a3ff706c4176649632b2cc68e1f912b8a578e3719ce7710885c7a966f49bcd43cb0000").unwrap_err();
837-
assert_eq!(err.to_string(), "parse failed: Invalid Schnorr signature len");
837+
assert_eq!(err.to_string(), "parse failed: Invalid Schnorr signature length");
838838
let err = hex_psbt!("70736274ff01005e02000000019bd48765230bf9a72e662001f972556e54f0c6f97feb56bcb5600d817f6995260100000000ffffffff0148e6052a01000000225120030da4fce4f7db28c2cb2951631e003713856597fe963882cb500e68112cca63000000000001012b00f2052a01000000225120c2247efbfd92ac47f6f40b8d42d169175a19fa9fa10e4a25d7f35eb4dd85b6926315c150929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac06f7d62059e9497a1a4a267569d9876da60101aff38e3529b9b939ce7f91ae970115f2e490af7cc45c4f78511f36057ce5c5a5c56325a29fb44dfc203f356e1f80023202cb13ac68248de806aa6a3659cf3c03eb6821d09c8114a4e868febde865bb6d2acc00000").unwrap_err();
839839
assert_eq!(err.to_string(), "parse failed: Invalid control block");
840840
let err = hex_psbt!("70736274ff01005e02000000019bd48765230bf9a72e662001f972556e54f0c6f97feb56bcb5600d817f6995260100000000ffffffff0148e6052a01000000225120030da4fce4f7db28c2cb2951631e003713856597fe963882cb500e68112cca63000000000001012b00f2052a01000000225120c2247efbfd92ac47f6f40b8d42d169175a19fa9fa10e4a25d7f35eb4dd85b6926115c150929b74c1a04954b78b4b6035e97a5e078a5a0f28ec96d547bfee9ace803ac06f7d62059e9497a1a4a267569d9876da60101aff38e3529b9b939ce7f91ae970115f2e490af7cc45c4f78511f36057ce5c5a5c56325a29fb44dfc203f356e123202cb13ac68248de806aa6a3659cf3c03eb6821d09c8114a4e868febde865bb6d2acc00000").unwrap_err();

‎src/util/psbt/serialize.rs

Lines changed: 36 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,19 @@ use io;
2424

2525
use blockdata::script::Script;
2626
use blockdata::witness::Witness;
27-
use blockdata::transaction::{EcdsaSigHashType, Transaction, TxOut};
27+
use blockdata::transaction::{Transaction, TxOut};
2828
use consensus::encode::{self, serialize, Decodable, Encodable, deserialize_partial};
2929
use secp256k1::{self, XOnlyPublicKey};
3030
use util::bip32::{ChildNumber, Fingerprint, KeySource};
3131
use hashes::{hash160, ripemd160, sha256, sha256d, Hash};
32-
use util::ecdsa::EcdsaSig;
33-
use util::taproot::{TapBranchHash, TapLeafHash, ControlBlock, LeafVersion};
32+
use util::ecdsa::{EcdsaSig, EcdsaSigError};
3433
use util::psbt;
34+
use util::taproot::{TapBranchHash, TapLeafHash, ControlBlock, LeafVersion};
3535
use schnorr;
36+
3637
use super::map::{TapTree, PsbtSigHashType};
3738

3839
use util::taproot::TaprootBuilder;
39-
use util::sighash::SchnorrSigHashType;
4040
/// A trait for serializing a value as raw data for insertion into PSBT
4141
/// key-value pairs.
4242
pub trait Serialize {
@@ -90,38 +90,35 @@ impl Deserialize for secp256k1::PublicKey {
9090

9191
impl Serialize for EcdsaSig {
9292
fn serialize(&self) -> Vec<u8> {
93-
let mut buf = Vec::with_capacity(72);
94-
buf.extend(self.sig.serialize_der().iter());
95-
buf.push(self.hash_ty as u8);
96-
buf
93+
self.to_vec()
9794
}
9895
}
9996

10097
impl Deserialize for EcdsaSig {
10198
fn deserialize(bytes: &[u8]) -> Result<Self, encode::Error> {
102-
let (sighash_byte, signature) = bytes.split_last()
103-
.ok_or(encode::Error::ParseFailed("empty partial signature data"))?;
104-
Ok(EcdsaSig {
105-
sig: secp256k1::ecdsa::Signature::from_der(signature)
106-
.map_err(|_| encode::Error::ParseFailed("non-DER encoded signature"))?,
107-
// NB: Since BIP-174 says "the signature as would be pushed to the stack from
108-
// a scriptSig or witness" we should ideally use a consensus deserialization and do
109-
// not error on a non-standard values. However,
110-
//
111-
// 1) the current implementation of from_u32_consensus(`flag`) does not preserve
112-
// the sighash byte `flag` mapping all unknown values to EcdsaSighashType::All or
113-
// EcdsaSigHashType::AllPlusAnyOneCanPay. Therefore, break the invariant
114-
// EcdsaSig::from_slice(&sl[..]).to_vec = sl.
115-
//
116-
// 2) This would cause to have invalid signatures because the sighash message
117-
// also has a field sighash_u32 (See BIP141). For example, when signing with non-standard
118-
// 0x05, the sighash message would have the last field as 0x05u32 while, the verification
119-
// would use check the signature assuming sighash_u32 as `0x01`.
120-
hash_ty: EcdsaSigHashType::from_u32_standard(*sighash_byte as u32)
121-
.map_err(|_e|
122-
encode::Error::from(psbt::Error::NonStandardSigHashType(*sighash_byte as u32))
123-
)?,
124-
})
99+
// NB: Since BIP-174 says "the signature as would be pushed to the stack from
100+
// a scriptSig or witness" we should ideally use a consensus deserialization and do
101+
// not error on a non-standard values. However,
102+
//
103+
// 1) the current implementation of from_u32_consensus(`flag`) does not preserve
104+
// the sighash byte `flag` mapping all unknown values to EcdsaSighashType::All or
105+
// EcdsaSigHashType::AllPlusAnyOneCanPay. Therefore, break the invariant
106+
// EcdsaSig::from_slice(&sl[..]).to_vec = sl.
107+
//
108+
// 2) This would cause to have invalid signatures because the sighash message
109+
// also has a field sighash_u32 (See BIP141). For example, when signing with non-standard
110+
// 0x05, the sighash message would have the last field as 0x05u32 while, the verification
111+
// would use check the signature assuming sighash_u32 as `0x01`.
112+
match EcdsaSig::from_slice(&bytes) {
113+
Ok(sig) => Ok(sig),
114+
Err(EcdsaSigError::EmptySignature) =>
115+
Err(encode::Error::ParseFailed("Empty partial signature data")),
116+
Err(EcdsaSigError::NonStandardSigHashType(flag)) =>
117+
Err(encode::Error::from(psbt::Error::NonStandardSigHashType(flag))),
118+
Err(EcdsaSigError::Secp256k1(..)) =>
119+
Err(encode::Error::ParseFailed("Invalid Ecdsa signature")),
120+
Err(EcdsaSigError::HexEncoding(..)) => unreachable!("Decoding from slice, not hex")
121+
}
125122
}
126123
}
127124

@@ -208,20 +205,15 @@ impl Serialize for schnorr::SchnorrSig {
208205

209206
impl Deserialize for schnorr::SchnorrSig {
210207
fn deserialize(bytes: &[u8]) -> Result<Self, encode::Error> {
211-
match bytes.len() {
212-
65 => {
213-
let hash_ty = SchnorrSigHashType::from_u8(bytes[64])
214-
.map_err(|_| encode::Error::ParseFailed("Invalid Sighash type"))?;
215-
let sig = secp256k1::schnorr::Signature::from_slice(&bytes[..64])
216-
.map_err(|_| encode::Error::ParseFailed("Invalid Schnorr signature"))?;
217-
Ok(schnorr::SchnorrSig{ sig, hash_ty })
218-
}
219-
64 => {
220-
let sig = secp256k1::schnorr::Signature::from_slice(&bytes[..64])
221-
.map_err(|_| encode::Error::ParseFailed("Invalid Schnorr signature"))?;
222-
Ok(schnorr::SchnorrSig{ sig, hash_ty: SchnorrSigHashType::Default })
208+
match schnorr::SchnorrSig::from_slice(&bytes) {
209+
Ok(sig) => Ok(sig),
210+
Err(schnorr::SchnorrSigError::InvalidSighashType(flag)) => {
211+
Err(encode::Error::from(psbt::Error::NonStandardSigHashType(flag as u32)))
223212
}
224-
_ => Err(encode::Error::ParseFailed("Invalid Schnorr signature len"))
213+
Err(schnorr::SchnorrSigError::InvalidSchnorrSigSize(_)) =>
214+
Err(encode::Error::ParseFailed("Invalid Schnorr signature length")),
215+
Err(schnorr::SchnorrSigError::Secp256k1(..)) =>
216+
Err(encode::Error::ParseFailed("Invalid Schnorr signature")),
225217
}
226218
}
227219
}

0 commit comments

Comments
 (0)