Type Alias PublicKey

pub type PublicKey = PublicKey<NistP384>;

NIST P-384 public key.

Aliased Type

struct PublicKey { /* private fields */ }

Implementations

impl<C> PublicKey<C>

where C: CurveArithmetic,

pub fn from_affine( point: <C as CurveArithmetic>::AffinePoint, ) -> Result<PublicKey<C>, Error>

Convert an AffinePoint into a PublicKey

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

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

where <C as Curve>::FieldBytesSize: ModulusSize, <C as CurveArithmetic>::AffinePoint: 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 to_sec1_bytes(&self) -> Box<[u8]>

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

Convert this PublicKey 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) -> &<C as CurveArithmetic>::AffinePoint

Borrow the inner AffinePoint from this PublicKey.

In ECC, public keys are elliptic curve points.

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

Convert this PublicKey to a ProjectivePoint for the given curve

pub fn to_nonidentity(&self) -> NonIdentity<<C as CurveArithmetic>::AffinePoint>

Convert this PublicKey to a NonIdentity of the inner AffinePoint

Trait Implementations

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

where C: CurveArithmetic,

fn as_ref(&self) -> &<C as CurveArithmetic>::AffinePoint

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

impl<C> AssociatedAlgorithmIdentifier for PublicKey<C>

where C: AssociatedOid + CurveArithmetic,

const ALGORITHM_IDENTIFIER: AlgorithmIdentifier<ObjectIdentifier>

AlgorithmIdentifier for this structure.

type Params = ObjectIdentifier

Algorithm parameters.

impl<C> Clone for PublicKey<C>

where C: Clone + CurveArithmetic,

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: Debug + CurveArithmetic,

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

Formats the value using the given formatter.

impl<C> EncodePublicKey for PublicKey<C>

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

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

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<&EphemeralSecret<C>> for PublicKey<C>

where C: CurveArithmetic,

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

Converts to this type from the input type.

impl<C, P> From<&NonIdentity<P>> for PublicKey<C>

where C: CurveArithmetic, P: Copy + Into<<C as CurveArithmetic>::AffinePoint>,

fn from(value: &NonIdentity<P>) -> PublicKey<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, P> From<NonIdentity<P>> for PublicKey<C>

where C: CurveArithmetic, P: Copy + Into<<C as CurveArithmetic>::AffinePoint>,

fn from(value: NonIdentity<P>) -> PublicKey<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> FromEncodedPoint<C> for PublicKey<C>

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

fn from_encoded_point( encoded_point: &EncodedPoint<<C as Curve>::FieldBytesSize>, ) -> CtOption<PublicKey<C>>

Initialize PublicKey from an EncodedPoint

impl<C> FromStr for PublicKey<C>

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

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PublicKey<C>, Error>

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

impl<C> Ord for PublicKey<C>

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

fn cmp(&self, other: &PublicKey<C>) -> 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 PublicKey<C>

where C: PartialEq + CurveArithmetic,

fn eq(&self, other: &PublicKey<C>) -> 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 PublicKey<C>

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

fn partial_cmp(&self, other: &PublicKey<C>) -> 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> ToEncodedPoint<C> for PublicKey<C>

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

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

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

impl<C> ToString for PublicKey<C>

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

fn to_string(&self) -> String

Converts the given value to a String.

impl<C> TryFrom<&AffinePoint<C>> for PublicKey<C>

where C: PrimeCurveParams,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(affine_point: &AffinePoint<C>) -> Result<PublicKey<C>, Error>

Performs the conversion.

impl<C> TryFrom<&EncodedPoint<<C as Curve>::FieldBytesSize>> for PublicKey<C>

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from( point: &EncodedPoint<<C as Curve>::FieldBytesSize>, ) -> Result<PublicKey<C>, Error>

Performs the conversion.

impl<C> TryFrom<&GenericArray<u8, <<C as Curve>::FieldBytesSize as ModulusSize>::CompressedPointSize>> for PublicKey<C>

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from( point: &GenericArray<u8, <<C as Curve>::FieldBytesSize as ModulusSize>::CompressedPointSize>, ) -> Result<PublicKey<C>, Error>

Performs the conversion.

impl<C> TryFrom<&ProjectivePoint<C>> for PublicKey<C>

where C: PrimeCurveParams,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(point: &ProjectivePoint<C>) -> Result<PublicKey<C>, Error>

Performs the conversion.

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

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from( spki: &SubjectPublicKeyInfo<AnyRef<'_>, BitStringRef<'_>>, ) -> Result<PublicKey<C>, Error>

Performs the conversion.

impl<C> TryFrom<AffinePoint<C>> for PublicKey<C>

where C: PrimeCurveParams,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(affine_point: AffinePoint<C>) -> Result<PublicKey<C>, Error>

Performs the conversion.

impl<C> TryFrom<EncodedPoint<<C as Curve>::FieldBytesSize>> for PublicKey<C>

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from( point: EncodedPoint<<C as Curve>::FieldBytesSize>, ) -> Result<PublicKey<C>, Error>

Performs the conversion.

impl<C> TryFrom<GenericArray<u8, <<C as Curve>::FieldBytesSize as ModulusSize>::CompressedPointSize>> for PublicKey<C>

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from( point: GenericArray<u8, <<C as Curve>::FieldBytesSize as ModulusSize>::CompressedPointSize>, ) -> Result<PublicKey<C>, Error>

Performs the conversion.

impl<C> TryFrom<ProjectivePoint<C>> for PublicKey<C>

where C: PrimeCurveParams,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(point: ProjectivePoint<C>) -> Result<PublicKey<C>, Error>

Performs the conversion.

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

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from( spki: SubjectPublicKeyInfo<AnyRef<'_>, BitStringRef<'_>>, ) -> Result<PublicKey<C>, Error>

Performs the conversion.

impl<C> Copy for PublicKey<C>

where C: CurveArithmetic,

impl<C> Eq for PublicKey<C>

where C: Eq + CurveArithmetic,

impl<C> StructuralPartialEq for PublicKey<C>

where C: CurveArithmetic,