Struct pkcs8::PrivateKeyDocument

source · [−]

pub struct PrivateKeyDocument(_);

Expand description

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

source

impl PrivateKeyDocument

source

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

Parse the PrivateKeyInfo contained in this PrivateKeyDocument

source

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

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

source

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

Parse PrivateKeyDocument from PEM-encoded PKCS#8.

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

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

source

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

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

source

pub fn to_pem_with_le(&self, line_ending: LineEnding) -> Zeroizing<String>

Serialize PrivateKeyDocument as self-zeroizing PEM-encoded PKCS#8 string with the given LineEnding.

source

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

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

source

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

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

source

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

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

source

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

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

Trait Implementations

source

impl AsRef<[u8 ]> for PrivateKeyDocument

source

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

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

source

impl Clone for PrivateKeyDocument

source

fn clone(&self) -> PrivateKeyDocument

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for PrivateKeyDocument

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Converts to this type from the input type.

source

impl From<PrivateKeyInfo<'_>> for PrivateKeyDocument

source

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

Converts to this type from the input type.

source

impl FromStr for PrivateKeyDocument

type Err = Error

The associated error which can be returned from parsing.

source

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

Parses a string s to return a value of this type. Read more

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for PrivateKeyDocument

impl Send for PrivateKeyDocument

impl Sync for PrivateKeyDocument

impl Unpin for PrivateKeyDocument

impl UnwindSafe for PrivateKeyDocument

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct pkcs8::PrivateKeyDocument

Implementations

impl PrivateKeyDocument

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

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

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

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

pub fn to_pem_with_le(&self, line_ending: LineEnding) -> Zeroizing<String>

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

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

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

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

Trait Implementations

impl AsRef<[u8]> for PrivateKeyDocument

fn as_ref(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

impl Clone for PrivateKeyDocument

fn clone(&self) -> PrivateKeyDocument

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

impl Debug for PrivateKeyDocument

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

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

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

impl From<PrivateKeyInfo<'_>> for PrivateKeyDocument

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

impl FromStr for PrivateKeyDocument

type Err = Error

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

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

type Error = Error

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

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

type Error = Error

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

Auto Trait Implementations

impl RefUnwindSafe for PrivateKeyDocument

impl Send for PrivateKeyDocument

impl Sync for PrivateKeyDocument

impl Unpin for PrivateKeyDocument

impl UnwindSafe for PrivateKeyDocument

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

impl AsRef<[u8 ]> for PrivateKeyDocument

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,