Struct sequoia_openpgp::cert::raw::RawCert

pub struct RawCert<'a> { /* private fields */ }

A mostly unparsed Cert.

This data structure contains the unparsed packets for a certificate or key. The packet sequence is well formed in the sense that the sequence of tags conforms to the Transferable Public Key grammar or Transferable Secret Key grammar, and that it can extract the primary key’s fingerprint. Beyond that, the packets are not guaranteed to be valid.

This data structure exists to quickly split a large keyring, and only parse those certificates that appear to be relevant.

Implementations

impl<'a> RawCert<'a>

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

Returns the certificate’s bytes.

If you want an individual packet’s bytes, use RawCert::packet or RawCert::packets, and then call RawPacket::as_bytes.

pub fn fingerprint(&self) -> Fingerprint

Returns the certificate’s fingerprint.

pub fn keyid(&self) -> KeyID

Returns the certificate’s Key ID.

pub fn packet(&self, i: usize) -> Option<RawPacket<'_>>

Returns the ith packet.

pub fn packets(&self) -> impl Iterator<Item = RawPacket<'_>>

Returns an iterator over each raw packet.

pub fn count(&self) -> usize

Returns the number of packets.

pub fn keys(&self) -> KeyIter<'_, PublicParts, UnspecifiedRole>

Returns an iterator over the certificate’s keys.

Note: this parses the key packets, but it does not verify any binding signatures. As such, this can only be used as part of a precheck. If the certificate appears to match, then the caller must convert the RawCert to a Cert or a ValidCert, depending on the requirements, and perform the check again.

Use subkeys to just return the subkeys. This function also changes the return type. Instead of the iterator returning a Key whose role is key::UnspecifiedRole, the role is key::SubordinateRole.

Examples

use sequoia_openpgp as openpgp;
use openpgp::cert::raw::RawCertParser;
use openpgp::parse::Parse;
for cert in RawCertParser::from_bytes(&bytes)? {
    /// Ignore corrupt and invalid certificates.
    let cert = if let Ok(cert) = cert {
        cert
    } else {
        continue;
    };

    // Iterate over the keys.  Note: this parses the Key
    // packets.
    for key in cert.keys() {
        println!("{}", key.fingerprint());
    }
}

pub fn primary_key(&self) -> Key<PublicParts, PrimaryRole>

Returns the certificate’s primary key.

Note: this parses the primary key packet, but it does not verify any binding signatures. As such, this can only be used as part of a precheck. If the certificate appears to match, then the caller must convert the RawCert to a Cert or a ValidCert, depending on the requirements, and perform the check again.

pub fn userids(&self) -> impl Iterator<Item = UserID> + '_

Returns the certificate’s User IDs.

Note: this parses the User ID packets, but it does not verify any binding signatures. That is, there is no guarantee that the User IDs should actually be associated with the primary key. As such, this can only be used as part of a precheck. If a User ID appears to match, then the caller must convert the RawCert to a Cert or a ValidCert, depending on the requirements, and perform the check again.

Trait Implementations

impl<'a> Clone for RawCert<'a>

fn clone(&self) -> RawCert<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RawCert<'a>

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

Formats the value using the given formatter.

impl<'a> Marshal for RawCert<'a>

fn serialize(&self, o: &mut dyn Write) -> Result<()>

Writes a serialized version of the object to o.

fn export(&self, o: &mut dyn Write) -> Result<()>

Exports a serialized version of the object to o.

impl<'a> Parse<'a, RawCert<'a>> for RawCert<'a>

fn from_buffered_reader<R>(reader: R) -> Result<RawCert<'a>>

where R: BufferedReader<Cookie> + 'a,

Returns the first RawCert encountered in the reader.

Returns an error if there are multiple certificates.

fn from_reader<R: 'a + Read + Send + Sync>(reader: R) -> Result<Self>

Returns the first RawCert encountered in the reader.

Returns an error if there are multiple certificates.

fn from_file<P: AsRef<Path>>(path: P) -> Result<T>

Reads from the given file.

fn from_bytes<D: AsRef<[u8]> + ?Sized + Send + Sync>(data: &'a D) -> Result<T>

Reads from the given slice.

impl<'a> PartialEq for RawCert<'a>

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

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

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.

impl<'a> TryFrom<&RawCert<'a>> for Cert

type Error = Error

The type returned in the event of a conversion error.

fn try_from(c: &RawCert<'_>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<RawCert<'a>> for Cert

type Error = Error

The type returned in the event of a conversion error.

fn try_from(c: RawCert<'_>) -> Result<Self>

Performs the conversion.

impl<'a> Eq for RawCert<'a>