2 releases
new 0.8.2 | Dec 4, 2024 |
---|---|
0.8.1 | Dec 4, 2024 |
#167 in Authentication
200 downloads per month
46KB
772 lines
pam - Safe Rust API to the Linux Pluggable Authentication Modules (PAM)
Note: Currently only supports basic username/password authentication out-of-the-box.
Warning
Environment support through the env
module is probably broken and should not be used in the current state!
Usage
- Add
pam
to your Cargo.toml:
[dependencies]
pam = { package = "pam-f", version = "0.8.1" }
- Use the
Authenticator
struct to authenticate and open a session
pub fn main() {
let service = "<yourapp>";
let user = "<user>";
let password = "<pass>";
let mut auth = pam::Authenticator::with_password(service).unwrap();
auth.handler_mut().set_credentials(user, password);
if auth.authenticate().is_ok() && auth.open_session().is_ok() {
println!("Successfully opened a session!");
}
else {
println!("Authentication failed =/");
}
}
TODO:
- Implement basic user/password authentication
- Add
Authenticator
struct - Add (more) documentation
- Verify current
conv
does not leak memory - Allow custom
conv
functions to be passed - Code cleanup
Supported Rust versions
The library is only continuously built against Rust stable, beta and nightly but as it does not use a lot of new language features it should probably compile on older versions as well. If you encounter problems building on older versions and a small fix can be applied to make the build succeed, consider opening a pull request.
Note about stability
This crate follows semantic versioning. As such all versions below 1.0.0
should be
considered development versions. This means the API could change any time.
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~0.3–2.8MB
~56K SLoC