Struct pkcs8::PrivateKeyDocument

pub struct PrivateKeyDocument(_);

This is supported on crate feature alloc only.

PKCS#8 private key document.

This type provides storage for PrivateKeyInfo encoded as ASN.1 DER with the invariant that the contained-document is “well-formed”, i.e. it will parse successfully according to this crate’s parsing rules.

Implementations

impl PrivateKeyDocument

pub fn private_key_info(&self) -> PrivateKeyInfo<'_>

Parse the PrivateKeyInfo contained in this PrivateKeyDocument

pub fn from_der(bytes: &[u8]) -> Result<Self>

Parse PrivateKeyDocument from ASN.1 DER-encoded PKCS#8

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

This is supported on crate feature pem only.

Parse PrivateKeyDocument from PEM-encoded PKCS#8.

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

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

pub fn to_pem(&self) -> Zeroizing<String>

This is supported on crate feature pem only.

Serialize PrivateKeyDocument as self-zeroizing PEM-encoded PKCS#8 string.

pub fn read_der_file(path: impl AsRef<Path>) -> Result<Self>

This is supported on crate feature std only.

Load PrivateKeyDocument from an ASN.1 DER-encoded file on the local filesystem (binary format).

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

This is supported on crate features pem and std only.

Load PrivateKeyDocument from a PEM-encoded file on the local filesystem.

pub fn write_der_file(&self, path: impl AsRef<Path>) -> Result<()>

This is supported on crate feature std only.

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

pub fn write_pem_file(&self, path: impl AsRef<Path>) -> Result<()>

This is supported on crate features pem and std only.

Write PEM-encoded PKCS#8 private key to the given path

pub fn encrypt(
    &self,
    rng: impl CryptoRng + RngCore,
    password: impl AsRef<[u8]>
) -> Result<EncryptedPrivateKeyDocument>

This is supported on crate feature encryption only.

Encrypt this private key using a symmetric encryption key derived from the provided password.

Uses the following algorithms for encryption:

• PBKDF: scrypt with default parameters:
  • log₂(N): 15
  • r: 8
  • p: 1
• Cipher: AES-256-CBC (best available option for PKCS#5 encryption)

pub fn encrypt_with_params(
    &self,
    pbes2_params: Parameters<'_>,
    password: impl AsRef<[u8]>
) -> Result<EncryptedPrivateKeyDocument>

This is supported on crate feature encryption only.

Encrypt this private key using a symmetric encryption key derived from the provided password and pbes2::Parameters.

Trait Implementations

impl AsRef<[u8]> for PrivateKeyDocument

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for PrivateKeyDocument

fn clone(&self) -> PrivateKeyDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateKeyDocument

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

Formats the value using the given formatter.

impl From<&'_ PrivateKeyInfo<'_>> for PrivateKeyDocument

fn from(private_key_info: &PrivateKeyInfo<'_>) -> PrivateKeyDocument

Performs the conversion.

impl From<PrivateKeyInfo<'_>> for PrivateKeyDocument

fn from(private_key_info: PrivateKeyInfo<'_>) -> PrivateKeyDocument

Performs the conversion.

impl FromStr for PrivateKeyDocument

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.

impl TryFrom<&'_ [u8]> for PrivateKeyDocument

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8, Global>> for PrivateKeyDocument

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self>

Performs the conversion.