commit a00ab41eae3a5e1934a6e1dc538503b55b873e74
parent fa6766202164222de301768454e9e3ae516418e1
Author: Jan Pobrislo <ccx@te2000.cz>
Date: Sat, 15 Feb 2025 15:33:49 +0000
basic README & TODO files
Diffstat:
| A | README | | | 37 | +++++++++++++++++++++++++++++++++++++ |
| A | TODO | | | 5 | +++++ |
2 files changed, 42 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,37 @@
+miniroon: minimalist implementation of Macaroon authentication primitive for POSIX systems
+==========================================================================================
+
+dependencies
+------------
+
+For building:
+
+* gcc with C11 standard support
+* GNU make
+* skalibs https://skarnet.org/software/skalibs/
+
+For development & tests:
+
+* triehash https://github.com/julian-klode/triehash
+* Python 3 (no external packages used)
+
+miniroon wire format
+--------------------
+
+TBD
+
+miniroon programs and directory structure
+-----------------------------------------
+
+TBD
+
+references
+----------
+
+The original macaroon paper: https://research.google.com/pubs/archive/41892.pdf
+@inproceedings{41892,
+ title = {Macaroons: Cookies with Contextual Caveats for Decentralized Authorization in the Cloud},
+ author = {Arnar Birgisson and Joe Gibbs Politz and Úlfar Erlingsson and Ankur Taly and Michael Vrable and Mark Lentczner},
+ year = {2014},
+ booktitle = {Network and Distributed System Security Symposium}
+}
diff --git a/TODO b/TODO
@@ -0,0 +1,5 @@
+Current:
+* Fatal errors to be mocked via sigsetjmp/siglongjmp.
+
+Resolved
+* [DONE] Convert caveat checks to produce miniroon_error return code.
