Enum ssh_key::private::KeypairData

source · [−]

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

Expand description

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)

This enum is marked as 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.

Implementations

source

impl KeypairData

source

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

Get the Algorithm for this private key.

source

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

Available on crate feature alloc only.

Get DSA keypair if this key is the correct type.

source

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

Available on crate feature ecdsa only.

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

source

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

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

source

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

Available on crate feature alloc only.

Get the encrypted ciphertext if this key is encrypted.

source

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

Available on crate feature alloc only.

Get RSA keypair if this key is the correct type.

source

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.

source

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.

source

pub fn is_dsa(&self) -> bool

Available on crate feature alloc only.

Is this key a DSA key?

source

pub fn is_ecdsa(&self) -> bool

Available on crate feature ecdsa only.

Is this key an ECDSA key?

source

pub fn is_ed25519(&self) -> bool

Is this key an Ed25519 key?

source

pub fn is_encrypted(&self) -> bool

Is this key encrypted?

source

pub fn is_rsa(&self) -> bool

Available on crate feature alloc only.

Is this key an RSA key?

source

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?

source

pub fn is_sk_ed25519(&self) -> bool

Available on crate feature alloc only.

Is this key a FIDO/U2F Ed25519 key?

Trait Implementations

source

impl Clone for KeypairData

source

fn clone(&self) -> KeypairData

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl ConstantTimeEq for KeypairData

Available on crate feature subtle only.

source

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

Determine if two items are equal. Read more

source

impl Debug for KeypairData

source

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

Formats the value using the given formatter. Read more

source

impl From<DsaKeypair> for KeypairData

Available on crate feature alloc only.

source

fn from(keypair: DsaKeypair) -> KeypairData

Converts to this type from the input type.

source

impl From<EcdsaKeypair> for KeypairData

Available on crate feature ecdsa only.

source

fn from(keypair: EcdsaKeypair) -> KeypairData

Converts to this type from the input type.

source

impl From<Ed25519Keypair> for KeypairData

source

fn from(keypair: Ed25519Keypair) -> KeypairData

Converts to this type from the input type.

source

impl From<RsaKeypair> for KeypairData

Available on crate feature alloc only.

source

fn from(keypair: RsaKeypair) -> KeypairData

Converts to this type from the input type.

source

impl PartialEq<KeypairData> for KeypairData

Available on crate feature subtle only.

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

source

impl Signer<Signature> for KeypairData

source

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. Read more

source

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

Sign the given message and return a digital signature

source

impl TryFrom<&'_ KeypairData> for KeyData

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl TryFrom<KeypairData> for PrivateKey

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl Eq for KeypairData

Available on crate feature subtle only.

Auto Trait Implementations

impl RefUnwindSafe for KeypairData

impl Send for KeypairData

impl Sync for KeypairData

impl Unpin for KeypairData

impl UnwindSafe for KeypairData

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, S> SignerMut<S> for T where
T: Signer<S>,
S: Signature,

source

fn try_sign(&mut self, msg: &[u8 ]) -> Result<S, Error>

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

source

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

Sign the given message, update the state, and return a digital signature

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum ssh_key::private::KeypairData

Variants (Non-exhaustive)

Dsa(DsaKeypair)

Ecdsa(EcdsaKeypair)

Ed25519(Ed25519Keypair)

Encrypted(Vec<u8>)

Rsa(RsaKeypair)

SkEcdsaSha2NistP256(SkEcdsaSha2NistP256)

SkEd25519(SkEd25519)

Implementations

impl KeypairData

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

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

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

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

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

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

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

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

pub fn is_dsa(&self) -> bool

pub fn is_ecdsa(&self) -> bool

pub fn is_ed25519(&self) -> bool

pub fn is_encrypted(&self) -> bool

pub fn is_rsa(&self) -> bool

pub fn is_sk_ecdsa_p256(&self) -> bool

pub fn is_sk_ed25519(&self) -> bool

Trait Implementations

impl Clone for KeypairData

fn clone(&self) -> KeypairData

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

impl ConstantTimeEq for KeypairData

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

impl Debug for KeypairData

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

impl From<DsaKeypair> for KeypairData

fn from(keypair: DsaKeypair) -> KeypairData

impl From<EcdsaKeypair> for KeypairData

fn from(keypair: EcdsaKeypair) -> KeypairData

impl From<Ed25519Keypair> for KeypairData

fn from(keypair: Ed25519Keypair) -> KeypairData

impl From<RsaKeypair> for KeypairData

fn from(keypair: RsaKeypair) -> KeypairData

impl PartialEq<KeypairData> for KeypairData

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

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

impl Signer<Signature> for KeypairData

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

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

impl TryFrom<&'_ KeypairData> for KeyData

type Error = Error

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

impl TryFrom<KeypairData> for PrivateKey

type Error = Error

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

impl Eq for KeypairData

Auto Trait Implementations

impl RefUnwindSafe for KeypairData

impl Send for KeypairData

impl Sync for KeypairData

impl Unpin for KeypairData

impl UnwindSafe for KeypairData

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, S> SignerMut<S> for T where T: Signer<S>, S: Signature,

fn try_sign(&mut self, msg: &[u8]) -> Result<S, Error>

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

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

`Dsa(DsaKeypair)`

`Ecdsa(EcdsaKeypair)`

`Ed25519(Ed25519Keypair)`

`Encrypted(Vec<u8>)`

`Rsa(RsaKeypair)`

`SkEcdsaSha2NistP256(SkEcdsaSha2NistP256)`

`SkEd25519(SkEd25519)`

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, S> SignerMut<S> for T where
T: Signer<S>,
S: Signature,

fn try_sign(&mut self, msg: &[u8 ]) -> Result<S, Error>

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

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,