]> git.immae.eu Git - github/fretlink/hmacaroons.git/blob - README.md
Fix build and add travis badge
[github/fretlink/hmacaroons.git] / README.md
1 Macaroons: Pure haskell implementation of macaroons [![Build Status](https://travis-ci.org/jtanguy/hmacaroons.svg?branch=master)](https://travis-ci.org/jtanguy/hmacaroons)
2 ===================================================
3
4 Macaroons is a pure haskell implementation of macaroons. It aims to provide
5 compatibility at a serialized level with the [reference implementation](https://github.com/rescrv/libmacaroons)
6 and the [python implementation](https://github.com/ecordell/pymacaroons)
7
8 **WARNING: This library has not been audited by security experts.**
9 **There is no error handling at the moment, everyhting is silently accepted**
10
11 It is developed in the purpose of exploration purposes, and would need much
12 more attention if it were to be used in production.
13
14 References
15 ==========
16
17 Papers and articles
18 -------------------
19
20 - [Google paper on macaroons](http://research.google.com/pubs/pub41892.html)
21 - [Macaroons at Mozilla](https://air.mozilla.org/macaroons-cookies-with-contextual-caveats-for-decentralized-authorization-in-the-cloud/)
22 - [Time for better security in NoSQL](http://hackingdistributed.com/2014/11/23/macaroons-in-hyperdex/)
23
24 Implementations
25 ---------------
26
27 - [C](https://github.com/rescrv/libmacaroons)
28 - [Java](https://github.com/nitram509/jmacaroons)
29 - [Node.js](https://github.com/nitram509/macaroons.js)
30 - [Python](https://github.com/ecordell/pymacaroons)
31 - [Rust](https://github.com/cryptosphere/rust-macaroons.git)
32
33 TODO
34 ====
35
36 - Third party caveats
37 - Verify Macaroons
38 - Discharge Macaroons
39 - JSON serialization
40 - Quickcheck tests
41 - Error handling
42 - FFI's for testing and benchmarking purposes