From 744b0ef278ed577d3642ea6cf6b1a86cbdc8ad31 Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Fri, 29 Sep 2023 13:04:04 -0400
Subject: [PATCH] haddock for the Key type
---
src/Tahoe/CHK/Cipher.hs | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/src/Tahoe/CHK/Cipher.hs b/src/Tahoe/CHK/Cipher.hs
index 43a45ef..953c6fa 100644
--- a/src/Tahoe/CHK/Cipher.hs
+++ b/src/Tahoe/CHK/Cipher.hs
@@ -16,6 +16,13 @@ import qualified Data.ByteArray as BA
import Data.Coerce (coerce)
import GHC.Generics (Generic)
+{- | A block cipher key which can be deserialized from or serialized to a
+ ByteArray.
+
+ This is a wrapper around Crypto.Cipher.Types.Cipher which does not provide a
+ way to recover the original bytes of the key. We provide this by keeping the
+ original bytes around.
+-}
data Key cipher = Key {keyBytes :: ScrubbedBytes, keyCipher :: cipher}
deriving instance Generic (Key cipher)
--
GitLab