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.

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.

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<'a> Document<'a> for EncryptedPrivateKeyDocument

type Message = EncryptedPrivateKeyInfo<'a>

ASN.1 message type this document decodes to.

const SENSITIVE: bool

Does this type contain potentially sensitive data?

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

Borrow the inner serialized bytes of this document.

fn to_der(&self) -> Box<[u8], Global>

Return an allocated ASN.1 DER serialization as a boxed slice.

fn decode(&'a self) -> Self::Message

Decode this document as ASN.1 DER.

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

Create a new document from the provided ASN.1 DER bytes.

fn from_msg(msg: &Self::Message) -> Result<Self, Error>

Encode the provided type as ASN.1 DER.

fn from_pem(s: &str) -> Result<Self, Error> where
    Self: PemLabel, 

Decode ASN.1 DER document from PEM.

fn to_pem(&self, line_ending: LineEnding) -> Result<String, Error> where
    Self: PemLabel, 

Encode ASN.1 DER document as a PEM string.

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

Read ASN.1 DER document from a file.

fn read_pem_file(path: impl AsRef<Path>) -> Result<Self, Error> where
    Self: PemLabel, 

Read PEM-encoded ASN.1 DER document from a file.

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

Write ASN.1 DER document to a file.

fn write_pem_file(
    &self,
    path: impl AsRef<Path>,
    line_ending: LineEnding
) -> Result<(), Error> where
    Self: PemLabel, 

Write PEM-encoded ASN.1 DER document to a file.

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

This is supported on crate feature pem only.

const TYPE_LABEL: &'static str

Expected PEM type label for a given document, e.g. "PRIVATE KEY"

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<&'_ EncryptedPrivateKeyInfo<'_>> for EncryptedPrivateKeyDocument

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<EncryptedPrivateKeyInfo<'_>> for EncryptedPrivateKeyDocument

type Error = Error

The type returned in the event of a conversion error.

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

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.

impl Eq for EncryptedPrivateKeyDocument

impl StructuralEq for EncryptedPrivateKeyDocument

impl StructuralPartialEq for EncryptedPrivateKeyDocument