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

This is supported on crate feature pem only.

Deserialize PKCS#8-encoded private key from PEM.

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

This is supported on crate feature std only.

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>

This is supported on crate features pem and std only.

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

fn from_pkcs8_encrypted_der(
    bytes: &[u8],
    password: impl AsRef<[u8]>
) -> Result<Self>

This is supported on crate feature encryption only.

Deserialize encrypted PKCS#8 private key from ASN.1 DER-encoded data (binary format) and attempt to decrypt it using the provided password.

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

This is supported on crate feature alloc only.

Deserialize PKCS#8 private key from a PrivateKeyDocument.

fn from_pkcs8_encrypted_pem(s: &str, password: impl AsRef<[u8]>) -> Result<Self>

This is supported on crate features encryption and pem only.

Deserialize encrypted PKCS#8-encoded private key from PEM and attempt to decrypt it using the provided password.

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

type Message = PrivateKeyInfo<'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 EncodePrivateKey for PrivateKeyDocument

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

This is supported on crate feature alloc only.

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

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

This is supported on crate features alloc and pem only.

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

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

This is supported on crate features alloc and std only.

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

This is supported on crate features pem and std and alloc only.

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

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

This is supported on crate features alloc and encryption only.

Create an EncryptedPrivateKeyDocument containing the ciphertext of a PKCS#8 encoded private key encrypted under the given password.

fn to_pkcs8_encrypted_pem(
    &self,
    rng: impl CryptoRng + RngCore,
    password: impl AsRef<[u8]>,
    line_ending: LineEnding
) -> Result<Zeroizing<String>>

This is supported on crate features encryption and pem and alloc only.

Serialize this private key as an encrypted PEM-encoded PKCS#8 private key using the provided to derive an encryption key.

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

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 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, 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.