Add maintenance status badge

[github/fretlink/hmacaroons.git] / hmacaroons.cabal

diff --git a/hmacaroons.cabal b/hmacaroons.cabal
index 2b23c89c32ceb4032da476330cfd31567cfa5a00..81a9c33eb7b58d395e9b0f8b432120ec9f773a29 100644 (file)
--- a/hmacaroons.cabal
+++ b/hmacaroons.cabal
@@ -1,36 +1,78 @@
 name:                hmacaroons
-version:             0.1.0.0
+version:             0.5.0.0
 synopsis:            Haskell implementation of macaroons
--- description:         
+description:
+  Hmacaroons is a pure haskell implementation of macaroons. It aims to
+  provide compatibility at a serialized level with the
+  <https://github.com/rescrv/libmacaroons reference implementation> and
+  the <https://github.com/ecordell/pymacaroons python implementation>
+  .
+  __WARNING: This library has not been audited by security experts.__
+  __There is no error handling at the moment, everything is silently accepted__
+  .
+  It is developed in the purpose of exploration purposes, and would need
+  much more attention if it were to be used in production.
+  .
+  = References
+  #references#
+  .
+  == Papers and articles
+  #papers-and-articles#
+  .
+  -   <http://research.google.com/pubs/pub41892.html Google paper on macaroons>
+  -   <https://air.mozilla.org/macaroons-cookies-with-contextual-caveats-for-decentralized-authorization-in-the-cloud/ Macaroons at Mozilla>
+  -   <http://hackingdistributed.com/2014/11/23/macaroons-in-hyperdex/ Time for better security in NoSQL>
+  .
+  == Implementations
+  #implementations#
+  .
+  -   <https://github.com/rescrv/libmacaroons C>
+  -   <https://github.com/nitram509/jmacaroons Java>
+  -   <https://github.com/nitram509/macaroons.js Node.js>
+  -   <https://github.com/ecordell/pymacaroons Python>
+  -   <https://github.com/cryptosphere/rust-macaroons.git Rust>
 license:             BSD3
 license-file:        LICENSE
 author:              Julien Tanguy
 maintainer:          julien.tanguy@jhome.fr
--- copyright:           
+homepage:            https://github.com/jtanguy/hmacaroons
+bug-reports:         https://github.com/jtanguy/hmacaroons/issues
 category:            Data
 build-type:          Simple
 extra-source-files:  README.md
+                     CONTRIBUTING.md
+                     CHANGELOG.md
 cabal-version:       >=1.10
+tested-with:         GHC==7.8.4, GHC==7.10.1
+
+source-repository head
+    type:       git
+    branch:     master
+    location:   https://github.com/jtanguy/hmacaroons
 
 library
-  exposed-modules:     Crypto.Macaroon,
-                       Crypto.Macaroon.Binder
+  exposed-modules:     Crypto.Macaroon
+                       -- Crypto.Macaroon.Binder
                        Crypto.Macaroon.Serializer.Base64
+                       Crypto.Macaroon.Verifier
   other-modules:       Crypto.Macaroon.Internal
-  -- other-extensions:    
+                       Crypto.Macaroon.Verifier.Internal
   build-depends:  base >=4 && < 5,
                   attoparsec >=0.12,
+                  transformers >= 0.3,
                   bytestring >=0.10,
                   base64-bytestring >= 1.0,
                   byteable >= 0.1 && <0.2,
                   cereal >= 0.4,
                   cryptohash >=0.11 && <0.12,
-                  cipher-aes >=0.2 && <0.3,
+                  either >=4.4,
+                  -- nonce,
+                  -- cipher-aes >=0.2 && <0.3,
                   deepseq >= 1.1,
                   hex >= 0.1
   hs-source-dirs:      src
   default-language:    Haskell2010
- 
+
 benchmark bench
   default-language: Haskell2010
   type:             exitcode-stdio-1.0
@@ -41,18 +83,20 @@ benchmark bench
                   attoparsec >=0.12,
                   bytestring >=0.10,
                   base64-bytestring >= 1.0,
+                  byteable >= 0.1 && <0.2,
                   cereal >= 0.4,
                   cryptohash >=0.11 && <0.12,
-                  cipher-aes >=0.2 && <0.3,
-                  byteable >= 0.1 && <0.2,
+                  transformers >= 0.3,
+                  -- cipher-aes >=0.2 && <0.3,
+                  either >=4.4,
                   hex >= 0.1,
                   deepseq >= 1.1,
                   criterion >= 1.1
- 
+
 test-suite test
   default-language: Haskell2010
   type: exitcode-stdio-1.0
-  hs-source-dirs: test
+  hs-source-dirs: src, test
   main-is: main.hs
   build-depends:  base >= 4 && <5,
                   attoparsec >=0.12,
@@ -61,8 +105,11 @@ test-suite test
                   byteable >= 0.1 && <0.2,
                   cereal >= 0.4,
                   cryptohash >=0.11 && <0.12,
+                  either >=4.4,
                   hex >= 0.1,
                   tasty >= 0.10,
                   tasty-hunit >= 0.9,
                   tasty-quickcheck >= 0.8,
-                  hmacaroons
+                  QuickCheck >= 2.8,
+                  deepseq >= 1.1,
+                  transformers >= 0.3