Enum sequoia_openpgp::KeyID

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

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)

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

impl KeyID

pub fn new(data: u64) -> KeyID

Converts a u64 to a KeyID.

Examples

use openpgp::KeyID;

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

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);

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);

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]);

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));

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());

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());

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());

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());

Trait Implementations

impl Clone for KeyID

fn clone(&self) -> KeyID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyID

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

Formats the value using the given formatter.

impl Display for KeyID

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

Formats the value using the given formatter.

impl Eq for KeyID

impl<'_> From<&'_ Fingerprint> for KeyID

fn from(fp: &Fingerprint) -> Self

Performs the conversion.

impl<'_> From<&'_ KeyHandle> for KeyID

fn from(i: &KeyHandle) -> Self

Performs the conversion.

impl<'_> From<&'_ KeyID> for KeyHandle

fn from(i: &KeyID) -> Self

Performs the conversion.

impl From<[u8; 8]> for KeyID

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

Performs the conversion.

impl From<Fingerprint> for KeyID

fn from(fp: Fingerprint) -> Self

Performs the conversion.

impl From<KeyHandle> for KeyID

fn from(i: KeyHandle) -> Self

Performs the conversion.

impl From<KeyID> for Vec<u8>

fn from(id: KeyID) -> Self

Performs the conversion.

impl From<KeyID> for KeyHandle

fn from(i: KeyID) -> Self

Performs the conversion.

impl From<u64> for KeyID

fn from(id: u64) -> Self

Performs the conversion.

impl FromStr for KeyID

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Hash for KeyID

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

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

Formats the value using the given formatter.

impl Marshal for KeyID

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

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

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<KeyID> for KeyID

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

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

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

This method tests for !=.

impl PartialOrd<KeyID> for KeyID

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for KeyID

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 KeyID

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

impl StructuralPartialEq for KeyID

impl UpperHex for KeyID

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

Formats the value using the given formatter.