Struct Conversation

pub struct Conversation { /* private fields */ }

Command-line implementation of ConversationHandler

This struct is unavailable if pam-client is built without the "cli" feature.

Prompts, info and error messages will be written to STDERR, non-secret input in read from STDIN and rpassword is used to prompt the user for passwords.

Limitations

Please note that UTF-8 encoding is assumed for terminal I/O, so this handler may fail to authenticate on legacy non-UTF-8 systems when the user input contains non-ASCII characters.

Implementations

impl Conversation

pub fn new() -> Self

Creates a new CLI conversation handler.

pub fn info_prefix(&self) -> &str

The prefix text written before info text

pub fn set_info_prefix(&mut self, prefix: impl Into<String>)

Updates the prefix put before info text

pub fn error_prefix(&self) -> &str

The prefix text written before error messages

pub fn set_error_prefix(&mut self, prefix: impl Into<String>)

Updates the prefix put before error messages

Trait Implementations

impl Clone for Conversation

fn clone(&self) -> Conversation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConversationHandler for Conversation

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 init(&mut self, _default_user: Option<impl AsRef<str>>)

Called by Context directly after taking ownership of the handler.

fn radio_prompt(&mut self, prompt: &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.