Struct ethers::core::k256::elliptic_curve::SecretKey

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

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][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) -> SecretKey<C> where
    C: ProjectiveArithmetic,
    <C as ScalarArithmetic>::Scalar: Zeroize, 

Generate a random SecretKey

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

Create a new secret key from a serialized scalar value

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<SecretKey<C>, Error>

Deserialize raw private scalar as a big endian integer

pub fn to_bytes(
    &self
) -> GenericArray<u8, <<C as Curve>::UInt as ArrayEncoding>::ByteSize>

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,
    <C as ScalarArithmetic>::Scalar: Zeroize, 

Get the secret scalar value for this key..

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

Get the PublicKey which corresponds to this secret key

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

pub fn drop(&mut self)

Executes the destructor for this type.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'_> From<&'_ SecretKey<Secp256k1>> for SigningKey

pub fn from(secret_key: &SecretKey<Secp256k1>) -> SigningKey

Performs the conversion.

impl<'_> From<&'_ SigningKey> for SecretKey<Secp256k1>

pub fn from(signing_key: &SigningKey) -> SecretKey<Secp256k1>

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl From<SecretKey<Secp256k1>> for SigningKey

pub fn from(secret_key: SecretKey<Secp256k1>) -> SigningKey

Performs the conversion.

impl From<SecretKey<Secp256k1>> for Wallet<SigningKey>

pub fn from(key: SecretKey<Secp256k1>) -> Wallet<SigningKey>

Performs the conversion.

impl From<SigningKey> for SecretKey<Secp256k1>

pub fn from(signing_key: SigningKey) -> SecretKey<Secp256k1>

Performs the conversion.

impl<C> FromPrivateKey for SecretKey<C> where
    C: Curve + AlgorithmParameters + ValidatePublicKey,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: Add<UInt<UTerm, B1>>,
    <<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output: ArrayLength<u8>,
    <<<<C as Curve>::UInt as ArrayEncoding>::ByteSize as Add<<<C as Curve>::UInt as ArrayEncoding>::ByteSize>>::Output as Add<UInt<UTerm, B1>>>::Output: ArrayLength<u8>, 

pub fn from_pkcs8_private_key_info(
    private_key_info: PrivateKeyInfo<'_>
) -> Result<SecretKey<C>, Error>

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).

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

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(slice: &[u8]) -> Result<SecretKey<C>, Error>

Performs the conversion.