pam-rs 0.9.5

An up-to-date fork of the `pam` crate.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# pam-rs - An up-to-date fork of [pam](https://github.com/1wilkens/pam)

[![Crates.io](https://img.shields.io/crates/v/pam-rs.svg)](https://crates.io/crates/pam-rs)
[![Documentation](https://docs.rs/pam-rs/badge.svg)](https://docs.rs/pam-rs/)
![License](https://img.shields.io/crates/l/pam-rs.svg?branch=master)

**Note:** This is an updated fork of the [pam](https://github.com/1wilkens/pam) crate, I am not the original author of this crate.

***

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
1. Add `pam-rs` to your Cargo.toml:
```toml
[dependencies]
pam-rs = "0.9.2"
```
2. Use the `Authenticator` struct to authenticate and open a session
```rust
extern crate pam_rs;
pub fn main() {
        let service = "<yourapp>";
        let user = "<user>";
        let password = "<pass>";

        let mut auth = pam_rs::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:
  - [x] Implement basic user/password authentication
  - [x] Add `Authenticator` struct
  - [ ] Add (more) documentation
  - [x] Verify current `conv` does not leak memory
  - [x] 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](http://semver.org). 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](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](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.