[−][src]Enum sequoia_openpgp::Fingerprint

#[non_exhaustive]pub enum Fingerprint {
    V4([u8; 20]),
    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.

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.

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`[src]

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

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]`[src]

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`[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::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`[src]

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.

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

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`[src]

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"));