Struct spki::Document

source ·
pub struct Document { /* private fields */ }
Available on crate feature alloc only.
Expand description

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§

source§

impl Document

source

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

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

source

pub fn into_secret(self) -> SecretDocument

Available on crate feature zeroize only.

Convert to a SecretDocument.

source

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

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

source

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

Return an ASN.1 DER-encoded byte vector.

source

pub fn len(&self) -> Length

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

source

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

Try to decode the inner ASN.1 DER message contained in this Document as the given type.

source

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

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

source

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

Available on crate feature pem only.

Decode ASN.1 DER document from PEM.

Returns the PEM label and decoded Document on success.

source

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

source

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

Available on crate feature std only.

Read ASN.1 DER document from a file.

source

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.

source

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

Available on crate features pem and std only.

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

source

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§

source§

impl AsRef<[u8]> for Document

source§

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

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

impl Clone for Document

source§

fn clone(&self) -> Document

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
source§

impl Debug for Document

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Attempt to decode this message using the provided decoder.
source§

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

Parse Self from the provided DER-encoded byte slice.
source§

impl Encode for Document

source§

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

Compute the length of this value in bytes when encoded as ASN.1 DER.
source§

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

Encode this value as ASN.1 DER using the provided Writer.
source§

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

Encode this value to the provided byte slice, returning a sub-slice containing the encoded message.
source§

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

Available on crate feature alloc only.
Encode this message as ASN.1 DER, appending it to the provided byte vector.
source§

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

Available on crate feature alloc only.
Encode this type as DER, returning a byte vector.
source§

impl FixedTag for Document

source§

const TAG: Tag = Tag::Sequence

ASN.1 tag
source§

impl PartialEq for Document

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl TryFrom<&[u8]> for Document

§

type Error = Error

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

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

Performs the conversion.
source§

impl<'a: 'k, 'k, Params, Key> TryFrom<&SubjectPublicKeyInfo<Params, Key>> for Documentwhere Params: Choice<'a> + Encode, Key: Decode<'a> + Encode + FixedTag + 'k, BitStringRef<'a>: From<&'k Key>,

§

type Error = Error

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

fn try_from(spki: &SubjectPublicKeyInfo<Params, Key>) -> Result<Document>

Performs the conversion.
source§

impl<'a: 'k, 'k, Params, Key> TryFrom<SubjectPublicKeyInfo<Params, Key>> for Documentwhere Params: Choice<'a> + Encode, Key: Decode<'a> + Encode + FixedTag + 'k, BitStringRef<'a>: From<&'k Key>,

§

type Error = Error

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

fn try_from(spki: SubjectPublicKeyInfo<Params, Key>) -> Result<Document>

Performs the conversion.
source§

impl TryFrom<Vec<u8>> for Document

§

type Error = Error

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

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

Performs the conversion.
source§

impl Eq for Document

source§

impl StructuralEq for Document

source§

impl StructuralPartialEq for Document

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<'a, T> Choice<'a> for Twhere T: Decode<'a> + FixedTag,

source§

fn can_decode(tag: Tag) -> bool

Is the provided Tag decodable as a variant of this CHOICE?
source§

impl<T> DecodePublicKey for Twhere T: for<'a> TryFrom<SubjectPublicKeyInfo<AnyRef<'a>, BitStringRef<'a>>, Error = Error>,

source§

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

Deserialize object from ASN.1 DER-encoded SubjectPublicKeyInfo (binary format).
source§

fn from_public_key_pem(s: &str) -> Result<Self>

Available on crate feature pem only.
Deserialize PEM-encoded SubjectPublicKeyInfo. Read more
source§

fn read_public_key_der_file(path: impl AsRef<Path>) -> Result<Self>

Available on crate feature std only.
Load public key object from an ASN.1 DER-encoded file on the local filesystem (binary format).
source§

fn read_public_key_pem_file(path: impl AsRef<Path>) -> Result<Self>

Available on crate features pem and std only.
Load public key object 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 Twhere 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> Tagged for Twhere T: FixedTag,

source§

fn tag(&self) -> Tag

Get the ASN.1 tag that this type is encoded with.
source§

impl<T> ToOwned for Twhere 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 Twhere 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 Twhere 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.
source§

impl<T> DecodeOwned for Twhere T: for<'a> Decode<'a>,