Struct k256::ecdsa::recoverable::Signature

pub struct Signature { /* private fields */ }

This is supported on crate feature ecdsa-core only.

Ethereum-style “recoverable signatures” which allow for the recovery of the signer’s VerifyingKey from the signature itself.

This format consists of Signature followed by a 1-byte recovery Id (65-bytes total):

• r: 32-byte integer, big endian
• s: 32-byte integer, big endian
• v: 1-byte recovery Id

Implementations

impl Signature

pub fn new(signature: &Signature, recovery_id: Id) -> Result<Self>

Create a new recoverable ECDSA/secp256k1 signature from a regular fixed-size signature and an associated recovery Id.

This is an “unchecked” conversion and assumes the provided Id is valid for this signature.

pub fn recovery_id(self) -> Id

Get the recovery Id for this signature

pub fn from_trial_recovery(
    public_key: &VerifyingKey,
    msg: &[u8],
    signature: &Signature
) -> Result<Self>

This is supported on crate features ecdsa and keccak256 only.

Given a public key, message, and signature, use trial recovery to determine if a suitable recovery ID exists, or return an error otherwise.

Assumes Keccak256 as the message digest function. Use Signature::from_digest_trial_recovery to support other digest functions.

pub fn from_digest_trial_recovery<D>(
    public_key: &VerifyingKey,
    digest: D,
    signature: &Signature
) -> Result<Self> where
    D: Clone + Digest + FixedOutput<OutputSize = U32>, 

This is supported on crate feature ecdsa only.

Given a public key, message digest, and signature, use trial recovery to determine if a suitable recovery ID exists, or return an error otherwise.

pub fn recover_verify_key(&self, msg: &[u8]) -> Result<VerifyingKey>

This is supported on crate features ecdsa and keccak256 only.

Recover the public key used to create the given signature as a VerifyingKey.

pub fn recover_verify_key_from_digest<D>(
    &self,
    msg_digest: D
) -> Result<VerifyingKey> where
    D: Digest<OutputSize = U32>, 

This is supported on crate feature ecdsa only.

Recover the public key used to create the given signature as a VerifyingKey from the provided precomputed Digest.

pub fn recover_verify_key_from_digest_bytes(
    &self,
    digest_bytes: &FieldBytes
) -> Result<VerifyingKey>

This is supported on crate feature ecdsa only.

Recover the public key used to create the given signature as a VerifyingKey from the raw bytes of a message digest.

pub fn r(&self) -> NonZeroScalar

This is supported on crate feature ecdsa only.

Parse the r component of this signature to a NonZeroScalar

pub fn s(&self) -> NonZeroScalar

This is supported on crate feature ecdsa only.

Parse the s component of this signature to a NonZeroScalar

Trait Implementations

impl AsRef<[u8]> for Signature

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for Signature

fn clone(&self) -> Signature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<D> DigestSigner<D, Signature> for SigningKey where
    D: CoreProxy + Digest + FixedOutput<OutputSize = U32>,
    D::Core: BlockSizeUser + BufferKindUser<BufferKind = Eager> + Clone + Default + FixedOutputCore + HashMarker + OutputSizeUser<OutputSize = D::OutputSize>,
    <D::Core as BlockSizeUser>::BlockSize: IsLess<U256>,
    Le<<D::Core as BlockSizeUser>::BlockSize, U256>: NonZero, 

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

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<D> DigestVerifier<D, Signature> for VerifyingKey where
    D: Digest + FixedOutput<OutputSize = U32>, 

fn verify_digest(&self, digest: D, signature: &Signature) -> Result<(), Error>

Verify the signature against the given Digest output.

impl From<Signature> for Signature

fn from(sig: Signature) -> Self

Performs the conversion.

impl PartialEq<Signature> for Signature

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PrehashSignature for Signature

type Digest = Keccak256

Preferred Digest algorithm to use when computing this signature type.

impl<D> RandomizedDigestSigner<D, Signature> for SigningKey where
    D: CoreProxy + Digest + FixedOutput<OutputSize = U32>,
    D::Core: BlockSizeUser + BufferKindUser<BufferKind = Eager> + Clone + Default + FixedOutputCore + HashMarker + OutputSizeUser<OutputSize = D::OutputSize>,
    <D::Core as BlockSizeUser>::BlockSize: IsLess<U256>,
    Le<<D::Core as BlockSizeUser>::BlockSize, U256>: NonZero, 

fn try_sign_digest_with_rng(
    &self,
    rng: impl CryptoRng + RngCore,
    msg_digest: D
) -> Result<Signature, Error>

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: impl CryptoRng + RngCore, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl Signature for Signature

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

Parse a signature from its byte representation

fn as_bytes(&self) -> &[u8]

Borrow a byte slice representing the serialized form of this signature

impl TryFrom<&'_ [u8]> for Signature

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Signature

impl Eq for Signature