2 unstable releases
| 0.2.0 | Aug 3, 2025 |
|---|---|
| 0.1.0 | Jul 31, 2025 |
#651 in Authentication
134 downloads per month
Used in 2 crates
48KB
797 lines
libpam-sys: low-level bindings to Pluggable Authentication Modules
- Supports all known PAM implementations on Linux, Mac OS, BSD, and Illumos/Solaris
- Works with zero configuration for common use cases
- No need for system header files
- Depends only on
libc
If you're looking for a nice, safe, Rusty API to PAM, may I recommend nonstick?
PAM implementations
Supported PAM implementations are defined in the pam_impl::PamImpl enum.
This crate automatically chooses the appropriate PAM implementation you are most likely to need installed based on the target OS.
You can also explicitly specify the PAM implementation you want (if not detected correctly) by setting the LIBPAMSYS_IMPL environment variable at build time.
All build-time configuration is performed by the build script of the libpam-sys-impls crate.
Normally, this crate exports all functionality available in the selected PAM library.
XSso exports only the subset of the X/SSO specification supported by both OpenPAM and Sun PAM.
Changing behavior based on PAM implementation
Downstream crates can detect the current PAM implementation using custom #[cfg]s:
// Your package's build.rs:
use libpam_sys::pam_impl;
fn main() {
pam_impl::enable_pam_impl_cfg();
// the rest of your build script...
}
This will enable the use of #[cfg]s that look like this:
#[cfg(pam_impl = "Sun")]
fn some_func() { /* Sun-specific implementation */ }
#[cfg(any(pam_impl = "LinuxPam", pam_impl = "OpenPam"))]
fn some_func() { /* Linux-PAM / OpenPAM implementation */ }
Further documentation on this is available in libpam-sys-impls.
Testing
Tests are mostly run through libpam-sys-test, which lives in the crate's workspace in its repository (along with nonstick).
ctestverifies the correctness of the FFI bindings (function/struct alignment, etc.).- A kind of scuffed homebrew thing also verifies that the constants are correct.
There are some unit tests of glue code and other type checks.
Minimum Rust version
This crate supports Rust 1.75, the current version in Debian Trixie and Ubuntu 24.04.2 LTS. There shouldn't be much that needs changing, since PAM's API is quite stable.
References
- X/SSO PAM specification: This 1997 document laid out the original specification for PAM.
- Linux-PAM repository: The Linux-PAM implementation, used by most (all?) Linux distributions. Contains many extensions.
- Linux-PAM man page: Root man page for Linux-PAM, with links to additional PAM man pages.
- Linux-PAM guides: Documentation for developers using PAM and sysadmins.
- OpenPAM repository: The OpenPAM implementation, used by many BSD varieties. This hews very close to the spec.
- OpenPAM man page: NetBSD's root man page for OpenPAM.
- Illumos PAM repository: Illumos's implementation of PAM, based on Sun's Solaris. Even more basic than OpenPAM.
- Illumos PAM man page: Illumos's root man page for its PAM implementation.