Struct Auth

pub struct Auth {
    pub name: Option<String>,
    pub pass_file: Option<String>,
    pub pass: Option<String>,
    pub token_file: Option<String>,
    pub token: Option<String>,
}

Authentication context used to signal how to authenticate a connection.

Fields

name: Option<String>

Account name used to authenticate.

pass_file: Option<String>

Load raw account passphrase from the specified filename.

pass: Option<String>

Raw account passphrase to authenticate with. Only used if name has been set.

token_file: Option<String>

Use the specified file for authentication token storage.

token: Option<String>

Authentication token.

Implementations

impl Auth

pub fn have_pass(&self) -> bool

Return true if there’s either a raw passphrase set in pass or a passphrase file has beeen set in pass_file. This function does not validate if the passphrase file exists or is accessible.

pub fn get_pass(&self) -> Result<String, Error>

Get passphrase.

Return the raw pass field if set. Otherwise, load the pass_file if set, and return error if the passphrase could not be loaded from the file.

If neither pass nor pass_file have been set, return an error.

pub fn get_token(&self) -> Result<Option<String>, Error>

Get authentication token.

Return the raw token field if set. Otherwise, check if token_file is set. If it is, then attempt to load the token from it. If the file does not exist, then:

• Return Ok(None) if account name and pass(file) have been set.
• Return error if account name has not been set.

pub async fn authenticate<C>( &self, conn: &mut Framed<C, Codec>, ) -> Result<Option<String>, Error>

where C: AsyncRead + AsyncWrite + Unpin,

Helper function for authenticating a connection.

Authenticates the connection specified in conn, using the credentials stored in the Auth buffer using the following logic:

1. If a raw token has been supplied in the token field, then attempt to authenticate with it and return the results.
2. If a token_file has been been set, then:
   • If the file exists, try to load the authentication token, authenticate with it, and return the results.
   • If the file does not exist, then:
     • If account name and/or passphrase have not been set, then return error.
     • If account name and passphrase have been set, then continue.
3. Make sure that an account name and a passphrase has been set. The passphrase is either set from the pass field or by loading the contents of the file in pass_file. Return error account name or passphrase can not be acquired.
4. Authenticate using account name and passphrase. If a token_file was specified, then request an authentication token and store it in token_file on success. Return error on failure.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.

impl Default for Auth

fn default() -> Auth

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Auth

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.