Struct elliptic_curve::SecretKey[−][src]

pub struct SecretKey<C: Curve> { /* fields omitted */ }

This is supported on crate feature zeroize only.

Expand description

Elliptic curve secret keys.

This type wraps a secret scalar value, helping to prevent accidental exposure and securely erasing the value from memory when dropped (when the zeroize feature of this crate is enabled).

Parsing PKCS#8 Keys

PKCS#8 is a commonly used format for encoding secret keys (especially ones generated by OpenSSL).

Keys in PKCS#8 format are either binary (ASN.1 BER/DER), or PEM encoded (ASCII) and begin with the following:

-----BEGIN PRIVATE KEY-----

To decode an elliptic curve private key from PKCS#8, enable the pkcs8 feature of this crate (or the pkcs8 feature of a specific RustCrypto elliptic curve crate) and use the elliptic_curve::pkcs8::FromPrivateKey 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> SecretKey<C> where
    C: Curve,

pub fn random(rng: impl CryptoRng + RngCore) -> Self where
    C: ProjectiveArithmetic,
    Scalar<C>: Zeroize,

This is supported on crate feature arithmetic only.

Generate a random SecretKey

pub fn new(scalar: ScalarBytes<C>) -> Self

Create a new secret key from a serialized scalar value

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

Deserialize raw private scalar as a big endian integer

pub fn to_bytes(&self) -> FieldBytes<C>

Expose the byte serialization of the value this SecretKey wraps

pub fn as_scalar_bytes(&self) -> &ScalarBytes<C>

Borrow the inner secret ScalarBytes value.

Warning

This value is key material.

Please treat it with the care it deserves!

pub fn to_secret_scalar(&self) -> NonZeroScalar<C> where
    C: Curve + ProjectiveArithmetic,
    Scalar<C>: Zeroize,

This is supported on crate feature arithmetic only.

Get the secret scalar value for this key..

pub fn public_key(&self) -> PublicKey<C> where
    C: Curve + ProjectiveArithmetic,
    Scalar<C>: Zeroize,

This is supported on crate feature arithmetic only.

Get the PublicKey which corresponds to this secret key

pub fn from_jwk(jwk: &JwkEcKey) -> Result<Self> where
    C: JwkParameters + ValidatePublicKey,
    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 SecretKey.

pub fn from_jwk_str(jwk: &str) -> Result<Self> where
    C: JwkParameters + ValidatePublicKey,
    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 SecretKey.

pub fn to_jwk(&self) -> JwkEcKey where
    C: JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    Scalar<C>: Zeroize,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

This is supported on crate features arithmetic and jwk only.

Serialize this secret key as JwkEcKey JSON Web Key (JWK).

pub fn to_jwk_string(&self) -> String where
    C: JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    Scalar<C>: Zeroize,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

This is supported on crate features arithmetic and jwk only.

Serialize this secret key as JSON Web Key (JWK) string.

Trait Implementations

impl<C: Clone + Curve> Clone for SecretKey<C>

fn clone(&self) -> SecretKey<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 for SecretKey<C> where
    C: Curve,

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

Formats the value using the given formatter. Read more

impl<C> Drop for SecretKey<C> where
    C: Curve,

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<C> From<&'_ NonZeroScalar<C>> for SecretKey<C> where
    C: Curve + ProjectiveArithmetic,

This is supported on crate feature arithmetic only.

fn from(scalar: &NonZeroScalar<C>) -> SecretKey<C>

Performs the conversion.

impl<C> From<&'_ SecretKey<C>> for NonZeroScalar<C> where
    C: Curve + ProjectiveArithmetic,

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

Performs the conversion.

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

This is supported on crate features arithmetic and jwk only.

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

Performs the conversion.

impl<C> From<NonZeroScalar<C>> for SecretKey<C> where
    C: Curve + ProjectiveArithmetic,

This is supported on crate feature arithmetic only.

fn from(scalar: NonZeroScalar<C>) -> SecretKey<C>

Performs the conversion.

impl<C> From<SecretKey<C>> for NonZeroScalar<C> where
    C: Curve + ProjectiveArithmetic,

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

Performs the conversion.

impl<C> From<SecretKey<C>> for JwkEcKey where
    C: Curve + JwkParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    Scalar<C>: Zeroize,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

This is supported on crate features arithmetic and jwk only.

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

Performs the conversion.

impl<C> FromPrivateKey for SecretKey<C> where
    C: Curve + AlgorithmParameters + ValidatePublicKey,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

This is supported on crate feature pkcs8 only.

fn from_pkcs8_private_key_info(
    private_key_info: PrivateKeyInfo<'_>
) -> Result<Self>

Parse the PrivateKeyInfo from a PKCS#8-encoded document.

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

Deserialize PKCS#8 private key from ASN.1 DER-encoded data (binary format). Read more

fn from_pkcs8_doc(doc: &PrivateKeyDocument) -> Result<Self, Error>

Deserialize PKCS#8 private key from a PrivateKeyDocument.

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

Deserialize PKCS#8-encoded private key from PEM. Read more

impl<C> FromStr for SecretKey<C> where
    C: Curve + AlgorithmParameters + ValidatePublicKey,
    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> ToPrivateKey for SecretKey<C> where
    C: Curve + AlgorithmParameters + ProjectiveArithmetic,
    AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>,
    Scalar<C>: Zeroize,
    UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>,
    UncompressedPointSize<C>: ArrayLength<u8>,

This is supported on crate features arithmetic and pem only.

fn to_pkcs8_der(&self) -> Result<PrivateKeyDocument>

Serialize a PrivateKeyDocument containing a PKCS#8-encoded private key.

fn to_pkcs8_pem(&self) -> Result<Zeroizing<String>, Error>

Serialize this private key as PEM-encoded PKCS#8.

impl<C> TryFrom<&'_ [u8]> for SecretKey<C> where
    C: Curve,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(slice: &[u8]) -> Result<Self>

Performs the conversion.

impl<C> TryFrom<&'_ JwkEcKey> for SecretKey<C> where
    C: Curve + JwkParameters + ValidatePublicKey,
    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<SecretKey<C>, Error>

Performs the conversion.

impl<C> TryFrom<JwkEcKey> for SecretKey<C> where
    C: Curve + JwkParameters + ValidatePublicKey,
    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<SecretKey<C>, Error>

Performs the conversion.

Auto Trait Implementations

impl<C> RefUnwindSafe for SecretKey<C> where
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as ArrayLength<u8>>::ArrayType: RefUnwindSafe,

impl<C> Send for SecretKey<C>

impl<C> Sync for SecretKey<C>

impl<C> Unpin for SecretKey<C> where
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as ArrayLength<u8>>::ArrayType: Unpin,

impl<C> UnwindSafe for SecretKey<C> where
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as ArrayLength<u8>>::ArrayType: 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.