Struct LibPamHandle 

pub struct LibPamHandle(/* private fields */);

An owned variation of a basic PAM handle.

This is the most basic version of a wrapped PAM handle. It’s mostly used as the inside of the LibPamTransaction, but can also be used to “adopt” a PAM handle created by another library.

If Self::end is not called, this will always call pam_end reporting successful completion.

Implementations

impl LibPamHandle

pub fn end(&mut self, result: Result<()>)

Ends the transaction, reporting error_code to cleanup callbacks.

References

• Application Developers’ Guide on pam_end
• Linux-PAM manpage for pam_end
• OpenPAM manpage for pam_end
• Illumos manpage for pam_end
• X/SSO spec for pam_end

pub fn end_silent(&mut self, result: Result<()>)

Ends the transaction “quietly”, reporting the given result.

On Linux-PAM only, this sets the PAM_DATA_SILENT flag on the value passed to the cleanup callbacks. This conventionally means that this pam_end call is occurring on a forked process, and that a session may still be open on the parent process, and modules “should not treat the call too seriously”.

References

• Application Developers’ Guide on pam_end
• Linux-PAM manpage for pam_end
• OpenPAM manpage for pam_end
• Illumos manpage for pam_end
• X/SSO spec for pam_end

pub fn inner(&self) -> &pam_handle

Gets a reference to the inner PAM handle.

pub fn inner_mut(&mut self) -> &mut pam_handle

Gets a mutable reference to the inner PAM handle.

Trait Implementations

impl Conversation for LibPamHandle

fn communicate(&self, messages: &[Exchange<'_>])

Sends messages to the user.

impl Logger for LibPamHandle

fn log(&self, level: Level, loc: Location<'_>, entry: Arguments<'_>)

Logs something via this PAM handle.

impl ModuleClient for LibPamHandle

fn username(&mut self, prompt: Option<&OsStr>) -> Result<OsString>

Retrieves the name of the user who is authenticating or logging in.

fn authtok(&mut self, prompt: Option<&OsStr>) -> Result<OsString>

Retrieves the authentication token from the user.

fn old_authtok(&mut self, prompt: Option<&OsStr>) -> Result<OsString>

Retrieves the user’s old authentication token when changing passwords.

fn get_module_data<T: 'static>(&self, key: &str) -> Option<&T>

Gets an item of module-specific data stored over the transaction.

fn set_module_data<T: 'static>(&mut self, key: &str, data: T) -> Result<()>

Sets module-specific data.

fn authtok_item(&self) -> Result<Option<OsString>>

Gets the user’s authentication token (e.g., password).

fn old_authtok_item(&self) -> Result<Option<OsString>>

Gets the user’s old authentication token when changing passwords.

impl PamShared for LibPamHandle

fn environ(&self) -> impl EnvironMap<'_>

The contents of the environment to set for the logged-in user.

fn environ_mut(&mut self) -> impl EnvironMapMut<'_>

A writable map of the environment to set for the logged-in user.

fn items(&self) -> impl Items<'_>

Gets Items, data shared by PAM, the application, and modules.

fn items_mut(&mut self) -> impl ItemsMut<'_>

Read-write access to PAM Items.

impl Transaction for LibPamHandle

fn authenticate(&mut self, flags: AuthnFlags) -> Result<()>

Starts the authentication process for the user.

fn account_management(&mut self, flags: AuthnFlags) -> Result<()>

Verifies the validity of the user’s account (and other stuff).

fn change_authtok(&mut self, flags: AuthtokFlags) -> Result<()>

Changes the authentication token.