2 files changed, 85 insertions, 14 deletions
diff --git a/src/Data/Digest.hs b/src/Data/Digest.hs
index 336b38d..a17c438 100644
--- a/src/Data/Digest.hs
+++ b/src/Data/Digest.hs
@@ -12,15 +12,33 @@
 -- License for the specific language governing permissions and limitations under
 -- the License.
 
+{-|
+  Module: Data.Digest
+  Description: Cryptographic hash functions
+  Copyright: 2017 Google LLC
+  License: Apache License, version 2.0
+
+  Cryptographic hash functions.
+-}
 module Data.Digest
-  ( Algorithm
-  , Digest
+  ( -- * Computing digests
+    Digest
   , hash
+
+    -- * Digest algorithms
+  , Algorithm
+
+    -- ** SHA-2 family
+    -- | The SHA-2 family of hash functions is defined in
+    -- [FIPS 180-4](https://csrc.nist.gov/publications/detail/fips/180/4/final).
+  , sha224, sha256, sha384, sha512
+
+    -- * Legacy functions
   , md5
   , sha1
-  , sha224, sha256, sha384, sha512
   ) where
 
+import qualified Data.ByteString.Lazy as Lazy (ByteString)
 import qualified Data.ByteString.Lazy as ByteString.Lazy
 import Foreign (withForeignPtr)
 import Foreign.Marshal.Unsafe (unsafeLocalState)
@@ -30,18 +48,44 @@ import BTLS.BoringSSL.Digest
 import BTLS.Buffer (onBufferOfMaxSize)
 import BTLS.Types (Algorithm(Algorithm), Digest(Digest))
 
-type LazyByteString = ByteString.Lazy.ByteString
+-- | Message Digest 5, a 128-bit digest defined in
+-- [RFC 1321](https://tools.ietf.org/html/rfc1321). This algorithm is
+-- cryptographically broken; do not use it except to interface with legacy
+-- applications.
+md5 :: Algorithm
+md5 = Algorithm evpMD5
+
+-- | Secure Hash Algorithm 1, a 160-bit digest defined in
+-- [FIPS 180-4](https://csrc.nist.gov/publications/detail/fips/180/4/final).
+-- Hashing with this algorithm is cryptographically broken, although
+-- constructing HMACs with it is safe.
+sha1 :: Algorithm
+sha1 = Algorithm evpSHA1
 
-md5, sha1, sha224, sha256, sha384, sha512 :: Algorithm
-md5    = Algorithm evpMD5
-sha1   = Algorithm evpSHA1
+-- | The SHA224 digest, a 224-bit digest and Secure Hash Algorithm 2 family
+-- member.
+sha224 :: Algorithm
 sha224 = Algorithm evpSHA224
+
+-- | The SHA256 digest, a 256-bit digest and Secure Hash Algorithm 2 family
+-- member. Prefer this algorithm on 32-bit CPUs; it will run faster than
+-- 'sha384' or 'sha512'.
+sha256 :: Algorithm
 sha256 = Algorithm evpSHA256
+
+-- | The SHA384 digest, a 384-bit digest and Secure Hash Algorithm 2 family
+-- member.
+sha384 :: Algorithm
 sha384 = Algorithm evpSHA384
+
+-- | The SHA512 digest, a 512-bit digest and Secure Hash Algorithm 2 family
+-- member. Prefer this algorithm on 64-bit CPUs; it will run faster than
+-- 'sha224' or 'sha256'.
+sha512 :: Algorithm
 sha512 = Algorithm evpSHA512
 
 -- | Hashes according to the given 'Algorithm'.
-hash :: Algorithm -> LazyByteString -> Digest
+hash :: Algorithm -> Lazy.ByteString -> Digest
 hash (Algorithm md) bytes =
   unsafeLocalState $ do
     ctxFP <- mallocEVPMDCtx
diff --git a/src/Data/HMAC.hs b/src/Data/HMAC.hs
index bf1bef8..fb67817 100644
--- a/src/Data/HMAC.hs
+++ b/src/Data/HMAC.hs
@@ -12,15 +12,43 @@
 -- License for the specific language governing permissions and limitations under
 -- the License.
 
+{-|
+  Module: Data.HMAC
+  Description: Hash-based message authentication codes
+  Copyright: 2018 Google LLC
+  License: Apache License, version 2.0
+
+  Hash-based message authentication codes (HMACs). An HMAC guarantees
+  authenticity but not confidentiality.
+-}
 module Data.HMAC
-  ( SecretKey(SecretKey)
-  , HMAC, Result
+  ( -- * Computing HMACs
+    HMAC
   , hmac
+
+    -- * Cryptographic hash algorithms
+  , Algorithm
+  , sha1
+
+    -- ** SHA-2 family
+    -- | The SHA-2 family of hash functions is defined in
+    -- [FIPS 180-4](https://csrc.nist.gov/publications/detail/fips/180/4/final).
+  , sha224, sha256, sha384, sha512
+
+    -- * Keys
+  , SecretKey(SecretKey)
+
+    -- * Error handling
+  , Error
+
+    -- * Legacy functions
+  , md5
   ) where
 
 import Control.Monad.Trans.Class (lift)
 import Control.Monad.Trans.Except (runExceptT)
 import Data.ByteString (ByteString)
+import qualified Data.ByteString.Lazy as Lazy (ByteString)
 import qualified Data.ByteString.Lazy as ByteString.Lazy
 import qualified Data.ByteString.Unsafe as ByteString
 import Foreign (withForeignPtr)
@@ -31,10 +59,9 @@ import BTLS.BoringSSL.Digest (evpMaxMDSize)
 import BTLS.BoringSSL.HMAC
 import BTLS.BoringSSL.Mem (cryptoMemcmp)
 import BTLS.Buffer (onBufferOfMaxSize)
-import BTLS.Result (Result, check)
+import BTLS.Result (Error, check)
 import BTLS.Types (Algorithm(Algorithm), Digest(Digest), SecretKey(SecretKey))
-
-type LazyByteString = ByteString.Lazy.ByteString
+import Data.Digest (md5, sha1, sha224, sha256, sha384, sha512)
 
 -- | A hash-based message authentication code. Equality comparisons on this type
 -- are constant-time.
@@ -51,7 +78,7 @@ instance Show HMAC where
   show (HMAC m) = show (Digest m)
 
 -- | Creates an HMAC according to the given 'Algorithm'.
-hmac :: Algorithm -> SecretKey -> LazyByteString -> Result HMAC
+hmac :: Algorithm -> SecretKey -> Lazy.ByteString -> Either [Error] HMAC
 hmac (Algorithm md) (SecretKey key) bytes =
   unsafeLocalState $ do
     ctxFP <- mallocHMACCtx