comparison README.md @ 45:ce47901aab7a

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
comparison
equal deleted inserted replaced
44:50371046c61a 45:ce47901aab7a
1 pam-rs 1 # 🍳 nonstick
2 ========
3 2
4 Rust interface to the pluggable authentication module framework (PAM). 3 Nonstick lets you use PAM (Pluggable Authentication Modules) from Rust without having to deal with icky unsafe code.
5 4
6 The goal of this library is to provide a type-safe API that can be used to 5 ## Status
7 interact with PAM. The library is incomplete - currently it supports a subset
8 of functions for use in a pam authentication module. A pam module is a shared
9 library that is invoked to authenticate a user, or to perform other functions.
10 6
11 ## 🌐 [pam-http](pam-http) 7 It is currently very incomplete.
8 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).
9 At the moment, [Linux-PAM](https://github.com/linux-pam/linux-pam) is the only supported PAM implementation.
12 10
13 An example of using pam-rs by performing HTTP basic access auth to authenticate users. 11 I will make an effort not to break APIs with development, but consider it alpha, pre-1.0 software.
12 While the code itself should be _secure_ and mostly safe, the API may not be completely stable.
14 13
15 ## 🍻 [pam-sober](pam-sober) 14 Goals include:
16 15
17 If you aren't sober enough for basic math, you can't login! 16 - Bindings for PAM clients.
17 - Support for non–Linux-PAM implementations.
18 18
19 ### Credits 19 ## Credits
20 20
21 The contents of this repo are heavily borrowed from: 21 This is a direct fork of [Anthony Nowell](http://anowell.com/)’s [`pam-rs`/`pam-bindings` crate](https://crates.io/crates/pam-bindings).
22 `pam-rs` was in turn inspired by:
22 23
23 - [tozny/rust-pam](https://github.com/tozny/rust-pam) 24 - [`rust-pam` by tozny](https://github.com/tozny/rust-pam)
24 - [ndenev/pam_groupmap](https://github.com/ndenev/pam_groupmap) 25 - [`pam_groupmap` by ndenev](https://github.com/ndenev/pam_groupmap)
25 - [beatgammit/pam-http](https://github.com/beatgammit/pam-http) 26 - [`pam-http` by beatgammit](https://github.com/beatgammit/pam-http)