Skip to content

Remove bitcoin-hashes feature #837

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.

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 0 additions & 32 deletions Cargo-minimal.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ version = "1.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dde20b3d026af13f561bdd0f15edf01fc734f0dafcedbaf42bba506a9517f223"

[[package]]
name = "arrayvec"
version = "0.7.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7c02d123df017efcdfbd739ef81735b36c5ba83ec3c59c80a9d7ecc718f92e50"

[[package]]
name = "bincode"
version = "1.3.3"
Expand All @@ -23,22 +17,6 @@ dependencies = [
"serde",
]

[[package]]
name = "bitcoin-io"
version = "0.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "340e09e8399c7bd8912f495af6aa58bea0c9214773417ffaa8f6460f93aaee56"

[[package]]
name = "bitcoin_hashes"
version = "0.14.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bb18c03d0db0247e147a21a6faafd5a7eb851c743db062de72018b6b7e8e4d16"
dependencies = [
"bitcoin-io",
"hex-conservative",
]

[[package]]
name = "bitflags"
version = "2.9.0"
Expand Down Expand Up @@ -105,15 +83,6 @@ version = "1.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ee6c0438de3ca4d8cac2eec62b228e2f8865cfe9ebefea720406774223fa2d2e"

[[package]]
name = "hex-conservative"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5313b072ce3c597065a808dbf612c4c8e8590bdbf8b579508bf7a762c5eae6cd"
dependencies = [
"arrayvec",
]

[[package]]
name = "hex_lit"
version = "0.1.1"
Expand Down Expand Up @@ -232,7 +201,6 @@ version = "0.31.1"
dependencies = [
"arbitrary",
"bincode",
"bitcoin_hashes",
"getrandom",
"hex_lit",
"rand",
Expand Down
32 changes: 0 additions & 32 deletions Cargo-recent.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ version = "1.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dde20b3d026af13f561bdd0f15edf01fc734f0dafcedbaf42bba506a9517f223"

[[package]]
name = "arrayvec"
version = "0.7.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7c02d123df017efcdfbd739ef81735b36c5ba83ec3c59c80a9d7ecc718f92e50"

[[package]]
name = "bincode"
version = "1.3.3"
Expand All @@ -23,22 +17,6 @@ dependencies = [
"serde",
]

[[package]]
name = "bitcoin-io"
version = "0.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "340e09e8399c7bd8912f495af6aa58bea0c9214773417ffaa8f6460f93aaee56"

[[package]]
name = "bitcoin_hashes"
version = "0.14.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bb18c03d0db0247e147a21a6faafd5a7eb851c743db062de72018b6b7e8e4d16"
dependencies = [
"bitcoin-io",
"hex-conservative",
]

[[package]]
name = "bitflags"
version = "2.9.0"
Expand Down Expand Up @@ -99,15 +77,6 @@ version = "1.8.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "eabb4a44450da02c90444cf74558da904edde8fb4e9035a9a6a4e15445af0bd7"

[[package]]
name = "hex-conservative"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5313b072ce3c597065a808dbf612c4c8e8590bdbf8b579508bf7a762c5eae6cd"
dependencies = [
"arrayvec",
]

[[package]]
name = "hex_lit"
version = "0.1.1"
Expand Down Expand Up @@ -223,7 +192,6 @@ version = "0.31.1"
dependencies = [
"arbitrary",
"bincode",
"bitcoin_hashes",
"getrandom",
"hex_lit",
"rand",
Expand Down
7 changes: 3 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ rustdoc-args = ["--cfg", "docsrs"]

[features]
default = ["std"]
std = ["alloc", "secp256k1-sys/std", "rand?/std", "rand?/std_rng", "rand?/thread_rng", "hashes?/std"]
std = ["alloc", "secp256k1-sys/std", "rand?/std", "rand?/std_rng", "rand?/thread_rng"]
# allow use of Secp256k1::new and related API that requires an allocator
alloc = ["secp256k1-sys/alloc"]
recovery = ["secp256k1-sys/recovery"]
Expand All @@ -38,7 +38,6 @@ arbitrary = ["dep:arbitrary"]
secp256k1-sys = { version = "0.11.0", default-features = false, path = "./secp256k1-sys" }

arbitrary = { version = "1.4", optional = true }
hashes = { package = "bitcoin_hashes", version = "0.14", default-features = false, optional = true }
rand = { version = "0.9", default-features = false, optional = true }
serde = { version = "1.0.103", default-features = false, optional = true }

Expand All @@ -58,11 +57,11 @@ unexpected_cfgs = { level = "deny", check-cfg = ['cfg(bench)', 'cfg(secp256k1_fu

[[example]]
name = "sign_verify_recovery"
required-features = ["recovery", "hashes", "std"]
required-features = ["recovery", "std"]

[[example]]
name = "sign_verify"
required-features = ["hashes", "std"]
required-features = ["std"]

[[example]]
name = "generate_keys"
Expand Down
33 changes: 22 additions & 11 deletions examples/sign_verify.rs
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
extern crate hashes;
//! Signing and Verification Example
//!
//! In this example we directly sign the "output of a hash function"
//! as represented by a 32-byte array. In practice, when signing with
//! the ECDSA API, you should not sign an arbitrary hash like this,
//! whether it is typed as a `[u8; 32]` or a `sha2::Sha256` or whatever.
//!
//! Instead, you should have a dedicated signature hash type, which has
//! constructors ensuring that it represents an (ideally) domain-separated
//! hash of the data you intend to sign. This type should implement
//! `Into<Message>` so it can be passed to `sign_ecdsa` as a message.
//!
//! An example of such a type is `bitcoin::LegacySighash` from rust-bitcoin.
//!

extern crate secp256k1;

use hashes::{sha256, Hash};
use secp256k1::{ecdsa, Error, Message, PublicKey, Secp256k1, SecretKey, Signing, Verification};

fn verify<C: Verification>(
secp: &Secp256k1<C>,
msg: &[u8],
msg_digest: [u8; 32],
sig: [u8; 64],
pubkey: [u8; 33],
) -> Result<bool, Error> {
let msg = sha256::Hash::hash(msg);
let msg = Message::from_digest(msg.to_byte_array());
let msg = Message::from_digest(msg_digest);
let sig = ecdsa::Signature::from_compact(&sig)?;
let pubkey = PublicKey::from_slice(&pubkey)?;

Expand All @@ -20,11 +32,10 @@ fn verify<C: Verification>(

fn sign<C: Signing>(
secp: &Secp256k1<C>,
msg: &[u8],
msg_digest: [u8; 32],
seckey: [u8; 32],
) -> Result<ecdsa::Signature, Error> {
let msg = sha256::Hash::hash(msg);
let msg = Message::from_digest(msg.to_byte_array());
let msg = Message::from_digest(msg_digest);
let seckey = SecretKey::from_byte_array(seckey)?;
Ok(secp.sign_ecdsa(msg, &seckey))
}
Expand All @@ -40,11 +51,11 @@ fn main() {
2, 29, 21, 35, 7, 198, 183, 43, 14, 208, 65, 139, 14, 112, 205, 128, 231, 245, 41, 91, 141,
134, 245, 114, 45, 63, 82, 19, 251, 210, 57, 79, 54,
];
let msg = b"This is some message";
let msg_digest = *b"this must be secure hash output.";

let signature = sign(&secp, msg, seckey).unwrap();
let signature = sign(&secp, msg_digest, seckey).unwrap();

let serialize_sig = signature.serialize_compact();

assert!(verify(&secp, msg, serialize_sig, pubkey).unwrap());
assert!(verify(&secp, msg_digest, serialize_sig, pubkey).unwrap());
}
18 changes: 7 additions & 11 deletions examples/sign_verify_recovery.rs
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
extern crate hashes;
extern crate secp256k1;

use hashes::{sha256, Hash};
use secp256k1::{ecdsa, Error, Message, PublicKey, Secp256k1, SecretKey, Signing, Verification};

fn recover<C: Verification>(
secp: &Secp256k1<C>,
msg: &[u8],
msg_digest: [u8; 32],
sig: [u8; 64],
recovery_id: u8,
) -> Result<PublicKey, Error> {
let msg = sha256::Hash::hash(msg);
let msg = Message::from_digest(msg.to_byte_array());
let msg = Message::from_digest(msg_digest);
let id = ecdsa::RecoveryId::try_from(i32::from(recovery_id))?;
let sig = ecdsa::RecoverableSignature::from_compact(&sig, id)?;

Expand All @@ -20,11 +17,10 @@ fn recover<C: Verification>(

fn sign_recovery<C: Signing>(
secp: &Secp256k1<C>,
msg: &[u8],
msg_digest: [u8; 32],
seckey: [u8; 32],
) -> Result<ecdsa::RecoverableSignature, Error> {
let msg = sha256::Hash::hash(msg);
let msg = Message::from_digest(msg.to_byte_array());
let msg = Message::from_digest(msg_digest);
let seckey = SecretKey::from_byte_array(seckey)?;
Ok(secp.sign_ecdsa_recoverable(msg, &seckey))
}
Expand All @@ -41,11 +37,11 @@ fn main() {
134, 245, 114, 45, 63, 82, 19, 251, 210, 57, 79, 54,
])
.unwrap();
let msg = b"This is some message";
let msg_digest = *b"this must be secure hash output.";

let signature = sign_recovery(&secp, msg, seckey).unwrap();
let signature = sign_recovery(&secp, msg_digest, seckey).unwrap();

let (recovery_id, serialize_sig) = signature.serialize_compact();

assert_eq!(recover(&secp, msg, serialize_sig, recovery_id.to_u8()), Ok(pubkey));
assert_eq!(recover(&secp, msg_digest, serialize_sig, recovery_id.to_u8()), Ok(pubkey));
}
34 changes: 3 additions & 31 deletions src/ecdh.rs
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,9 @@ impl AsRef<[u8]> for SharedSecret {
/// 64 bytes representing the (x,y) co-ordinates of a point on the curve (32 bytes each).
///
/// # Examples
/// ```
/// # #[cfg(all(feature = "hashes", feature = "rand", feature = "std"))] {
/// # use secp256k1::{ecdh, rand, Secp256k1, PublicKey, SecretKey};
/// # use secp256k1::hashes::{Hash, sha512};
/// ```ignore
/// use bitcoin_hashes::{Hash, sha512};
/// use secp256k1::{ecdh, rand, Secp256k1, PublicKey, SecretKey};
///
/// let s = Secp256k1::new();
/// let (sk1, pk1) = s.generate_keypair(&mut rand::rng());
Expand All @@ -124,7 +123,6 @@ impl AsRef<[u8]> for SharedSecret {
/// let point2 = ecdh::shared_secret_point(&pk1, &sk2);
/// let secret2 = sha512::Hash::hash(&point2);
/// assert_eq!(secret1, secret2)
/// # }
/// ```
pub fn shared_secret_point(point: &PublicKey, scalar: &SecretKey) -> [u8; 64] {
let mut xy = [0u8; 64];
Expand Down Expand Up @@ -224,32 +222,6 @@ mod tests {
assert_eq!(y, new_y);
}

#[test]
#[cfg(not(secp256k1_fuzz))]
#[cfg(all(feature = "hashes", feature = "rand", feature = "std"))]
fn hashes_and_sys_generate_same_secret() {
use hashes::{sha256, Hash, HashEngine};

use crate::ecdh::shared_secret_point;

let s = Secp256k1::signing_only();
let (sk1, _) = s.generate_keypair(&mut rand::rng());
let (_, pk2) = s.generate_keypair(&mut rand::rng());

let secret_sys = SharedSecret::new(&pk2, &sk1);

let xy = shared_secret_point(&pk2, &sk1);

// Mimics logic in `bitcoin-core/secp256k1/src/module/main_impl.h`
let version = (xy[63] & 0x01) | 0x02;
let mut engine = sha256::HashEngine::default();
engine.input(&[version]);
engine.input(&xy.as_ref()[..32]);
let secret_bh = sha256::Hash::from_engine(engine);

assert_eq!(secret_bh.as_byte_array(), secret_sys.as_ref());
}

#[test]
#[cfg(all(feature = "serde", feature = "alloc"))]
fn serde() {
Expand Down
19 changes: 2 additions & 17 deletions src/key.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ use crate::ellswift::ElligatorSwift;
use crate::ffi::types::c_uint;
use crate::ffi::{self, CPtr};
use crate::Error::{self, InvalidPublicKey, InvalidPublicKeySum, InvalidSecretKey};
#[cfg(feature = "hashes")]
#[allow(deprecated)]
use crate::ThirtyTwoByteHash;
#[cfg(feature = "global-context")]
use crate::SECP256K1;
use crate::{
Expand Down Expand Up @@ -371,15 +368,6 @@ impl SecretKey {
}
}

#[cfg(feature = "hashes")]
#[allow(deprecated)]
impl<T: ThirtyTwoByteHash> From<T> for SecretKey {
/// Converts a 32-byte hash directly to a secret key without error paths.
fn from(t: T) -> SecretKey {
SecretKey::from_byte_array(t.into_32()).expect("failed to create secret key")
}
}

#[cfg(feature = "serde")]
impl serde::Serialize for SecretKey {
fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
Expand Down Expand Up @@ -1889,15 +1877,12 @@ mod test {
}

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

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

let mut buf = [0u8; constants::SECRET_KEY_SIZE * 2];
assert_eq!(
Expand Down
Loading
Loading