aboutsummaryrefslogtreecommitdiff
path: root/src/BTLS/Types.hs
diff options
context:
space:
mode:
Diffstat (limited to 'src/BTLS/Types.hs')
-rw-r--r--src/BTLS/Types.hs6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/BTLS/Types.hs b/src/BTLS/Types.hs
index 06b5173..44b29bc 100644
--- a/src/BTLS/Types.hs
+++ b/src/BTLS/Types.hs
@@ -31,7 +31,10 @@ newtype Algorithm = Algorithm (Ptr EVPMD)
newtype AssociatedData = AssociatedData ByteString
deriving (Eq, Ord, Show)
--- | The result of a hash operation.
+-- | The result of a hash operation. Equality comparisons on this type are
+-- variable-time.
+--
+-- The 'Show' instance for this type displays the digest as a hexadecimal string.
newtype Digest = Digest ByteString
deriving (Eq, Ord)
@@ -46,6 +49,7 @@ instance Show Digest where
newtype Salt = Salt ByteString
deriving (Eq, Ord, Show)
+-- | A special value used to request that no salt be used.
noSalt :: Salt
noSalt = Salt ByteString.empty