pub struct SecretDocument(/* private fields */);
Available on crate features pkcs8 and zeroize only.
Expand description

Secret Document type.

Useful for formats which represent potentially secret data, such as cryptographic keys.

This type provides additional hardening such as ensuring that the contents are zeroized-on-drop, and also using more restrictive file permissions when writing files to disk.

Implementations§

§

impl SecretDocument

pub fn as_bytes(&self) -> &[u8]

Borrow the inner serialized bytes of this document.

pub fn to_bytes(&self) -> Zeroizing<Vec<u8>>

Return an allocated ASN.1 DER serialization as a byte vector.

pub fn len(&self) -> Length

Get the length of the encoded ASN.1 DER in bytes.

pub fn decode_msg<'a, T>(&'a self) -> Result<T, Error>
where T: Decode<'a>,

Try to decode the inner ASN.1 DER message as the given type.

pub fn encode_msg<T>(msg: &T) -> Result<SecretDocument, Error>
where T: Encode,

Encode the provided type as ASN.1 DER.

pub fn from_pem(pem: &str) -> Result<(&str, SecretDocument), Error>

Available on crate feature pem only.

Decode ASN.1 DER document from PEM.

pub fn to_pem( &self, label: &'static str, line_ending: LineEnding ) -> Result<Zeroizing<String>, Error>

Available on crate feature pem only.

Encode ASN.1 DER document as a PEM string.

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

Available on crate feature std only.

Read ASN.1 DER document from a file.

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

Available on crate feature std only.

Write ASN.1 DER document to a file.

pub fn read_pem_file( path: impl AsRef<Path> ) -> Result<(String, SecretDocument), Error>

Available on crate features pem and std only.

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

pub fn write_pem_file( &self, path: impl AsRef<Path>, label: &'static str, line_ending: LineEnding ) -> Result<(), Error>

Available on crate features pem and std only.

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

Trait Implementations§

§

impl Clone for SecretDocument

§

fn clone(&self) -> SecretDocument

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
§

impl Debug for SecretDocument

§

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

Formats the value using the given formatter. Read more
§

impl Drop for SecretDocument

§

fn drop(&mut self)

Executes the destructor for this type. Read more
§

impl From<Document> for SecretDocument

§

fn from(doc: Document) -> SecretDocument

Converts to this type from the input type.
§

impl TryFrom<&[u8]> for SecretDocument

§

type Error = Error

The type returned in the event of a conversion error.
§

fn try_from(der_bytes: &[u8]) -> Result<SecretDocument, Error>

Performs the conversion.
§

impl TryFrom<&PrivateKeyInfo<'_>> for SecretDocument

Available on crate feature alloc only.
§

type Error = Error

The type returned in the event of a conversion error.
§

fn try_from(private_key: &PrivateKeyInfo<'_>) -> Result<SecretDocument, Error>

Performs the conversion.
§

impl TryFrom<PrivateKeyInfo<'_>> for SecretDocument

Available on crate feature alloc only.
§

type Error = Error

The type returned in the event of a conversion error.
§

fn try_from(private_key: PrivateKeyInfo<'_>) -> Result<SecretDocument, Error>

Performs the conversion.
§

impl TryFrom<Vec<u8>> for SecretDocument

§

type Error = Error

The type returned in the event of a conversion error.
§

fn try_from(der_bytes: Vec<u8>) -> Result<SecretDocument, Error>

Performs the conversion.
§

impl ZeroizeOnDrop for SecretDocument

Auto Trait Implementations§

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> DecodePrivateKey for T
where T: for<'a> TryFrom<PrivateKeyInfo<'a>, Error = Error>,

§

fn from_pkcs8_der(bytes: &[u8]) -> Result<T, Error>

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

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

Available on crate feature pem only.
Deserialize PKCS#8-encoded private key from PEM. Read more
§

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

Available 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, Error>

Available on crate features pem and std only.
Load PKCS#8 private key from a PEM-encoded file on the local filesystem.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.