Struct ecdsa::SignatureWithOid

pub struct SignatureWithOid<C: PrimeCurve> { /* private fields */ }

Available on crate feature digest only.

An extended Signature type which is parameterized by an ObjectIdentifier which identifies the ECDSA variant used by a particular signature.

Valid ObjectIdentifiers are defined in RFC5758 § 3.2:

• SHA-224: ECDSA_SHA224_OID (1.2.840.10045.4.3.1)
• SHA-256: ECDSA_SHA256_OID (1.2.840.10045.4.3.2)
• SHA-384: ECDSA_SHA384_OID (1.2.840.10045.4.3.3)
• SHA-512: ECDSA_SHA512_OID (1.2.840.10045.4.3.4)

Implementations

impl<C> SignatureWithOid<C>where C: PrimeCurve,

pub fn new(signature: Signature<C>, oid: ObjectIdentifier) -> Result<Self>

Create a new signature with an explicitly provided OID.

OID must begin with 1.2.840.10045.4, the RFC5758 OID prefix for ECDSA variants.

pub fn new_with_digest<D>(signature: Signature<C>) -> Result<Self>where D: AssociatedOid + Digest,

Create a new signature, determining the OID from the given digest.

Supports SHA-2 family digests as enumerated in RFC5758 § 3.2, i.e. SHA-224, SHA-256, SHA-384, or SHA-512.

pub fn from_bytes_with_digest<D>(bytes: &SignatureBytes<C>) -> Result<Self>where D: AssociatedOid + Digest, SignatureSize<C>: ArrayLength<u8>,

Parse a signature from fixed-with bytes.

pub fn from_slice_with_digest<D>(slice: &[u8]) -> Result<Self>where D: AssociatedOid + Digest, SignatureSize<C>: ArrayLength<u8>,

Parse a signature from a byte slice.

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

Get the fixed-width ECDSA signature.

pub fn oid(&self) -> ObjectIdentifier

Get the ECDSA OID for this signature.

pub fn to_bytes(&self) -> SignatureBytes<C>where SignatureSize<C>: ArrayLength<u8>,

Serialize this signature as bytes.

Trait Implementations

impl<C: Clone + PrimeCurve> Clone for SignatureWithOid<C>

fn clone(&self) -> SignatureWithOid<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, D> DigestSigner<D, SignatureWithOid<C>> for SigningKey<C>where C: PrimeCurve + CurveArithmetic + DigestPrimitive, D: AssociatedOid + Digest + FixedOutput<OutputSize = FieldBytesSize<C>>, Scalar<C>: Invert<Output = CtOption<Scalar<C>>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

Available on crate feature signing only.

fn try_sign_digest(&self, msg_digest: D) -> Result<SignatureWithOid<C>>

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<C> DynAssociatedAlgorithmIdentifier for SignatureWithOid<C>where C: PrimeCurve,

Available on crate features alloc and pkcs8 only.

fn algorithm_identifier(&self) -> Result<AlgorithmIdentifierOwned>

AlgorithmIdentifier for this structure.

impl<C> From<SignatureWithOid<C>> for SignatureBytes<C>where C: PrimeCurve, SignatureSize<C>: ArrayLength<u8>,

fn from(signature: SignatureWithOid<C>) -> SignatureBytes<C>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<C: PartialEq + PrimeCurve> PartialEq for SignatureWithOid<C>

fn eq(&self, other: &SignatureWithOid<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 SignatureWithOid<C>where C: DigestPrimitive, C::Digest: AssociatedOid, SignatureSize<C>: ArrayLength<u8>,

Available on crate feature hazmat only.

NOTE: this implementation assumes the default digest for the given elliptic curve as defined by hazmat::DigestPrimitive.

When working with alternative digests, you will need to use e.g. SignatureWithOid::new_with_digest.

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<SignatureWithOid<C>> for SigningKey<C>where C: PrimeCurve + CurveArithmetic + DigestPrimitive, C::Digest: AssociatedOid, Scalar<C>: Invert<Output = CtOption<Scalar<C>>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

Available on crate feature signing only.

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

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 SignatureWithOid<C>where C: DigestPrimitive, C::Digest: AssociatedOid, SignatureSize<C>: ArrayLength<u8>,

Available on crate feature hazmat only.

NOTE: this implementation assumes the default digest for the given elliptic curve as defined by hazmat::DigestPrimitive.

When working with alternative digests, you will need to use e.g. SignatureWithOid::new_with_digest.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<C> Verifier<SignatureWithOid<C>> for VerifyingKey<C>where C: PrimeCurve + CurveArithmetic + DigestPrimitive, AffinePoint<C>: VerifyPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

Available on crate features verifying and sha2 only.

fn verify(&self, msg: &[u8], sig: &SignatureWithOid<C>) -> Result<()>

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

impl<C> Copy for SignatureWithOid<C>where C: PrimeCurve, SignatureSize<C>: ArrayLength<u8>, <SignatureSize<C> as ArrayLength<u8>>::ArrayType: Copy,

impl<C: Eq + PrimeCurve> Eq for SignatureWithOid<C>

impl<C: PrimeCurve> StructuralEq for SignatureWithOid<C>

impl<C: PrimeCurve> StructuralPartialEq for SignatureWithOid<C>