pub struct SecretKey<C: Curve> { /* private fields */ }
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.

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 DecodePrivateKey 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§

source§

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

source

pub fn random(rng: &mut impl CryptoRngCore) -> Selfwhere C: CurveArithmetic,

Available on crate feature arithmetic only.

Generate a random SecretKey.

source

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

Create a new secret key from a scalar value.

source

pub fn as_scalar_primitive(&self) -> &ScalarPrimitive<C>

Borrow the inner secret ScalarPrimitive value.

⚠️ Warning

This value is key material.

Please treat it with the care it deserves!

source

pub fn to_nonzero_scalar(&self) -> NonZeroScalar<C>where C: CurveArithmetic,

Available on crate feature arithmetic only.

Get the secret NonZeroScalar value for this key.

⚠️ Warning

This value is key material.

Please treat it with the care it deserves!

source

pub fn public_key(&self) -> PublicKey<C>where C: CurveArithmetic,

Available on crate feature arithmetic only.

Get the PublicKey which corresponds to this secret key

source

pub fn from_bytes(bytes: &FieldBytes<C>) -> Result<Self>

Deserialize secret key from an encoded secret scalar.

source

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

Deserialize secret key from an encoded secret scalar passed as a byte slice.

The slice is expected to be a minimum of 24-bytes (192-byts) and at most C::FieldBytesSize bytes in length.

Byte slices shorter than the field size are handled by zero padding the input.

source

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

Serialize raw secret scalar as a big endian integer.

source

pub fn from_sec1_der(der_bytes: &[u8]) -> Result<Self>where C: Curve + ValidatePublicKey, FieldBytesSize<C>: ModulusSize,

Available on crate feature sec1 only.

Deserialize secret key encoded in the SEC1 ASN.1 DER ECPrivateKey format.

source

pub fn to_sec1_der(&self) -> Result<Zeroizing<Vec<u8>>>where C: CurveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

Available on crate features alloc and arithmetic and sec1 only.

Serialize secret key in the SEC1 ASN.1 DER ECPrivateKey format.

source

pub fn from_sec1_pem(s: &str) -> Result<Self>where C: Curve + ValidatePublicKey, FieldBytesSize<C>: ModulusSize,

Available on crate feature pem only.

Parse SecretKey from PEM-encoded SEC1 ECPrivateKey format.

PEM-encoded SEC1 keys can be identified by the leading delimiter:

-----BEGIN EC PRIVATE KEY-----
source

pub fn to_sec1_pem(&self, line_ending: LineEnding) -> Result<Zeroizing<String>>where C: CurveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

Available on crate feature pem only.

Serialize private key as self-zeroizing PEM-encoded SEC1 ECPrivateKey with the given pem::LineEnding.

Pass Default::default() to use the OS’s native line endings.

source

pub fn from_jwk(jwk: &JwkEcKey) -> Result<Self>where C: JwkParameters + ValidatePublicKey, FieldBytesSize<C>: ModulusSize,

Available on crate feature jwk only.

Parse a JwkEcKey JSON Web Key (JWK) into a SecretKey.

source

pub fn from_jwk_str(jwk: &str) -> Result<Self>where C: JwkParameters + ValidatePublicKey, FieldBytesSize<C>: ModulusSize,

Available on crate feature jwk only.

Parse a string containing a JSON Web Key (JWK) into a SecretKey.

source

pub fn to_jwk(&self) -> JwkEcKeywhere C: CurveArithmetic + JwkParameters, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

Available on crate features arithmetic and jwk only.

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

source

pub fn to_jwk_string(&self) -> Zeroizing<String>where C: CurveArithmetic + JwkParameters, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

Available on crate features arithmetic and jwk only.

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

Trait Implementations§

source§

impl<C> AssociatedAlgorithmIdentifier for SecretKey<C>where C: AssociatedOid + Curve,

Available on crate features pkcs8 and sec1 only.
§

type Params = ObjectIdentifier

Algorithm parameters.
source§

const ALGORITHM_IDENTIFIER: AlgorithmIdentifier<ObjectIdentifier> = _

AlgorithmIdentifier for this structure.
source§

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

source§

fn clone(&self) -> SecretKey<C>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal. Read more
source§

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<C> EncodePrivateKey for SecretKey<C>where C: AssociatedOid + CurveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

Available on crate features pkcs8 and sec1 and alloc and arithmetic only.
source§

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

Serialize a [SecretDocument] containing a PKCS#8-encoded private key.
source§

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

Available on crate feature pem only.
Serialize this private key as PEM-encoded PKCS#8 with the given LineEnding.
source§

fn write_pkcs8_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Available on crate feature std only.
Write ASN.1 DER-encoded PKCS#8 private key to the given path
source§

fn write_pkcs8_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding ) -> Result<(), Error>

Available on crate features pem and std only.
Write ASN.1 DER-encoded PKCS#8 private key to the given path
source§

impl<C> From<&NonZeroScalar<C>> for SecretKey<C>where C: CurveArithmetic,

Available on crate feature arithmetic only.
source§

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

Converts to this type from the input type.
source§

impl<C> From<&SecretKey<C>> for JwkEcKeywhere C: CurveArithmetic + JwkParameters, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

Available on crate features jwk and arithmetic only.
source§

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

Converts to this type from the input type.
source§

impl<C> From<&SecretKey<C>> for NonZeroScalar<C>where C: CurveArithmetic,

Available on crate feature arithmetic only.
source§

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

Converts to this type from the input type.
source§

impl<C> From<NonZeroScalar<C>> for SecretKey<C>where C: CurveArithmetic,

Available on crate feature arithmetic only.
source§

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

Converts to this type from the input type.
source§

impl<C> From<SecretKey<C>> for JwkEcKeywhere C: CurveArithmetic + JwkParameters, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, FieldBytesSize<C>: ModulusSize,

Available on crate features jwk and arithmetic only.
source§

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

Converts to this type from the input type.
source§

impl<C> From<SecretKey<C>> for NonZeroScalar<C>where C: CurveArithmetic,

Available on crate feature arithmetic only.
source§

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

Converts to this type from the input type.
source§

impl<C> FromStr for SecretKey<C>where C: Curve + AssociatedOid + ValidatePublicKey, FieldBytesSize<C>: ModulusSize,

Available on crate features pkcs8 and sec1 and pem only.
§

type Err = Error

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type. Read more
source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

Available on crate feature jwk only.
§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(jwk: &JwkEcKey) -> Result<SecretKey<C>>

Performs the conversion.
source§

impl<C> TryFrom<EcPrivateKey<'_>> for SecretKey<C>where C: Curve + ValidatePublicKey, FieldBytesSize<C>: ModulusSize,

Available on crate feature sec1 only.
§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(sec1_private_key: EcPrivateKey<'_>) -> Result<Self>

Performs the conversion.
source§

impl<C> TryFrom<JwkEcKey> for SecretKey<C>where C: Curve + JwkParameters + ValidatePublicKey, FieldBytesSize<C>: ModulusSize,

Available on crate feature jwk only.
§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(jwk: JwkEcKey) -> Result<SecretKey<C>>

Performs the conversion.
source§

impl<C> TryFrom<PrivateKeyInfo<'_>> for SecretKey<C>where C: AssociatedOid + Curve + ValidatePublicKey, FieldBytesSize<C>: ModulusSize,

Available on crate features pkcs8 and sec1 only.
§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<C: Curve> Eq for SecretKey<C>

source§

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

Auto Trait Implementations§

§

impl<C> RefUnwindSafe for SecretKey<C>where <C as Curve>::Uint: RefUnwindSafe,

§

impl<C> Send for SecretKey<C>

§

impl<C> Sync for SecretKey<C>

§

impl<C> Unpin for SecretKey<C>where <C as Curve>::Uint: Unpin,

§

impl<C> UnwindSafe for SecretKey<C>where <C as Curve>::Uint: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Conv for T

source§

fn conv<T>(self) -> Twhere Self: Into<T>,

Converts self into T using Into<T>. Read more
source§

impl<T> DecodeEcPrivateKey for Twhere T: for<'a> TryFrom<PrivateKeyInfo<'a>, Error = Error>,

source§

fn from_sec1_der(private_key: &[u8]) -> Result<T, Error>

Deserialize SEC1 private key from ASN.1 DER-encoded data (binary format).
source§

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

Available on crate feature pem only.
Deserialize SEC1-encoded private key from PEM. Read more
source§

fn read_sec1_der_file(path: impl AsRef<Path>) -> Result<Self, Error>

Available on crate feature std only.
Load SEC1 private key from an ASN.1 DER-encoded file on the local filesystem (binary format).
source§

fn read_sec1_pem_file(path: impl AsRef<Path>) -> Result<Self, Error>

Available on crate features pem and std only.
Load SEC1 private key from a PEM-encoded file on the local filesystem.
source§

impl<T> DecodePrivateKey for Twhere T: for<'a> TryFrom<PrivateKeyInfo<'a>, Error = Error>,

source§

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

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

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

Available on crate feature pem only.
Deserialize PKCS#8-encoded private key from PEM. Read more
source§

fn read_pkcs8_der_file(path: impl AsRef<Path>) -> Result<Self, Error>

Available on crate feature std only.
Load PKCS#8 private key from an ASN.1 DER-encoded file on the local filesystem (binary format).
source§

fn read_pkcs8_pem_file(path: impl AsRef<Path>) -> Result<Self, Error>

Available on crate features pem and std only.
Load PKCS#8 private key from a PEM-encoded file on the local filesystem.
§

impl<T> DynAssociatedAlgorithmIdentifier for Twhere T: AssociatedAlgorithmIdentifier,

§

fn algorithm_identifier(&self) -> Result<AlgorithmIdentifier<Any>, Error>

AlgorithmIdentifier for this structure.
source§

impl<T> EncodeEcPrivateKey for Twhere T: EncodePrivateKey,

source§

fn to_sec1_der(&self) -> Result<SecretDocument, Error>

Serialize a [SecretDocument] containing a SEC1-encoded private key.
source§

fn to_sec1_pem( &self, line_ending: LineEnding ) -> Result<Zeroizing<String>, Error>

Available on crate feature pem only.
Serialize this private key as PEM-encoded SEC1 with the given LineEnding. Read more
source§

fn write_sec1_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Available on crate feature std only.
Write ASN.1 DER-encoded SEC1 private key to the given path.
source§

fn write_sec1_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding ) -> Result<(), Error>

Available on crate features pem and std only.
Write ASN.1 DER-encoded SEC1 private key to the given path.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Pipe for Twhere T: ?Sized,

source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> Rwhere Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> Tap for T

source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

source§

fn try_conv<T>(self) -> Result<T, Self::Error>where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.