[−][src]Enum sequoia_openpgp::KeyID
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)
Lower 8 byte SHA-1 hash.
Used for holding invalid keyids encountered during parsing e.g. wrong number of bytes.
Implementations
impl KeyID
[src]
pub fn new(data: u64) -> KeyID
[src]
pub fn as_u64(&self) -> Result<u64>
[src]
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
[src]
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]
[src]
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
[src]
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
[src]
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
[src]
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 from_hex(s: &str) -> Result<Self, Error>
[src]
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
[src]
impl Debug for KeyID
[src]
impl Display for KeyID
[src]
impl Eq for KeyID
[src]
impl<'_> From<&'_ Fingerprint> for KeyID
[src]
pub fn from(fp: &Fingerprint) -> Self
[src]
impl<'_> From<&'_ KeyHandle> for KeyID
[src]
impl<'_> From<&'_ KeyID> for KeyHandle
[src]
impl From<[u8; 8]> for KeyID
[src]
impl From<Fingerprint> for KeyID
[src]
pub fn from(fp: Fingerprint) -> Self
[src]
impl From<KeyHandle> for KeyID
[src]
impl From<KeyID> for Vec<u8>
[src]
impl From<KeyID> for KeyHandle
[src]
impl From<u64> for KeyID
[src]
impl FromStr for KeyID
[src]
type Err = Error
The associated error which can be returned from parsing.
pub fn from_str(s: &str) -> Result<Self, Self::Err>
[src]
impl Hash for KeyID
[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 LowerHex for KeyID
[src]
impl Marshal for KeyID
[src]
pub fn serialize(&self, o: &mut dyn Write) -> Result<()>
[src]
pub fn export(&self, o: &mut dyn Write) -> Result<()>
[src]
impl MarshalInto for KeyID
[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 KeyID
[src]
pub fn cmp(&self, other: &KeyID) -> 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<KeyID> for KeyID
[src]
impl PartialOrd<KeyID> for KeyID
[src]
pub fn partial_cmp(&self, other: &KeyID) -> Option<Ordering>
[src]
pub fn lt(&self, other: &KeyID) -> bool
[src]
pub fn le(&self, other: &KeyID) -> bool
[src]
pub fn gt(&self, other: &KeyID) -> bool
[src]
pub fn ge(&self, other: &KeyID) -> bool
[src]
impl Serialize for KeyID
[src]
pub fn serialize(&self, o: &mut dyn Write) -> Result<()>
[src]
pub fn export(&self, o: &mut dyn Write) -> Result<()>
[src]
impl SerializeInto for KeyID
[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 StructuralEq for KeyID
[src]
impl StructuralPartialEq for KeyID
[src]
impl UpperHex for KeyID
[src]
Auto Trait Implementations
impl RefUnwindSafe for KeyID
[src]
impl Send for KeyID
[src]
impl Sync for KeyID
[src]
impl Unpin for KeyID
[src]
impl UnwindSafe for KeyID
[src]
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> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
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>,