#pam #authentication #libpam

pam-client

Application API wrapper to Pluggable Authentication Modules (PAM)

6 releases

0.3.1 Nov 18, 2021
0.3.0 Mar 2, 2021
0.2.0 Feb 12, 2021
0.1.2 Feb 12, 2021

#70 in Unix APIs

Download history 61/week @ 2021-08-10 148/week @ 2021-08-17 168/week @ 2021-08-24 36/week @ 2021-09-07 34/week @ 2021-09-14 6/week @ 2021-09-21 39/week @ 2021-09-28 3/week @ 2021-10-05 42/week @ 2021-10-12 39/week @ 2021-10-19 2/week @ 2021-10-26 34/week @ 2021-11-02 6/week @ 2021-11-09 46/week @ 2021-11-16 6/week @ 2021-11-23

92 downloads per month
Used in rudo

MPL-2.0 license

125KB
2.5K SLoC

pam-client - Rust-style API to Pluggable Authentication Modules (PAM)

Crates.io Documentation License Build Status Test Coverage

Usage

  1. Add the following to your Cargo.toml:
[dependencies]
pam-client = "0.3"
  1. Read the crate documentation

Functionality

The pam-client crate a safe API to the application-faced parts of PAM. This includes in detail:

  • PAM authentication, account validation and session management
  • PAM password changing
  • Three sample conversation handler implementations
  • Custom conversation handlers via trait implementation
  • On-the-fly switching of the conversation handler
  • Suspendable RAII session handling
  • Methods for refreshing and reinitialization of PAM credentials
  • PAM environment list support with easy integration to std::process::Command and nix::unistd::execve
  • Getters and setters for all standard and most Linux-specific PAM items.
  • Raw access methods for non-standard PAM items
  • Errors mostly convertible to std::io::Error

Features

  • cli: by default a conversation handler for command line applications is included. Disable this feature if you don't need it to remove a dependency on rpassword.
  • serde: enable this feature to get serde (de-)serialization support for the error, flag and token types and the default conversation handlers. Additionally EnvList becomes serializable into [(OsStr, OsStr)].

Supported Rust versions

The minimum supported Rust toolchain version is Rust 1.43.0.

Currently tested up to version 1.52.0-nightly.

Platform support

The pam-client crate is currently only tested on Linux, but support is implemented for Solaris and OpenPAM-based platforms like NetBSD.

Stability

This crate follows semantic versioning with the additional promise that below 1.0.0 backwards-incompatible changes will not be introduced with only a patch-level version number change.

Comparison with similar crates

This crate provides safe wrappers for the same library as pam. This crate aims to provide safe wrappers for different use cases at the expense of a slightly more complex interface, while pam provides an easier interface, but restricts the order of operations to the most common use cases.

License

Licensed under Mozilla Public License, Version 2.0 (LICENSE or https://www.mozilla.org/en-US/MPL/2.0/).

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above including compatibility with secondary licenses, as defined by the MPL.

Dependencies

~0.4–2.3MB
~52K SLoC