Enum KeyData 

#[non_exhaustive]
pub enum KeyData {
    Dsa(DsaPublicKey),
    Ecdsa(EcdsaPublicKey),
    Ed25519(Ed25519PublicKey),
    Rsa(RsaPublicKey),
    SkEcdsaSha2NistP256(SkEcdsaSha2NistP256),
    SkEd25519(SkEd25519),
    Certificate(Box<Certificate>),
    Other(OpaquePublicKey),
}

Public key data.

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(DsaPublicKey)

Available on crate feature alloc only.

Digital Signature Algorithm (DSA) public key data.

Ecdsa(EcdsaPublicKey)

Available on crate feature ecdsa only.

Elliptic Curve Digital Signature Algorithm (ECDSA) public key data.

Ed25519(Ed25519PublicKey)

Ed25519 public key data.

Rsa(RsaPublicKey)

Available on crate feature alloc only.

RSA public key data.

SkEcdsaSha2NistP256(SkEcdsaSha2NistP256)

Available on crate feature ecdsa only.

Security Key (FIDO/U2F) using ECDSA/NIST P-256 as specified in PROTOCOL.u2f.

SkEd25519(SkEd25519)

Security Key (FIDO/U2F) using Ed25519 as specified in PROTOCOL.u2f.

Certificate(Box<Certificate>)

Available on crate feature alloc only.

Certificate key as specified in draft-miller-ssh-cert (and PROTOCOL.certkeys, now deprecated in favor of the IETF draft).

Other(OpaquePublicKey)

Available on crate feature alloc only.

Opaque public key data.

Implementations

impl KeyData

pub fn algorithm(&self) -> Algorithm

Get the Algorithm for this public key.

pub fn dsa(&self) -> Option<&DsaPublicKey>

Available on crate feature alloc only.

Get DSA public key if this key is the correct type.

pub fn ecdsa(&self) -> Option<&EcdsaPublicKey>

Available on crate feature ecdsa only.

Get ECDSA public key if this key is the correct type.

pub fn ed25519(&self) -> Option<&Ed25519PublicKey>

Get Ed25519 public key if this key is the correct type.

pub fn fingerprint(&self, hash_alg: HashAlg) -> Fingerprint

Compute key fingerprint.

Use Default::default() to use the default hash function (SHA-256).

pub fn rsa(&self) -> Option<&RsaPublicKey>

Available on crate feature alloc only.

Get RSA public key if this key is the correct type.

pub fn sk_ecdsa_p256(&self) -> Option<&SkEcdsaSha2NistP256>

Available on crate feature ecdsa only.

Get FIDO/U2F ECDSA/NIST P-256 public key if this key is the correct type.

pub fn sk_ed25519(&self) -> Option<&SkEd25519>

Get FIDO/U2F Ed25519 public key if this key is the correct type.

pub fn other(&self) -> Option<&OpaquePublicKey>

Available on crate feature alloc only.

Get the custom, opaque public key if this key is the correct type.

pub fn certificate(&self) -> Option<&Certificate>

Available on crate feature alloc only.

Get the certificate if this key is the correct type.

pub fn into_certificate(self) -> Option<Certificate>

Available on crate feature alloc only.

Get the certificate, consuming the KeyData, if this key is the correct type.

pub fn is_dsa(&self) -> bool

Available on crate feature alloc only.

Is this key a DSA key?

pub fn is_ecdsa(&self) -> bool

Available on crate feature ecdsa only.

Is this key an ECDSA key?

pub fn is_ed25519(&self) -> bool

Is this key an Ed25519 key?

pub fn is_rsa(&self) -> bool

Available on crate feature alloc only.

Is this key an RSA key?

pub fn is_sk_ecdsa_p256(&self) -> bool

Available on crate feature ecdsa only.

Is this key a FIDO/U2F ECDSA/NIST P-256 key?

pub fn is_sk_ed25519(&self) -> bool

Is this key a FIDO/U2F Ed25519 key?

pub fn is_other(&self) -> bool

Available on crate feature alloc only.

Is this a key with a custom algorithm?

pub fn is_certificate(&self) -> bool

Available on crate feature alloc only.

Is this a certificate?

pub fn decode_as(reader: &mut impl Reader, algorithm: Algorithm) -> Result<Self>

Decode KeyData for the specified algorithm.

Errors

• Returns Error::AlgorithmUnknown if the provided algorithm is unknown or unsupported by this library.
• Returns Error::Encoding in the event of an encoding error.

pub fn decode_as_certificate( reader: &mut impl Reader, algorithm: Algorithm, ) -> Result<Self>

Available on crate feature alloc only.

Decode KeyData as a certificate with the specified algorithm.

Errors

Propagates errors from Certificate::decode_as.

Trait Implementations

impl Clone for KeyData

fn clone(&self) -> KeyData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyData

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

Formats the value using the given formatter.

impl Decode for KeyData

type Error = Error

Type returned in the event of a decoding error.

fn decode(reader: &mut impl Reader) -> Result<Self>

Attempt to decode a value of this type using the provided Reader.

impl Encode for KeyData

fn encoded_len(&self) -> Result<usize>

Get the length of this type encoded in bytes, prior to Base64 encoding.

fn encode(&self, writer: &mut impl Writer) -> Result<()>

Encode this value using the provided Writer.

fn encoded_len_prefixed(&self) -> Result<usize, Error>

Return the length of this type after encoding when prepended with a uint32 length prefix.

fn encode_prefixed(&self, writer: &mut impl Writer) -> Result<(), Error>

Encode this value, first prepending a uint32 length prefix set to Encode::encoded_len.

fn encode_vec(&self) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Encode this value, returning a Vec<u8> containing the encoded message.

impl From<&PrivateKey> for KeyData

fn from(private_key: &PrivateKey) -> KeyData

Converts to this type from the input type.

impl From<&PublicKey> for KeyData

fn from(public_key: &PublicKey) -> KeyData

Converts to this type from the input type.

impl From<Certificate> for KeyData

Available on crate feature alloc only.

fn from(certificate: Certificate) -> KeyData

Converts to this type from the input type.

impl From<DsaPublicKey> for KeyData

Available on crate feature alloc only.

fn from(public_key: DsaPublicKey) -> KeyData

Converts to this type from the input type.

impl From<EcdsaPublicKey> for KeyData

Available on crate feature ecdsa only.

fn from(public_key: EcdsaPublicKey) -> KeyData

Converts to this type from the input type.

impl From<Ed25519PublicKey> for KeyData

fn from(public_key: Ed25519PublicKey) -> KeyData

Converts to this type from the input type.

impl From<KeyData> for PublicKey

fn from(key_data: KeyData) -> PublicKey

Converts to this type from the input type.

impl From<PrivateKey> for KeyData

fn from(private_key: PrivateKey) -> KeyData

Converts to this type from the input type.

impl From<PublicKey> for KeyData

fn from(public_key: PublicKey) -> KeyData

Converts to this type from the input type.

impl From<RsaPublicKey> for KeyData

Available on crate feature alloc only.

fn from(public_key: RsaPublicKey) -> KeyData

Converts to this type from the input type.

impl From<SkEcdsaSha2NistP256> for KeyData

Available on crate feature ecdsa only.

fn from(public_key: SkEcdsaSha2NistP256) -> KeyData

Converts to this type from the input type.

impl From<SkEd25519> for KeyData

fn from(public_key: SkEd25519) -> KeyData

Converts to this type from the input type.

impl Hash for KeyData

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 Ord for KeyData

fn cmp(&self, other: &KeyData) -> 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,

Restrict a value to a certain interval.

impl PartialEq for KeyData

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for KeyData

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&KeypairData> for KeyData

type Error = Error

The type returned in the event of a conversion error.

fn try_from(keypair_data: &KeypairData) -> Result<KeyData>

Performs the conversion.

impl Verifier<Signature> for KeyData

Available on crate feature alloc only.

fn verify(&self, message: &[u8], signature: &Signature) -> Result<()>

Use Self (e.g. a verifying key) to verify that the provided signature is authentic for a given message bytestring.

impl Eq for KeyData

impl StructuralPartialEq for KeyData