Struct spki::Document

source · [−]

pub struct Document { /* private fields */ }

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 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

source

pub fn into_secret(self) -> SecretDocument

Convert to a SecretDocument.

source

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

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

source

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

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>

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>

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>

Read ASN.1 DER document from a file.

source

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

Write ASN.1 DER document to a file.

source

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

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>

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

Trait Implementations

source

impl AsRef<[u8 ]> for Document

source

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [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 dyn Writer) -> Result<(), Error>

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

source

fn encode_to_slice(&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. Read more

source

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

Encode this message as ASN.1 DER, appending it to the provided byte vector. Read more

source

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

Serialize this message as a byte vector.

source

impl FixedTag for Document

source

const TAG: Tag = Tag::Sequence

ASN.1 tag

source

impl PartialEq<Document> for Document

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

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 TryFrom<&'_ SubjectPublicKeyInfo<'_>> for Document

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(spki: &SubjectPublicKeyInfo<'_>) -> Result<Document>

Performs the conversion.

source

impl TryFrom<SubjectPublicKeyInfo<'_>> for Document

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(spki: SubjectPublicKeyInfo<'_>) -> Result<Document>

Performs the conversion.

source

impl TryFrom<Vec<u8, Global>> for Document

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl Eq for Document

source

impl StructuralEq for Document

source

impl StructuralPartialEq for Document

Auto Trait Implementations

impl RefUnwindSafe for Document

impl Send for Document

impl Sync for Document

impl Unpin for Document

impl UnwindSafe for Document

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<'a, T> Choice<'a> for T where
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> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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<T> for T

type Output = T

Should always be Self

source

impl<T> Tagged for T where
T: FixedTag,

source

fn tag(&self) -> Tag

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

source

impl<T> ToOwned for T where
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)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct spki::Document

Implementations

impl Document

pub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

pub fn into_secret(self) -> SecretDocument

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

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

pub fn len(&self) -> Length

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

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

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

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

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

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

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

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

Trait Implementations

impl AsRef<[u8]> for Document

fn as_ref(&self) -> &[u8]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

impl Clone for Document

fn clone(&self) -> Document

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

impl Debug for Document

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

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

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

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

impl Encode for Document

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

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

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

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

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

impl FixedTag for Document

const TAG: Tag = Tag::Sequence

impl PartialEq<Document> for Document

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

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

impl<'_> TryFrom<&'_ [u8]> for Document

type Error = Error

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

impl TryFrom<&'_ SubjectPublicKeyInfo<'_>> for Document

type Error = Error

fn try_from(spki: &SubjectPublicKeyInfo<'_>) -> Result<Document>

impl TryFrom<SubjectPublicKeyInfo<'_>> for Document

type Error = Error

fn try_from(spki: SubjectPublicKeyInfo<'_>) -> Result<Document>

impl TryFrom<Vec<u8, Global>> for Document

type Error = Error

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

impl Eq for Document

impl StructuralEq for Document

impl StructuralPartialEq for Document

Auto Trait Implementations

impl RefUnwindSafe for Document

impl Send for Document

impl Sync for Document

impl Unpin for Document

impl UnwindSafe for Document

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

fn can_decode(tag: Tag) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> Tagged for T where T: FixedTag,

fn tag(&self) -> Tag

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

pub fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

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

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

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

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

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

impl AsRef<[u8 ]> for Document

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

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

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

impl<'_> TryFrom<&'_ [u8 ]> for Document

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

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

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

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

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

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> Tagged for T where
T: FixedTag,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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