Enum elliptic_curve::weierstrass::public_key::PublicKey

pub enum PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,  {
    Compressed(CompressedPoint<C>),
    Uncompressed(UncompressedPoint<C>),
}

This is supported on feature="weierstrass" only.

Public keys for Weierstrass curves

Variants

Compressed(CompressedPoint<C>)

This is supported on feature="weierstrass" only.

Compressed Weierstrass elliptic curve point

Uncompressed(UncompressedPoint<C>)

This is supported on feature="weierstrass" only.

Uncompressed Weierstrass elliptic curve point

Implementations

impl<C> PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Option<Self>

This is supported on feature="weierstrass" only.

Decode public key from an elliptic curve point (compressed or uncompressed) encoded using the Elliptic-Curve-Point-to-Octet-String algorithm 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 from_untagged_point(
    bytes: &GenericArray<u8, UntaggedPointSize<C>>
) -> Self where
    <C::ElementSize as Add>::Output: ArrayLength<u8>, 

This is supported on feature="weierstrass" only.

Decode public key from a raw uncompressed point serialized as a bytestring, without a 0x04-byte tag.

This will be twice the modulus size, or 1-byte smaller than the Elliptic-Curve-Point-to-Octet-String encoding i.e with the leading 0x04 byte in that encoding removed.

pub fn compress(&mut self)

This is supported on feature="weierstrass" only.

Compress this PublicKey.

If the key is already compressed, this is a no-op.

pub fn as_bytes(&self) -> &[u8]

This is supported on feature="weierstrass" only.

Obtain public key as a byte array reference

impl<C> PublicKey<C> where
    C: Curve + Arithmetic,
    C::AffinePoint: Mul<NonZeroScalar<C>, Output = C::AffinePoint>,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPoint<C>: From<C::AffinePoint>,
    UncompressedPoint<C>: From<C::AffinePoint>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

pub fn from_secret_key(
    secret_key: &SecretKey<C>,
    compress: bool
) -> Result<Self, Error>

This is supported on feature="weierstrass" only.

Compute the PublicKey for the provided SecretKey.

The compress flag requests point compression.

Trait Implementations

impl<C> AsRef<[u8]> for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<C: Clone> Clone for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

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> Copy for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,
    <CompressedPointSize<C> as ArrayLength<u8>>::ArrayType: Copy,
    <UncompressedPointSize<C> as ArrayLength<u8>>::ArrayType: Copy, 

impl<C> Debug for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

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

Formats the value using the given formatter.

impl<C: Eq> Eq for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

impl<C, '_> From<&'_ EphemeralSecret<C>> for PublicKey<C> where
    C: Curve + Arithmetic,
    C::Scalar: Clone + Generate + Zeroize,
    C::AffinePoint: FromPublicKey<C> + Mul<NonZeroScalar<C>, Output = C::AffinePoint> + Zeroize,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPoint<C>: From<C::AffinePoint>,
    UncompressedPoint<C>: From<C::AffinePoint>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

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

Performs the conversion.

impl<C> From<CompressedPoint<C>> for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

fn from(point: CompressedPoint<C>) -> Self

Performs the conversion.

impl<C> From<UncompressedPoint<C>> for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

fn from(point: UncompressedPoint<C>) -> Self

Performs the conversion.

impl<C: Ord> Ord for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

fn cmp(&self, other: &PublicKey<C>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<C: PartialEq> PartialEq<PublicKey<C>> for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

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> PartialOrd<PublicKey<C>> for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

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

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

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

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

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

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

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

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

impl<C> StructuralEq for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

impl<C> StructuralPartialEq for PublicKey<C> where
    C: Curve,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

impl<C, '_> TryFrom<&'_ SecretKey<C>> for PublicKey<C> where
    C: Curve + Arithmetic,
    C::AffinePoint: Mul<NonZeroScalar<C>, Output = C::AffinePoint>,
    C::ElementSize: Add<U1>,
    <C::ElementSize as Add>::Output: Add<U1>,
    CompressedPoint<C>: From<C::AffinePoint>,
    UncompressedPoint<C>: From<C::AffinePoint>,
    CompressedPointSize<C>: ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(secret_key: &SecretKey<C>) -> Result<Self, Error>

Performs the conversion.