Struct ethers::signers::yubihsm::ecdsa::Signature

pub struct Signature<C> where
    C: Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>,  { /* fields omitted */ }

ECDSA signature (fixed-size). Generic over elliptic curve types.

Serialized as fixed-sized big endian scalar values with no added framing:

• r: field element size for the given curve, big-endian
• s: field element size for the given curve, big-endian

For example, in a curve with a 256-bit modulus like NIST P-256 or secp256k1, r and s will both be 32-bytes, resulting in a signature with a total of 64-bytes.

ASN.1 DER-encoded signatures also supported via the Signature::from_der and Signature::to_der methods.

Implementations

impl<C> Signature<C> where
    C: Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

pub fn from_scalars(
    r: impl Into<GenericArray<u8, <<C as Curve>::UInt as ArrayEncoding>::ByteSize>>,
    s: impl Into<GenericArray<u8, <<C as Curve>::UInt as ArrayEncoding>::ByteSize>>
) -> Result<Signature<C>, Error>

Create a Signature from the serialized r and s scalar values which comprise the signature.

pub fn from_der(bytes: &[u8]) -> Result<Signature<C>, Error> where
    <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output as Add<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>>::Output: ArrayLength<u8>,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: Add<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

Parse a signature from ASN.1 DER

pub fn to_der(&self) -> Signature<C> where
    <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output as Add<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>>::Output: ArrayLength<u8>,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: Add<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

Serialize this signature as ASN.1 DER

impl<C> Signature<C> where
    C: Curve + ProjectiveArithmetic,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

pub fn r(&self) -> NonZeroScalar<C>

Get the r component of this signature

pub fn s(&self) -> NonZeroScalar<C>

Get the s component of this signature

pub fn normalize_s(&mut self) -> Result<bool, Error> where
    <C as ScalarArithmetic>::Scalar: NormalizeLow, 

Normalize signature into “low S” form as described in BIP 0062: Dealing with Malleability.

Trait Implementations

impl<C> AsRef<[u8]> for Signature<C> where
    C: Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

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

Performs the conversion.

impl<C> Clone for Signature<C> where
    C: Clone + Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

pub fn clone(&self) -> Signature<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for Signature<C> where
    C: Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

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

Formats the value using the given formatter.

impl<C, D> DigestSigner<D, Signature<C>> for SigningKey<C> where
    C: Curve + ProjectiveArithmetic,
    D: FixedOutput<OutputSize = <<C as Curve>::UInt as ArrayEncoding>::ByteSize> + BlockInput + Clone + Default + Reset + Update,
    <C as ScalarArithmetic>::Scalar: FromDigest<C>,
    <C as ScalarArithmetic>::Scalar: Invert,
    <C as ScalarArithmetic>::Scalar: SignPrimitive<C>,
    <C as ScalarArithmetic>::Scalar: Zeroize,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>,
    <<C as ScalarArithmetic>::Scalar as Invert>::Output == <C as ScalarArithmetic>::Scalar, 

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

Sign message prehash using a deterministic ephemeral scalar (k) computed using the algorithm described in RFC 6979 (Section 3.2): https://tools.ietf.org/html/rfc6979#section-3

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

Sign the given prehashed message Digest, returning a signature.

impl<D> DigestSigner<D, Signature<NistP256>> for Signer<NistP256> where
    D: Digest<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>> + Default, 

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

Compute a fixed-sized P-256 ECDSA signature of the given digest

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

Sign the given prehashed message Digest, returning a signature.

impl<D> DigestSigner<D, Signature<NistP384>> for Signer<NistP384> where
    D: Digest<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>> + Default, 

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

Compute a fixed-sized P-384 ECDSA signature of the given digest

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

Sign the given prehashed message Digest, returning a signature.

impl<D> DigestSigner<D, Signature<Secp256k1>> for SigningKey where
    D: BlockInput + FixedOutput<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>> + Clone + Default + Reset + Update, 

pub fn try_sign_digest(&self, digest: D) -> Result<Signature<Secp256k1>, 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> DigestSigner<D, Signature<Secp256k1>> for DerivedXPriv where
    D: BlockInput + FixedOutput<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>> + Clone + Default + Reset + Update, 

pub fn try_sign_digest(&self, digest: D) -> Result<Signature<Secp256k1>, 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> DigestSigner<D, Signature<Secp256k1>> for XPriv where
    D: BlockInput + FixedOutput<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>> + Clone + Default + Reset + Update, 

pub fn try_sign_digest(&self, digest: D) -> Result<Signature<Secp256k1>, 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> DigestSigner<D, Signature<Secp256k1>> for Signer<Secp256k1> where
    D: Digest<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>> + Default, 

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

Compute a fixed-size secp256k1 ECDSA signature of the given digest

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

Sign the given prehashed message Digest, returning a signature.

impl<C, D> DigestVerifier<D, Signature<C>> for VerifyingKey<C> where
    C: Curve + ProjectiveArithmetic,
    D: Digest<OutputSize = <<C as Curve>::UInt as ArrayEncoding>::ByteSize>,
    <C as AffineArithmetic>::AffinePoint: VerifyPrimitive<C>,
    <C as ScalarArithmetic>::Scalar: FromDigest<C>,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

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

Verify the signature against the given Digest output.

impl<D> DigestVerifier<D, Signature<Secp256k1>> for VerifyingKey where
    D: Digest<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>, 

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

Verify the signature against the given Digest output.

impl<D> DigestVerifier<D, Signature<Secp256k1>> for XPub where
    D: Digest<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>, 

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

Verify the signature against the given Digest output.

impl<D> DigestVerifier<D, Signature<Secp256k1>> for DerivedXPub where
    D: Digest<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>, 

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

Verify the signature against the given Digest output.

impl<D> DigestVerifier<D, Signature<Secp256k1>> for DerivedPubkey where
    D: Digest<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>, 

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

Verify the signature against the given Digest output.

impl From<Signature> for Signature<Secp256k1>

pub fn from(sig: Signature) -> Signature<Secp256k1>

Performs the conversion.

impl<C> PartialEq<Signature<C>> for Signature<C> where
    C: PartialEq<C> + Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

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

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

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

This method tests for !=.

impl<C> PrehashSignature for Signature<C> where
    C: DigestPrimitive,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

type Digest = <C as DigestPrimitive>::Digest

Preferred Digest algorithm to use when computing this signature type.

impl<C, D> RandomizedDigestSigner<D, Signature<C>> for SigningKey<C> where
    C: Curve + ProjectiveArithmetic,
    D: FixedOutput<OutputSize = <<C as Curve>::UInt as ArrayEncoding>::ByteSize> + BlockInput + Clone + Default + Reset + Update,
    <C as ScalarArithmetic>::Scalar: FromDigest<C>,
    <C as ScalarArithmetic>::Scalar: Invert,
    <C as ScalarArithmetic>::Scalar: SignPrimitive<C>,
    <C as ScalarArithmetic>::Scalar: Zeroize,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>,
    <<C as ScalarArithmetic>::Scalar as Invert>::Output == <C as ScalarArithmetic>::Scalar, 

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

Sign message prehash using an ephemeral scalar (k) derived according to a variant of RFC 6979 (Section 3.6) which supplies additional entropy from an RNG.

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

Sign the given prehashed message Digest, returning a signature.

impl<D> RandomizedDigestSigner<D, Signature<Secp256k1>> for SigningKey where
    D: BlockInput + FixedOutput<OutputSize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>> + Clone + Default + Reset + Update, 

pub fn try_sign_digest_with_rng(
    &self,
    rng: impl CryptoRng + RngCore,
    digest: D
) -> Result<Signature<Secp256k1>, 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<C> RandomizedSigner<Signature<C>> for SigningKey<C> where
    C: Curve + ProjectiveArithmetic + DigestPrimitive,
    SigningKey<C>: RandomizedDigestSigner<<C as DigestPrimitive>::Digest, Signature<C>>,
    <C as ScalarArithmetic>::Scalar: FromDigest<C>,
    <C as ScalarArithmetic>::Scalar: Invert,
    <C as ScalarArithmetic>::Scalar: SignPrimitive<C>,
    <C as ScalarArithmetic>::Scalar: Zeroize,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>,
    <<C as ScalarArithmetic>::Scalar as Invert>::Output == <C as ScalarArithmetic>::Scalar, 

pub fn try_sign_with_rng(
    &self,
    rng: impl CryptoRng + RngCore,
    msg: &[u8]
) -> Result<Signature<C>, Error>

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: impl CryptoRng + RngCore, msg: &[u8]) -> S

Sign the given message and return a digital signature

impl<C> Signature for Signature<C> where
    C: Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

pub fn from_bytes(bytes: &[u8]) -> Result<Signature<C>, Error>

Parse a signature from its byte representation

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

Borrow a byte slice representing the serialized form of this signature

impl<C> Signer<Signature<C>> for SigningKey<C> where
    C: Curve + ProjectiveArithmetic + DigestPrimitive,
    SigningKey<C>: DigestSigner<<C as DigestPrimitive>::Digest, Signature<C>>,
    <C as ScalarArithmetic>::Scalar: FromDigest<C>,
    <C as ScalarArithmetic>::Scalar: Invert,
    <C as ScalarArithmetic>::Scalar: SignPrimitive<C>,
    <C as ScalarArithmetic>::Scalar: Zeroize,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>,
    <<C as ScalarArithmetic>::Scalar as Invert>::Output == <C as ScalarArithmetic>::Scalar, 

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

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<'_, C> TryFrom<&'_ [u8]> for Signature<C> where
    C: Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(bytes: &[u8]) -> Result<Signature<C>, Error>

Performs the conversion.

impl<C> TryFrom<Signature<C>> for Signature<C> where
    C: Curve,
    <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output as Add<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>>::Output: ArrayLength<u8>,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: Add<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(sig: Signature<C>) -> Result<Signature<C>, Error>

Performs the conversion.

impl<C> Verifier<Signature<C>> for VerifyingKey<C> where
    C: Curve + ProjectiveArithmetic + DigestPrimitive,
    <C as DigestPrimitive>::Digest: Digest,
    <C as AffineArithmetic>::AffinePoint: VerifyPrimitive<C>,
    <C as ScalarArithmetic>::Scalar: FromDigest<C>,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>,
    <<C as DigestPrimitive>::Digest as Digest>::OutputSize == <<C as Curve>::UInt as ArrayEncoding>::ByteSize, 

pub fn verify(&self, msg: &[u8], signature: &Signature<C>) -> Result<(), Error>

Use Self to verify that the provided signature for a given message bytestring is authentic.

impl<C> Copy for Signature<C> where
    C: Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>,
    <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output as ArrayLength<u8>>::ArrayType: Copy, 

impl<C> Eq for Signature<C> where
    C: Eq + Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

impl<C> StructuralEq for Signature<C> where
    C: Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>, 

impl<C> StructuralPartialEq for Signature<C> where
    C: Curve,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>,