Struct pkcs8::PublicKeyDocument

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

SPKI public key document.

This type provides storage for SubjectPublicKeyInfo encoded as ASN.1 DER with the invariant that the contained-document is “well-formed”, i.e. it will parse successfully according to this crate’s parsing rules.

Trait Implementations

impl AsRef<[u8]> for PublicKeyDocument

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

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

impl Clone for PublicKeyDocument

fn clone(&self) -> PublicKeyDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublicKeyDocument

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

Formats the value using the given formatter.

impl DecodePublicKey for PublicKeyDocument

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

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

fn from_public_key_pem(s: &str) -> Result<PublicKeyDocument, Error>

Deserialize PEM-encoded SubjectPublicKeyInfo.

fn read_public_key_der_file( path: impl AsRef<Path> ) -> Result<PublicKeyDocument, Error>

Load public key object from an ASN.1 DER-encoded file on the local filesystem (binary format).

fn read_public_key_pem_file( path: impl AsRef<Path> ) -> Result<PublicKeyDocument, Error>

Load public key object from a PEM-encoded file on the local filesystem.

fn from_public_key_doc(doc: &PublicKeyDocument) -> Result<Self, Error>

Deserialize SPKI public key from a PublicKeyDocument.

impl<'a> Document<'a> for PublicKeyDocument

type Message = SubjectPublicKeyInfo<'a>

ASN.1 message type this document decodes to.

const SENSITIVE: bool = false

Does this type contain potentially sensitive data?

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

Borrow the inner serialized bytes of this document.

fn to_der(&self) -> Box<[u8]>

Return an allocated ASN.1 DER serialization as a boxed slice.

fn decode(&'a self) -> Self::Message

Decode this document as ASN.1 DER.

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

Create a new document from the provided ASN.1 DER bytes.

fn from_msg(msg: &Self::Message) -> Result<Self, Error>

Encode the provided type as ASN.1 DER.

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

where Self: PemLabel,

Decode ASN.1 DER document from PEM.

fn to_pem(&self, line_ending: LineEnding) -> Result<String, Error>

where Self: PemLabel,

Encode ASN.1 DER document as a PEM string.

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

Read ASN.1 DER document from a file.

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

where Self: PemLabel,

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

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

Write ASN.1 DER document to a file.

fn write_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding ) -> Result<(), Error>

where Self: PemLabel,

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

impl EncodePublicKey for PublicKeyDocument

fn to_public_key_der(&self) -> Result<PublicKeyDocument, Error>

Serialize a PublicKeyDocument containing a SPKI-encoded public key.

fn to_public_key_pem(&self, line_ending: LineEnding) -> Result<String, Error>

Serialize this public key as PEM-encoded SPKI with the given LineEnding.

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

Write ASN.1 DER-encoded public key to the given path

fn write_public_key_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding ) -> Result<(), Error>

Write ASN.1 DER-encoded public key to the given path

impl FromStr for PublicKeyDocument

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PublicKeyDocument, Error>

Parses a string s to return a value of this type.

impl PemLabel for PublicKeyDocument

const TYPE_LABEL: &'static str = "PUBLIC KEY"

Expected PEM type label for a given document, e.g. "PRIVATE KEY"

impl TryFrom<&[u8]> for PublicKeyDocument

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<PublicKeyDocument, Error>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(spki: &SubjectPublicKeyInfo<'_>) -> Result<PublicKeyDocument, Error>

Performs the conversion.

impl TryFrom<SubjectPublicKeyInfo<'_>> for PublicKeyDocument

type Error = Error

The type returned in the event of a conversion error.

fn try_from(spki: SubjectPublicKeyInfo<'_>) -> Result<PublicKeyDocument, Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for PublicKeyDocument

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<PublicKeyDocument, Error>

Performs the conversion.