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>

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

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

Encode the provided type as ASN.1 DER.

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

Decode ASN.1 DER document from PEM.

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

Encode ASN.1 DER document as a PEM string.

Trait Implementations

impl Clone for SecretDocument

fn clone(&self) -> SecretDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretDocument

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

Formats the value using the given formatter.

impl Drop for SecretDocument

fn drop(&mut self)

Executes the destructor for this type.

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

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

Performs the conversion.

impl ZeroizeOnDrop for SecretDocument