Struct k256::ecdsa::recoverable::Signature

source · [−]

pub struct Signature { /* private fields */ }

Available on crate feature ecdsa-core only.

Expand description

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

source

impl Signature

source

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.

source

pub fn recovery_id(self) -> Id

Get the recovery Id for this signature

source

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

Available 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.

source

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

Available 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.

source

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

Available on crate features ecdsa and keccak256 only.

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

source

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

Available on crate feature ecdsa only.

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

source

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

Available 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.

source

pub fn r(&self) -> NonZeroScalar

Available on crate feature ecdsa only.

Parse the r component of this signature to a NonZeroScalar

source

pub fn s(&self) -> NonZeroScalar

Available on crate feature ecdsa only.

Parse the s component of this signature to a NonZeroScalar

Trait Implementations

source

impl AsRef<[u8]> for Signature

source

fn as_ref(&self) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

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

source

impl Clone for Signature

source

fn clone(&self) -> Signature

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Signature

source

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

Formats the value using the given formatter. Read more

source

impl<D> DigestSigner<D, Signature> for SigningKey where
D: Digest + FixedOutput<OutputSize = U32>,

source

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. Read more

source

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

Sign the given prehashed message Digest, returning a signature. Read more

source

impl<D> DigestVerifier<D, Signature> for VerifyingKey where
D: Digest + FixedOutput<OutputSize = U32>,

source

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

Verify the signature against the given Digest output.

source

impl From<Signature> for Signature

source

fn from(sig: Signature) -> Self

Converts to this type from the input type.

source

impl PartialEq<Signature> for Signature

source

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

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

source

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

This method tests for !=.

source

impl PrehashSignature for Signature

type Digest = CoreWrapper<Keccak256Core>

Preferred Digest algorithm to use when computing this signature type.

source

impl<D> RandomizedDigestSigner<D, Signature> for SigningKey where
D: Digest + FixedOutput<OutputSize = U32>,

source

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. Read more

source

fn sign_digest_with_rng(&self, rng: impl CryptoRng + RngCore, digest: D) -> S

Sign the given prehashed message Digest, returning a signature. Read more

source

impl Signature for Signature

source

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

Parse a signature from its byte representation

source

fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

Borrow a byte slice representing the serialized form of this signature

source

impl TryFrom<&[u8]> for Signature

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl StructuralPartialEq for Signature

Auto Trait Implementations

impl RefUnwindSafe for Signature

impl Send for Signature

impl Sync for Signature

impl Unpin for Signature

impl UnwindSafe for Signature

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct k256::ecdsa::recoverable::Signature

Implementations

impl Signature

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

pub fn recovery_id(self) -> Id

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

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

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

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

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

pub fn r(&self) -> NonZeroScalar

pub fn s(&self) -> NonZeroScalar

Trait Implementations

impl AsRef<[u8]> for Signature

fn as_ref(&self) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]

impl Clone for Signature

fn clone(&self) -> Signature

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

impl Debug for Signature

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

impl<D> DigestSigner<D, Signature> for SigningKey where D: Digest + FixedOutput<OutputSize = U32>,

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

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

impl<D> DigestVerifier<D, Signature> for VerifyingKey where D: Digest + FixedOutput<OutputSize = U32>,

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

impl From<Signature> for Signature

fn from(sig: Signature) -> Self

impl PartialEq<Signature> for Signature

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

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

impl PrehashSignature for Signature

type Digest = CoreWrapper<Keccak256Core>

impl<D> RandomizedDigestSigner<D, Signature> for SigningKey where D: Digest + FixedOutput<OutputSize = U32>,

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

fn sign_digest_with_rng(&self, rng: impl CryptoRng + RngCore, digest: D) -> S

impl Signature for Signature

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

fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]

impl TryFrom<&[u8]> for Signature

type Error = Error

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

impl Copy for Signature

impl Eq for Signature

impl StructuralEq for Signature

impl StructuralPartialEq for Signature

Auto Trait Implementations

impl RefUnwindSafe for Signature

impl Send for Signature

impl Sync for Signature

impl Unpin for Signature

impl UnwindSafe for Signature

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

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

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

fn as_ref(&self) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

impl<D> DigestSigner<D, Signature> for SigningKey where
D: Digest + FixedOutput<OutputSize = U32>,

impl<D> DigestVerifier<D, Signature> for VerifyingKey where
D: Digest + FixedOutput<OutputSize = U32>,

impl<D> RandomizedDigestSigner<D, Signature> for SigningKey where
D: Digest + FixedOutput<OutputSize = U32>,

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

fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]`impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,