commit ad4364c8678ea7813f36667dff11bb6c052d4a9d parent a00ab41eae3a5e1934a6e1dc538503b55b873e74 Author: Jan Pobrislo <ccx@te2000.cz> Date: Sat, 15 Feb 2025 16:02:05 +0000 add short description Diffstat:
| M | README | | | 12 | ++++++++++++ |
1 file changed, 12 insertions(+), 0 deletions(-)
diff --git a/README b/README @@ -1,6 +1,18 @@ miniroon: minimalist implementation of Macaroon authentication primitive for POSIX systems ========================================================================================== +Macaroons are simple authentication cookies that allow for attenuation of authority, +that is the cookie can be extended by additional restrictions called caveats. + +Miniroon is an implementation of macaroons for UNIX-like systems that strives to be as +simple as possible, but no simpler. + +For each miniroon id three pieces of information need to be provided: +* secret: random / unguessable 32 bytes used as signature base +* command to be executed upon succesful authentication +* environment whitelist declaring which environment variables may be modified by the + miniroon + dependencies ------------