Mercurial > crates > nonstick
changeset 57:2a5c83d04b93 v0.0.4
Update some docs; bump to v0.0.4.
| author | Paul Fisher <paul@pfish.zone> |
|---|---|
| date | Mon, 05 May 2025 00:16:00 -0400 |
| parents | daa2cde64601 |
| children | 868a278a362c |
| files | Cargo.toml README.md src/lib.rs |
| diffstat | 3 files changed, 5 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/Cargo.toml Sun May 04 02:56:55 2025 -0400 +++ b/Cargo.toml Mon May 05 00:16:00 2025 -0400 @@ -1,7 +1,7 @@ [package] name = "nonstick" description = "PAM bindings for Rust" -version = "0.0.3" +version = "0.0.4" authors = ["Paul Fisher <paul@pfish.zone>", "Anthony Nowell <anowell@gmail.com>" ] repository = "https://hg.pfish.zone/crates/nonstick/" readme = "README.md"
--- a/README.md Sun May 04 02:56:55 2025 -0400 +++ b/README.md Mon May 05 00:16:00 2025 -0400 @@ -6,10 +6,11 @@ It is currently very incomplete. It only provides functionality for developing your own PAM authentication module (i.e., a backend that PAM calls to authenticate a user or do something similar). +If you’re looking for a library to implement a PAM client (i.e., something that authenticates using PAM), consider the [`pam` crate](https://crates.io/crates/pam). At the moment, [Linux-PAM](https://github.com/linux-pam/linux-pam) is the only supported PAM implementation. -I will make an effort not to break APIs with development, but consider it alpha, pre-1.0 software. -While the code itself should be _secure_ and mostly safe, the API may not be completely stable. +An earlier version of this suggested that I would try not to break APIs. +This was optimistic on my part; it is likely APIs will break before v0.1.0, after which I _will_ try to break things _less_. Goals include:
--- a/src/lib.rs Sun May 04 02:56:55 2025 -0400 +++ b/src/lib.rs Mon May 05 00:16:00 2025 -0400 @@ -14,10 +14,7 @@ //! A typical authentication module will define an external function called //! `pam_sm_authenticate()`, which will use functions in this library to //! interrogate the program that requested authentication for more information, -//! and to render a result. For a working example that uses this library, see -//! [toznyauth-pam][]. -//! -//! [toznyauth-pam]: https://github.com/tozny/toznyauth-pam +//! and to render a result. //! //! Note that constants that are normally read from pam header files are //! hard-coded in the `constants` module. The values there are taken from