Struct Document 

pub struct Document { /* private fields */ }

Available on crate feature alloc only.

ASN.1 DER-encoded document.

This type wraps an encoded ASN.1 DER message. The document checked to ensure it contains a valid DER-encoded SEQUENCE.

It implements common functionality related to encoding/decoding such documents, such as PEM encapsulation as well as reading/writing documents from/to the filesystem.

The SecretDocument provides a wrapper for this type with additional hardening applied.

Implementations

impl Document

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

Get the ASN.1 DER-encoded bytes of this document.

pub fn into_secret(self) -> SecretDocument

Available on crate feature zeroize only.

Convert to a SecretDocument.

pub fn into_vec(self) -> Vec<u8>

Convert to an ASN.1 DER-encoded byte vector.

pub fn to_vec(&self) -> Vec<u8>

Return an ASN.1 DER-encoded 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 contained in this Document as the given type.

Errors

If a decoding error occurred.

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

Encode the provided type as ASN.1 DER, storing the resulting encoded DER as a Document.

Errors

If an encoding error occurred.

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

Available on crate feature pem only.

Decode ASN.1 DER document from PEM.

Returns the PEM label and decoded Document on success.

Errors

If a decoding error occurred.

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

Available on crate feature pem only.

Encode ASN.1 DER document as a PEM string with encapsulation boundaries containing the provided PEM type label (e.g. CERTIFICATE).

Errors

If an encoding error occurred.

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

Available on crate feature std only.

Read ASN.1 DER document from a file.

Errors

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

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.

Errors

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

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

Available on crate features pem and std only.

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

Errors

If the 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>

Available on crate features pem and std only.

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

Errors

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

Trait Implementations

impl AsRef<[u8]> for Document

fn as_ref(&self) -> &[u8]

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

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl<'a> Decode<'a> for Document

type Error = Error

Type returned in the event of a decoding error.

fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Document, Error>

Attempt to decode this TLV message using the provided decoder.

fn from_ber(bytes: &'a [u8]) -> Result<Self, Self::Error>

Available on crate feature ber only.

Parse Self from the provided BER-encoded byte slice.

fn from_der(bytes: &'a [u8]) -> Result<Self, Self::Error>

Parse Self from the provided DER-encoded byte slice.

fn from_der_partial(bytes: &'a [u8]) -> Result<(Self, &'a [u8]), Self::Error>

Parse Self from the provided DER-encoded byte slice.

impl Encode for Document

fn encoded_len(&self) -> Result<Length, Error>

Compute the length of this TLV object in bytes when encoded as ASN.1 DER.

fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>

Encode this TLV object as ASN.1 DER using the provided Writer.

fn encode_to_slice<'a>(&self, buf: &'a mut [u8]) -> Result<&'a [u8]>

Encode this TLV object to the provided byte slice, returning a sub-slice containing the encoded message.

fn encode_to_vec(&self, buf: &mut Vec<u8>) -> Result<Length>

Encode this TLV object as ASN.1 DER, appending it to the provided byte vector.

fn to_der(&self) -> Result<Vec<u8>>

Encode this TLV object as ASN.1 DER, returning a byte vector.

impl FixedTag for Document

const TAG: Tag = Tag::Sequence

ASN.1 tag

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 PartialEq for Document

fn eq(&self, other: &Document) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for Document

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 Document

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 Eq for Document

impl StructuralPartialEq for Document