Enum sequoia_openpgp::KeyID

source ·
#[non_exhaustive]
pub enum KeyID { V4([u8; 8]), Invalid(Box<[u8]>), }
Expand description

A short identifier for certificates and keys.

A KeyID identifies a public key. It is used, for example, to reference the issuing key of a signature in its Issuer subpacket.

Currently, Sequoia supports version 4 fingerprints and Key IDs only. Version 3 fingerprints and Key IDs were deprecated by RFC 4880 in 2007.

A v4 KeyID is defined as a fragment (the lower 8 bytes) of the key’s fingerprint, which in turn is essentially a SHA-1 hash of the public key packet. As a general rule of thumb, you should prefer the fingerprint as it is possible to create keys with a colliding KeyID using a birthday attack.

For more details about how a KeyID is generated, see Section 12.2 of RFC 4880.

In previous versions of OpenPGP, the Key ID used to be called “long Key ID”, as there even was a “short Key ID”. At only 4 bytes length, short Key IDs vulnerable to preimage attacks. That is, an attacker can create a key with any given short Key ID in short amount of time.

See also Fingerprint and KeyHandle.

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

§Examples

use openpgp::KeyID;

let id: KeyID = "0123 4567 89AB CDEF".parse()?;

assert_eq!("0123456789ABCDEF", id.to_hex());

Variants (Non-exhaustive)§

This enum is marked as 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.
§

V4([u8; 8])

Lower 8 byte SHA-1 hash.

§

Invalid(Box<[u8]>)

Used for holding invalid keyids encountered during parsing e.g. wrong number of bytes.

Implementations§

source§

impl KeyID

source

pub fn new(data: u64) -> KeyID

Converts a u64 to a KeyID.

§Examples
use openpgp::KeyID;

let keyid = KeyID::new(0x0123456789ABCDEF);
source

pub fn as_u64(&self) -> Result<u64>

Converts the KeyID to a u64 if possible.

§Examples
use openpgp::KeyID;

let keyid = KeyID::new(0x0123456789ABCDEF);

assert_eq!(keyid.as_u64()?, 0x0123456789ABCDEF);
source

pub fn from_bytes(raw: &[u8]) -> KeyID

Creates a KeyID from a big endian byte slice.

§Examples
use openpgp::KeyID;

let keyid: KeyID = "0123 4567 89AB CDEF".parse()?;

let bytes = [0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF];
assert_eq!(KeyID::from_bytes(&bytes), keyid);
source

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

Returns a reference to the raw KeyID as a byte slice in big endian representation.

§Examples
use openpgp::KeyID;

let keyid: KeyID = "0123 4567 89AB CDEF".parse()?;

assert_eq!(keyid.as_bytes(), [0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF]);
source

pub fn wildcard() -> Self

Creates a wildcard KeyID.

Refer to Section 5.1 of RFC 4880 for details.

§Examples
use openpgp::KeyID;

assert_eq!(KeyID::wildcard(), KeyID::new(0x0000000000000000));
source

pub fn is_wildcard(&self) -> bool

Returns true if this is the wildcard KeyID.

Refer to Section 5.1 of RFC 4880 for details.

§Examples
use openpgp::KeyID;

assert!(KeyID::new(0x0000000000000000).is_wildcard());
source

pub fn to_hex(&self) -> String

Converts this KeyID to its canonical hexadecimal representation.

This representation is always uppercase and without spaces and is suitable for stable key identifiers.

The output of this function is exactly the same as formatting this object with the :X format specifier.

use openpgp::KeyID;

let keyid: KeyID = "fb3751f1587daef1".parse()?;

assert_eq!("FB3751F1587DAEF1", keyid.to_hex());
assert_eq!(format!("{:X}", keyid), keyid.to_hex());
source

pub fn to_spaced_hex(&self) -> String

Converts this KeyID to its hexadecimal representation with spaces.

This representation is always uppercase and with spaces grouping the hexadecimal digits into groups of four. It is suitable for manual comparison of Key IDs.

Note: The spaces will hinder other kind of use cases. For example, it is harder to select the whole Key ID for copying, and it has to be quoted when used as a command line argument. Only use this form for displaying a Key ID with the intent of manual comparisons.

let keyid: openpgp::KeyID = "fb3751f1587daef1".parse()?;

assert_eq!("FB37 51F1 587D AEF1", keyid.to_spaced_hex());
source

pub fn from_hex(s: &str) -> Result<Self, Error>

Parses the hexadecimal representation of an OpenPGP KeyID.

This function is the reverse of to_hex. It also accepts other variants of the keyID notation including lower-case letters, spaces and optional leading 0x.

use openpgp::KeyID;

let keyid = KeyID::from_hex("0xfb3751f1587daef1")?;

assert_eq!("FB3751F1587DAEF1", keyid.to_hex());
source

pub fn aliases<H>(&self, other: H) -> bool
where H: Borrow<KeyHandle>,

Returns whether self and other could be aliases of each other.

KeyHandle’s PartialEq implementation cannot assert that a Fingerprint and a KeyID are equal, because distinct fingerprints may have the same KeyID, and PartialEq must be transitive, i.e.,

a == b and b == c implies a == c.

That is, if fpr1 and fpr2 are distinct fingerprints with the same key ID then:

fpr1 == keyid and fpr2 == keyid, but fpr1 != fpr2.

This definition of equality makes searching for a given KeyHandle using PartialEq awkward. This function fills that gap. It answers the question: given a KeyHandle and a KeyID, could they be aliases? That is, it implements the desired, non-transitive equality relation:

// fpr1 and fpr2 are different fingerprints with the same KeyID.
assert_ne!(fpr1, fpr2);
assert_eq!(KeyID::from(&fpr1), KeyID::from(&fpr2));
assert!(keyid.aliases(KeyHandle::from(&fpr1)));
assert!(keyid.aliases(KeyHandle::from(&fpr2)));

Trait Implementations§

source§

impl Clone for KeyID

source§

fn clone(&self) -> KeyID

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 KeyID

source§

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

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

impl Display for KeyID

source§

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

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

impl From<&Fingerprint> for KeyID

source§

fn from(fp: &Fingerprint) -> Self

Converts to this type from the input type.
source§

impl From<&KeyHandle> for KeyID

source§

fn from(i: &KeyHandle) -> Self

Converts to this type from the input type.
source§

impl From<&KeyID> for KeyHandle

source§

fn from(i: &KeyID) -> Self

Converts to this type from the input type.
source§

impl From<[u8; 8]> for KeyID

source§

fn from(id: [u8; 8]) -> Self

Converts to this type from the input type.
source§

impl From<Fingerprint> for KeyID

source§

fn from(fp: Fingerprint) -> Self

Converts to this type from the input type.
source§

impl From<KeyHandle> for KeyID

source§

fn from(i: KeyHandle) -> Self

Converts to this type from the input type.
source§

impl From<KeyID> for KeyHandle

source§

fn from(i: KeyID) -> Self

Converts to this type from the input type.
source§

impl From<KeyID> for Vec<u8>

source§

fn from(id: KeyID) -> Self

Converts to this type from the input type.
source§

impl From<u64> for KeyID

source§

fn from(id: u64) -> Self

Converts to this type from the input type.
source§

impl FromStr for KeyID

§

type Err = Error

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
source§

impl Hash for KeyID

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 LowerHex for KeyID

source§

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

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

impl Marshal for KeyID

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 KeyID

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 KeyID

source§

fn cmp(&self, other: &KeyID) -> 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 KeyID

source§

fn eq(&self, other: &KeyID) -> 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 KeyID

source§

fn partial_cmp(&self, other: &KeyID) -> 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 Serialize for KeyID

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

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 UpperHex for KeyID

source§

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

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

impl Eq for KeyID

source§

impl StructuralPartialEq for KeyID

Auto Trait Implementations§

§

impl Freeze for KeyID

§

impl RefUnwindSafe for KeyID

§

impl Send for KeyID

§

impl Sync for KeyID

§

impl Unpin for KeyID

§

impl UnwindSafe for KeyID

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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. 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