Enum sequoia_openpgp::Packet

#[non_exhaustive]
pub enum Packet {
    Unknown(Unknown),
    Signature(Signature),
    OnePassSig(OnePassSig),
    PublicKey(Key<PublicParts, PrimaryRole>),
    PublicSubkey(Key<PublicParts, SubordinateRole>),
    SecretKey(Key<SecretParts, PrimaryRole>),
    SecretSubkey(Key<SecretParts, SubordinateRole>),
    Marker(Marker),
    Trust(Trust),
    UserID(UserID),
    UserAttribute(UserAttribute),
    Literal(Literal),
    CompressedData(CompressedData),
    PKESK(PKESK),
    SKESK(SKESK),
    SEIP(SEIP),
    MDC(MDC),
    AED(AED),
}

Enumeration of packet types.

The different OpenPGP packets are detailed in Section 5 of RFC 4880.

The Unknown packet allows Sequoia to deal with packets that it doesn’t understand. It is basically a binary blob that includes the packet’s tag. See the module-level documentation for details.

Note: This enum cannot be exhaustively matched to allow future extensions.

A note on equality

We define equality on Packet as the equality of the serialized form of their packet bodies as defined by RFC 4880. That is, two packets are considered equal if and only if their serialized forms are equal, modulo the OpenPGP framing (CTB and length style, potential partial body encoding).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unknown(Unknown)

Unknown packet.

Signature(Signature)

Signature packet.

OnePassSig(OnePassSig)

One pass signature packet.

PublicKey(Key<PublicParts, PrimaryRole>)

Public key packet.

PublicSubkey(Key<PublicParts, SubordinateRole>)

Public subkey packet.

SecretKey(Key<SecretParts, PrimaryRole>)

Public/Secret key pair.

SecretSubkey(Key<SecretParts, SubordinateRole>)

Public/Secret subkey pair.

Marker(Marker)

Marker packet.

Trust(Trust)

Trust packet.

UserID(UserID)

User ID packet.

UserAttribute(UserAttribute)

User attribute packet.

Literal(Literal)

Literal data packet.

CompressedData(CompressedData)

Compressed literal data packet.

PKESK(PKESK)

Public key encrypted data packet.

SKESK(SKESK)

Symmetric key encrypted data packet.

SEIP(SEIP)

Symmetric key encrypted, integrity protected data packet.

MDC(MDC)

👎 Deprecated

Modification detection code packet.

AED(AED)

AEAD Encrypted Data Packet.

Implementations

impl Packet

pub fn tag(&self) -> Tag

Returns the Packet's corresponding OpenPGP tag.

Tags are explained in Section 4.3 of RFC 4880.

pub fn kind(&self) -> Option<Tag>

Returns the parsed Packet's corresponding OpenPGP tag.

Returns the packets tag, but only if it was successfully parsed into the corresponding packet type. If e.g. a Signature Packet uses some unsupported methods, it is parsed into an Packet::Unknown. tag() returns Tag::Signature, whereas kind() returns None.

pub fn version(&self) -> Option<u8>

Returns the Packet's version, if the packet is versioned and recognized.

If the packet is not versioned, or we couldn’t parse the packet, this function returns None.

pub fn normalized_hash<H>(&self, state: &mut H) where
    H: Hasher, 

Hashes most everything into state.

This is an alternate implementation of Hash, which does not hash:

• The unhashed subpacket area of Signature packets.
• Secret key material.

Unlike Signature::normalize, this method ignores authenticated packets in the unhashed subpacket area.

Trait Implementations

impl Any<AED> for Packet

fn downcast(self) -> Result<AED, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&AED>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut AED>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<CompressedData> for Packet

fn downcast(self) -> Result<CompressedData, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&CompressedData>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut CompressedData>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<Key<PublicParts, PrimaryRole>> for Packet

fn downcast(self) -> Result<Key<PublicParts, PrimaryRole>, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&Key<PublicParts, PrimaryRole>>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut Key<PublicParts, PrimaryRole>>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<Key<PublicParts, SubordinateRole>> for Packet

fn downcast(self) -> Result<Key<PublicParts, SubordinateRole>, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&Key<PublicParts, SubordinateRole>>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut Key<PublicParts, SubordinateRole>>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<Key<SecretParts, PrimaryRole>> for Packet

fn downcast(self) -> Result<Key<SecretParts, PrimaryRole>, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&Key<SecretParts, PrimaryRole>>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut Key<SecretParts, PrimaryRole>>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<Key<SecretParts, SubordinateRole>> for Packet

fn downcast(self) -> Result<Key<SecretParts, SubordinateRole>, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&Key<SecretParts, SubordinateRole>>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut Key<SecretParts, SubordinateRole>>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<Literal> for Packet

fn downcast(self) -> Result<Literal, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&Literal>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut Literal>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<MDC> for Packet

fn downcast(self) -> Result<MDC, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&MDC>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut MDC>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<Marker> for Packet

fn downcast(self) -> Result<Marker, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&Marker>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut Marker>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<OnePassSig> for Packet

fn downcast(self) -> Result<OnePassSig, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&OnePassSig>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut OnePassSig>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<PKESK> for Packet

fn downcast(self) -> Result<PKESK, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&PKESK>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut PKESK>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<SEIP> for Packet

fn downcast(self) -> Result<SEIP, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&SEIP>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut SEIP>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<SKESK> for Packet

fn downcast(self) -> Result<SKESK, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&SKESK>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut SKESK>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<Signature> for Packet

fn downcast(self) -> Result<Signature, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&Signature>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut Signature>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<Trust> for Packet

fn downcast(self) -> Result<Trust, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&Trust>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut Trust>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<Unknown> for Packet

fn downcast(self) -> Result<Unknown, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&Unknown>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut Unknown>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<UserAttribute> for Packet

fn downcast(self) -> Result<UserAttribute, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&UserAttribute>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut UserAttribute>

Attempts to downcast to &mut T, returning None if it fails.

impl Any<UserID> for Packet

fn downcast(self) -> Result<UserID, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&UserID>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut UserID>

Attempts to downcast to &mut T, returning None if it fails.

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl Deref for Packet

type Target = Common

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Packet

fn deref_mut(&mut self) -> &mut Common

Mutably dereferences the value.

impl From<&Packet> for Tag

fn from(p: &Packet) -> Tag

Converts to this type from the input type.

impl From<AED> for Packet

fn from(p: AED) -> Self

Converts to this type from the input type.

impl From<AED1> for Packet

fn from(p: AED1) -> Self

Converts to this type from the input type.

impl From<CompressedData> for Packet

fn from(s: CompressedData) -> Self

Converts to this type from the input type.

impl From<Key<PublicParts, PrimaryRole>> for Packet

fn from(k: Key<PublicParts, PrimaryRole>) -> Self

Convert the Key struct to a Packet.

impl From<Key<PublicParts, SubordinateRole>> for Packet

fn from(k: Key<PublicParts, SubordinateRole>) -> Self

Convert the Key struct to a Packet.

impl From<Key<SecretParts, PrimaryRole>> for Packet

fn from(k: Key<SecretParts, PrimaryRole>) -> Self

Convert the Key struct to a Packet.

impl From<Key<SecretParts, SubordinateRole>> for Packet

fn from(k: Key<SecretParts, SubordinateRole>) -> Self

Convert the Key struct to a Packet.

impl From<Literal> for Packet

fn from(s: Literal) -> Self

Converts to this type from the input type.

impl From<MDC> for Packet

fn from(s: MDC) -> Self

Converts to this type from the input type.

impl From<Marker> for Packet

fn from(p: Marker) -> Self

Converts to this type from the input type.

impl From<OnePassSig> for Packet

fn from(s: OnePassSig) -> Self

Converts to this type from the input type.

impl From<OnePassSig3> for Packet

fn from(p: OnePassSig3) -> Self

Converts to this type from the input type.

impl From<PKESK> for Packet

fn from(p: PKESK) -> Self

Converts to this type from the input type.

impl From<PKESK3> for Packet

fn from(p: PKESK3) -> Self

Converts to this type from the input type.

impl From<Packet> for Tag

fn from(p: Packet) -> Tag

Converts to this type from the input type.

impl From<Packet> for Result<Packet>

fn from(p: Packet) -> Self

Converts to this type from the input type.

impl From<Packet> for PacketPile

fn from(p: Packet) -> Self

Converts to this type from the input type.

impl From<SEIP> for Packet

fn from(p: SEIP) -> Self

Converts to this type from the input type.

impl From<SEIP1> for Packet

fn from(s: SEIP1) -> Self

Converts to this type from the input type.

impl From<SKESK> for Packet

fn from(p: SKESK) -> Self

Converts to this type from the input type.

impl From<SKESK4> for Packet

fn from(s: SKESK4) -> Self

Converts to this type from the input type.

impl From<SKESK5> for Packet

fn from(s: SKESK5) -> Self

Converts to this type from the input type.

impl From<Signature> for Packet

fn from(s: Signature) -> Self

Converts to this type from the input type.

impl From<Signature3> for Packet

fn from(s: Signature3) -> Self

Converts to this type from the input type.

impl From<Signature4> for Packet

fn from(s: Signature4) -> Self

Converts to this type from the input type.

impl From<Trust> for Packet

fn from(s: Trust) -> Self

Converts to this type from the input type.

impl From<Unknown> for Packet

fn from(s: Unknown) -> Self

Converts to this type from the input type.

impl From<UserAttribute> for Packet

fn from(s: UserAttribute) -> Self

Converts to this type from the input type.

impl From<UserID> for Packet

fn from(s: UserID) -> Self

Converts to this type from the input type.

impl FromIterator<Packet> for PacketPile

fn from_iter<I: IntoIterator<Item = Packet>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for Packet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Packet

Implement IntoIterator so that cert::insert_packets(sig) just works.

type Item = Packet

The type of the elements being iterated over.

type IntoIter = Once<Packet>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Marshal for Packet

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

Writes a serialized version of the specified Packet to o.

This function works recursively: if the packet contains any packets, they are also serialized.

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

Exports a serialized version of the specified Packet to o.

This function works recursively: if the packet contains any packets, they are also serialized.

impl MarshalInto for Packet

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

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

Serializes the packet to a vector.

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

Exports to a vector.

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

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

Reads from the given reader.

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

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

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

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

This method tests for !=.

impl Serialize for Packet

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 SerializeInto for Packet

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

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

Serializes the packet to a vector.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

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

Exports to a vector.

impl TryFrom<Packet> for Unknown

fn try_from(p: Packet) -> Result<Self, Self::Error>

Tries to convert a packet to an Unknown. Returns an error if the given packet is a container packet (i.e. a compressed data packet or an encrypted data packet of any kind).

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Packet> for Cert

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: Packet) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<RawPacket<'a>> for Packet

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: RawPacket<'a>) -> Result<Self>

Performs the conversion.

impl Eq for Packet

impl StructuralEq for Packet

impl StructuralPartialEq for Packet