Struct elliptic_curve::PublicKey

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

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][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

Trait Implementations

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

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

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

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

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 for PublicKey<C>where
    C: Curve + ProjectiveArithmetic + Debug,

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Initialize PublicKey from an EncodedPoint

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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

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: &Rhs) -> bool

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

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

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

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

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

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

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

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

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