Skip to content

key: don't use Hasher to generate fingerprints; just use hashes crate #726

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 26, 2024
Merged

key: don't use Hasher to generate fingerprints; just use hashes crate #726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a16e5ec
secret keys: debug output only when `hashes` is enabled
apoelstra Aug 25, 2024
b8ac971
keypair: use public key for Debug output
apoelstra Aug 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions src/key.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -772,7 +772,6 @@ impl<'de> serde::Deserialize<'de> for PublicKey {
/// [`cbor`]: https://docs.rs/cbor
#[derive(Copy, Clone, PartialOrd, Ord, PartialEq, Eq, Hash)]
pub struct Keypair(ffi::Keypair);
impl_display_secret!(Keypair);
impl_fast_comparisons!(Keypair);

impl Keypair {
Expand Down Expand Up @@ -972,6 +971,15 @@ impl Keypair {
pub fn non_secure_erase(&mut self) { self.0.non_secure_erase(); }
}

impl fmt::Debug for Keypair {
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
f.debug_struct("Keypair")
.field("pubkey", &self.public_key())
.field("secret", &"<hidden>")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea.

.finish()
}
}

impl From<Keypair> for SecretKey {
#[inline]
fn from(pair: Keypair) -> Self { SecretKey::from_keypair(&pair) }
Expand Down Expand Up @@ -1705,12 +1713,15 @@ mod test {
}

#[test]
#[cfg(all(feature = "rand", feature = "alloc"))]
#[cfg(all(feature = "rand", feature = "alloc", not(feature = "hashes")))]
fn test_debug_output() {
let s = Secp256k1::new();
let (sk, _) = s.generate_keypair(&mut StepRng::new(1, 1));

assert_eq!(&format!("{:?}", sk), "SecretKey(#d3e0c51a23169bb5)");
assert_eq!(
&format!("{:?}", sk),
"<secret key; enable `hashes` feature of `secp256k1` to display fingerprint>"
);

let mut buf = [0u8; constants::SECRET_KEY_SIZE * 2];
assert_eq!(
Expand Down
30 changes: 6 additions & 24 deletions src/secret.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,7 @@ use crate::to_hex;
macro_rules! impl_display_secret {
// Default hasher exists only in standard library and not alloc
($thing:ident) => {
#[cfg(feature = "std")]
impl core::fmt::Debug for $thing {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
use core::hash::Hasher;
const DEBUG_HASH_TAG: &[u8] = &[
0x66, 0xa6, 0x77, 0x1b, 0x9b, 0x6d, 0xae, 0xa1, 0xb2, 0xee, 0x4e, 0x07, 0x49,
0x4a, 0xac, 0x87, 0xa9, 0xb8, 0x5b, 0x4b, 0x35, 0x02, 0xaa, 0x6d, 0x0f, 0x79,
0xcb, 0x63, 0xe6, 0xf8, 0x66, 0x22,
]; // =SHA256(b"rust-secp256k1DEBUG");

let mut hasher = std::collections::hash_map::DefaultHasher::new();

hasher.write(DEBUG_HASH_TAG);
hasher.write(DEBUG_HASH_TAG);
hasher.write(&self.secret_bytes());
let hash = hasher.finish();

f.debug_tuple(stringify!($thing)).field(&format_args!("#{:016x}", hash)).finish()
}
}

#[cfg(all(not(feature = "std"), feature = "hashes"))]
#[cfg(feature = "hashes")]
impl ::core::fmt::Debug for $thing {
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
use hashes::{sha256, Hash, HashEngine};
Expand All @@ -50,10 +29,13 @@ macro_rules! impl_display_secret {
}
}

#[cfg(all(not(feature = "std"), not(feature = "hashes")))]
#[cfg(not(feature = "hashes"))]
impl ::core::fmt::Debug for $thing {
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
write!(f, "<secret requires std or hashes feature to display>")
write!(
f,
"<secret key; enable `hashes` feature of `secp256k1` to display fingerprint>"
)
}
}
};
Expand Down
Loading