Struct ring_compat::signature::ecdsa::Signature

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

Available on crate feature signature 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>::Output: ArrayLength<u8>,

pub fn from_bytes( bytes: &GenericArray<u8, <<C as Curve>::FieldBytesSize as Add>::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>::Output as Add<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B1>>>::Output: ArrayLength<u8>, <<C as Curve>::FieldBytesSize as Add>::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>::Output>

Serialize this signature as bytes.

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

Available on crate feature alloc only.

Convert this signature into a byte vector.

Trait Implementations

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>::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>::Output: ArrayLength<u8>,

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

Formats the value using the given formatter.

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

fn from( signature: Signature<C> ) -> GenericArray<u8, <<C as Curve>::FieldBytesSize as Add>::Output>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Formats the value using the given formatter.

impl<C> PartialEq for Signature<C>where C: PartialEq + 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> SignatureEncoding for Signature<C>where C: PrimeCurve, <<C as Curve>::FieldBytesSize as Add>::Output: ArrayLength<u8>,

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

Byte representation of a signature.

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

Encode signature as its byte representation.

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

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<C> Signer<Signature<C>> for SigningKey<C>where C: CurveAlg, SignatureSize<C>: ArrayLength<u8>,

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

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

Formats the value using the given formatter.

impl<C> Verifier<Signature<C>> for VerifyingKey<C>where C: CurveAlg + PrimeCurve, FieldBytesSize<C>: ModulusSize, SignatureSize<C>: ArrayLength<u8>,

fn verify(&self, msg: &[u8], sig: &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: PrimeCurve, <<C as Curve>::FieldBytesSize as Add>::Output: ArrayLength<u8>, <<<C as Curve>::FieldBytesSize as Add>::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,