Mercurial > crates > nonstick
diff README.md @ 62:d83623951070
Further improve docs and put `conv` behind a feature gate.
author | Paul Fisher <paul@pfish.zone> |
---|---|
date | Wed, 21 May 2025 23:10:09 -0400 |
parents | 2a5c83d04b93 |
children |
line wrap: on
line diff
--- a/README.md Wed May 21 19:01:17 2025 -0400 +++ b/README.md Wed May 21 23:10:09 2025 -0400 @@ -1,20 +1,22 @@ # 🍳 nonstick -Nonstick lets you use PAM (Pluggable Authentication Modules) from Rust without having to deal with icky unsafe code. +Nonstick lets you use PAM (Pluggable Authentication Modules) from Rust without getting stuck in unsafe code. ## Status -It is currently very incomplete. +This 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). +A very immature implementation of the PAM Conversation structure is gated behind the `experimental` feature. At the moment, [Linux-PAM](https://github.com/linux-pam/linux-pam) is the only supported PAM implementation. -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_. +*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). + +APIs are likely to break before v0.1.0, and thereafter should stabilize to an eventual 1.0 release. Goals include: - Bindings for PAM clients. +- A robust and mature implementation of Conversation. - Support for non–Linux-PAM implementations. ## Credits