Enum sequoia_openpgp::KeyID
source · [−]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
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
sourceimpl KeyID
impl KeyID
sourcepub fn as_u64(&self) -> Result<u64>
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);
sourcepub fn from_bytes(raw: &[u8]) -> KeyID
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);
sourcepub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]
pub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [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]);
sourcepub fn wildcard() -> Self
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));
sourcepub fn is_wildcard(&self) -> bool
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());
sourcepub fn to_hex(&self) -> String
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());
sourcepub fn to_spaced_hex(&self) -> String
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());
sourcepub fn from_hex(s: &str) -> Result<Self, Error>
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
sourceimpl From<&Fingerprint> for KeyID
impl From<&Fingerprint> for KeyID
sourcefn from(fp: &Fingerprint) -> Self
fn from(fp: &Fingerprint) -> Self
Converts to this type from the input type.
sourceimpl From<Fingerprint> for KeyID
impl From<Fingerprint> for KeyID
sourcefn from(fp: Fingerprint) -> Self
fn from(fp: Fingerprint) -> Self
Converts to this type from the input type.
sourceimpl MarshalInto for KeyID
impl MarshalInto for KeyID
sourcefn serialized_len(&self) -> usize
fn serialized_len(&self) -> usize
Computes the maximal length of the serialized representation. Read more
sourcefn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
Serializes into the given buffer. Read more
sourceimpl Ord for KeyID
impl Ord for KeyID
sourceimpl PartialOrd<KeyID> for KeyID
impl PartialOrd<KeyID> for KeyID
sourcefn partial_cmp(&self, other: &KeyID) -> Option<Ordering>
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 · sourcefn lt(&self, other: &Rhs) -> bool
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 · sourcefn le(&self, other: &Rhs) -> bool
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
sourceimpl SerializeInto for KeyID
impl SerializeInto for KeyID
sourcefn serialized_len(&self) -> usize
fn serialized_len(&self) -> usize
Computes the maximal length of the serialized representation. Read more
sourcefn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>
Serializes into the given buffer. Read more
impl Eq for KeyID
impl StructuralEq for KeyID
impl StructuralPartialEq for KeyID
Auto Trait Implementations
impl RefUnwindSafe for KeyID
impl Send for KeyID
impl Sync for KeyID
impl Unpin for KeyID
impl UnwindSafe for KeyID
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more