Struct SecretDocument 

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

Available on crate features pkcs8 and zeroize only.

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, <T as Decode<'a>>::Error>

where T: Decode<'a>,

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>(msg: &T) -> Result<SecretDocument, Error>

where T: Encode,

Encode the provided type as ASN.1 DER.

Errors

If 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

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

Formats the value using the given formatter.

impl Drop for SecretDocument

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

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<'a, Params, Key, PubKey> TryFrom<&PrivateKeyInfo<Params, Key, PubKey>> for SecretDocument

where Params: Choice<'a, Error = Error> + Encode, Key: DecodeValue<'a, Error = Error> + FixedTag + 'a + EncodeValue, PubKey: DecodeValue<'a, Error = Error> + FixedTag + 'a + BitStringLike,

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<Params, Key, PubKey>, ) -> Result<SecretDocument, Error>

Performs the conversion.

impl<'a, Params, Key, PubKey> TryFrom<PrivateKeyInfo<Params, Key, PubKey>> for SecretDocument

where Params: Choice<'a, Error = Error> + Encode, Key: DecodeValue<'a, Error = Error> + FixedTag + 'a + EncodeValue, PubKey: DecodeValue<'a, Error = Error> + FixedTag + 'a + BitStringLike,

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<Params, Key, PubKey>, ) -> 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