Struct SigningKey

pub struct SigningKey { /* private fields */ }

Taproot Schnorr signing key.

Implementations

impl SigningKey

pub fn random(rng: &mut impl CryptoRngCore) -> Self

Generate a cryptographically random SigningKey.

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Parse signing key from big endian-encoded bytes.

pub fn to_bytes(&self) -> FieldBytes

Serialize as bytes.

pub fn verifying_key(&self) -> &VerifyingKey

Get the VerifyingKey that corresponds to this signing key.

pub fn as_nonzero_scalar(&self) -> &NonZeroScalar

Borrow the secret NonZeroScalar value for this key.

⚠️ Warning

This value is key material.

Please treat it with the care it deserves!

pub fn sign_prehash_with_aux_rand( &self, msg_digest: &[u8; 32], aux_rand: &[u8; 32], ) -> Result<Signature>

Compute Schnorr signature.

⚠️ Warning

This is a low-level interface intended only for unusual use cases involving signing pre-hashed messages.

The preferred interfaces are the Signer or RandomizedSigner traits.

pub fn sign_raw(&self, msg: &[u8], aux_rand: &[u8; 32]) -> Result<Signature>

Compute Schnorr signature.

⚠️ Warning

This is a low-level interface intended only for unusual use cases involving signing pre-hashed messages, or “raw” messages where the message is not hashed at all prior to being used to generate the Schnorr signature.

The preferred interfaces are the Signer or RandomizedSigner traits.

Trait Implementations

impl AsRef<VerifyingKey> for SigningKey

fn as_ref(&self) -> &VerifyingKey

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SigningKey

fn clone(&self) -> SigningKey

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D> DigestSigner<D, Signature> for SigningKey

where D: Digest + FixedOutput<OutputSize = U32>,

fn try_sign_digest(&self, digest: D) -> Result<Signature>

Attempt to sign the given prehashed message Digest, returning a digital signature on success, or an error if something went wrong.

fn sign_digest(&self, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl Drop for SigningKey

fn drop(&mut self)

Executes the destructor for this type.

impl From<&SecretKey<Secp256k1>> for SigningKey

fn from(secret_key: &SecretKey) -> SigningKey

Converts to this type from the input type.

impl From<NonZeroScalar<Secp256k1>> for SigningKey

fn from(secret_key: NonZeroScalar) -> SigningKey

Converts to this type from the input type.

impl From<SecretKey<Secp256k1>> for SigningKey

fn from(secret_key: SecretKey) -> SigningKey

Converts to this type from the input type.

impl KeypairRef for SigningKey

type VerifyingKey = VerifyingKey

Verifying key type for this keypair.

impl PrehashSigner<Signature> for SigningKey

fn sign_prehash(&self, prehash: &[u8]) -> Result<Signature>

Attempt to sign the given message digest, returning a digital signature on success, or an error if something went wrong.

impl<D> RandomizedDigestSigner<D, Signature> for SigningKey

where D: Digest + FixedOutput<OutputSize = U32>,

fn try_sign_digest_with_rng( &self, rng: &mut impl CryptoRngCore, digest: D, ) -> Result<Signature>

Attempt to sign the given prehashed message Digest, returning a digital signature on success, or an error if something went wrong.

fn sign_digest_with_rng(&self, rng: &mut impl CryptoRngCore, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl RandomizedPrehashSigner<Signature> for SigningKey

fn sign_prehash_with_rng( &self, rng: &mut impl CryptoRngCore, prehash: &[u8], ) -> Result<Signature>

Attempt to sign the given message digest, returning a digital signature on success, or an error if something went wrong.

impl RandomizedSigner<Signature> for SigningKey

fn try_sign_with_rng( &self, rng: &mut impl CryptoRngCore, msg: &[u8], ) -> Result<Signature>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign_with_rng(&self, rng: &mut impl CryptoRngCore, msg: &[u8]) -> S

Sign the given message and return a digital signature

impl Signer<Signature> for SigningKey

fn try_sign(&self, msg: &[u8]) -> Result<Signature>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign(&self, msg: &[u8]) -> S

Sign the given message and return a digital signature

impl ZeroizeOnDrop for SigningKey