pub enum KeyHandle {
Fingerprint(Fingerprint),
KeyID(KeyID),
}Expand description
Enum representing an identifier for certificates and keys.
A KeyHandle contains either a Fingerprint or a KeyID.
This is needed because signatures can reference their issuer
either by Fingerprint or by KeyID.
Currently, Sequoia supports version 6 fingerprints and Key IDs, and version 4 fingerprints and Key IDs. Version 3 fingerprints and Key IDs were deprecated by RFC 4880 in 2007.
Essentially, a fingerprint is a hash over the key’s public key
packet. Version 6 and version 4 KeyIDs are a truncated
version of the key’s fingerprint. For details, see Section 5.5.4
of RFC 9580.
Both fingerprint and Key ID are used to identify a key, e.g., the issuer of a signature.
§A Note on Equality
Like other data types, two KeyHandles are considered equal if
their serialized forms are the same. That is, if you compare a
key handle that contains a Fingerprint, and a key handle that
contains a KeyID, they will not be considered equal even if
the key ID aliases the fingerprint. If you want to check for
aliasing, you should use KeyHandle::aliases.
§Examples
use openpgp::KeyHandle;
use openpgp::KeyID;
use openpgp::Packet;
use openpgp::parse::Parse;
let p = Packet::from_bytes(
"-----BEGIN PGP SIGNATURE-----
// ...
-----END PGP SIGNATURE-----")?;
if let Packet::Signature(sig) = p {
let issuers = sig.get_issuers();
assert_eq!(issuers.len(), 2);
let kh: KeyHandle
= "C03F A641 1B03 AE12 5764 6118 7223 B566 78E0 2528".parse()?;
assert!(&issuers[0].aliases(&kh));
assert!(&issuers[1].aliases(&kh));
} else {
unreachable!("It's a signature!");
}Variants§
Implementations§
Source§impl KeyHandle
impl KeyHandle
Sourcepub fn aliases<H>(&self, other: H) -> bool
pub fn aliases<H>(&self, other: H) -> bool
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 two KeyHandles,
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));
// fpr1 and fpr2 are different v4 fingerprints with the same KeyID.
assert!(! fpr1.eq(&fpr2));
assert!(fpr1.aliases(&keyid));
assert!(fpr2.aliases(&keyid));
assert!(! fpr1.aliases(&fpr2));
// v6_fpr1 and v6_fpr2 are different v6 fingerprints with the same KeyID.
assert!(! v6_fpr1.eq(&v6_fpr2));
assert!(v6_fpr1.aliases(&keyid));
assert!(v6_fpr2.aliases(&keyid));
assert!(! v6_fpr1.aliases(&v6_fpr2));
// And of course, v4 and v6 don't alias.
assert!(! fpr1.aliases(&v6_fpr1));Sourcepub fn is_invalid(&self) -> bool
pub fn is_invalid(&self) -> bool
Returns whether the KeyHandle is invalid.
A KeyHandle is invalid if the Fingerprint or KeyID that it
contains is invalid.
use sequoia_openpgp as openpgp;
use openpgp::Fingerprint;
use openpgp::KeyID;
use openpgp::KeyHandle;
// A perfectly valid fingerprint:
let kh : KeyHandle = "8F17 7771 18A3 3DDA 9BA4 8E62 AACB 3243 6300 52D9"
.parse()?;
assert!(! kh.is_invalid());
// But, V3 fingerprints are invalid.
let kh : KeyHandle = "9E 94 45 13 39 83 5F 70 7B E7 D8 ED C4 BE 5A A6"
.parse()?;
assert!(kh.is_invalid());
// A perfectly valid Key ID:
let kh : KeyHandle = "AACB 3243 6300 52D9"
.parse()?;
assert!(! kh.is_invalid());
// But, short Key IDs are invalid:
let kh : KeyHandle = "6300 52D9"
.parse()?;
assert!(kh.is_invalid());Sourcepub fn is_fingerprint(&self) -> bool
pub fn is_fingerprint(&self) -> bool
Returns whether the KeyHandle contains a fingerprint.
§Examples
let fpr: KeyHandle = "8F17 7771 18A3 3DDA 9BA4 8E62 AACB 3243 6300 52D9"
.parse()?;
let keyid: KeyHandle = KeyHandle::from(KeyID::from(&fpr));
assert!(fpr.is_fingerprint());
assert!(! keyid.is_fingerprint());Sourcepub fn is_keyid(&self) -> bool
pub fn is_keyid(&self) -> bool
Returns whether the KeyHandle contains a key ID.
§Examples
let fpr: KeyHandle = "8F17 7771 18A3 3DDA 9BA4 8E62 AACB 3243 6300 52D9"
.parse()?;
let keyid: KeyHandle = KeyHandle::from(KeyID::from(&fpr));
assert!(! fpr.is_keyid());
assert!(keyid.is_keyid());Sourcepub fn to_hex(&self) -> String
pub fn to_hex(&self) -> String
Converts this KeyHandle 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::KeyHandle;
let h: KeyHandle =
"0123 4567 89AB CDEF 0123 4567 89AB CDEF 0123 4567".parse()?;
assert_eq!("0123456789ABCDEF0123456789ABCDEF01234567", h.to_hex());
assert_eq!(format!("{:X}", h), h.to_hex());Sourcepub fn to_spaced_hex(&self) -> String
pub fn to_spaced_hex(&self) -> String
Converts this KeyHandle to its hexadecimal representation
with spaces.
This representation is always uppercase and with spaces grouping the hexadecimal digits into groups of four. It is only suitable for manual comparison of key handles.
Note: The spaces will hinder other kind of use cases. For example, it is harder to select the whole key handle for copying, and it has to be quoted when used as a command line argument. Only use this form for displaying a key handle with the intent of manual comparisons.
use openpgp::KeyHandle;
let h: KeyHandle =
"0123 4567 89AB CDEF 0123 4567 89AB CDEF 0123 4567".parse()?;
assert_eq!("0123 4567 89AB CDEF 0123 4567 89AB CDEF 0123 4567",
h.to_spaced_hex());