Enum KeypairData

#[non_exhaustive]
pub enum KeypairData {
    Dsa(DsaKeypair),
    Ecdsa(EcdsaKeypair),
    Ed25519(Ed25519Keypair),
    Encrypted(Vec<u8>),
    Rsa(RsaKeypair),
    SkEcdsaSha2NistP256(SkEcdsaSha2NistP256),
    SkEd25519(SkEd25519),
    Other(OpaqueKeypair),
}

Private key data: digital signature key pairs.

SSH private keys contain pairs of public and private keys for various supported digital signature algorithms.

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

Available on crate feature alloc only.

Digital Signature Algorithm (DSA) keypair.

Ecdsa(EcdsaKeypair)

Available on crate feature ecdsa only.

ECDSA keypair.

Ed25519(Ed25519Keypair)

Ed25519 keypair.

Encrypted(Vec<u8>)

Available on crate feature alloc only.

Encrypted private key (ciphertext).

Rsa(RsaKeypair)

Available on crate feature alloc only.

RSA keypair.

SkEcdsaSha2NistP256(SkEcdsaSha2NistP256)

Available on crate features alloc and ecdsa only.

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

SkEd25519(SkEd25519)

Available on crate feature alloc only.

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

Other(OpaqueKeypair)

Available on crate feature alloc only.

Opaque keypair.

Implementations

impl KeypairData

pub fn algorithm(&self) -> Result<Algorithm>

Get the Algorithm for this private key.

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

Available on crate feature alloc only.

Get DSA keypair if this key is the correct type.

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

Available on crate feature ecdsa only.

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

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

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

pub fn encrypted(&self) -> Option<&[u8]>

Available on crate feature alloc only.

Get the encrypted ciphertext if this key is encrypted.

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

Available on crate feature alloc only.

Get RSA keypair if this key is the correct type.

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

Available on crate features alloc and ecdsa only.

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

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

Available on crate feature alloc only.

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

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

Available on crate feature alloc only.

Get the custom, opaque private key 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_encrypted(&self) -> bool

Available on crate feature alloc only.

Is this key encrypted?

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 features alloc and ecdsa only.

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

pub fn is_sk_ed25519(&self) -> bool

Available on crate feature alloc only.

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 decode_as(reader: &mut impl Reader, algorithm: Algorithm) -> Result<Self>

Decode KeypairData for the specified algorithm.

Trait Implementations

impl Clone for KeypairData

fn clone(&self) -> KeypairData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for KeypairData

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for KeypairData

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

Formats the value using the given formatter.

impl Decode for KeypairData

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 KeypairData

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.

impl From<DsaKeypair> for KeypairData

Available on crate feature alloc only.

fn from(keypair: DsaKeypair) -> KeypairData

Converts to this type from the input type.

impl From<EcdsaKeypair> for KeypairData

Available on crate feature ecdsa only.

fn from(keypair: EcdsaKeypair) -> KeypairData

Converts to this type from the input type.

impl From<Ed25519Keypair> for KeypairData

fn from(keypair: Ed25519Keypair) -> KeypairData

Converts to this type from the input type.

impl From<RsaKeypair> for KeypairData

Available on crate feature alloc only.

fn from(keypair: RsaKeypair) -> KeypairData

Converts to this type from the input type.

impl From<SkEcdsaSha2NistP256> for KeypairData

Available on crate features alloc and ecdsa only.

fn from(keypair: SkEcdsaSha2NistP256) -> KeypairData

Converts to this type from the input type.

impl From<SkEd25519> for KeypairData

Available on crate feature alloc only.

fn from(keypair: SkEd25519) -> KeypairData

Converts to this type from the input type.

impl PartialEq for KeypairData

fn eq(&self, other: &Self) -> 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 Signer<Signature> for KeypairData

Available on crate feature alloc only.

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

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign(&self, msg: &[u8]) -> S

Sign the given message and return a digital signature

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 TryFrom<KeypairData> for PrivateKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(key_data: KeypairData) -> Result<PrivateKey>

Performs the conversion.

impl Eq for KeypairData