Struct VerifyingKey

pub struct VerifyingKey<C>
where
    C: PrimeCurve + CurveArithmetic,
{ /* private fields */ }

ECDSA public key used for verifying signatures. Generic over prime order elliptic curves (e.g. NIST P-curves)

Requires an elliptic_curve::CurveArithmetic impl on the curve, and a VerifyPrimitive impl on its associated AffinePoint type.

Usage

The signature crate defines the following traits which are the primary API for verifying:

• Verifier: verify a message against a provided key and signature
• DigestVerifier: verify a message Digest against a provided key and signature
• PrehashVerifier: verify the low-level raw output bytes of a message digest

See the p256 crate for examples of using this type with a concrete elliptic curve.

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 leverages the encoding used by the PublicKey type, which is a binary-oriented ASN.1 DER encoding.

Implementations

impl<C> VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, AffinePoint<C>: DecompressPoint<C> + FromEncodedPoint<C> + ToEncodedPoint<C> + VerifyPrimitive<C>, FieldBytesSize<C>: ModulusSize, SignatureSize<C>: ArrayLength<u8>,

pub fn recover_from_msg( msg: &[u8], signature: &Signature<C>, recovery_id: RecoveryId, ) -> Result<Self>

where C: DigestPrimitive,

Recover a VerifyingKey from the given message, signature, and RecoveryId.

The message is first hashed using this curve’s DigestPrimitive.

pub fn recover_from_digest<D>( msg_digest: D, signature: &Signature<C>, recovery_id: RecoveryId, ) -> Result<Self>

where D: Digest,

Recover a VerifyingKey from the given message Digest, signature, and RecoveryId.

pub fn recover_from_prehash( prehash: &[u8], signature: &Signature<C>, recovery_id: RecoveryId, ) -> Result<Self>

Recover a VerifyingKey from the given prehash of a message, the signature over that prehashed message, and a RecoveryId.

impl<C> VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

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

Initialize VerifyingKey from a SEC1-encoded public key.

pub fn from_affine(affine: AffinePoint<C>) -> Result<Self>

Initialize VerifyingKey from an affine point.

Returns an Error if the given affine point is the additive identity (a.k.a. point at infinity).

pub fn from_encoded_point(public_key: &EncodedPoint<C>) -> Result<Self>

Initialize VerifyingKey from an EncodedPoint.

pub fn to_encoded_point(&self, compress: bool) -> EncodedPoint<C>

Serialize this VerifyingKey as a SEC1 EncodedPoint, optionally applying point compression.

pub fn to_sec1_bytes(&self) -> Box<[u8]>

where C: PointCompression,

Convert this VerifyingKey into the Elliptic-Curve-Point-to-Octet-String encoding described in SEC 1: Elliptic Curve Cryptography (Version 2.0) section 2.3.3 (page 10).

http://www.secg.org/sec1-v2.pdf

pub fn as_affine(&self) -> &AffinePoint<C>

Borrow the inner AffinePoint for this public key.

Trait Implementations

impl<C> AsRef<<C as CurveArithmetic>::AffinePoint> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn as_ref(&self) -> &AffinePoint<C>

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

impl<C> AsRef<VerifyingKey<C>> for SigningKey<C>

where C: PrimeCurve + CurveArithmetic, Scalar<C>: Invert<Output = CtOption<Scalar<C>>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn as_ref(&self) -> &VerifyingKey<C>

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

impl<C> AssociatedAlgorithmIdentifier for VerifyingKey<C>

where C: AssociatedOid + CurveArithmetic + PrimeCurve, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

const ALGORITHM_IDENTIFIER: AlgorithmIdentifier<ObjectIdentifier> = PublicKey<C>::ALGORITHM_IDENTIFIER

AlgorithmIdentifier for this structure.

type Params = ObjectIdentifier

Algorithm parameters.

impl<C> Clone for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic + Debug,

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for VerifyingKey<C>

where C: PrimeCurve + AssociatedOid + CurveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C, D> DigestVerifier<D, Signature<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, D: Digest + FixedOutput<OutputSize = FieldBytesSize<C>>, AffinePoint<C>: VerifyPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

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

Verify the signature against the given Digest output.

impl<C, D> DigestVerifier<D, Signature<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, D: Digest + FixedOutput<OutputSize = FieldBytesSize<C>>, AffinePoint<C>: VerifyPrimitive<C>, SignatureSize<C>: ArrayLength<u8>, MaxSize<C>: ArrayLength<u8>, <FieldBytesSize<C> as Add>::Output: Add<MaxOverhead> + ArrayLength<u8>,

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

Verify the signature against the given Digest output.

impl<C> EncodePublicKey for VerifyingKey<C>

where C: PrimeCurve + AssociatedOid + CurveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn to_public_key_der(&self) -> Result<Document>

Serialize a Document containing a SPKI-encoded public key.

fn to_public_key_pem(&self, line_ending: LineEnding) -> Result<String, Error>

Serialize this public key as PEM-encoded SPKI with the given LineEnding.

fn write_public_key_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write ASN.1 DER-encoded public key to the given path

fn write_public_key_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding, ) -> Result<(), Error>

Write ASN.1 DER-encoded public key to the given path

impl<C> From<&PublicKey<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic,

fn from(public_key: &PublicKey<C>) -> VerifyingKey<C>

Converts to this type from the input type.

impl<C> From<&SigningKey<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, Scalar<C>: Invert<Output = CtOption<Scalar<C>>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn from(signing_key: &SigningKey<C>) -> VerifyingKey<C>

Converts to this type from the input type.

impl<C> From<&VerifyingKey<C>> for EncodedPoint<C>

where C: PrimeCurve + CurveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn from(verifying_key: &VerifyingKey<C>) -> EncodedPoint<C>

Converts to this type from the input type.

impl<C> From<&VerifyingKey<C>> for CompressedPoint<C>

where C: PrimeCurve + CurveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn from(verifying_key: &VerifyingKey<C>) -> CompressedPoint<C>

Converts to this type from the input type.

impl<C> From<&VerifyingKey<C>> for PublicKey<C>

where C: PrimeCurve + CurveArithmetic,

fn from(verifying_key: &VerifyingKey<C>) -> PublicKey<C>

Converts to this type from the input type.

impl<C> From<PublicKey<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic,

fn from(public_key: PublicKey<C>) -> VerifyingKey<C>

Converts to this type from the input type.

impl<C> From<SigningKey<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, Scalar<C>: Invert<Output = CtOption<Scalar<C>>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn from(signing_key: SigningKey<C>) -> VerifyingKey<C>

Converts to this type from the input type.

impl<C> From<VerifyingKey<C>> for EncodedPoint<C>

where C: PrimeCurve + CurveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn from(verifying_key: VerifyingKey<C>) -> EncodedPoint<C>

Converts to this type from the input type.

impl<C> From<VerifyingKey<C>> for CompressedPoint<C>

where C: PrimeCurve + CurveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn from(verifying_key: VerifyingKey<C>) -> CompressedPoint<C>

Converts to this type from the input type.

impl<C> From<VerifyingKey<C>> for PublicKey<C>

where C: PrimeCurve + CurveArithmetic,

fn from(verifying_key: VerifyingKey<C>) -> PublicKey<C>

Converts to this type from the input type.

impl<C> FromStr for VerifyingKey<C>

where C: PrimeCurve + AssociatedOid + CurveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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

impl<C> Ord for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<C> PartialEq for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C> PartialOrd for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<C> PrehashVerifier<Signature<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, AffinePoint<C>: VerifyPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn verify_prehash(&self, prehash: &[u8], signature: &Signature<C>) -> Result<()>

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

impl<C> PrehashVerifier<Signature<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic + DigestPrimitive, AffinePoint<C>: VerifyPrimitive<C>, SignatureSize<C>: ArrayLength<u8>, MaxSize<C>: ArrayLength<u8>, <FieldBytesSize<C> as Add>::Output: Add<MaxOverhead> + ArrayLength<u8>,

fn verify_prehash(&self, prehash: &[u8], signature: &Signature<C>) -> Result<()>

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

impl<C> Serialize for VerifyingKey<C>

where C: PrimeCurve + AssociatedOid + CurveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<C> SignatureAlgorithmIdentifier for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize, Signature<C>: AssociatedAlgorithmIdentifier<Params = AnyRef<'static>>,

const SIGNATURE_ALGORITHM_IDENTIFIER: AlgorithmIdentifier<Self::Params> = Signature<C>::ALGORITHM_IDENTIFIER

AlgorithmIdentifier for the corresponding singature system.

type Params = AnyRef<'static>

Algorithm parameters.

impl<C> TryFrom<&[u8]> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<C> TryFrom<SubjectPublicKeyInfo<AnyRef<'_>, BitStringRef<'_>>> for VerifyingKey<C>

where C: PrimeCurve + AssociatedOid + CurveArithmetic + PointCompression, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(spki: SubjectPublicKeyInfoRef<'_>) -> Result<Self>

Performs the conversion.

impl<C> Verifier<Signature<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic + DigestPrimitive, AffinePoint<C>: VerifyPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

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

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

impl<C> Verifier<Signature<C>> for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic + DigestPrimitive, AffinePoint<C>: VerifyPrimitive<C>, SignatureSize<C>: ArrayLength<u8>, MaxSize<C>: ArrayLength<u8>, <FieldBytesSize<C> as Add>::Output: Add<MaxOverhead> + ArrayLength<u8>,

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

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

impl<C> Copy for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic,

impl<C> Eq for VerifyingKey<C>

where C: PrimeCurve + CurveArithmetic,