move sized-memory out of lithium

.gitlab-ci.yml

@@ -20,7 +20,7 @@ build:
 coverage:
   stage: coverage
   script:
-    - nix-env -f "<nixpkgs>" -iA git xz make
+    - nix-env -f "<nixpkgs>" -iA git xz gnumake
     - git clone https://github.com/jlengyel/codecov-haskell
     - cd codecov-haskell
     - stack install .

CHANGELOG.md

@@ -4,4 +4,4 @@ lithium uses [Semantic Versioning][].
 The change log is available through the [releases on GitHub][].
 
 [Semantic Versioning]: http://semver.org/spec/v2.0.0.html
-[releases on GitHub]: https://github.com/ether-ash/lithium/releases
+[releases on GitHub]: https://github.com/eth-r/lithium/releases

Crypto/Lithium/Aead.hs

@@ -38,6 +38,7 @@ import Crypto.Lithium.Internal.Util
 import Foundation
 import Control.DeepSeq
 import Data.ByteArray as B
+import Data.ByteArray.Sized
 import Data.ByteString as BS
 
 {-|

Crypto/Lithium/Internal/Util.hs

@@ -3,7 +3,6 @@
 module Crypto.Lithium.Internal.Util
   ( module Foundation.Foreign
   , module Crypto.Lithium.Util.Init
-  , module Crypto.Lithium.Util.Nat
   , module Crypto.Lithium.Util.Phantom
   , module Crypto.Lithium.Util.Random
   , module Crypto.Lithium.Util.Secret
@@ -19,7 +18,6 @@ import Foundation.Foreign
 import System.IO.Unsafe ( unsafePerformIO )
 
 import Crypto.Lithium.Util.Init
-import Crypto.Lithium.Util.Nat
 import Crypto.Lithium.Util.Phantom
 import Crypto.Lithium.Util.Random
 import Crypto.Lithium.Util.Secret

Crypto/Lithium/SecretBox.hs

@@ -32,6 +32,7 @@ module Crypto.Lithium.SecretBox
 import Crypto.Lithium.Unsafe.SecretBox (Key)
 import qualified Crypto.Lithium.Unsafe.SecretBox as U
 import Crypto.Lithium.Internal.Util
+import Data.ByteArray.Sized
 import Foundation
 import Control.DeepSeq
 import Data.ByteString as BS

Crypto/Lithium/Types.hs

@@ -20,31 +20,23 @@ module Crypto.Lithium.Types
   , type Encoder
   , type Decoder
 
-  , N
-  , fromN
-
-  , emptyN
-  , allocRetN
-
-  , maybeToN
-  , coerceToN
-  , convertN
-
-  , appendN
-
-  , takeN'
-  , takeN
-
-  , dropN'
-  , dropN
-
-  , tailN'
-  , tailN
-
-  , splitN'
-  , splitN
-
-  , xorN
+  , Sized
+  , unSized
+
+  , empty
+  , allocRet
+
+  , asSized
+  , coerce
+  , convert
+  , append
+  , append3
+  , take
+  , drop
+  , tail
+  , split
+  , split3
+  , xor
 
   , Secret
 

Crypto/Lithium/Unsafe/Aead.hs

@@ -66,6 +66,7 @@ import Crypto.Lithium.Internal.Util
 import Crypto.Lithium.Unsafe.Types
 
 import Data.ByteArray as B
+import Data.ByteArray.Sized as Sized
 
 import Control.DeepSeq
 import Foundation hiding (splitAt)
@@ -121,7 +122,7 @@ aead (Key key) (Nonce nonce) message aad =
       -- ^ Length of associated data
 
       (_e, ciphertext) = unsafePerformIO $
-        allocRet clen $ \pc ->
+        B.allocRet clen $ \pc ->
         withSecret key $ \pk ->
         withByteArray nonce $ \pn ->
         withByteArray message $ \pm ->
@@ -138,7 +139,7 @@ openAead (Key k) (Nonce n) ciphertext aad =
   withLithium $ -- Ensure Sodium is initialized
 
   let (e, message) = unsafePerformIO $
-        allocRet (B.length ciphertext - macSize) $ \pm ->
+        B.allocRet (B.length ciphertext - macSize) $ \pm ->
         withSecret k $ \pk ->
         withByteArray n $ \pn ->
         withByteArray ciphertext $ \pc ->
@@ -176,7 +177,7 @@ openAeadPrefix (Key key) ciphertext aad =
       -- ^ Length of associated data
 
       (e, message) = unsafePerformIO $
-        allocRet mlen $ \pmessage ->
+        B.allocRet mlen $ \pmessage ->
         withSecret key $ \pkey ->
         withByteArray ciphertext $ \pc ->
         withByteArray aad $ \padata ->
@@ -208,11 +209,11 @@ aeadN :: forall l a.
 aeadN (Key key) (Nonce nonce) secret aad =
   withLithium $
 
-  let mlen = asNum (ByteSize @l)
+  let mlen = theNat @l
       alen = B.length aad
 
       (_e, ciphertext) = unsafePerformIO $
-        allocRetN $ \pc ->
+        Sized.allocRet $ \pc ->
         withSecret key $ \pk ->
         withByteArray nonce $ \pn ->
         withSecret secret $ \pm ->
@@ -230,7 +231,7 @@ openAeadN :: forall l a.
 openAeadN (Key k) (Nonce n) ciphertext aad =
   withLithium $
 
-  let mlen = asNum (ByteSize @l)
+  let mlen = theNat @l
       clen = mlen + macSize
       alen = B.length aad
       (e, message) = unsafePerformIO $
@@ -257,8 +258,8 @@ aeadDetached (Key key) (Nonce nonce) message aad =
       alen = B.length aad
 
       ((_e, mac), ciphertext) = unsafePerformIO $
-        allocRet (B.length message) $ \pc ->
-        allocRetN $ \pmac ->
+        B.allocRet (B.length message) $ \pc ->
+        Sized.allocRet $ \pmac ->
         withSecret key $ \pk ->
         withByteArray nonce $ \pn ->
         withByteArray message $ \pm ->
@@ -278,7 +279,7 @@ openAeadDetached (Key key) (Nonce nonce) (Mac mac) ciphertext aad =
       alen = B.length aad
 
       (e, message) = unsafePerformIO $
-        allocRet clen $ \pm ->
+        B.allocRet clen $ \pm ->
         withSecret key $ \pk ->
         withByteArray nonce $ \pn ->
         withByteArray mac $ \pmac ->
@@ -297,12 +298,12 @@ aeadDetachedN :: forall l a. (KnownNat l, ByteArrayAccess a)
 aeadDetachedN (Key key) (Nonce nonce) message aad =
   withLithium $
 
-  let mlen = asNum (ByteSize @l)
+  let mlen = theNat @l
       alen = B.length aad
 
       ((_e, mac), ciphertext) = unsafePerformIO $
-        allocRetN $ \pc ->
-        allocRetN $ \pmac ->
+        Sized.allocRet $ \pc ->
+        Sized.allocRet $ \pmac ->
         withSecret key $ \pk ->
         withByteArray nonce $ \pn ->
         withSecret message $ \pm ->
@@ -318,7 +319,7 @@ openAeadDetachedN :: forall l a. (KnownNat l, ByteArrayAccess a)
 openAeadDetachedN (Key key) (Nonce nonce) (Mac mac) ciphertext aad =
   withLithium $
 
-  let clen = asNum (ByteSize @l)
+  let clen = theNat @l
       alen = B.length aad
 
       (e, message) = unsafePerformIO $

Crypto/Lithium/Unsafe/Auth.hs

@@ -44,6 +44,7 @@ import Crypto.Lithium.Internal.Util
 import Crypto.Lithium.Unsafe.Types
 
 import Data.ByteArray as B
+import Data.ByteArray.Sized as Sized
 
 import Control.DeepSeq
 import Foundation hiding (splitAt)
@@ -87,7 +88,7 @@ auth (Key key) message =
       -- ^ Length of message
 
       (_e, mac) = unsafePerformIO $
-        allocRetN $ \pmac ->
+        Sized.allocRet $ \pmac ->
         withSecret key $ \pkey ->
         withByteArray message $ \pmessage ->
         sodium_auth pmac

Crypto/Lithium/Unsafe/Box.hs

@@ -109,6 +109,7 @@ import Crypto.Lithium.Unsafe.Types
 import Control.DeepSeq
 import Foundation
 import Data.ByteArray as B
+import Data.ByteArray.Sized as Sized
 
 {-|
 Opaque 'box' secret key type, wrapping the sensitive data in 'ScrubbedBytes' to
@@ -172,7 +173,7 @@ makeKeypair s =
 
 unKeypair :: Keypair -> SecretN (SecretKeyBytes + PublicKeyBytes)
 unKeypair (Keypair (SecretKey sk) (PublicKey pk)) =
-  appendN <$> sk <*> concealN pk
+  Sized.append <$> sk <*> concealN pk
 
 asKeypair :: Decoder Keypair
 asKeypair = decodeSecret makeKeypair
@@ -221,7 +222,7 @@ fromMac = encodeWith unMac
 newKeypair :: IO Keypair
 newKeypair = withLithium $ do
   ((_e, sk), pk) <-
-    allocRetN $ \ppk ->
+    Sized.allocRet $ \ppk ->
     allocSecretN $ \psk ->
     sodium_box_keypair ppk psk
   let sk' = SecretKey sk
@@ -231,7 +232,7 @@ newKeypair = withLithium $ do
 seedKeypair :: Seed -> Keypair
 seedKeypair (Seed s) = withLithium $
   let ((_e, sk), pk) = unsafePerformIO $
-        allocRetN $ \ppk ->
+        Sized.allocRet $ \ppk ->
         allocSecretN $ \psk ->
         withSecret s $ \ps ->
         sodium_box_seed_keypair ppk psk ps
@@ -251,7 +252,7 @@ box (PublicKey pk) (SecretKey sk) (Nonce n) message =
       clen = mlen + macSize
 
       (_e, ciphertext) = unsafePerformIO $
-        allocRet clen $ \pctext ->
+        B.allocRet clen $ \pctext ->
         withByteArray pk $ \ppk ->
         withSecret sk $ \psk ->
         withByteArray n $ \pnonce ->
@@ -270,7 +271,7 @@ openBox (PublicKey pk) (SecretKey sk) (Nonce n) ciphertext =
       mlen = clen - macSize
 
       (e, message) = unsafePerformIO $
-        allocRet mlen $ \pmessage ->
+        B.allocRet mlen $ \pmessage ->
         withByteArray pk $ \ppk ->
         withSecret sk $ \psk ->
         withByteArray n $ \pnonce ->
@@ -310,7 +311,7 @@ openBoxPrefix pk sk ciphertext =
   --     --   ciphertext - (nonce + mac)
 
   --     (e, message) = unsafePerformIO $
-  --       allocRet mlen $ \pmessage ->
+  --       B.allocRet mlen $ \pmessage ->
   --       -- Allocate plaintext
   --       withByteArray pk $ \ppk ->
   --       withSecret sk $ \psk ->
@@ -331,8 +332,8 @@ detachedBox :: ByteOp m c
             => PublicKey -> SecretKey -> Nonce -> m -> (c, Mac)
 detachedBox (PublicKey pk) (SecretKey sk) (Nonce n) message = withLithium $
   let ((_e, mac), ciphertext) = unsafePerformIO $
-        allocRet (B.length message) $ \pc ->
-        allocRetN $ \pmac ->
+        B.allocRet (B.length message) $ \pc ->
+        Sized.allocRet $ \pmac ->
         withByteArray pk $ \ppk ->
         withSecret sk $ \psk ->
         withByteArray n $ \pn ->
@@ -344,7 +345,7 @@ openDetachedBox :: ByteOp c m
                 => PublicKey -> SecretKey -> Nonce -> Mac -> c -> Maybe m
 openDetachedBox (PublicKey pk) (SecretKey sk) (Nonce n) (Mac mac) ciphertext = withLithium $
   let (e, message) = unsafePerformIO $
-        allocRet (B.length ciphertext) $ \pm ->
+        B.allocRet (B.length ciphertext) $ \pm ->
         withByteArray mac $ \pmac ->
         withByteArray pk $ \ppk ->
         withSecret sk $ \psk ->
@@ -405,7 +406,7 @@ box' (SharedKey k) (Nonce n) message =
       clen = mlen + macSize
 
       (_e, ciphertext) = unsafePerformIO $
-        allocRet clen $ \pctext ->
+        B.allocRet clen $ \pctext ->
         withSecret k $ \pkey ->
         withByteArray n $ \pnonce ->
         withByteArray message $ \pmessage ->
@@ -423,7 +424,7 @@ openBox' (SharedKey k) (Nonce n) ciphertext =
       mlen = clen - macSize
 
       (e, message) = unsafePerformIO $
-        allocRet mlen $ \pmessage ->
+        B.allocRet mlen $ \pmessage ->
         withSecret k $ \pkey ->
         withByteArray n $ \pnonce ->
         withByteArray ciphertext $ \pctext ->
@@ -438,8 +439,8 @@ detachedBox' :: ByteOp m c
             => SharedKey -> Nonce -> m -> (c, Mac)
 detachedBox' (SharedKey k) (Nonce n) message = withLithium $
   let ((_e, mac), ciphertext) = unsafePerformIO $
-        allocRet (B.length message) $ \pc ->
-        allocRetN $ \pmac ->
+        B.allocRet (B.length message) $ \pc ->
+        Sized.allocRet $ \pmac ->
         withSecret k $ \pkey ->
         withByteArray n $ \pn ->
         withByteArray message $ \pm ->
@@ -452,7 +453,7 @@ openDetachedBox' :: ByteOp c m
                  => SharedKey -> Nonce -> Mac -> c -> Maybe m
 openDetachedBox' (SharedKey k) (Nonce n) (Mac mac) ciphertext = withLithium $
   let (e, message) = unsafePerformIO $
-        allocRet (B.length ciphertext) $ \pm ->
+        B.allocRet (B.length ciphertext) $ \pm ->
         withByteArray mac $ \pmac ->
         withSecret k $ \pkey ->
         withByteArray n $ \pn ->
@@ -475,7 +476,7 @@ sealBox (PublicKey pk) message =
       clen = mlen + sealSize
 
   (_e, ciphertext) <-
-        allocRet clen $ \pctext ->
+        B.allocRet clen $ \pctext ->
         withByteArray pk $ \ppk ->
         withByteArray message $ \pmessage ->
         sodium_box_seal pctext
@@ -491,7 +492,7 @@ openSealedBox (Keypair (SecretKey sk) (PublicKey pk)) ciphertext =
       mlen = clen - sealSize
 
       (e, message) = unsafePerformIO $
-        allocRet mlen $ \pmessage ->
+        B.allocRet mlen $ \pmessage ->
         withByteArray pk $ \ppk ->
         withSecret sk $ \psk ->
         withByteArray ciphertext $ \pctext ->

Crypto/Lithium/Unsafe/Derive.hs

@@ -49,10 +49,10 @@ import Foundation
 import Control.DeepSeq
 import Data.ByteArray as B
 import Data.ByteString.Char8 as BC
+import Data.ByteArray.Sized as Sized
 
 import Crypto.Lithium.Internal.Util
 import Crypto.Lithium.Internal.Derive
-import Crypto.Lithium.Unsafe.Types
 
 -- deriveable types
 
@@ -153,7 +153,7 @@ Byte arrays longer than 8 bytes are truncated
 Byte arrays shorter than 8 bytes have zeros appended to the value
 -}
 makeContext :: ByteArray a => a -> Context
-makeContext bs = Context $ coerceToN $ B.convert bs
+makeContext bs = Context $ Sized.coerce $ B.convert bs
 
 newtype Subkey (context :: Symbol) subkeyType = Subkey
   { unSubkey :: subkeyType } deriving (Eq, Ord, Show, NFData)
@@ -163,7 +163,7 @@ deriveSecretN :: forall l. (KnownNat l)
 deriveSecretN (MasterKey master) (SubkeyId i) context =
   withLithium $
 
-  let slen = asNum $ ByteSize @l
+  let slen = theNat @l
       (_e, subkey) = unsafePerformIO $
         allocSecretN $ \psubkey ->
         withSecret master $ \pmaster ->