Struct elliptic_curve::PublicKey

pub struct PublicKey<C> where
    C: Curve + ProjectiveArithmetic,  { /* private fields */ }

This is supported on crate feature arithmetic only.

Elliptic curve public keys.

This is a wrapper type for AffinePoint which ensures an inner non-identity point and provides a common place to handle encoding/decoding.

Parsing “SPKI” Keys

X.509 SubjectPublicKeyInfo (SPKI) is a commonly used format for encoding public keys, notably public keys corresponding to PKCS#8 private keys. (especially ones generated by OpenSSL).

Keys in SPKI format are either binary (ASN.1 BER/DER), or PEM encoded (ASCII) and begin with the following:

-----BEGIN PUBLIC KEY-----

To decode an elliptic curve public key from SPKI, enable the pkcs8 feature of this crate (or the pkcs8 feature of a specific RustCrypto elliptic curve crate) and use the elliptic_curve::pkcs8::DecodePublicKey trait to parse it.

When the pem feature of this crate (or a specific RustCrypto elliptic curve crate) is enabled, a FromStr impl is also available.

serde support

When the optional serde feature of this create is enabled, Serialize and Deserialize impls are provided for this type.

The serialization is binary-oriented and supports ASN.1 DER Subject Public Key Info (SPKI) as the encoding format.

For a more text-friendly encoding of public keys, use JwkEcKey instead.

Implementations

impl<C> PublicKey<C> where
    C: Curve + ProjectiveArithmetic, 

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

Convert an AffinePoint into a PublicKey

pub fn from_secret_scalar(scalar: &NonZeroScalar<C>) -> Self

Compute a PublicKey from a secret NonZeroScalar value (i.e. a secret key represented as a raw scalar value)

pub fn from_sec1_bytes(bytes: &[u8]) -> Result<Self> where
    C: Curve,
    FieldSize<C>: ModulusSize,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, 

Decode PublicKey (compressed or uncompressed) from 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 from this PublicKey.

In ECC, public keys are elliptic curve points.

pub fn to_projective(&self) -> ProjectivePoint<C>

Convert this PublicKey to a ProjectivePoint for the given curve

pub fn from_jwk(jwk: &JwkEcKey) -> Result<Self> where
    C: Curve + JwkParameters,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature jwk only.

Parse a JwkEcKey JSON Web Key (JWK) into a PublicKey.

pub fn from_jwk_str(jwk: &str) -> Result<Self> where
    C: Curve + JwkParameters,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature jwk only.

Parse a string containing a JSON Web Key (JWK) into a PublicKey.

pub fn to_jwk(&self) -> JwkEcKey where
    C: Curve + JwkParameters,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature jwk only.

Serialize this public key as JwkEcKey JSON Web Key (JWK).

pub fn to_jwk_string(&self) -> String where
    C: Curve + JwkParameters,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature jwk only.

Serialize this public key as JSON Web Key (JWK) string.

Trait Implementations

impl<C> AsRef<<C as AffineArithmetic>::AffinePoint> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic, 

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

Performs the conversion.

impl<C: Clone> Clone for PublicKey<C> where
    C: Curve + ProjectiveArithmetic, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for PublicKey<C> where
    C: Curve + ProjectiveArithmetic, 

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

Formats the value using the given formatter.

impl<C> DecodePublicKey for PublicKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate features pkcs8 and sec1 only.

fn from_public_key_der(bytes: &[u8]) -> Result<Self, Error>

Deserialize object from ASN.1 DER-encoded SubjectPublicKeyInfo (binary format).

fn from_public_key_doc(doc: &PublicKeyDocument) -> Result<Self, Error>

Deserialize SPKI public key from a PublicKeyDocument.

fn from_public_key_pem(s: &str) -> Result<Self, Error>

Deserialize PEM-encoded SubjectPublicKeyInfo.

impl<'de, C> Deserialize<'de> for PublicKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate features pem and serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<C> EncodePublicKey for PublicKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature pem only.

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

Serialize a PublicKeyDocument 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.

impl<C> From<&'_ EphemeralSecret<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic, 

This is supported on crate feature ecdh only.

fn from(ephemeral_secret: &EphemeralSecret<C>) -> Self

Performs the conversion.

impl<C> From<&'_ PublicKey<C>> for EncodedPoint<C> where
    C: Curve + ProjectiveArithmetic + PointCompression,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature sec1 only.

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

Performs the conversion.

impl<C> From<&'_ PublicKey<C>> for JwkEcKey where
    C: Curve + JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature jwk only.

fn from(pk: &PublicKey<C>) -> JwkEcKey

Performs the conversion.

impl<C> From<PublicKey<C>> for EncodedPoint<C> where
    C: Curve + ProjectiveArithmetic + PointCompression,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature sec1 only.

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

Performs the conversion.

impl<C> From<PublicKey<C>> for JwkEcKey where
    C: Curve + JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature jwk only.

fn from(pk: PublicKey<C>) -> JwkEcKey

Performs the conversion.

impl<C> FromEncodedPoint<C> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature sec1 only.

fn from_encoded_point(encoded_point: &EncodedPoint<C>) -> CtOption<Self>

Initialize PublicKey from an EncodedPoint

impl<C> FromStr for PublicKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature pem only.

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 PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature sec1 only.

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<C: PartialEq> PartialEq<PublicKey<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic, 

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

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

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

This method tests for !=.

impl<C> PartialOrd<PublicKey<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature sec1 only.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<C> Serialize for PublicKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate features pem and serde only.

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

Serialize this value into the given Serde serializer.

impl<C> ToEncodedPoint<C> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature sec1 only.

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

Serialize this PublicKey as a SEC1 EncodedPoint, optionally applying point compression

impl<C> ToString for PublicKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature pem only.

fn to_string(&self) -> String

Converts the given value to a String.

impl<C> TryFrom<&'_ JwkEcKey> for PublicKey<C> where
    C: Curve + JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature jwk only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &JwkEcKey) -> Result<PublicKey<C>>

Performs the conversion.

impl<C> TryFrom<JwkEcKey> for PublicKey<C> where
    C: Curve + JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature jwk only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: JwkEcKey) -> Result<PublicKey<C>>

Performs the conversion.

impl<C> TryFrom<SubjectPublicKeyInfo<'_>> for PublicKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate features pkcs8 and sec1 only.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<C> Copy for PublicKey<C> where
    C: Curve + ProjectiveArithmetic, 

impl<C: Eq> Eq for PublicKey<C> where
    C: Curve + ProjectiveArithmetic, 

impl<C> StructuralEq for PublicKey<C> where
    C: Curve + ProjectiveArithmetic, 

impl<C> StructuralPartialEq for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,