Struct elliptic_curve::PublicKey[−][src]

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

This is supported on crate feature arithmetic only.

Expand description

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::FromPublicKey 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.

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
    Self: TryFrom<EncodedPoint<C>, Error = Error>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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: JwkParameters,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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: JwkParameters,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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: JwkParameters,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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: JwkParameters,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

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. Read more

impl<C> From<&'_ EphemeralSecret<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: Zeroize,
    Scalar<C>: Zeroize,
    SharedSecret<C>: for<'a> From<&'a AffinePoint<C>>,

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>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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

Initialize PublicKey from an EncodedPoint

impl<C> FromPublicKey for PublicKey<C> where
    Self: TryFrom<EncodedPoint<C>, Error = Error>,
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

This is supported on crate feature pkcs8 only.

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

Parse SubjectPublicKeyInfo into a public key object.

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

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

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

Deserialize PKCS#8 private key from a PrivateKeyDocument.

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

Deserialize PEM-encoded SubjectPublicKeyInfo. Read more

impl<C> FromStr for PublicKey<C> where
    Self: TryFrom<EncodedPoint<C>, Error = Error>,
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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. Read more

impl<C> Ord for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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

This method returns an Ordering between self and other. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

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

Restrict a value to a certain interval. Read more

impl<C> PartialEq<PublicKey<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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

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

1.0.0[src]

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

This method tests for !=.

impl<C> PartialOrd<PublicKey<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

1.0.0[src]

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

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

impl<C> ToEncodedPoint<C> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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

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

impl<C> ToPublicKey for PublicKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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) -> Result<String, Error>

Serialize this public key as PEM-encoded SPKI.

impl<C> ToString for PublicKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

This is supported on crate feature pem only.

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<C> TryFrom<&'_ EncodedPoint<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(encoded_point: &EncodedPoint<C>) -> Result<Self>

Performs the conversion.

impl<C> TryFrom<&'_ JwkEcKey> for PublicKey<C> where
    C: Curve + JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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>, Error>

Performs the conversion.

impl<C> TryFrom<EncodedPoint<C>> for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(encoded_point: EncodedPoint<C>) -> Result<Self>

Performs the conversion.

impl<C> TryFrom<JwkEcKey> for PublicKey<C> where
    C: Curve + JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

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>, Error>

Performs the conversion.

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

impl<C> Eq for PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

Auto Trait Implementations

impl<C> RefUnwindSafe for PublicKey<C> where
    <C as AffineArithmetic>::AffinePoint: RefUnwindSafe,

impl<C> Send for PublicKey<C>

impl<C> Sync for PublicKey<C>

impl<C> Unpin for PublicKey<C> where
    <C as AffineArithmetic>::AffinePoint: Unpin,

impl<C> UnwindSafe for PublicKey<C> where
    <C as AffineArithmetic>::AffinePoint: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.