Enum ssh_key::Algorithm

#[non_exhaustive]
pub enum Algorithm {
    Dsa,
    Ecdsa {
        curve: EcdsaCurve,
    },
    Ed25519,
    Rsa {
        hash: Option<HashAlg>,
    },
    SkEcdsaSha2NistP256,
    SkEd25519,
}

SSH key algorithms.

This type provides a registry of supported digital signature algorithms used for SSH keys.

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.

Dsa

Digital Signature Algorithm

Ecdsa

Fields

curve: EcdsaCurve

Elliptic curve with which to instantiate ECDSA.

Elliptic Curve Digital Signature Algorithm

Ed25519

Ed25519

Rsa

Fields

hash: Option<HashAlg>

Hash function to use with RSASSA-PKCS#1v15 signatures as specified using RFC8332 algorithm identifiers.

If hash is set to None, then ssh-rsa is used as the algorithm name.

RSA

SkEcdsaSha2NistP256

FIDO/U2F key with ECDSA/NIST-P256 + SHA-256

SkEd25519

FIDO/U2F key with Ed25519

Implementations

impl Algorithm

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

Decode algorithm from the given string identifier.

Supported algorithms

• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• ssh-dss
• ssh-ed25519
• ssh-rsa
• sk-ecdsa-sha2-nistp256@openssh.com (FIDO/U2F key)
• sk-ssh-ed25519@openssh.com (FIDO/U2F key)

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

Decode algorithm from the given string identifier as used by the OpenSSH certificate format.

OpenSSH certificate algorithms end in *-cert-v01@openssh.com. See PROTOCOL.certkeys for more information.

Supported algorithms

• ssh-rsa-cert-v01@openssh.com
• ssh-dss-cert-v01@openssh.com
• ecdsa-sha2-nistp256-cert-v01@openssh.com
• ecdsa-sha2-nistp384-cert-v01@openssh.com
• ecdsa-sha2-nistp521-cert-v01@openssh.com
• ssh-ed25519-cert-v01@openssh.com
• sk-ecdsa-sha2-nistp256-cert-v01@openssh.com (FIDO/U2F key)
• sk-ssh-ed25519-cert-v01@openssh.com (FIDO/U2F key)

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

Get the string identifier which corresponds to this algorithm.

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

Get the string identifier which corresponds to the OpenSSH certificate format.

OpenSSH certificate algorithms end in *-cert-v01@openssh.com. See PROTOCOL.certkeys for more information.

pub fn is_dsa(self) -> bool

Is the algorithm DSA?

pub fn is_ecdsa(self) -> bool

Is the algorithm ECDSA?

pub fn is_ed25519(self) -> bool

Is the algorithm Ed25519?

pub fn is_rsa(self) -> bool

Is the algorithm RSA?

Trait Implementations

impl AsRef<str> for Algorithm

fn as_ref(&self) -> &str

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

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl Default for Algorithm

fn default() -> Algorithm

Returns the “default value” for a type.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl FromStr for Algorithm

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 Hash for Algorithm

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 Label for Algorithm

type Error = Error

Type returned in the event of an encoding error.

impl Ord for Algorithm

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Algorithm> for Algorithm

fn eq(&self, other: &Algorithm) -> 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<Algorithm> for Algorithm

fn partial_cmp(&self, other: &Algorithm) -> 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 Copy for Algorithm

impl Eq for Algorithm

impl StructuralEq for Algorithm

impl StructuralPartialEq for Algorithm