Replace SomeNamedDigest with DSum HashAlgo Digest

Co-Authored-By: Richard Marko <[email protected]>

Author: Ericson2314

cabal.project

@@ -2,5 +2,9 @@ packages:
   ./hnix-store-core/hnix-store-core.cabal
   ./hnix-store-remote/hnix-store-remote.cabal
 
+-- till https://github.com/obsidiansystems/dependent-sum/pull/80
+allow-newer:
+  dependent-sum:some
+
 package hnix-store-remote
   flags: +build-readme +io-testsuite

hnix-store-core/hnix-store-core.cabal

@@ -87,6 +87,8 @@ library
     , containers
     , constraints-extras
     , data-default-class
+    , dependent-sum > 0.7
+    , dependent-sum-template > 0.1.1 && < 0.2
     , generic-arbitrary < 1.1
     -- Required for cryptonite low-level type convertion
     , memory

hnix-store-core/src/System/Nix/Hash.hs

@@ -13,7 +13,6 @@ module System.Nix.Hash
   , NamedAlgo(..)
   , algoToText
   , textToAlgo
-  , SomeNamedDigest(..)
   , mkNamedDigest
 
   , mkStorePathHash
@@ -22,13 +21,17 @@ module System.Nix.Hash
   , encodeDigestWith
   , decodeDigestWith
 
+  , algoDigestBuilder
   , digestBuilder
   ) where
 
 import Crypto.Hash (Digest, HashAlgorithm, MD5(..), SHA1(..), SHA256(..), SHA512(..))
 import Data.ByteString (ByteString)
 import Data.Constraint.Extras (Has(has))
 import Data.Constraint.Extras.TH (deriveArgDict)
+import Data.Dependent.Sum (DSum((:=>)))
+import Data.GADT.Compare.TH (deriveGEq, deriveGCompare)
+import Data.GADT.Show.TH (deriveGShow)
 import Data.Kind (Type)
 import Data.Some (Some(Some))
 import Data.Text (Text)
@@ -81,13 +84,16 @@ data HashAlgo :: Type -> Type where
   HashAlgo_SHA256 :: HashAlgo SHA256
   HashAlgo_SHA512 :: HashAlgo SHA512
 
+deriveGEq ''HashAlgo
+deriveGCompare ''HashAlgo
+deriveGShow ''HashAlgo
 deriveArgDict ''HashAlgo
 
 algoToText :: forall t. HashAlgo t -> Text
 algoToText x = has @NamedAlgo x (algoName @t)
 
-_hashAlgoValue :: HashAlgo a -> a
-_hashAlgoValue = \case
+hashAlgoValue :: HashAlgo a -> a
+hashAlgoValue = \case
   HashAlgo_MD5 -> MD5
   HashAlgo_SHA1 -> SHA1
   HashAlgo_SHA256 -> SHA256
@@ -101,44 +107,20 @@ textToAlgo = \case
     "sha512" -> Right $ Some HashAlgo_SHA512
     name     -> Left $ "Unknown hash name: " <> Data.Text.unpack name
 
--- | A digest whose 'NamedAlgo' is not known at compile time.
-data SomeNamedDigest = forall a . NamedAlgo a => SomeDigest (Digest a)
-
-instance Arbitrary SomeNamedDigest where
+instance Arbitrary (DSum HashAlgo Digest)  where
   arbitrary = oneof
-    [ SomeDigest @MD5 <$> arbitrary
-    , SomeDigest @SHA1 <$> arbitrary
-    , SomeDigest @SHA256 <$> arbitrary
-    , SomeDigest @SHA512 <$> arbitrary
+    [ (HashAlgo_MD5 :=>)    <$> arbitrary
+    , (HashAlgo_SHA1 :=>)   <$> arbitrary
+    , (HashAlgo_SHA256 :=>) <$> arbitrary
+    , (HashAlgo_SHA512 :=>) <$> arbitrary
     ]
 
-instance Show SomeNamedDigest where
-  show sd = case sd of
-    SomeDigest (digest :: Digest hashType) ->
-      Data.Text.unpack $ "SomeDigest"
-      <> " "
-      <> algoName @hashType
-      <> ":"
-      <> encodeDigestWith NixBase32 digest
-
-instance Eq SomeNamedDigest where
-  (==) (SomeDigest (a :: Digest aType))
-       (SomeDigest (b :: Digest bType))
-    = algoName @aType == algoName @bType
-      && encodeDigestWith NixBase32 a == encodeDigestWith NixBase32 b
-
-instance Ord SomeNamedDigest where
-  (<=) (SomeDigest (a :: Digest aType))
-       (SomeDigest (b :: Digest bType))
-    = algoName @aType <= algoName @bType
-      && encodeDigestWith NixBase32 a <= encodeDigestWith NixBase32 b
-
--- | Make @SomeNamedDigest@ based on provided SRI hash name
+-- | Make @DSum HashAlgo Digest@ based on provided SRI hash name
 -- and its encoded form
 mkNamedDigest
   :: Text -- ^ SRI name
   -> Text -- ^ base encoded hash
-  -> Either String SomeNamedDigest
+  -> Either String (DSum HashAlgo Digest)
 mkNamedDigest name sriHash =
   let (sriName, h) = Data.Text.breakOnEnd "-" sriHash in
     if sriName == "" || sriName == name <> "-"
@@ -154,13 +136,10 @@ mkNamedDigest name sriHash =
       <> " "
       <> name
  where
-  mkDigest h = case name of
-    "md5"    -> SomeDigest <$> decodeGo MD5    h
-    "sha1"   -> SomeDigest <$> decodeGo SHA1   h
-    "sha256" -> SomeDigest <$> decodeGo SHA256 h
-    "sha512" -> SomeDigest <$> decodeGo SHA512 h
-    _        -> Left $ "Unknown hash name: " <> Data.Text.unpack name
-  decodeGo :: forall a . NamedAlgo a => a -> Text -> Either String (Digest a)
+  mkDigest h =
+    textToAlgo name
+    >>= \(Some a) -> has @HashAlgorithm a $ fmap (a :=>) $ decodeGo a h
+  decodeGo :: HashAlgorithm a => HashAlgo a -> Text -> Either String (Digest a)
   decodeGo a h
     | size == base16Len = decodeDigestWith Base16 h
     | size == base32Len = decodeDigestWith NixBase32 h
@@ -181,7 +160,7 @@ mkNamedDigest name sriHash =
         <> Data.Text.pack (show [base16Len, base32Len, base64Len])
    where
     size = Data.Text.length h
-    hsize = Crypto.Hash.hashDigestSize a
+    hsize = Crypto.Hash.hashDigestSize (hashAlgoValue a)
     base16Len = hsize * 2
     base32Len = ((hsize * 8 - 1) `div` 5) + 1;
     base64Len = ((4 * hsize `div` 3) + 3) `div` 4 * 4;
@@ -227,3 +206,10 @@ digestBuilder digest =
   <> ":"
   <> Data.Text.Lazy.Builder.fromText
       (System.Nix.Hash.encodeDigestWith NixBase32 digest)
+
+-- | Builder for @DSum HashAlgo Digest@s
+algoDigestBuilder :: DSum HashAlgo Digest -> Builder
+algoDigestBuilder (a :=> d) =
+  Data.Text.Lazy.Builder.fromText (System.Nix.Hash.algoToText a)
+  <> ":"
+  <> Data.Text.Lazy.Builder.fromText (encodeDigestWith NixBase32 d)

hnix-store-core/src/System/Nix/StorePath/Metadata.hs

@@ -6,13 +6,15 @@ module System.Nix.StorePath.Metadata
   , StorePathTrust(..)
   ) where
 
+import Crypto.Hash (Digest)
+import Data.Dependent.Sum (DSum)
 import Data.HashSet (HashSet)
 import Data.Set (Set)
 import Data.Time (UTCTime)
 import Data.Word (Word64)
 import GHC.Generics (Generic)
 
-import System.Nix.Hash (SomeNamedDigest)
+import System.Nix.Hash (HashAlgo)
 import System.Nix.Signature (NarSignature)
 import System.Nix.ContentAddress (ContentAddress)
 
@@ -38,7 +40,7 @@ data Metadata a = Metadata
     deriverPath :: !(Maybe a)
   , -- TODO should this be optional?
     -- | The hash of the nar serialization of the path.
-    narHash :: !SomeNamedDigest
+    narHash :: !(DSum HashAlgo Digest)
   , -- | The paths that this path directly references
     references :: !(HashSet a)
   , -- | When was this path registered valid in the store?

hnix-store-remote/hnix-store-remote.cabal

@@ -80,10 +80,11 @@ library
     , containers
     , cryptonite
     , data-default-class
+    , dependent-sum > 0.7 && < 1
     , text
     , time
     , network
-    , nix-derivation >= 1.1.1 && <2
+    , nix-derivation >= 1.1.1 && < 2
     , mtl
     , unordered-containers
     , hnix-store-core >= 0.7 && <0.8

hnix-store-remote/src/System/Nix/Store/Remote.hs

@@ -30,12 +30,14 @@ module System.Nix.Store.Remote
   , module System.Nix.Store.Remote.Types
   ) where
 
+import Data.Dependent.Sum (DSum((:=>)))
 import Data.HashSet (HashSet)
 import Data.Map (Map)
 import Data.Text (Text)
 import qualified Control.Monad
 import qualified Data.Attoparsec.ByteString.Char8
 import qualified Data.Text.Encoding
+import qualified System.Nix.Hash
 --
 import qualified Data.ByteString.Lazy          as BSL
 
@@ -44,7 +46,6 @@ import           System.Nix.Build               ( BuildMode
                                                 , BuildResult
                                                 )
 import           System.Nix.Hash                ( NamedAlgo(..)
-                                                , SomeNamedDigest(..)
                                                 , BaseEncoding(NixBase32)
                                                 , decodeDigestWith
                                                 )
@@ -237,7 +238,7 @@ queryPathInfoUncached path = do
         decodeDigestWith @SHA256 NixBase32 narHashText
         of
         Left  e -> error e
-        Right x -> SomeDigest x
+        Right d -> System.Nix.Hash.HashAlgo_SHA256 :=> d
 
   references       <- sockGetPaths
   registrationTime <- sockGet getTime

hnix-store-remote/src/System/Nix/Store/Remote/Util.hs

@@ -25,7 +25,7 @@ import           Network.Socket.ByteString      ( recv
 import           Nix.Derivation
 
 import           System.Nix.Build
-import           System.Nix.StorePath
+import           System.Nix.StorePath (StoreDir, StorePath, InvalidPathError, parsePath, storePathToRawFilePath)
 import           System.Nix.Store.Remote.Binary
 import           System.Nix.Store.Remote.Types