[−][src]Enum sequoia_openpgp::KeyHandle
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 4 fingerprints and Key ID only. Version 3 fingerprints and Key ID were deprecated by RFC 4880 in 2007.
A v4 fingerprint is, essentially, a 20-byte SHA-1 hash over the key's public key packet. A v4 Key ID is defined as the fingerprint's lower 8 bytes.
For the exact definition, see Section 12.2 of RFC 4880.
Both fingerprint and Key ID are used to identify a key, e.g., the issuer of a signature.
Examples
use openpgp::KeyHandle; 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); assert_eq!(&issuers[0], &KeyHandle::Fingerprint( "C03F A641 1B03 AE12 5764 6118 7223 B566 78E0 2528" .parse()?)); assert_eq!(&issuers[1], &KeyHandle::KeyID("7223 B566 78E0 2528".parse()?)); } else { unreachable!("It's a signature!"); }
Variants
Fingerprint(Fingerprint)
A Fingerprint.
KeyID(KeyID)
A KeyID.
Implementations
impl KeyHandle
[src]
pub fn as_bytes(&self) -> &[u8]
[src]
Returns the raw identifier as a byte slice.
pub fn aliases<H>(&self, other: H) -> bool where
H: Borrow<KeyHandle>,
[src]
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.
In these cases (and only these cases) KeyHandle
's
PartialOrd
implementation returns None
to correctly
indicate that a comparison is not possible.
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!(! fpr1.eq(&fpr2)); assert!(fpr1.aliases(&keyid)); assert!(fpr2.aliases(&keyid)); assert!(! fpr1.aliases(&fpr2));
pub fn is_invalid(&self) -> bool
[src]
Returns whether the KeyHandle is invalid.
A KeyHandle is invalid if the Fingerprint
or KeyID
that it
contains is valid.
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());
pub fn to_hex(&self) -> String
[src]
Converts this fingerprint 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());
Trait Implementations
impl Clone for KeyHandle
[src]
impl Debug for KeyHandle
[src]
impl Display for KeyHandle
[src]
impl<'_> From<&'_ Fingerprint> for KeyHandle
[src]
fn from(i: &Fingerprint) -> Self
[src]
impl<'_> From<&'_ KeyHandle> for KeyID
[src]
impl<'_> From<&'_ KeyID> for KeyHandle
[src]
impl From<Fingerprint> for KeyHandle
[src]
fn from(i: Fingerprint) -> Self
[src]
impl From<KeyHandle> for KeyID
[src]
impl From<KeyID> for KeyHandle
[src]
impl FromStr for KeyHandle
[src]
type Err = Error
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Self, Self::Err>
[src]
impl LowerHex for KeyHandle
[src]
impl PartialEq<KeyHandle> for KeyHandle
[src]
impl PartialOrd<KeyHandle> for KeyHandle
[src]
fn partial_cmp(&self, other: &KeyHandle) -> Option<Ordering>
[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'_> TryFrom<&'_ KeyHandle> for Fingerprint
[src]
type Error = Error
The type returned in the event of a conversion error.
fn try_from(i: &KeyHandle) -> Result<Self>
[src]
impl TryFrom<KeyHandle> for Fingerprint
[src]
type Error = Error
The type returned in the event of a conversion error.
fn try_from(i: KeyHandle) -> Result<Self>
[src]
impl UpperHex for KeyHandle
[src]
Auto Trait Implementations
impl RefUnwindSafe for KeyHandle
impl Send for KeyHandle
impl Sync for KeyHandle
impl Unpin for KeyHandle
impl UnwindSafe for KeyHandle
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,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DynClone for T where
T: Clone,
[src]
T: Clone,
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.
fn to_owned(&self) -> T
[src]
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.
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>,