logo
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 elliptic_curve::pkcs8::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

This is supported on crate feature arithmetic only.

Generate a random SecretKey.

Create a new secret key from a scalar value.

Borrow the inner secret ScalarCore value.

⚠️ Warning

This value is key material.

Please treat it with the care it deserves!

This is supported 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!

This is supported on crate feature arithmetic only.

Get the PublicKey which corresponds to this secret key

Deserialize raw secret scalar as a big endian integer.

Serialize raw secret scalar as a big endian integer.

This is supported on crate feature sec1 only.

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

This is supported on crate features alloc and arithmetic and sec1 only.

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

This is supported 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-----
This is supported 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.

This is supported on crate feature jwk only.

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

This is supported on crate feature jwk only.

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

This is supported on crate features arithmetic and jwk only.

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

This is supported on crate features arithmetic and jwk only.

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

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Determine if two items are equal. Read more

Formats the value using the given formatter. Read more

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

Deserialize PKCS#8 private key from a PrivateKeyDocument.

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

Executes the destructor for this type. Read more

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

Serialize this private key as PEM-encoded PKCS#8 with the given LineEnding.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

The associated error which can be returned from parsing.

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

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

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

Deserialize SEC1-encoded private key from PEM. Read more

Serialize a EcPrivateKeyDocument containing a SEC1-encoded private key.

Serialize this private key as PEM-encoded SEC1 with the given LineEnding. Read more

Performs the conversion.

Performs the conversion.

Should always be Self

The resulting type after obtaining ownership.

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

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

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.