Struct SecretDocument 

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

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: Decode<'a>>(&'a self) -> Result<T, T::Error>

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

Errors

Returns T::Error if a decoding error occurred.

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

Encode the provided type as ASN.1 DER.

Errors

If an encoding error occurred.

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

Decode ASN.1 DER document from PEM.

Errors

If a decoding error occurred.

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

Encode ASN.1 DER document as a PEM string.

Errors

If an encoding error occurred.

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

Read ASN.1 DER document from a file.

Errors

If file could not be read, or a decoding error occurred.

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

Write ASN.1 DER document to a file.

Errors

If file could not be written, or an encoding error occurred.

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

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

Errors

If file could not be read, or a decoding error occurred.

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

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

Errors

If file could not be written, or an encoding error occurred.

Trait Implementations

impl Clone for SecretDocument

fn clone(&self) -> SecretDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretDocument

Available on crate feature zeroize only.

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

Formats the value using the given formatter.

impl Drop for SecretDocument

Available on crate feature zeroize only.

fn drop(&mut self)

Executes the destructor for this type.

impl From<Document> for SecretDocument

Available on crate feature zeroize only.

fn from(doc: Document) -> SecretDocument

Converts to this type from the input type.

impl TryFrom<&[u8]> for SecretDocument

Available on crate feature zeroize only.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for SecretDocument

Available on crate feature zeroize only.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ZeroizeOnDrop for SecretDocument

Available on crate feature zeroize only.