Struct pkcs8::PrivateKeyDocument

pub struct PrivateKeyDocument(/* private fields */);

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.

Trait Implementations

impl AsRef<[u8]> for PrivateKeyDocument

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

Converts this type into a shared reference of the (usually inferred) input type.

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 DecodePrivateKey for PrivateKeyDocument

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

Deserialize PKCS#8 private key from ASN.1 DER-encoded data (binary format).

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

Deserialize PKCS#8-encoded private key from PEM.

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

Load PKCS#8 private key from an ASN.1 DER-encoded file on the local filesystem (binary format).

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

Load PKCS#8 private key from a PEM-encoded file on the local filesystem.

fn from_pkcs8_doc(doc: &PrivateKeyDocument) -> Result<Self>

Deserialize PKCS#8 private key from a PrivateKeyDocument.

impl<'a> Document<'a> for PrivateKeyDocument

type Message = PrivateKeyInfo<'a>

ASN.1 message type this document decodes to.

const SENSITIVE: bool = true

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]>

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 EncodePrivateKey for PrivateKeyDocument

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

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

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

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

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

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

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

impl FromStr for PrivateKeyDocument

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

const TYPE_LABEL: &'static str = "PRIVATE KEY"

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

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<&PrivateKeyInfo<'_>> for PrivateKeyDocument

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<PrivateKeyInfo<'_>> for PrivateKeyDocument

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> 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.