Struct Conversation

pub struct Conversation {
    pub username: String,
    pub password: String,
    pub log: Vec<LogEntry>,
}

Non-interactive implementation of ConversationHandler

When a PAM module asks for a non-secret string, username will be returned and when a secret string is asked for, password will be returned.

All info and error messages will be recorded in log.

Limitations

This is enough to handle many authentication flows non-interactively, but flows with two-factor-authentication and things like chauthok() will most definitely fail.

Please also note that UTF-8 encoding is assumed for both username and password, so this handler may fail to authenticate on legacy non-UTF-8 systems when one of the strings contains non-ASCII characters.

Fields

username: String

The username to use

password: String

The password to use

log: Vec<LogEntry>

All received info/error messages

Implementations

impl Conversation

pub const fn new() -> Self

Creates a new CLI conversation handler

If username isn’t manually set to a non-empty string, it will be automatically set to the Contexts default username on context initialization.

pub fn with_credentials( username: impl Into<String>, password: impl Into<String>, ) -> Self

Creatse a new CLI conversation handler with preset credentials

pub fn clear_log(&mut self)

Clears the error/info log

pub fn errors(&self) -> impl Iterator<Item = &CString> + FusedIterator

Lists only errors from the log

pub fn infos(&self) -> impl Iterator<Item = &CString> + FusedIterator

Lists only info messages from the log

Trait Implementations

impl Clone for Conversation

fn clone(&self) -> Conversation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConversationHandler for Conversation

fn init(&mut self, default_user: Option<&str>)

Called by Context directly after taking ownership of the handler.

fn prompt_echo_on(&mut self, _msg: &CStr) -> Result<CString, ErrorCode>

Obtains a string whilst echoing text (e.g. username)

fn prompt_echo_off(&mut self, _msg: &CStr) -> Result<CString, ErrorCode>

Obtains a string without echoing any text (e.g. password)

fn text_info(&mut self, msg: &CStr)

Displays some text.

fn error_msg(&mut self, msg: &CStr)

Displays an error message.

fn radio_prompt(&mut self, _msg: &CStr) -> Result<bool, ErrorCode>

Obtains a yes/no answer (Linux specific).

fn binary_prompt( &mut self, _type: u8, _data: &[u8], ) -> Result<(u8, Vec<u8>), ErrorCode>

Exchanges binary data (Linux specific, experimental).

impl Debug for Conversation

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

Formats the value using the given formatter.

impl Default for Conversation

fn default() -> Self

Returns the “default value” for a type.