aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJulien Tanguy <julien.tanguy@jhome.fr>2015-05-06 14:07:26 +0200
committerJulien Tanguy <julien.tanguy@jhome.fr>2015-05-06 14:07:26 +0200
commita5822779f64dcf42a271df7d0043f6665583ea0a (patch)
treeae66210900441e9f3d5d5e6bf7c4f3f0729c4a8f
parent7986de7cc40d5c063805b060c1796623d3584995 (diff)
downloadhmacaroons-a5822779f64dcf42a271df7d0043f6665583ea0a.tar.gz
hmacaroons-a5822779f64dcf42a271df7d0043f6665583ea0a.tar.zst
hmacaroons-a5822779f64dcf42a271df7d0043f6665583ea0a.zip
Fix haddock and add changelog
[ci skip]
-rw-r--r--CHANGELOG.md7
-rw-r--r--hmacaroons.cabal31
2 files changed, 17 insertions, 21 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..3a8e1eb
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,7 @@
1# Revision history for [hmacaroons](https://github.com/jtanguy/hmacaroons)
2
3## 0.1.0 -- (Current development version)
4
5 * Macaroon creation
6 * Base64 serialization
7 * First party caveats
diff --git a/hmacaroons.cabal b/hmacaroons.cabal
index a2878f2..c26ea19 100644
--- a/hmacaroons.cabal
+++ b/hmacaroons.cabal
@@ -4,48 +4,36 @@ synopsis: Haskell implementation of macaroons
4description: 4description:
5 = Macaroons: Pure haskell implementation of macaroons 5 = Macaroons: Pure haskell implementation of macaroons
6 #macaroons-pure-haskell-implementation-of-macaroons# 6 #macaroons-pure-haskell-implementation-of-macaroons#
7 7 .
8 Macaroons is a pure haskell implementation of macaroons. It aims to 8 Macaroons is a pure haskell implementation of macaroons. It aims to
9 provide compatibility at a serialized level with the 9 provide compatibility at a serialized level with the
10 <https://github.com/rescrv/libmacaroons reference implementation> and 10 <https://github.com/rescrv/libmacaroons reference implementation> and
11 the <https://github.com/ecordell/pymacaroons python implementation> 11 the <https://github.com/ecordell/pymacaroons python implementation>
12 12 .
13 __WARNING: This library has not been audited by security experts.__ 13 __WARNING: This library has not been audited by security experts.__
14 __There is no error handling at the moment, everyhting is silently 14 __There is no error handling at the moment, everyhting is silently accepted__
15 accepted__ 15 .
16
17 It is developed in the purpose of exploration purposes, and would need 16 It is developed in the purpose of exploration purposes, and would need
18 much more attention if it were to be used in production. 17 much more attention if it were to be used in production.
19 18 .
20 = References 19 = References
21 #references# 20 #references#
22 21 .
23 == Papers and articles 22 == Papers and articles
24 #papers-and-articles# 23 #papers-and-articles#
25 24 .
26 - <http://research.google.com/pubs/pub41892.html Google paper on macaroons> 25 - <http://research.google.com/pubs/pub41892.html Google paper on macaroons>
27 - <https://air.mozilla.org/macaroons-cookies-with-contextual-caveats-for-decentralized-authorization-in-the-cloud/ Macaroons at Mozilla> 26 - <https://air.mozilla.org/macaroons-cookies-with-contextual-caveats-for-decentralized-authorization-in-the-cloud/ Macaroons at Mozilla>
28 - <http://hackingdistributed.com/2014/11/23/macaroons-in-hyperdex/ Time for better security in NoSQL> 27 - <http://hackingdistributed.com/2014/11/23/macaroons-in-hyperdex/ Time for better security in NoSQL>
29 28 .
30 == Implementations 29 == Implementations
31 #implementations# 30 #implementations#
32 31 .
33 - <https://github.com/rescrv/libmacaroons C> 32 - <https://github.com/rescrv/libmacaroons C>
34 - <https://github.com/nitram509/jmacaroons Java> 33 - <https://github.com/nitram509/jmacaroons Java>
35 - <https://github.com/nitram509/macaroons.js Node.js> 34 - <https://github.com/nitram509/macaroons.js Node.js>
36 - <https://github.com/ecordell/pymacaroons Python> 35 - <https://github.com/ecordell/pymacaroons Python>
37 - <https://github.com/cryptosphere/rust-macaroons.git Rust> 36 - <https://github.com/cryptosphere/rust-macaroons.git Rust>
38
39 = TODO
40 #todo#
41
42 - Third party caveats
43 - Verify Macaroons
44 - Discharge Macaroons
45 - JSON serialization
46 - Quickcheck tests
47 - Error handling
48 - FFI\'s for testing and benchmarking purposes
49license: BSD3 37license: BSD3
50license-file: LICENSE 38license-file: LICENSE
51author: Julien Tanguy 39author: Julien Tanguy
@@ -56,6 +44,7 @@ category: Data
56build-type: Simple 44build-type: Simple
57extra-source-files: README.md 45extra-source-files: README.md
58 CONTRIBUTING.md 46 CONTRIBUTING.md
47 CHANGELOG
59cabal-version: >=1.10 48cabal-version: >=1.10
60 49
61source-repository head 50source-repository head