Enum PrivateKey 

#[non_exhaustive]
pub enum PrivateKey {
    Rsa(RsaPrivateKey),
    EcP256(SecretKey),
    EcP384(SecretKey),
}

A private key for any algorithm supported by the crate.

This key is split from the SigningKey type so that it could be decoded and encoded using the [$dec_trait], [$dec_rsa_trait] and EncodePrivateKey traits.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Rsa(RsaPrivateKey)

PKCS#1 v1.5 RSA private key.

EcP256(SecretKey)

ECDSA with NIST P-256 curve private key.

EcP384(SecretKey)

ECDSA with NIST P-384 curve private key.

Implementations

impl PrivateKey

pub fn read_pem_file(path: impl AsRef<Path>) -> Result<Self, DecodeError>

Tries to parse a PEM file at the specified path as a private key.

pub fn from_pem(pem: &str) -> Result<Self, DecodeError>

Tries to parse an in-memory PEM file as a private key.

pub fn to_public_key(&self) -> PublicKey

Creates a public key from a private key.

Trait Implementations

impl Clone for PrivateKey

fn clone(&self) -> PrivateKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateKey

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

Formats the value using the given formatter.

impl EncodePrivateKey for PrivateKey

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

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

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

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

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

Write ASN.1 DER-encoded PKCS#8 private key to the given path

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

Write ASN.1 DER-encoded PKCS#8 private key to the given path

impl From<RsaPrivateKey> for PrivateKey

fn from(value: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl From<SecretKey<NistP256>> for PrivateKey

fn from(value: SecretKey) -> Self

Converts to this type from the input type.

impl From<SecretKey<NistP384>> for PrivateKey

fn from(value: SecretKey) -> Self

Converts to this type from the input type.

impl From<SigningKey> for PrivateKey

fn from(value: SigningKey) -> Self

Converts to this type from the input type.

impl PartialEq for PrivateKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<PrivateKeyInfo<'_>> for PrivateKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(info: PrivateKeyInfo<'_>) -> Result<Self, Error>

Performs the conversion.

impl Eq for PrivateKey

impl StructuralPartialEq for PrivateKey