Struct Secp256k1

pub struct Secp256k1<C>where
    C: Context,
{ /* private fields */ }

Expand description

The secp256k1 engine, used to execute all signature operations.

Implementations§

§

impl<C> Secp256k1<C>
where C: Context,

pub fn gen_new() -> Secp256k1<C>

Lets you create a context in a generic manner (sign/verify/all).

If rand-std feature is enabled, context will have been randomized using thread_rng. If rand-std feature is not enabled please consider randomizing the context as follows:

let mut ctx = Secp256k1::new();
// let seed = <32 bytes of random data>
ctx.seeded_randomize(&seed);

§

impl Secp256k1<All>

pub fn new() -> Secp256k1<All>

Creates a new Secp256k1 context with all capabilities.

If rand-std feature is enabled, context will have been randomized using thread_rng. If rand-std feature is not enabled please consider randomizing the context (see docs for Secp256k1::gen_new()).

§

impl Secp256k1<SignOnly>

pub fn signing_only() -> Secp256k1<SignOnly>

Creates a new Secp256k1 context that can only be used for signing.

If rand-std feature is enabled, context will have been randomized using thread_rng. If rand-std feature is not enabled please consider randomizing the context (see docs for Secp256k1::gen_new()).

§

impl Secp256k1<VerifyOnly>

pub fn verification_only() -> Secp256k1<VerifyOnly>

Creates a new Secp256k1 context that can only be used for verification.

If rand-std feature is enabled, context will have been randomized using thread_rng.
If rand-std feature is not enabled please consider randomizing the context (see docs for Secp256k1::gen_new()).

§

impl<'buf, C> Secp256k1<C>
where C: Context + PreallocatedContext<'buf>,

pub fn preallocated_gen_new( buf: &'buf mut [AlignedType], ) -> Result<Secp256k1<C>, Error>

Lets you create a context with a preallocated buffer in a generic manner (sign/verify/all).

§

impl<'buf> Secp256k1<AllPreallocated<'buf>>

pub fn preallocated_new( buf: &'buf mut [AlignedType], ) -> Result<Secp256k1<AllPreallocated<'buf>>, Error>

Creates a new Secp256k1 context with all capabilities.

pub fn preallocate_size() -> usize

Uses the ffi secp256k1_context_preallocated_size to check the memory size needed for a context.

pub unsafe fn from_raw_all( raw_ctx: NonNull<Context>, ) -> ManuallyDrop<Secp256k1<AllPreallocated<'buf>>>

Creates a context from a raw context.

The returned core::mem::ManuallyDrop context will never deallocate the memory pointed to by raw_ctx nor destroy the context. This may lead to memory leaks. ManuallyDrop::drop (or core::ptr::drop_in_place) will only destroy the context; the caller is required to free the memory.

§Safety

This is highly unsafe due to a number of conditions that aren’t checked, specifically:

raw_ctx must be a valid pointer (live, aligned…) to memory that was initialized by secp256k1_context_preallocated_create (either called directly or from this library by one of the context creation methods - all of which call it internally).
The version of libsecp256k1 used to create raw_ctx must be exactly the one linked into this library.
The lifetime of the raw_ctx pointer must outlive 'buf.
raw_ctx must point to writable memory (cannot be ffi::secp256k1_context_no_precomp).

§

impl<'buf> Secp256k1<SignOnlyPreallocated<'buf>>

pub fn preallocated_signing_only( buf: &'buf mut [AlignedType], ) -> Result<Secp256k1<SignOnlyPreallocated<'buf>>, Error>

Creates a new Secp256k1 context that can only be used for signing.

pub fn preallocate_signing_size() -> usize

Uses the ffi secp256k1_context_preallocated_size to check the memory size needed for the context.

pub unsafe fn from_raw_signing_only( raw_ctx: NonNull<Context>, ) -> ManuallyDrop<Secp256k1<SignOnlyPreallocated<'buf>>>

Creates a context from a raw context that can only be used for signing.

§Safety

Please see Secp256k1::from_raw_all for full documentation and safety requirements.

§

impl<'buf> Secp256k1<VerifyOnlyPreallocated<'buf>>

pub fn preallocated_verification_only( buf: &'buf mut [AlignedType], ) -> Result<Secp256k1<VerifyOnlyPreallocated<'buf>>, Error>

Creates a new Secp256k1 context that can only be used for verification

pub fn preallocate_verification_size() -> usize

Uses the ffi secp256k1_context_preallocated_size to check the memory size needed for the context.

pub unsafe fn from_raw_verification_only( raw_ctx: NonNull<Context>, ) -> ManuallyDrop<Secp256k1<VerifyOnlyPreallocated<'buf>>>

Creates a context from a raw context that can only be used for verification.

§Safety

Please see Secp256k1::from_raw_all for full documentation and safety requirements.

§

impl<C> Secp256k1<C>
where C: Signing,

pub fn sign_ecdsa_recoverable( &self, msg: &Message, sk: &SecretKey, ) -> RecoverableSignature

Constructs a signature for msg using the secret key sk and RFC6979 nonce Requires a signing-capable context.

pub fn sign_ecdsa_recoverable_with_noncedata( &self, msg: &Message, sk: &SecretKey, noncedata: &[u8; 32], ) -> RecoverableSignature

Constructs a signature for msg using the secret key sk and RFC6979 nonce and includes 32 bytes of noncedata in the nonce generation via inclusion in one of the hash operations during nonce generation. This is useful when multiple signatures are needed for the same Message and SecretKey while still using RFC6979. Requires a signing-capable context.

§

impl<C> Secp256k1<C>
where C: Verification,

pub fn recover_ecdsa( &self, msg: &Message, sig: &RecoverableSignature, ) -> Result<PublicKey, Error>

Determines the public key for which sig is a valid signature for msg. Requires a verify-capable context.

§

impl<C> Secp256k1<C>
where C: Signing,

pub fn sign_ecdsa(&self, msg: &Message, sk: &SecretKey) -> Signature

Constructs a signature for msg using the secret key sk and RFC6979 nonce Requires a signing-capable context.

pub fn sign_ecdsa_with_noncedata( &self, msg: &Message, sk: &SecretKey, noncedata: &[u8; 32], ) -> Signature

Constructs a signature for msg using the secret key sk and RFC6979 nonce and includes 32 bytes of noncedata in the nonce generation via inclusion in one of the hash operations during nonce generation. This is useful when multiple signatures are needed for the same Message and SecretKey while still using RFC6979. Requires a signing-capable context.

pub fn sign_ecdsa_grind_r( &self, msg: &Message, sk: &SecretKey, bytes_to_grind: usize, ) -> Signature

Constructs a signature for msg using the secret key sk, RFC6979 nonce and “grinds” the nonce by passing extra entropy if necessary to produce a signature that is less than 71 - bytes_to_grind bytes. The number of signing operation performed by this function is exponential in the number of bytes grinded. Requires a signing capable context.

pub fn sign_ecdsa_low_r(&self, msg: &Message, sk: &SecretKey) -> Signature

Constructs a signature for msg using the secret key sk, RFC6979 nonce and “grinds” the nonce by passing extra entropy if necessary to produce a signature that is less than 71 bytes and compatible with the low r signature implementation of bitcoin core. In average, this function will perform two signing operations. Requires a signing capable context.

§

impl<C> Secp256k1<C>
where C: Verification,

pub fn verify_ecdsa( &self, msg: &Message, sig: &Signature, pk: &PublicKey, ) -> Result<(), Error>

Checks that sig is a valid ECDSA signature for msg using the public key pubkey. Returns Ok(()) on success. Note that this function cannot be used for Bitcoin consensus checking since there may exist signatures which OpenSSL would verify but not libsecp256k1, or vice-versa. Requires a verify-capable context.

let message = Message::from_digest_slice(&[0xab; 32]).expect("32 bytes");
let sig = secp.sign_ecdsa(&message, &secret_key);
assert_eq!(secp.verify_ecdsa(&message, &sig, &public_key), Ok(()));

let message = Message::from_digest_slice(&[0xcd; 32]).expect("32 bytes");
assert_eq!(secp.verify_ecdsa(&message, &sig, &public_key), Err(Error::IncorrectSignature));

§

impl<C> Secp256k1<C>
where C: Signing,

pub fn sign_schnorr(&self, msg: &Message, keypair: &Keypair) -> Signature

Creates a schnorr signature internally using the rand::rngs::ThreadRng random number generator to generate the auxiliary random data.

pub fn sign_schnorr_no_aux_rand( &self, msg: &Message, keypair: &Keypair, ) -> Signature

Creates a schnorr signature without using any auxiliary random data.

pub fn sign_schnorr_with_aux_rand( &self, msg: &Message, keypair: &Keypair, aux_rand: &[u8; 32], ) -> Signature

Creates a schnorr signature using the given auxiliary random data.

pub fn sign_schnorr_with_rng<R>( &self, msg: &Message, keypair: &Keypair, rng: &mut R, ) -> Signature
where R: Rng + CryptoRng,

Creates a schnorr signature using the given random number generator to generate the auxiliary random data.

§

impl<C> Secp256k1<C>
where C: Verification,

pub fn verify_schnorr( &self, sig: &Signature, msg: &Message, pubkey: &XOnlyPublicKey, ) -> Result<(), Error>

Verifies a schnorr signature.

§

impl<C> Secp256k1<C>
where C: Context,

pub fn ctx(&self) -> NonNull<Context>

Getter for the raw pointer to the underlying secp256k1 context. This shouldn’t be needed with normal usage of the library. It enables extending the Secp256k1 with more cryptographic algorithms outside of this crate.

pub fn preallocate_size_gen() -> usize

Returns the required memory for a preallocated context buffer in a generic manner(sign/verify/all).

pub fn randomize<R>(&mut self, rng: &mut R)
where R: Rng + ?Sized,

(Re)randomizes the Secp256k1 context for extra sidechannel resistance.

Requires compilation with “rand” feature. See comment by Gregory Maxwell in libsecp256k1.

pub fn seeded_randomize(&mut self, seed: &[u8; 32])

(Re)randomizes the Secp256k1 context for extra sidechannel resistance given 32 bytes of cryptographically-secure random data; see comment in libsecp256k1 commit d2275795f by Gregory Maxwell.

§