Struct sequoia_openpgp::packet::signature::subpacket::Subpacket

source ·
pub struct Subpacket { /* private fields */ }
Expand description

Signature subpackets.

Most of a signature’s attributes are not stored in fixed fields, but in so-called subpackets. These subpackets are stored in a Signature’s so-called subpacket areas, which are effectively small key-value stores. The keys are subpacket tags (SubpacketTag). The values are well-structured (SubpacketValue).

In addition to their key and value, subpackets also include a critical flag. When set, this flag indicates to the OpenPGP implementation that if it doesn’t understand the subpacket, it must consider the signature to be invalid. (Likewise, if it isn’t set, then it means that it is safe for the implementation to ignore the subpacket.) This enables forward compatibility with security-relevant extensions.

It is possible to control how Sequoia’s higher-level functionality handles unknown, critical subpackets using a Policy object. Depending on the degree of control required, it may be sufficient to customize a StandardPolicy object using, for instance, the StandardPolicy::accept_critical_subpacket method.

The subpacket system is extensible in two ways. First, although limited, the subpacket name space is not exhausted. So, it is possible to introduce new packets. Second, one of the subpackets, the Notation Data subpacket (NotationData), is explicitly designed for adding arbitrary data to signatures.

Subpackets are described in Section 5.2.3.1 of RFC 4880.

Implementations§

source§

impl Subpacket

source

pub fn new(value: SubpacketValue, critical: bool) -> Result<Subpacket>

Creates a new Subpacket.

source

pub fn critical(&self) -> bool

Returns whether the critical bit is set.

source

pub fn tag(&self) -> SubpacketTag

Returns the Subpacket’s tag.

source

pub fn value(&self) -> &SubpacketValue

Returns the Subpacket’s value.

source

pub fn authenticated(&self) -> bool

Returns whether the information in this subpacket has been authenticated.

There are three ways a subpacket can be authenticated:

  • It is in the hashed subpacket area and the signature has been verified.
  • It is in the unhashed subpacket area and the information is self-authenticating and has been authenticated by Sequoia. This is can be done for issuer information and embedded Signatures.
  • The subpacket has been authenticated by the user and marked as such using Subpacket::set_authenticated.

Note: The authentication is only valid in the context of the signature the subpacket is in. If the an authenticated Subpacket is is added to a SubpacketArea, the flag is cleared.

source

pub fn set_authenticated(&self, authenticated: bool) -> bool

Marks the information in this subpacket as authenticated or not.

See Subpacket::authenticated for more information.

Trait Implementations§

source§

impl Clone for Subpacket

source§

fn clone(&self) -> Self

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 Subpacket

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for Subpacket

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Marshal for Subpacket

source§

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

Writes a serialized version of the object to o.
source§

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

Exports a serialized version of the object to o. Read more
source§

impl MarshalInto for Subpacket

source§

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation. Read more
source§

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

Serializes into the given buffer. Read more
source§

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

Serializes the packet to a vector.
source§

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

Exports into the given buffer. Read more
source§

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

Exports to a vector. Read more
source§

impl Ord for Subpacket

source§

fn cmp(&self, other: &Subpacket) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Subpacket

source§

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

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

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.
source§

impl PartialOrd for Subpacket

source§

fn partial_cmp(&self, other: &Subpacket) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Eq for Subpacket

Auto Trait Implementations§

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

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

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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 for T

§

type Output = T

Should always be Self
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)

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T