Enum AuthMethod

#[non_exhaustive]
pub enum AuthMethod {
    Password(String),
    PrivateKey {
        key_data: String,
        key_pass: Option<String>,
    },
    PrivateKeyFile {
        key_file_path: PathBuf,
        key_pass: Option<String>,
    },
    PublicKeyFile {
        key_file_path: PathBuf,
    },
    Agent,
    KeyboardInteractive(AuthKeyboardInteractive),
}

An authentification token.

Used when creating a Client for authentification. Supports password, private key, public key, SSH agent, and keyboard interactive authentication.

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.

Password(String)

PrivateKey

Fields

key_data: String

entire contents of private key file

key_pass: Option<String>

PrivateKeyFile

Fields

key_file_path: PathBuf

key_pass: Option<String>

PublicKeyFile

Fields

key_file_path: PathBuf

Agent

KeyboardInteractive(AuthKeyboardInteractive)

Implementations

impl AuthMethod

pub fn with_password(password: &str) -> Self

Convenience method to create a AuthMethod from a string literal.

pub fn with_key(key: &str, passphrase: Option<&str>) -> Self

pub fn with_key_file<T: AsRef<Path>>( key_file_path: T, passphrase: Option<&str>, ) -> Self

pub fn with_public_key_file<T: AsRef<Path>>(key_file_path: T) -> Self

pub fn with_agent() -> Self

Creates a new SSH agent authentication method.

This will attempt to authenticate using all identities available in the SSH agent. The SSH agent must be running and the SSH_AUTH_SOCK environment variable must be set.

Example

use async_ssh2_tokio::client::AuthMethod;

let auth = AuthMethod::with_agent();

Platform Support

This method is only available on Unix-like systems (Linux, macOS, etc.). It is not available on Windows.

pub const fn with_keyboard_interactive(auth: AuthKeyboardInteractive) -> Self

Trait Implementations

impl Clone for AuthMethod

fn clone(&self) -> AuthMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthMethod

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

Formats the value using the given formatter.

impl From<AuthKeyboardInteractive> for AuthMethod

fn from(value: AuthKeyboardInteractive) -> Self

Converts to this type from the input type.

impl Hash for AuthMethod

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 PartialEq for AuthMethod

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

impl StructuralPartialEq for AuthMethod