Struct signatory::ecdsa::Signature

pub struct Signature<C>where
    C: PrimeCurve,{ /* private fields */ }

Available on crate feature ecdsa only.

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

Both r and s MUST be non-zero.

For example, in a curve with a 256-bit modulus like NIST P-256 or secp256k1, r and s will both be 32-bytes and serialized as big endian, 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.

serde support

When the serde feature of this crate is enabled, it provides support for serializing and deserializing ECDSA signatures using the Serialize and Deserialize traits.

The serialization uses a hexadecimal encoding when used with “human readable” text formats, and a binary encoding otherwise.

Implementations

impl<C> Signature<C>where C: PrimeCurve, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>,

pub fn from_bytes( bytes: &GenericArray<u8, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output> ) -> Result<Signature<C>, Error>

Parse a signature from fixed-width bytes, i.e. 2 * the size of [FieldBytes] for a particular curve.

Returns

• Ok(signature) if the r and s components are both in the valid range 1..n when serialized as concatenated big endian integers.
• Err(err) if the r and/or s component of the signature is out-of-range when interpreted as a big endian integer.

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

Parse a signature from a byte slice.

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

Available on crate feature der only.

Parse a signature from ASN.1 DER.

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

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

Returns

• Ok(signature) if the r and s components are both in the valid range 1..n when serialized as concatenated big endian integers.
• Err(err) if the r and/or s component of the signature is out-of-range when interpreted as a big endian integer.

pub fn split_bytes( &self ) -> (GenericArray<u8, <C as Curve>::FieldBytesSize>, GenericArray<u8, <C as Curve>::FieldBytesSize>)

Split the signature into its r and s components, represented as bytes.

pub fn to_bytes( &self ) -> GenericArray<u8, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output>

Serialize this signature as bytes.

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

Available on crate feature der only.

Serialize this signature as ASN.1 DER.

pub fn to_vec(&self) -> Vec<u8, Global>

Available on crate feature alloc only.

Convert this signature into a byte vector.

impl<C> Signature<C>where C: PrimeCurve + CurveArithmetic, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>,

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

Available on crate feature arithmetic only.

Get the r component of this signature

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

Available on crate feature arithmetic only.

Get the s component of this signature

pub fn split_scalars(&self) -> (NonZeroScalar<C>, NonZeroScalar<C>)

Available on crate feature arithmetic only.

Split the signature into its r and s scalars.

pub fn normalize_s(&self) -> Option<Signature<C>>

Available on crate feature arithmetic only.

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

Trait Implementations

impl<C> AssociatedAlgorithmIdentifier for Signature<C>where C: PrimeCurve, Signature<C>: AssociatedOid,

Available on crate feature pkcs8 only.

ECDSA AlgorithmIdentifier which identifies the digest used by default with the Signer and Verifier traits.

type Params = AnyRef<'static>

Algorithm parameters.

const ALGORITHM_IDENTIFIER: AlgorithmIdentifier<AnyRef<'static>> = AlgorithmIdentifierRef{ oid: Self::OID, parameters: None,}

AlgorithmIdentifier for this structure.

impl<C> AssociatedOid for Signature<C>where C: DigestPrimitive, <C as DigestPrimitive>::Digest: AssociatedOid,

Available on crate features digest and hazmat only.

ECDSA [ObjectIdentifier] which identifies the digest used by default with the Signer and Verifier traits.

To support non-default digest algorithms, use the SignatureWithOid type instead.

const OID: ObjectIdentifier = match ecdsa_oid_for_digest(<C::Digest>::OID) { Some(oid) => oid, None => { ::core::panicking::panic_fmt(<#[lang = "format_arguments"]>::new_const(&["no RFC5758 ECDSA OID defined for DigestPrimitive::Digest"])); } }

The OID associated with this type.

impl<C> Clone for Signature<C>where C: Clone + PrimeCurve,

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: PrimeCurve, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>,

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

Formats the value using the given formatter.

impl<C> Display for Signature<C>where C: PrimeCurve, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>,

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

Formats the value using the given formatter.

impl<C> From<SignatureWithOid<C>> for Signature<C>where C: PrimeCurve,

Available on crate feature digest only.

fn from(sig: SignatureWithOid<C>) -> Signature<C>

Converts to this type from the input type.

impl<C> FromStr for Signature<C>where C: PrimeCurve + CurveArithmetic, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>,

Available on crate feature arithmetic only.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(hex: &str) -> Result<Signature<C>, Error>

Parses a string s to return a value of this type.

impl<C> LowerHex for Signature<C>where C: PrimeCurve, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>,

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

Formats the value using the given formatter.

impl<C> PartialEq<Signature<C>> for Signature<C>where C: PartialEq<C> + PrimeCurve,

fn eq(&self, other: &Signature<C>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

Available on crate feature digest only.

type Digest = <C as DigestPrimitive>::Digest

Preferred Digest algorithm to use when computing this signature type.

impl<C> SignatureEncoding for Signature<C>where C: PrimeCurve, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>,

type Repr = GenericArray<u8, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output>

Byte representation of a signature.

fn to_bytes(&self) -> Self::Repr

Encode signature as its byte representation.

fn to_vec(&self) -> Vec<u8, Global>

Available on crate feature alloc only.

Encode signature as a byte vector.

fn encoded_len(&self) -> usize

Get the length of this signature when encoded.

impl Signer<Signature<NistP256>> for SigningKey

Available on crate feature nistp256 only.

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 Signer<Signature<NistP384>> for SigningKey

Available on crate feature nistp384 only.

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 Signer<Signature<Secp256k1>> for SigningKey

Available on crate feature secp256k1 only.

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<C> TryFrom<&[u8]> for Signature<C>where C: PrimeCurve, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<C> UpperHex for Signature<C>where C: PrimeCurve, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>,

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

Formats the value using the given formatter.

impl<C> Copy for Signature<C>where C: PrimeCurve, <<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output: ArrayLength<u8>, <<<C as Curve>::FieldBytesSize as Add<<C as Curve>::FieldBytesSize>>::Output as ArrayLength<u8>>::ArrayType: Copy,

impl<C> Eq for Signature<C>where C: Eq + PrimeCurve,

impl<C> StructuralEq for Signature<C>where C: PrimeCurve,

impl<C> StructuralPartialEq for Signature<C>where C: PrimeCurve,