Enum sequoia_openpgp::Fingerprint

#[non_exhaustive]
pub enum Fingerprint {
    V4([u8; 20]),
    V5([u8; 32]),
    Invalid(Box<[u8]>),
}

A long identifier for certificates and keys.

A Fingerprint uniquely identifies a public key.

Currently, Sequoia supports version 4 fingerprints and Key IDs only. Version 3 fingerprints and Key IDs were deprecated by RFC 4880 in 2007.

Essentially, a v4 fingerprint is a SHA-1 hash over the key’s public key packet. For details, see Section 12.2 of RFC 4880.

Fingerprints are used, for example, to reference the issuing key of a signature in its IssuerFingerprint subpacket. As a general rule of thumb, you should prefer using fingerprints over KeyIDs because the latter are vulnerable to birthday attacks.

See also KeyID and KeyHandle.

Note: This enum cannot be exhaustively matched to allow future extensions.

Examples

use openpgp::Fingerprint;

let fp: Fingerprint =
    "0123 4567 89AB CDEF 0123 4567 89AB CDEF 0123 4567".parse()?;

assert_eq!("0123456789ABCDEF0123456789ABCDEF01234567", fp.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; 20])

A 20 byte SHA-1 hash of the public key packet as defined in the RFC.

V5([u8; 32])

A v5 OpenPGP fingerprint.

Invalid(Box<[u8]>)

Used for holding fingerprint data that is not a V4 fingerprint, e.g. a V3 fingerprint (deprecated) or otherwise wrong-length data.

Implementations

impl Fingerprint

pub fn from_bytes(raw: &[u8]) -> Fingerprint

Creates a Fingerprint from a byte slice in big endian representation.

Examples

use openpgp::Fingerprint;

let fp: Fingerprint =
    "0123 4567 89AB CDEF 0123 4567 89AB CDEF 0123 4567".parse()?;
let bytes =
    [0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, 0x01, 0x23,
     0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, 0x01, 0x23, 0x45, 0x67];

assert_eq!(Fingerprint::from_bytes(&bytes), fp);

pub fn as_bytes(&self) -> &[u8]

Returns the raw fingerprint as a byte slice in big endian representation.

Examples

use openpgp::Fingerprint;

let fp: Fingerprint =
    "0123 4567 89AB CDEF 0123 4567 89AB CDEF 0123 4567".parse()?;

assert_eq!(fp.as_bytes(),
           [0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, 0x01, 0x23,
            0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, 0x01, 0x23, 0x45, 0x67]);

pub fn to_hex(&self) -> String

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::Fingerprint;

let fp: Fingerprint =
    "0123 4567 89AB CDEF 0123 4567 89AB CDEF 0123 4567".parse()?;

assert_eq!("0123456789ABCDEF0123456789ABCDEF01234567", fp.to_hex());
assert_eq!(format!("{:X}", fp), fp.to_hex());

pub fn to_spaced_hex(&self) -> String

Converts this fingerprint to its hexadecimal representation with spaces.

This representation is always uppercase and with spaces grouping the hexadecimal digits into groups of four with a double space in the middle. It is only suitable for manual comparison of fingerprints.

Note: The spaces will hinder other kind of use cases. For example, it is harder to select the whole fingerprint for copying, and it has to be quoted when used as a command line argument. Only use this form for displaying a fingerprint with the intent of manual comparisons.

See also Fingerprint::to_icao.

let fp: openpgp::Fingerprint =
    "0123 4567 89AB CDEF 0123 4567 89AB CDEF 0123 4567".parse()?;

assert_eq!("0123 4567 89AB CDEF 0123  4567 89AB CDEF 0123 4567",
           fp.to_spaced_hex());

pub fn from_hex(s: &str) -> Result<Self, Error>

Parses the hexadecimal representation of an OpenPGP fingerprint.

This function is the reverse of to_hex. It also accepts other variants of the fingerprint notation including lower-case letters, spaces and optional leading 0x.

use openpgp::Fingerprint;

let fp =
    Fingerprint::from_hex("0123456789ABCDEF0123456789ABCDEF01234567")?;

assert_eq!("0123456789ABCDEF0123456789ABCDEF01234567", fp.to_hex());

let fp =
    Fingerprint::from_hex("0123 4567 89ab cdef 0123 4567 89ab cdef 0123 4567")?;

assert_eq!("0123456789ABCDEF0123456789ABCDEF01234567", fp.to_hex());

pub fn to_icao(&self) -> String

Converts the hex representation of the Fingerprint to a phrase in the ICAO spelling alphabet.

Examples

use openpgp::Fingerprint;

let fp: Fingerprint =
    "01AB 4567 89AB CDEF 0123 4567 89AB CDEF 0123 4567".parse()?;

assert!(fp.to_icao().starts_with("Zero One Alfa Bravo"));

pub fn aliases<H>(&self, other: H) -> bool

where 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.

This definition of equality makes searching for a given KeyHandle using PartialEq awkward. This function fills that gap. It answers the question: given a KeyHandle and a Fingerprint, 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!(fpr1.aliases(KeyHandle::from(&keyid)));
assert!(fpr2.aliases(KeyHandle::from(&keyid)));
assert!(! fpr1.aliases(KeyHandle::from(&fpr2)));

Trait Implementations

impl Clone for Fingerprint

fn clone(&self) -> Fingerprint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fingerprint

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

Formats the value using the given formatter.

impl Display for Fingerprint

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

Formats the value using the given formatter.

impl From<&Fingerprint> for KeyHandle

fn from(i: &Fingerprint) -> Self

Converts to this type from the input type.

impl From<&Fingerprint> for KeyID

fn from(fp: &Fingerprint) -> Self

Converts to this type from the input type.

impl From<Fingerprint> for KeyHandle

fn from(i: Fingerprint) -> Self

Converts to this type from the input type.

impl From<Fingerprint> for KeyID

fn from(fp: Fingerprint) -> Self

Converts to this type from the input type.

impl FromStr for Fingerprint

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 Fingerprint

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for Fingerprint

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

Formats the value using the given formatter.

impl Marshal for Fingerprint

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 Fingerprint

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 Fingerprint

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Fingerprint

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Fingerprint

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

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

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

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

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

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

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

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

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

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

impl Serialize for Fingerprint

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 Fingerprint

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 TryFrom<&KeyHandle> for Fingerprint

type Error = Error

The type returned in the event of a conversion error.

fn try_from(i: &KeyHandle) -> Result<Self>

Performs the conversion.

impl TryFrom<KeyHandle> for Fingerprint

type Error = Error

The type returned in the event of a conversion error.

fn try_from(i: KeyHandle) -> Result<Self>

Performs the conversion.

impl UpperHex for Fingerprint

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

Formats the value using the given formatter.

impl Eq for Fingerprint

impl StructuralPartialEq for Fingerprint