[−][src]Struct sequoia_openpgp::packet::signature::subpacket::Subpacket
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
impl Subpacket
[src]
pub fn new(value: SubpacketValue, critical: bool) -> Result<Subpacket>
[src]
Creates a new Subpacket.
pub fn critical(&self) -> bool
[src]
Returns whether the critical bit is set.
pub fn tag(&self) -> SubpacketTag
[src]
Returns the Subpacket's tag.
pub fn value(&self) -> &SubpacketValue
[src]
Returns the Subpacket's value.
pub fn authenticated(&self) -> bool
[src]
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 Subpacket
is cloned,
or a Subpacket
is added to a SubpacketArea
, the flag is
cleared.
pub fn set_authenticated(&mut self, authenticated: bool) -> bool
[src]
Marks the information in this subpacket as authenticated or not.
See Subpacket::authenticated
for more information.
Trait Implementations
impl Clone for Subpacket
[src]
impl Debug for Subpacket
[src]
impl Eq for Subpacket
[src]
impl Hash for Subpacket
[src]
pub fn hash<H: Hasher>(&self, state: &mut H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Marshal for Subpacket
[src]
pub fn serialize(&self, o: &mut dyn Write) -> Result<()>
[src]
pub fn export(&self, o: &mut dyn Write) -> Result<()>
[src]
impl MarshalInto for Subpacket
[src]
pub fn serialized_len(&self) -> usize
[src]
pub fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
[src]
pub fn to_vec(&self) -> Result<Vec<u8>>
[src]
pub fn export_into(&self, buf: &mut [u8]) -> Result<usize>
[src]
pub fn export_to_vec(&self) -> Result<Vec<u8>>
[src]
impl Ord for Subpacket
[src]
pub fn cmp(&self, other: &Subpacket) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Subpacket> for Subpacket
[src]
pub fn eq(&self, other: &Subpacket) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<Subpacket> for Subpacket
[src]
pub fn partial_cmp(&self, other: &Subpacket) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
Auto Trait Implementations
impl RefUnwindSafe for Subpacket
impl Send for Subpacket
impl Sync for Subpacket
impl Unpin for Subpacket
impl UnwindSafe for Subpacket
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DynClone for T where
T: Clone,
[src]
T: Clone,
pub fn __clone_box(&self, Private) -> *mut ()
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,