Struct elliptic_curve::JwkEcKey

pub struct JwkEcKey { /* private fields */ }

This is supported on crate feature jwk only.

JSON Web Key (JWK) with a kty of "EC" (elliptic curve).

Specified in RFC 7518 Section 6: Cryptographic Algorithms for Keys.

This type can represent either a public/private keypair, or just a public key, depending on whether or not the d parameter is present.

Implementations

impl JwkEcKey

pub fn crv(&self) -> &str

Get the crv parameter for this JWK.

pub fn is_keypair(&self) -> bool

Is this JWK a keypair that includes a private key?

pub fn is_public_key(&self) -> bool

Does this JWK contain only a public key?

pub fn to_public_key<C>(&self) -> Result<PublicKey<C>> where
    C: Curve + JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature arithmetic only.

Decode a JWK into a PublicKey.

pub fn from_encoded_point<C>(point: &EncodedPoint<C>) -> Option<Self> where
    C: Curve + JwkParameters,
    FieldSize<C>: ModulusSize, 

Create a JWK from a SEC1 EncodedPoint.

pub fn to_encoded_point<C>(&self) -> Result<EncodedPoint<C>> where
    C: Curve + JwkParameters,
    FieldSize<C>: ModulusSize, 

Get the public key component of this JWK as a SEC1 EncodedPoint.

pub fn to_secret_key<C>(&self) -> Result<SecretKey<C>> where
    C: Curve + JwkParameters + ValidatePublicKey,
    FieldSize<C>: ModulusSize, 

This is supported on crate feature arithmetic only.

Decode a JWK into a SecretKey.

Trait Implementations

impl Clone for JwkEcKey

fn clone(&self) -> JwkEcKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JwkEcKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JwkEcKey

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

Deserialize this value from the given Serde deserializer.

impl Drop for JwkEcKey

fn drop(&mut self)

Executes the destructor for this type.

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 arithmetic only.

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

Performs the conversion.

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

This is supported on crate feature arithmetic only.

fn from(sk: &SecretKey<C>) -> JwkEcKey

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 arithmetic only.

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

Performs the conversion.

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

This is supported on crate feature arithmetic only.

fn from(sk: SecretKey<C>) -> JwkEcKey

Performs the conversion.

impl FromStr for JwkEcKey

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 PartialEq<JwkEcKey> for JwkEcKey

fn eq(&self, other: &Self) -> 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 !=.

impl Serialize for JwkEcKey

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

Serialize this value into the given Serde serializer.

impl ToString for JwkEcKey

fn to_string(&self) -> String

Converts the given value to a String.

impl<C> TryFrom<&'_ JwkEcKey> for SecretKey<C> where
    C: Curve + JwkParameters + ValidatePublicKey,
    FieldSize<C>: ModulusSize, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: &JwkEcKey) -> Result<SecretKey<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 arithmetic 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 SecretKey<C> where
    C: Curve + JwkParameters + ValidatePublicKey,
    FieldSize<C>: ModulusSize, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(jwk: JwkEcKey) -> Result<SecretKey<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 arithmetic 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 Zeroize for JwkEcKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for JwkEcKey