Core: Internal: Base: (-> Nix)Base32

To name it honestly. It is not a standard Base32 encoding.

NixBase32 needs specific treatment over the stack (now & in the future), so it
is better to distinquish it from default encoding.

Author: Anton-Latukha

hnix-store-core/src/System/Nix/Internal/Base.hs

@@ -10,6 +10,6 @@ import System.Nix.Internal.Base32
 -- | Constructors to indicate the base encodings
 data BaseEncoding
   = Base16
-  | Base32
+  | NixBase32
   -- | ^ Nix has a special map of Base32 encoding
   | Base64

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

@@ -35,7 +35,7 @@ import qualified GHC.TypeLits           as Kind
                                         (Nat, KnownNat, natVal)
 import           Data.Coerce            (coerce)
 import           System.Nix.Internal.Base
-                                        (BaseEncoding(Base16,Base32,Base64))
+                                        (BaseEncoding(Base16,NixBase32,Base64))
 
 -- | The universe of supported hash algorithms.
 --
@@ -55,7 +55,7 @@ newtype Digest (a :: HashAlgorithm) =
   Digest BS.ByteString deriving (Eq, Ord, DataHashable.Hashable)
 
 instance Show (Digest a) where
-  show = ("Digest " <>) . show . encodeInBase Base32
+  show = ("Digest " <>) . show . encodeInBase NixBase32
 
 -- | The primitive interface for incremental hashing for a given
 -- 'HashAlgorithm'. Every 'HashAlgorithm' should have an instance.
@@ -97,7 +97,7 @@ data SomeNamedDigest = forall a . NamedAlgo a => SomeDigest (Digest a)
 
 instance Show SomeNamedDigest where
   show sd = case sd of
-    SomeDigest (digest :: Digest hashType) -> T.unpack $ "SomeDigest " <> algoName @hashType <> ":" <> encodeInBase Base32 digest
+    SomeDigest (digest :: Digest hashType) -> T.unpack $ "SomeDigest " <> algoName @hashType <> ":" <> encodeInBase NixBase32 digest
 
 mkNamedDigest :: Text -> Text -> Either String SomeNamedDigest
 mkNamedDigest name sriHash =
@@ -115,7 +115,7 @@ mkNamedDigest name sriHash =
   decodeGo :: forall a . (NamedAlgo a, ValidAlgo a) => Text -> Either String (Digest a)
   decodeGo h
     | size == base16Len = decodeBase Base16 h
-    | size == base32Len = decodeBase Base32 h
+    | size == base32Len = decodeBase NixBase32 h
     | size == base64Len = decodeBase Base64 h
     | otherwise = Left $ T.unpack sriHash <> " is not a valid " <> T.unpack name <> " hash. Its length (" <> show size <> ") does not match any of " <> show [base16Len, base32Len, base64Len]
    where
@@ -149,7 +149,7 @@ hashLazy bsl =
 -- | Take BaseEncoding type of the output -> take the Digeest as input -> encode Digest
 encodeInBase :: BaseEncoding -> Digest a -> T.Text
 encodeInBase Base16 = T.decodeUtf8 . Base16.encode . coerce
-encodeInBase Base32 = Base32.encode . coerce
+encodeInBase NixBase32 = Base32.encode . coerce
 encodeInBase Base64 = T.decodeUtf8 . Base64.encode . coerce
 
 
@@ -164,7 +164,7 @@ decodeBase Base16 = lDecode  -- this tacit sugar simply makes GHC pleased with n
     (x, "") -> Right $ Digest x
     _       -> Left $ "Unable to decode base16 string" <> T.unpack t
 #endif
-decodeBase Base32 = fmap Digest . Base32.decode
+decodeBase NixBase32 = fmap Digest . Base32.decode
 decodeBase Base64 = fmap Digest . Base64.decode . T.encodeUtf8
 
 

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

@@ -154,7 +154,7 @@ storePathToRawFilePath StorePath{..} =
   root <> "/" <> hashPart <> "-" <> name
  where
   root     = Bytes.Char8.pack storePathRoot
-  hashPart = Text.encodeUtf8 $ encodeInBase Base32 storePathHash
+  hashPart = Text.encodeUtf8 $ encodeInBase NixBase32 storePathHash
   name     = Text.encodeUtf8 $ unStorePathName storePathName
 
 -- | Render a 'StorePath' as a 'FilePath'.
@@ -169,7 +169,7 @@ storePathToText = Text.pack . Bytes.Char8.unpack . storePathToRawFilePath
 -- can be used to query binary caches.
 storePathToNarInfo :: StorePath -> Bytes.Char8.ByteString
 storePathToNarInfo StorePath{..} =
-  Text.encodeUtf8 $ encodeInBase Base32 storePathHash <> ".narinfo"
+  Text.encodeUtf8 $ encodeInBase NixBase32 storePathHash <> ".narinfo"
 
 -- | Parse `StorePath` from `Bytes.Char8.ByteString`, checking
 -- that store directory matches `expectedRoot`.
@@ -178,7 +178,7 @@ parsePath expectedRoot x =
   let
     (rootDir, fname) = FilePath.splitFileName . Bytes.Char8.unpack $ x
     (digestPart, namePart) = Text.breakOn "-" $ Text.pack fname
-    digest = decodeBase Base32 digestPart
+    digest = decodeBase NixBase32 digestPart
     name = makeStorePathName . Text.drop 1 $ namePart
     --rootDir' = dropTrailingPathSeparator rootDir
     -- cannot use ^^ as it drops multiple slashes /a/b/// -> /a/b
@@ -200,7 +200,7 @@ pathParser expectedRoot = do
       <?> "Expecting path separator"
 
   digest <-
-    decodeBase Base32
+    decodeBase NixBase32
     <$> Parser.Text.Lazy.takeWhile1 (`elem` Nix.Base32.digits32)
       <?> "Invalid Base32 part"
 

hnix-store-core/tests/Hash.hs

@@ -27,13 +27,13 @@ spec_hash = do
   describe "hashing parity with nix-store" $ do
 
     it "produces (base32 . sha256) of \"nix-output:foo\" the same as Nix does at the moment for placeholder \"foo\"" $
-      shouldBe (encodeInBase Base32 (hash @'SHA256 "nix-output:foo"))
+      shouldBe (encodeInBase NixBase32 (hash @'SHA256 "nix-output:foo"))
                "1x0ymrsy7yr7i9wdsqy9khmzc1yy7nvxw6rdp72yzn50285s67j5"
     it "produces (base16 . md5) of \"Hello World\" the same as the thesis" $
       shouldBe (encodeInBase Base16 (hash @'MD5 "Hello World"))
                "b10a8db164e0754105b7a99be72e3fe5"
     it "produces (base32 . sha1) of \"Hello World\" the same as the thesis" $
-      shouldBe (encodeInBase Base32 (hash @'SHA1 "Hello World"))
+      shouldBe (encodeInBase NixBase32 (hash @'SHA1 "Hello World"))
                "s23c9fs0v32pf6bhmcph5rbqsyl5ak8a"
 
     -- The example in question:
@@ -46,7 +46,7 @@ spec_hash = do
         "xv2iccirbrvklck36f1g7vldn5v58vck"
    where
     encodeInBase32 :: Digest a -> Text
-    encodeInBase32 = encodeInBase Base32
+    encodeInBase32 = encodeInBase NixBase32
 
 -- | Test that Nix-like base32 encoding roundtrips
 prop_nixBase32Roundtrip :: Property