Enum sequoia_openpgp::Packet
source · [−]#[non_exhaustive]
pub enum Packet {
Show 18 variants
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),
}
Expand description
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)
This enum is marked as non-exhaustive
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)
Modification detection code packet.
AED(AED)
AEAD Encrypted Data Packet.
Implementations
sourceimpl Packet
impl Packet
sourcepub fn tag(&self) -> Tag
pub fn tag(&self) -> Tag
Returns the Packet's
corresponding OpenPGP tag.
Tags are explained in Section 4.3 of RFC 4880.
sourcepub fn kind(&self) -> Option<Tag>
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
.
sourcepub fn normalized_hash<H>(&self, state: &mut H) where
H: Hasher,
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
sourceimpl From<CompressedData> for Packet
impl From<CompressedData> for Packet
sourcefn from(s: CompressedData) -> Self
fn from(s: CompressedData) -> Self
Performs the conversion.
sourceimpl From<Key<PublicParts, PrimaryRole>> for Packet
impl From<Key<PublicParts, PrimaryRole>> for Packet
sourcefn from(k: Key<PublicParts, PrimaryRole>) -> Self
fn from(k: Key<PublicParts, PrimaryRole>) -> Self
Convert the Key
struct to a Packet
.
sourceimpl From<Key<PublicParts, SubordinateRole>> for Packet
impl From<Key<PublicParts, SubordinateRole>> for Packet
sourcefn from(k: Key<PublicParts, SubordinateRole>) -> Self
fn from(k: Key<PublicParts, SubordinateRole>) -> Self
Convert the Key
struct to a Packet
.
sourceimpl From<Key<SecretParts, PrimaryRole>> for Packet
impl From<Key<SecretParts, PrimaryRole>> for Packet
sourcefn from(k: Key<SecretParts, PrimaryRole>) -> Self
fn from(k: Key<SecretParts, PrimaryRole>) -> Self
Convert the Key
struct to a Packet
.
sourceimpl From<Key<SecretParts, SubordinateRole>> for Packet
impl From<Key<SecretParts, SubordinateRole>> for Packet
sourcefn from(k: Key<SecretParts, SubordinateRole>) -> Self
fn from(k: Key<SecretParts, SubordinateRole>) -> Self
Convert the Key
struct to a Packet
.
sourceimpl From<OnePassSig> for Packet
impl From<OnePassSig> for Packet
sourcefn from(s: OnePassSig) -> Self
fn from(s: OnePassSig) -> Self
Performs the conversion.
sourceimpl From<OnePassSig3> for Packet
impl From<OnePassSig3> for Packet
sourcefn from(p: OnePassSig3) -> Self
fn from(p: OnePassSig3) -> Self
Performs the conversion.
sourceimpl From<Signature4> for Packet
impl From<Signature4> for Packet
sourcefn from(s: Signature4) -> Self
fn from(s: Signature4) -> Self
Performs the conversion.
sourceimpl From<UserAttribute> for Packet
impl From<UserAttribute> for Packet
sourcefn from(s: UserAttribute) -> Self
fn from(s: UserAttribute) -> Self
Performs the conversion.
sourceimpl FromIterator<Packet> for PacketPile
impl FromIterator<Packet> for PacketPile
sourcefn from_iter<I: IntoIterator<Item = Packet>>(iter: I) -> Self
fn from_iter<I: IntoIterator<Item = Packet>>(iter: I) -> Self
Creates a value from an iterator. Read more
sourceimpl IntoIterator for Packet
impl IntoIterator for Packet
Implement IntoIterator
so that
cert::insert_packets(sig)
just works.
sourceimpl Marshal for Packet
impl Marshal for Packet
sourceimpl MarshalInto for Packet
impl MarshalInto for Packet
sourcefn serialized_len(&self) -> usize
fn serialized_len(&self) -> usize
Computes the maximal length of the serialized representation. Read more
sourcefn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
Serializes into the given buffer. Read more
sourceimpl<'a> Parse<'a, Packet> for Packet
impl<'a> Parse<'a, Packet> for Packet
sourceimpl SerializeInto for Packet
impl SerializeInto for Packet
sourcefn serialized_len(&self) -> usize
fn serialized_len(&self) -> usize
Computes the maximal length of the serialized representation. Read more
sourcefn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
Serializes into the given buffer. Read more
impl Eq for Packet
impl StructuralEq for Packet
impl StructuralPartialEq for Packet
Auto Trait Implementations
impl !RefUnwindSafe for Packet
impl Send for Packet
impl Sync for Packet
impl Unpin for Packet
impl !UnwindSafe for Packet
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more