Enum ssh_key::Fingerprint

#[non_exhaustive]
pub enum Fingerprint {
    Sha256([u8; 32]),
    Sha512([u8; 64]),
}

SSH public key fingerprints.

Fingerprints have an associated key fingerprint algorithm, i.e. a hash function which is used to compute the fingerprint.

Parsing/serializing fingerprint strings

The FromStr and Display impls on Fingerprint can be used to parse and serialize fingerprints from the string format.

Example

SHA256:Nh0Me49Zh9fDw/VYUfq43IJmI1T+XrjiYONPND8GzaM

serde support

When the serde feature of this crate is enabled, this type receives impls of Deserialize and Serialize.

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.

Sha256([u8; 32])

Fingerprints computed using SHA-256.

Sha512([u8; 64])

Fingerprints computed using SHA-512.

Implementations

impl Fingerprint

pub fn new(algorithm: HashAlg, public_key: &KeyData) -> Self

Create a fingerprint of the given public key data using the provided hash algorithm.

pub fn algorithm(self) -> HashAlg

Get the hash algorithm used for this fingerprint.

pub fn prefix(self) -> &'static str

Get the name of the hash algorithm (upper case e.g. “SHA256”).

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

Get the raw digest output for the fingerprint as bytes.

pub fn sha256(self) -> Option<[u8; 32]>

Get the SHA-256 fingerprint, if this is one.

pub fn sha512(self) -> Option<[u8; 64]>

Get the SHA-512 fingerprint, if this is one.

pub fn is_sha256(self) -> bool

Is this fingerprint SHA-256?

pub fn is_sha512(self) -> bool

Is this fingerprint SHA-512?

pub fn fmt_randomart(self, header: &str, f: &mut Formatter<'_>) -> Result

Format “randomart” for this fingerprint using the provided formatter.

pub fn to_randomart(self, header: &str) -> String

Available on crate feature alloc only.

Render “randomart” hash visualization for this fingerprint as a string.

+--[ED25519 256]--+
|o+oO==+ o..      |
|.o++Eo+o..       |
|. +.oO.o . .     |
| . o..B.. . .    |
|  ...+ .S. o     |
|  .o. . . . .    |
|  o..    o       |
|   B      .      |
|  .o*            |
+----[SHA256]-----+

Trait Implementations

impl AsRef<[u8]> for Fingerprint

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

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<'de> Deserialize<'de> for Fingerprint

Available on crate features alloc and serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Fingerprint

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

Formats the value using the given formatter.

impl FromStr for Fingerprint

type Err = Error

The associated error which can be returned from parsing.

fn from_str(id: &str) -> Result<Self>

Parses a string s to return a value of this type.

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

Available on crate features alloc and serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Fingerprint

impl Eq for Fingerprint

impl StructuralPartialEq for Fingerprint