Mercurial > crates > nonstick

diff README.md @ 45:ce47901aab7a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rename to “nonstick”, move to root, update docs and license. - Renames the crate to “nonstick”. - Moves the main library to the root of the repository. - Removes the example PAM modules. - Updates copyright information in LICENSE file. - Updates the README.
author Paul Fisher <paul@pfish.zone>
date Tue, 15 Apr 2025 00:50:23 -0400
parents 53efbcff805d
children
line wrap: on
line diff
--- a/README.md	Sat Mar 08 19:29:46 2025 -0500
+++ b/README.md	Tue Apr 15 00:50:23 2025 -0400
@@ -1,25 +1,26 @@
-pam-rs
-========
+# 🍳 nonstick
 
-Rust interface to the pluggable authentication module framework (PAM).
+Nonstick lets you use PAM (Pluggable Authentication Modules) from Rust without having to deal with icky unsafe code.
+
+## Status
 
-The goal of this library is to provide a type-safe API that can be used to
-interact with PAM.  The library is incomplete - currently it supports a subset
-of functions for use in a pam authentication module.  A pam module is a shared
-library that is invoked to authenticate a user, or to perform other functions.
+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).
+At the moment, [Linux-PAM](https://github.com/linux-pam/linux-pam) is the only supported PAM implementation.
 
-## 🌐 [pam-http](pam-http)
+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 example of using pam-rs by performing HTTP basic access auth to authenticate users.
+Goals include:
 
-## 🍻 [pam-sober](pam-sober)
+- Bindings for PAM clients.
+- Support for non–Linux-PAM implementations.
 
-If you aren't sober enough for basic math, you can't login!
+## Credits
 
-### Credits
-
-The contents of this repo are heavily borrowed from:
+This is a direct fork of [Anthony Nowell](http://anowell.com/)’s [`pam-rs`/`pam-bindings` crate](https://crates.io/crates/pam-bindings).
+`pam-rs` was in turn inspired by:
 
-- [tozny/rust-pam](https://github.com/tozny/rust-pam)
-- [ndenev/pam_groupmap](https://github.com/ndenev/pam_groupmap)
-- [beatgammit/pam-http](https://github.com/beatgammit/pam-http)
+- [`rust-pam` by tozny](https://github.com/tozny/rust-pam)
+- [`pam_groupmap` by ndenev](https://github.com/ndenev/pam_groupmap)
+- [`pam-http` by beatgammit](https://github.com/beatgammit/pam-http)