Struct pkcs8::EncryptedPrivateKeyDocument

pub struct EncryptedPrivateKeyDocument(_);

This is supported on crate features alloc and pkcs5 only.

Encrypted PKCS#8 private key document.

This type provides heap-backed storage for EncryptedPrivateKeyInfo 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 EncryptedPrivateKeyDocument

pub fn decrypt(&self, password: impl AsRef<[u8]>) -> Result<PrivateKeyDocument>

This is supported on crate feature encryption only.

Attempt to decrypt this encrypted private key using the provided password to derive an encryption key.

pub fn encrypted_private_key_info(&self) -> EncryptedPrivateKeyInfo<'_>

Parse the EncryptedPrivateKeyInfo contained in this EncryptedPrivateKeyDocument.

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

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

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

This is supported on crate feature pem only.

Parse EncryptedPrivateKeyDocument from PEM-encoded PKCS#8.

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

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

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

This is supported on crate feature pem only.

Serialize EncryptedPrivateKeyDocument 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 EncryptedPrivateKeyDocument 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 EncryptedPrivateKeyDocument 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 encrypted 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 encrypted private key to the given path.

Trait Implementations

impl AsRef<[u8]> for EncryptedPrivateKeyDocument

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

Performs the conversion.

impl Clone for EncryptedPrivateKeyDocument

fn clone(&self) -> EncryptedPrivateKeyDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptedPrivateKeyDocument

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

Formats the value using the given formatter.

impl Eq for EncryptedPrivateKeyDocument

impl From<&'_ EncryptedPrivateKeyInfo<'_>> for EncryptedPrivateKeyDocument

fn from(key: &EncryptedPrivateKeyInfo<'_>) -> EncryptedPrivateKeyDocument

Performs the conversion.

impl From<EncryptedPrivateKeyInfo<'_>> for EncryptedPrivateKeyDocument

fn from(key: EncryptedPrivateKeyInfo<'_>) -> EncryptedPrivateKeyDocument

Performs the conversion.

impl FromStr for EncryptedPrivateKeyDocument

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 PartialEq<EncryptedPrivateKeyDocument> for EncryptedPrivateKeyDocument

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

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

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

This method tests for !=.

impl StructuralEq for EncryptedPrivateKeyDocument

impl StructuralPartialEq for EncryptedPrivateKeyDocument

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

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 EncryptedPrivateKeyDocument

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.