Don't allow uncompressed public keys without prefix 0x04

This commit is contained in:
Noah Lanson 2022-02-13 19:06:51 +11:00 committed by Noah
parent cb35766979
commit c0d36efb8b
3 changed files with 41 additions and 9 deletions

View File

@ -22,7 +22,7 @@ use prelude::*;
use core::{fmt, str, iter, slice}; use core::{fmt, str, iter, slice};
use hashes::{sha256d, Hash}; use hashes::{sha256d, Hash, hex};
use secp256k1; use secp256k1;
use util::{endian, key}; use util::{endian, key};
@ -46,6 +46,9 @@ pub enum Error {
TooShort(usize), TooShort(usize),
/// Secp256k1 error while parsing a secret key /// Secp256k1 error while parsing a secret key
Secp256k1(secp256k1::Error), Secp256k1(secp256k1::Error),
/// Hex decoding error
// TODO: Remove this as part of crate-smashing, there should not be any key related errors in this module
Hex(hex::Error)
} }
impl fmt::Display for Error { impl fmt::Display for Error {
@ -58,6 +61,7 @@ impl fmt::Display for Error {
Error::InvalidExtendedKeyVersion(ref v) => write!(f, "extended key version {:#04x?} is invalid for this base58 type", v), Error::InvalidExtendedKeyVersion(ref v) => write!(f, "extended key version {:#04x?} is invalid for this base58 type", v),
Error::TooShort(_) => write!(f, "base58ck data not even long enough for a checksum"), Error::TooShort(_) => write!(f, "base58ck data not even long enough for a checksum"),
Error::Secp256k1(ref e) => fmt::Display::fmt(&e, f), Error::Secp256k1(ref e) => fmt::Display::fmt(&e, f),
Error::Hex(ref e) => write!(f, "Hexadecimal decoding error: {}", e)
} }
} }
} }
@ -255,6 +259,8 @@ impl From<key::Error> for Error {
match e { match e {
key::Error::Secp256k1(e) => Error::Secp256k1(e), key::Error::Secp256k1(e) => Error::Secp256k1(e),
key::Error::Base58(e) => e, key::Error::Base58(e) => e,
key::Error::InvalidKeyPrefix(_) => Error::Secp256k1(secp256k1::Error::InvalidPublicKey),
key::Error::Hex(e) => Error::Hex(e)
} }
} }
} }

View File

@ -25,7 +25,7 @@ use core::{fmt, str::FromStr, default::Default};
#[cfg(feature = "serde")] use serde; #[cfg(feature = "serde")] use serde;
use hash_types::XpubIdentifier; use hash_types::XpubIdentifier;
use hashes::{sha512, Hash, HashEngine, Hmac, HmacEngine}; use hashes::{sha512, Hash, HashEngine, Hmac, HmacEngine, hex};
use secp256k1::{self, Secp256k1, XOnlyPublicKey}; use secp256k1::{self, Secp256k1, XOnlyPublicKey};
use network::constants::Network; use network::constants::Network;
@ -461,7 +461,9 @@ pub enum Error {
/// Encoded extended key data has wrong length /// Encoded extended key data has wrong length
WrongExtendedKeyLength(usize), WrongExtendedKeyLength(usize),
/// Base58 encoding error /// Base58 encoding error
Base58(base58::Error) Base58(base58::Error),
/// Hexadecimal decoding error
Hex(hex::Error)
} }
impl fmt::Display for Error { impl fmt::Display for Error {
@ -475,6 +477,7 @@ impl fmt::Display for Error {
Error::UnknownVersion(ref bytes) => write!(f, "unknown version magic bytes: {:?}", bytes), Error::UnknownVersion(ref bytes) => write!(f, "unknown version magic bytes: {:?}", bytes),
Error::WrongExtendedKeyLength(ref len) => write!(f, "encoded extended key data has wrong length {}", len), Error::WrongExtendedKeyLength(ref len) => write!(f, "encoded extended key data has wrong length {}", len),
Error::Base58(ref err) => write!(f, "base58 encoding error: {}", err), Error::Base58(ref err) => write!(f, "base58 encoding error: {}", err),
Error::Hex(ref e) => write!(f, "Hexadecimal decoding error: {}", e)
} }
} }
} }
@ -496,6 +499,8 @@ impl From<key::Error> for Error {
match err { match err {
key::Error::Base58(e) => Error::Base58(e), key::Error::Base58(e) => Error::Base58(e),
key::Error::Secp256k1(e) => Error::Secp256k1(e), key::Error::Secp256k1(e) => Error::Secp256k1(e),
key::Error::InvalidKeyPrefix(_) => Error::Secp256k1(secp256k1::Error::InvalidPublicKey),
key::Error::Hex(e) => Error::Hex(e)
} }
} }
} }

View File

@ -27,7 +27,7 @@ use io;
use secp256k1::{self, Secp256k1}; use secp256k1::{self, Secp256k1};
use network::constants::Network; use network::constants::Network;
use hashes::{Hash, hash160}; use hashes::{Hash, hash160, hex, hex::FromHex};
use hash_types::{PubkeyHash, WPubkeyHash}; use hash_types::{PubkeyHash, WPubkeyHash};
use util::base58; use util::base58;
@ -39,6 +39,10 @@ pub enum Error {
Base58(base58::Error), Base58(base58::Error),
/// secp256k1-related error /// secp256k1-related error
Secp256k1(secp256k1::Error), Secp256k1(secp256k1::Error),
/// Invalid key prefix error
InvalidKeyPrefix(u8),
/// Hex decoding error
Hex(hex::Error)
} }
@ -47,6 +51,8 @@ impl fmt::Display for Error {
match *self { match *self {
Error::Base58(ref e) => write!(f, "Key base58 error: {}", e), Error::Base58(ref e) => write!(f, "Key base58 error: {}", e),
Error::Secp256k1(ref e) => write!(f, "Key secp256k1 error: {}", e), Error::Secp256k1(ref e) => write!(f, "Key secp256k1 error: {}", e),
Error::InvalidKeyPrefix(ref e) => write!(f, "Key prefix invalid: {}", e),
Error::Hex(ref e) => write!(f, "Key hex decoding error: {}", e)
} }
} }
} }
@ -58,6 +64,8 @@ impl ::std::error::Error for Error {
match *self { match *self {
Error::Base58(ref e) => Some(e), Error::Base58(ref e) => Some(e),
Error::Secp256k1(ref e) => Some(e), Error::Secp256k1(ref e) => Some(e),
Error::InvalidKeyPrefix(_) => None,
Error::Hex(ref e) => Some(e)
} }
} }
} }
@ -76,6 +84,13 @@ impl From<secp256k1::Error> for Error {
} }
} }
#[doc(hidden)]
impl From<hex::Error> for Error {
fn from(e: hex::Error) -> Self {
Error::Hex(e)
}
}
/// A Bitcoin ECDSA public key /// A Bitcoin ECDSA public key
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
@ -158,6 +173,8 @@ impl PublicKey {
let reason = match e { let reason = match e {
Error::Base58(_) => "base58 error", Error::Base58(_) => "base58 error",
Error::Secp256k1(_) => "secp256k1 error", Error::Secp256k1(_) => "secp256k1 error",
Error::InvalidKeyPrefix(_) => "invalid key prefix",
Error::Hex(_) => "hex decoding error"
}; };
io::Error::new(io::ErrorKind::InvalidData, reason) io::Error::new(io::ErrorKind::InvalidData, reason)
}) })
@ -178,6 +195,10 @@ impl PublicKey {
len => { return Err(base58::Error::InvalidLength(len).into()); }, len => { return Err(base58::Error::InvalidLength(len).into()); },
}; };
if !compressed && data[0] != 0x04 {
return Err(Error::InvalidKeyPrefix(data[0]))
}
Ok(PublicKey { Ok(PublicKey {
compressed, compressed,
inner: secp256k1::PublicKey::from_slice(data)?, inner: secp256k1::PublicKey::from_slice(data)?,
@ -208,11 +229,11 @@ impl fmt::Display for PublicKey {
impl FromStr for PublicKey { impl FromStr for PublicKey {
type Err = Error; type Err = Error;
fn from_str(s: &str) -> Result<PublicKey, Error> { fn from_str(s: &str) -> Result<PublicKey, Error> {
let key = secp256k1::PublicKey::from_str(s)?; match s.len() {
Ok(PublicKey { 66 => PublicKey::from_slice(&<[u8; 33]>::from_hex(s)?),
inner: key, 130 => PublicKey::from_slice(&<[u8; 65]>::from_hex(s)?),
compressed: s.len() == 66 len => return Err(Error::Hex(hex::Error::InvalidLength(66, len)))
}) }
} }
} }