diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,3 @@ +## 0.1.0 + +* Initial release. diff --git a/Data/ContentStore.hs b/Data/ContentStore.hs new file mode 100644 --- /dev/null +++ b/Data/ContentStore.hs @@ -0,0 +1,482 @@ +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE UndecidableInstances #-} + +-- | +-- Module: Data.ContentStore +-- Copyright: (c) 2017 Red Hat, Inc. +-- License: LGPL +-- +-- Maintainer: https://github.com/weldr +-- Stability: alpha +-- Portability: portable +-- +-- Create content stores, put objects into them, and retrieve objects from them. + +module Data.ContentStore(ContentStore, + CsError(..), + CsMonad, + runCsMonad, + contentStoreDigest, + contentStoreValid, + fetchByteString, + fetchByteStringC, + fetchFile, + fetchLazyByteString, + fetchLazyByteStringC, + mkContentStore, + openContentStore, + storeByteString, + storeByteStringC, + storeByteStringSink, + storeDirectory, + storeFile, + storeLazyByteString, + storeLazyByteStringC, + storeLazyByteStringSink) + where + +import Conduit +import Control.Conditional(ifM, unlessM, whenM) +import Control.Monad((>=>), forM, forM_, join, void) +import Control.Monad.Base(MonadBase(..)) +import Control.Monad.Except(ExceptT, MonadError, catchError, runExceptT, throwError) +import Control.Monad.IO.Class(MonadIO, liftIO) +import Control.Monad.Trans.Control(MonadBaseControl(..)) +import Control.Monad.Trans.Resource(MonadResource, MonadThrow, ResourceT, runResourceT) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as LBS +import Data.Maybe(isNothing) +import System.Directory(canonicalizePath, createDirectoryIfMissing, doesDirectoryExist, doesFileExist, listDirectory, removeFile, renameFile) +import System.FilePath(()) +import System.IO(Handle, SeekMode(..)) +import System.IO.Temp(openTempFile) +import System.Posix.IO(FileLock, LockRequest(..), OpenMode(..), closeFd, defaultFileFlags, fdToHandle, getLock, handleToFd, openFd, setLock, waitToSetLock) + +import Data.ContentStore.Config(Config(..), defaultConfig, readConfig, writeConfig) +import Data.ContentStore.Digest + +-- | The ContentStore is an opaque type that contains various pieces of information +-- used to describe an on-disk content store. Values of this type are constructed +-- via 'mkContentStore' and 'openContentStore', depending on which operation you +-- need to perform. Users should not need to concern themselves with the internals +-- of this type. +data ContentStore = ContentStore { + csConfig :: Config, + csRoot :: FilePath, + csHash :: DigestAlgorithm + } + +-- | A type to represent various errors that can occur during content store operations. +data CsError = + -- | Miscellaneous, uncategorized errors. The string is the exact error message. + CsError String + -- | An object with this digest already exists in the content store. This error + -- is not typically raised during write operations, because attempting to write + -- the same thing twice is not really an error. + | CsErrorCollision String + -- | A parse error occurred reading the content store's internal config file. This + -- generally represents either a programming error or that someone has been modifying + -- the internals. The string contains the error message. + | CsErrorConfig String + -- | The content store directory is invalid. This usually occurs because some file + -- or directory is missing. The string is the name of what is missing. + | CsErrorInvalid String + -- | The content store does not exist. + | CsErrorMissing + -- | The requested object does not exist in the content store. The string contains + -- the object digest requested. + | CsErrorNoSuchObject String + -- | The hashing algorithm is not supported by the content store. Not all possible + -- algorithms are supported. The string contains the name of the algorithm requested. + | CsErrorUnsupportedHash String + deriving (Eq, Show) + +-- | Working with a 'ContentStore' requires a lot of behind-the-scenes management of +-- 'ResourceT', 'ExceptT', and 'IO'. Along with 'runCsMonad', this provides a type +-- and function for doing much of that management for you. These two can be used like +-- so: +-- +-- > result <- runCsMonad $ do +-- > cs <- mkContentStore "/tmp/cs.repo" +-- > storeDirectory cs "/tmp/test-data" +-- > +-- > case result of +-- > Left e -> print e +-- > Right d -> do putStrLn "Stored objects: " +-- > mapM_ print d +-- +-- Most functions in this module do not explicitly require use of 'CsMonad', but any +-- that have a return type including 'm' can be run inside it. +newtype CsMonad a = CsMonad { getCsMonad :: ResourceT (ExceptT CsError IO) a } + deriving (Applicative, Functor, Monad, MonadBase IO, MonadError CsError, MonadIO, MonadResource, MonadThrow) + +instance MonadBaseControl IO CsMonad where + type StM CsMonad a = StM (ResourceT (ExceptT CsError IO)) a + liftBaseWith f = CsMonad $ liftBaseWith $ \r -> f (r . getCsMonad) + restoreM = CsMonad . restoreM + +-- | See the documentation for 'CsMonad'. +runCsMonad :: CsMonad a -> IO (Either CsError a) +runCsMonad x = runExceptT $ runResourceT $ getCsMonad x + +csSubdirs :: [String] +csSubdirs = ["objects", "tmp", "lock"] + +-- +-- PRIVATE FUNCTIONS +-- + +-- Objects are stored in the content store in a subdirectory within the objects directory. +-- This function makes sure that path exists. +ensureObjectSubdirectory :: ContentStore -> String -> IO () +ensureObjectSubdirectory cs subdir = + createDirectoryIfMissing True (objectSubdirectoryPath cs subdir) + +-- Assemble the directory path where an object will be stored. +objectSubdirectoryPath :: ContentStore -> String -> FilePath +objectSubdirectoryPath ContentStore{..} subdir = + csRoot "objects" subdir + +-- Where in the content store should an object be stored? This function takes the calculated +-- digest of the object and splits it into a subdirectory and the filename within that +-- directory. +-- +-- This function is used when objects are on the way into the content store. +storedObjectDestination :: ObjectDigest -> (String, String) +storedObjectDestination = storedObjectLocation . toHex + +-- Where in the content store is an object stored? This function takes the digest of the object +-- that we got from somewhere outside of content store code and splits it into a subdirectory +-- and the filename within that directory. +-- +-- This function is used when objects are on the way out of the content store. +storedObjectLocation :: String -> (String, String) +storedObjectLocation = splitAt 2 + +-- Given a content store and a digest, try to find the file containing that object. This +-- does not read the object off the disk. +findObject :: (MonadError CsError m, MonadIO m) => ContentStore -> ObjectDigest -> m FilePath +findObject cs digest = do + let (subdir, filename) = storedObjectDestination digest + path = objectSubdirectoryPath cs subdir filename + + ifM (liftIO $ doesFileExist path) + (return path) + (throwError $ CsErrorNoSuchObject $ toHex digest) + +startStore :: ContentStore -> IO (FilePath, Handle) +startStore ContentStore{..} = do + -- Acquire the global lock to prevent a race between creating the tmp file and locking it. + (path, fd) <- withGlobalLock csRoot $ do + -- Create a new file in the tmp directory + (path, handle) <- openTempFile (csRoot "tmp") "import" + + -- NB: this step closes handle + fd <- handleToFd handle + + -- Lock the file + setLock fd fullLock + + return (path, fd) + + -- Reopen the locked fd as a handle and return + handle' <- fdToHandle fd + return (path, handle') + +finishStore :: ContentStore -> (FilePath, Handle) -> ObjectDigest -> IO () +finishStore cs (tmpPath, handle) digest = do + let (subdir, filename) = storedObjectDestination digest + let path = objectSubdirectoryPath cs subdir filename + + ensureObjectSubdirectory cs subdir + + -- Move the file into the object directory + renameFile tmpPath path + + -- Unlock the file and close the descriptor + fd <- handleToFd handle + setLock fd fullUnlock + closeFd fd + +-- This stores an object that is already (or can be) fully loaded into memory +doStore :: MonadIO m => ContentStore -> (a -> ObjectDigest) -> (Handle -> Consumer a IO ()) -> Conduit a m ObjectDigest +doStore cs hasher writer = awaitForever $ \object -> do + let digest = hasher object + let (subdir, filename) = storedObjectDestination digest + path = objectSubdirectoryPath cs subdir filename + + liftIO $ ensureObjectSubdirectory cs subdir + + -- Only store the object if it does not already exist in the content store. + -- If it's already there, just return the digest. + liftIO $ unlessM (doesFileExist path) $ do + (tmpPath, handle) <- startStore cs + void $ runConduit $ yield object .| writer handle + finishStore cs (tmpPath, handle) digest + + yield digest + +-- Stream data into the content-store without loading all of it at once +doStoreSink :: MonadIO m => ContentStore -> (DigestContext -> a -> DigestContext) -> (Handle -> Sink a m ()) -> Sink a m ObjectDigest +doStoreSink cs hasher writer = do + (tmpPath, handle) <- liftIO $ startStore cs + let initctx = digestInit $ csHash cs + + -- One sink calculates the digest, the other writes the data to the tmp file + (_, digest) <- getZipConduit ((,) <$> ZipConduit (writer handle) + <*> ZipConduit (digestSink initctx)) + + let (subdir, _) = storedObjectDestination digest + + liftIO $ ensureObjectSubdirectory cs subdir + liftIO $ finishStore cs (tmpPath, handle) digest + + return digest + where + digestSink ctx = await >>= \case + Nothing -> return $ digestFinalize ctx + Just chunk -> digestSink $ hasher ctx chunk + +-- lock file management +fullLock :: FileLock +fullLock = (WriteLock, AbsoluteSeek, 0, 0) + +fullUnlock :: FileLock +fullUnlock = (Unlock, AbsoluteSeek, 0, 0) + +withGlobalLock :: MonadIO m => FilePath -> m a -> m a +withGlobalLock csRoot action = do + let lockFile = csRoot "lock" "lockfile" + + -- Create or open the lock file + fd <- liftIO $ openFd lockFile WriteOnly (Just 0o644) defaultFileFlags + + -- Acquire the lock + liftIO $ waitToSetLock fd fullLock + + -- Perform the action + ret <- action + + -- Release the lock + liftIO $ setLock fd fullUnlock >> closeFd fd + + return ret + +-- Cleanup any stale tmp files. These are any files in the tmp directory +-- that are not locked, while the global lock is held. +cleanupTmp :: FilePath -> IO () +cleanupTmp csRoot = withGlobalLock csRoot $ listDirectory (csRoot "tmp") >>= mapM_ cleanupOne + where + cleanupOne :: FilePath -> IO () + cleanupOne tmpFile = do + let fullPath = csRoot tmpFile + fd <- openFd fullPath ReadOnly Nothing defaultFileFlags + whenM (isNothing <$> getLock fd fullLock) $ removeFile fullPath + +-- +-- PUBLIC FUNCTIONS +-- + +-- +-- CONTENT STORE MANAGEMENT +-- + +-- | Check that a content store exists and contains everything it's supposed to. This does +-- not check the validity of all the contents, however. A 'CsError' will be thrown if there +-- are any problems. Otherwise, this function returns True. +contentStoreValid :: (MonadError CsError m, MonadIO m) => FilePath -> m Bool +contentStoreValid fp = do + unlessM (liftIO $ doesDirectoryExist fp) $ + throwError CsErrorMissing + + unlessM (liftIO $ doesFileExist $ fp "config") $ + throwError $ CsErrorInvalid "config" + + forM_ csSubdirs $ \subdir -> + unlessM (liftIO $ doesDirectoryExist $ fp subdir) $ + throwError $ CsErrorInvalid subdir + + return True + +-- | Return the digest type used by a content store. +contentStoreDigest :: ContentStore -> DigestAlgorithm +contentStoreDigest ContentStore{..} = csHash + +-- | Create a new 'ContentStore' on disk, rooted at the path given, and return it as if +-- 'openContentStore' had also been called. If a content store already exists at the +-- given root and is valid, return that as if 'openContentStore' had been called. +-- Various 'CsError's could be thrown by this process. +mkContentStore :: (MonadError CsError m, MonadIO m) => FilePath -> m ContentStore +mkContentStore fp = do + path <- liftIO $ canonicalizePath fp + + csExists <- contentStoreValid path `catchError` \_ -> return False + if csExists then openContentStore path + else do + -- Create the required subdirectories. + mapM_ (\d -> liftIO $ createDirectoryIfMissing True (path d)) + csSubdirs + + -- Write a config file. + liftIO $ writeConfig (path "config") defaultConfig + + openContentStore path + +-- | Return an already existing 'ContentStore', after checking that it is valid. +-- Various 'CsError's could be thrown by this process. +openContentStore :: (MonadError CsError m, MonadIO m) => FilePath -> m ContentStore +openContentStore fp = do + path <- liftIO $ canonicalizePath fp + + void $ contentStoreValid path + + liftIO $ cleanupTmp path + + conf <- liftIO (readConfig $ path "config") >>= \case + Left e -> throwError $ CsErrorConfig (show e) + Right c -> return c + + let algo = confHash conf + + case getDigestAlgorithm algo of + Nothing -> throwError $ CsErrorUnsupportedHash (show algo) + Just da -> return ContentStore { csRoot=path, csConfig=conf, csHash=da } + +-- +-- STRICT BYTE STRING INTERFACE +-- + +-- Like headC, but throws a CsError if the stream is empty. You supply the error message. +headCError :: MonadError CsError m => String -> Consumer a m a +headCError s = + join $ maybe (throwError $ CsError s) return <$> headC + +-- Like headC, but throws a CsErrorNoSuchObject if the stream is empty. You supply the +-- digest of the object that's missing. +headCMissing :: MonadError CsError m => ObjectDigest -> Consumer a m a +headCMissing digest = + join $ maybe (throwError $ CsErrorNoSuchObject (show digest)) return <$> headC + +-- | Lookup and return some previously stored object as a strict 'ByteString'. Note that +-- you'll probably need to use 'fromByteString' to produce an 'ObjectDigest' from whatever +-- text or binary representation you've got from the user/mddb/etc. +fetchByteString :: (MonadBaseControl IO m, MonadError CsError m, MonadIO m, MonadThrow m) => + ContentStore -- ^ An opened 'ContentStore'. + -> ObjectDigest -- ^ The 'ObjectDigest' for some stored object. + -> m BS.ByteString +fetchByteString cs digest = + runConduitRes (yield digest .| fetchByteStringC cs .| headCMissing digest) + +-- | Given an opened 'ContentStore' and a 'Conduit' of 'ObjectDigest's, load each one into +-- a strict 'ByteString' and put it into the conduit. This is useful for stream many +-- objects out of the content store at a time, like with exporting an RPM or other package +-- format. +fetchByteStringC :: (MonadError CsError m, MonadIO m, MonadResource m) => ContentStore -> Conduit ObjectDigest m BS.ByteString +fetchByteStringC cs = awaitForever $ + findObject cs >=> sourceFile + +-- | Store some object into the content store and return its 'ObjectDigest'. If an object +-- with the same digest already exists in the content store, this is a duplicate. Simply +-- return the digest of the already stored object and do nothing else. A 'CsErrorCollision' +-- will NOT be thrown. +storeByteString :: (MonadBaseControl IO m, MonadError CsError m, MonadIO m) => + ContentStore -- ^ An opened 'ContentStore'. + -> BS.ByteString -- ^ An object to be stored, as a strict 'ByteString'. + -> m ObjectDigest +storeByteString cs bs = + runConduitRes (yield bs .| storeByteStringC cs .| headCError "Failed to store object") + +-- | Like 'storeByteString', but read strict 'ByteString's from a 'Conduit' and put their +-- 'ObjectDigest's into the conduit. This is useful for storing many objects at a time, +-- like with importing an RPM or other package format. +storeByteStringC :: (MonadError CsError m, MonadIO m) => ContentStore -> Conduit BS.ByteString m ObjectDigest +storeByteStringC cs = doStore cs (digestByteString $ csHash cs) sinkHandle + +-- | Read in a 'Conduit' of strict 'ByteString's, store the stream into an object in an +-- already opened 'ContentStore', and return the final digest. This is useful for +-- storing a stream of data as a single object. +storeByteStringSink :: MonadIO m => ContentStore -> Sink BS.ByteString m ObjectDigest +storeByteStringSink cs = doStoreSink cs digestUpdate sinkHandle + +-- +-- LAZY BYTE STRING INTERFACE +-- + +-- | Like 'fetchByteString', but uses lazy 'Data.ByteString.Lazy.ByteString's instead. +fetchLazyByteString :: (MonadBaseControl IO m, MonadError CsError m, MonadIO m, MonadThrow m) => + ContentStore + -> ObjectDigest + -> m LBS.ByteString +fetchLazyByteString cs digest = + runConduitRes (yield digest .| fetchLazyByteStringC cs .| headCMissing digest) + +-- | Like 'fetchByteStringC', but uses lazy 'Data.ByteString.Lazy.ByteString's instead. +fetchLazyByteStringC :: (MonadError CsError m, MonadIO m, MonadResource m) => ContentStore -> Conduit ObjectDigest m LBS.ByteString +fetchLazyByteStringC cs = awaitForever $ + findObject cs >=> \path -> sourceFile path .| sinkLazy + +-- | Like 'storeByteString', but uses lazy 'Data.ByteString.Lazy.ByteString's instead. +storeLazyByteString :: (MonadBaseControl IO m, MonadError CsError m, MonadIO m) => + ContentStore + -> LBS.ByteString + -> m ObjectDigest +storeLazyByteString cs bs = + runConduitRes (yield bs .| storeLazyByteStringC cs .| headCError "Failed to store object") + +-- | Like 'storeByteStringC', but uses lazy 'Data.ByteString.Lazy.ByteString's instead. +storeLazyByteStringC :: (MonadError CsError m, MonadIO m) => ContentStore -> Conduit LBS.ByteString m ObjectDigest +storeLazyByteStringC cs = doStore cs (digestLazyByteString $ csHash cs) (\h -> mapC LBS.toStrict .| sinkHandle h) + +-- | Like 'storeByteStringSink', but uses lazy 'Data.ByteString.Lazy.ByteString's instead. +storeLazyByteStringSink :: MonadIO m => ContentStore -> Sink LBS.ByteString m ObjectDigest +storeLazyByteStringSink cs = doStoreSink cs (LBS.foldlChunks digestUpdate) (\h -> mapC LBS.toStrict .| sinkHandle h) + +-- +-- DIRECTORY INTERFACE +-- + +-- | Store all objects in a directory tree in the content store, returning the name and 'ObjectDigest' +-- of each. Note that directories will not be stored. The content store only contains things that +-- have content. If you need to store directory information, that should be handled externally to +-- this module. +storeDirectory :: (MonadBaseControl IO m, MonadError CsError m, MonadIO m, MonadResource m) => + ContentStore -- ^ An opened 'ContentStore'. + -> FilePath -- ^ A directory tree containing many objects. + -> m [(FilePath, ObjectDigest)] +storeDirectory cs fp = do + entries <- runConduit $ sourceDirectoryDeep False fp .| sinkList + forM entries $ \entry -> do + digest <- storeFile cs entry + return (entry, digest) + +-- +-- FILE INTERFACE +-- + +-- | Find some object in the content store and write it to a destination. If the destination already +-- exists, it will be overwritten. If the object does not already exist, a 'CsErrorNoSuchObject' will +-- be thrown. +fetchFile :: (MonadBaseControl IO m, MonadError CsError m, MonadIO m, MonadResource m) => + ContentStore -- ^ An opened 'ContentStore'. + -> ObjectDigest -- ^ The 'ObjectDigest' of some stored object. + -> FilePath -- ^ The destination + -> m () +fetchFile cs digest dest = + runConduitRes $ yield digest .| fetchByteStringC cs .| sinkFile dest + +-- | Store an already existing file in the content store, returning its 'ObjectDigest'. The original +-- file will be left on disk. +storeFile :: (MonadBaseControl IO m, MonadError CsError m, MonadIO m, MonadResource m) => + ContentStore -- ^ An opened 'ContentStore'. + -> FilePath -- ^ The file to be stored. + -> m ObjectDigest +storeFile cs fp = do + lbs <- liftIO $ LBS.readFile fp + storeLazyByteString cs lbs diff --git a/Data/ContentStore/Config.hs b/Data/ContentStore/Config.hs new file mode 100644 --- /dev/null +++ b/Data/ContentStore/Config.hs @@ -0,0 +1,81 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} + +-- | Module: Data.ContentStore.Config +-- Copyright: (c) 2017 Red Hat, Inc. +-- License: LGPL +-- +-- Maintainer: https://github.com/weldr +-- Stability: alpha +-- Portability: portable +-- +-- Manage the content store's internal config file. + +module Data.ContentStore.Config(Config(..), + defaultConfig, + readConfig, + writeConfig) + where + +-- Objects in the store are given file names that are their hash. +-- Lots of hash algorithms are available, which means we need to +-- know which one was used in a given store if we ever want to be +-- able to pull objects back out of it. Thus, a config file. +-- +-- Right now the only thing it's storing is the name of the hash +-- algorithm. This may make using aeson seem like overkill, but +-- most of the config file parsing modules are unpleasant to use +-- and if this config file ever becomes too much more complicated, +-- we'll end up using aeson anyway. Might as well start with it. + +import Data.Aeson +import Data.Aeson.Types(Result(..), parseJSON) +import qualified Data.Text as T +import qualified Data.Text.IO as TIO +import Text.Toml(parseTomlDoc) + +{-# ANN module ("HLint: ignore Use newtype instead of data" :: String) #-} + +-- | Configuration information needed by the content store. +data Config = Config { + -- | What 'DigestAlgorithm' is in use by this content store? While we do support + -- several different algorithms, only one can ever be in use by a single content + -- store. Note that the 'ContentStore' record also stores this piece of + -- information. The difference is that here, we are only storing the text + -- representation as given in a config file. + confHash :: T.Text + } + +instance FromJSON Config where + parseJSON = withObject "Config" $ \v -> + Config <$> v .:? "hash" .!= "BLAKE2b256" + +instance ToJSON Config where + toJSON Config{..} = object [ "hash" .= toJSON confHash ] + +-- | Construct a default 'Config' record useful for when creating a new 'ContentStore', +-- as with 'mkContentStore'. Among other things, this is where the default hash +-- algorithm is defined. +defaultConfig :: Config +defaultConfig = + Config { confHash = "BLAKE2b256" } + +-- | Read a config file on disk, returning the 'Config' record on success and an error +-- message on error. This function is typically not useful outside of content store +-- internals. +readConfig :: FilePath -> IO (Either T.Text Config) +readConfig path = do + contents <- TIO.readFile path + case parseTomlDoc "" contents of + Left err -> return $ Left $ T.pack $ show err + Right tbl -> do let j = toJSON tbl + case (fromJSON j :: Result Config) of + Error err -> return $ Left $ T.pack $ show err + Success c -> return $ Right c + +-- | Write a 'Config' object to disk. This function is typically not useful outside +-- of content store internals. +writeConfig :: FilePath -> Config -> IO () +writeConfig path Config{..} = TIO.writeFile path configText + where + configText = T.concat ["hash = \"", confHash, "\"\n"] diff --git a/Data/ContentStore/Digest.hs b/Data/ContentStore/Digest.hs new file mode 100644 --- /dev/null +++ b/Data/ContentStore/Digest.hs @@ -0,0 +1,130 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE ExistentialQuantification #-} + +-- | +-- Module: Data.ContentStore.Digest +-- Copyright: (c) 2017 Red Hat, Inc. +-- License: LGPL +-- +-- Maintainer: https://github.com/weldr +-- Stability: alpha +-- Portability: portable +-- +-- Functions for working with digest algorithms as used by the content store + +module Data.ContentStore.Digest(DigestAlgorithm, + getDigestAlgorithm, + digestName, + digestSize, + digestInit, + DigestContext, + digestUpdate, + digestUpdates, + digestFinalize, + digestByteString, + digestLazyByteString, + ObjectDigest, + toHex, + fromByteString) + where + +import Crypto.Hash +import Data.ByteArray(Bytes, ByteArrayAccess, convert) +import Data.ByteArray.Encoding(Base(..), convertToBase) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as LBS +import qualified Data.Text as T +import Data.Text.Encoding(decodeUtf8) + +-- cryptonite is about 50% too clever with its types, if you ask me. +-- Here's simpler ones that we can use in ContentStore. + +-- +-- DIGEST TYPES +-- + +-- | A DigestAlgorithm represents one specific hash algorithm. +data DigestAlgorithm = forall a. (HashAlgorithm a, Show a) => DigestAlgorithm a + +-- | Holds the context for a given instance of a 'DigestAlgorithm'. +data DigestContext = forall a. HashAlgorithm a => DigestContext (Context a) + +-- | ObjectDigest is the (binary) representation of a digest. +newtype ObjectDigest = ObjectDigest Bytes + deriving (Eq, Ord, ByteArrayAccess) + +instance Show ObjectDigest where + show (ObjectDigest b) = show b + +-- +-- PRIVATE FUNCTIONS +-- + +fromDigest :: HashAlgorithm a => Digest a -> ObjectDigest +fromDigest = ObjectDigest . convert + +hashLazyWith :: HashAlgorithm a => a -> LBS.ByteString -> Digest a +hashLazyWith _ = hashlazy + +-- +-- PUBLIC FUNCTIONS +-- + +-- | Get the name of this 'DigestAlgorithm'. +digestName :: DigestAlgorithm -> String +digestName (DigestAlgorithm a) = show a + +-- | The size of the 'ObjectDigest' returned by this 'DigestAlgorithm'. +digestSize :: DigestAlgorithm -> Int +digestSize (DigestAlgorithm a) = hashDigestSize a + +-- | Initialize a new 'DigestContext' for this 'DigestAlgorithm'. +digestInit :: DigestAlgorithm -> DigestContext +digestInit (DigestAlgorithm a) = DigestContext $ hashInitWith a + +-- | Update the 'DigestContext' with one 'ByteString'/'Bytes'/etc item. +digestUpdate :: ByteArrayAccess ba => DigestContext -> ba -> DigestContext +digestUpdate (DigestContext ctx) = DigestContext . hashUpdate ctx + +-- | Update the 'DigestContext' with many 'ByteString'/'Bytes'/etc. items. +digestUpdates :: ByteArrayAccess ba => DigestContext -> [ba] -> DigestContext +digestUpdates (DigestContext ctx) = DigestContext . hashUpdates ctx + +-- | Finish the digest, returning an 'ObjectDigest'. +digestFinalize :: DigestContext -> ObjectDigest +digestFinalize (DigestContext ctx) = fromDigest $ hashFinalize ctx + +-- | Hash a strict 'ByteString' into an 'ObjectDigest'. +digestByteString :: DigestAlgorithm -> BS.ByteString -> ObjectDigest +digestByteString (DigestAlgorithm a) = fromDigest . hashWith a + +-- | Hash a lazy 'Data.ByteString.Lazy.ByteString' into an 'ObjectDigest'. +digestLazyByteString :: DigestAlgorithm -> LBS.ByteString -> ObjectDigest +digestLazyByteString (DigestAlgorithm a) = fromDigest . hashLazyWith a + +-- | Check and convert a 'ByteString' into an 'ObjectDigest'. +fromByteString :: ByteArrayAccess ba => DigestAlgorithm -> ba -> Maybe ObjectDigest +fromByteString (DigestAlgorithm a) = fmap fromDigest . digestFromByteStringWith a +-- helper for above +digestFromByteStringWith :: (HashAlgorithm a, ByteArrayAccess ba) => a -> ba -> Maybe (Digest a) +digestFromByteStringWith _ = digestFromByteString + +-- | Convert an 'ObjectDigest' to its hex representation. +-- TODO: probably more efficient if we can just coerce the converted Bytes.. +toHex :: ObjectDigest -> String +toHex = T.unpack . decodeUtf8 . convertToBase Base16 + + +-- | Given the 'Text' name of a digest algorithm, return a 'DigestAlgorithm' +-- (or Nothing if we don't recognize the DigestAlgorithm's name). +getDigestAlgorithm :: T.Text -> Maybe DigestAlgorithm +getDigestAlgorithm "SHA256" = Just $ DigestAlgorithm SHA256 +getDigestAlgorithm "SHA512" = Just $ DigestAlgorithm SHA512 +getDigestAlgorithm "BLAKE2" = Just $ DigestAlgorithm Blake2b_512 +getDigestAlgorithm "BLAKE2b" = Just $ DigestAlgorithm Blake2b_512 +getDigestAlgorithm "BLAKE2b512" = Just $ DigestAlgorithm Blake2b_512 +getDigestAlgorithm "BLAKE2b256" = Just $ DigestAlgorithm Blake2b_256 +getDigestAlgorithm "BLAKE2s" = Just $ DigestAlgorithm Blake2s_256 +getDigestAlgorithm "BLAKE2s256" = Just $ DigestAlgorithm Blake2s_256 +getDigestAlgorithm _ = Nothing diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/content-store.cabal b/content-store.cabal new file mode 100644 --- /dev/null +++ b/content-store.cabal @@ -0,0 +1,66 @@ +name: content-store +version: 0.1.0 +synopsis: Store and retrieve data from an on-disk store +description: This module provides a way to store and retrieve arbitrary + data from an on-disk store, similar to how a source + control system works but without the assumptions of such + a system. +homepage: https://github.com/weldr/content-store +category: System +author: Chris Lumens +maintainer: clumens@redhat.com +license: LGPL +license-file: LICENSE +build-type: Simple +cabal-version: >= 1.10 + +extra-source-files: ChangeLog.md, + tests/*.hs, + tests/Data/*.hs, + tests/Data/ContentStore/*.hs + +source-repository head + type: git + location: https://github.com/weldr/content-store + +library + exposed-modules: Data.ContentStore, + Data.ContentStore.Config, + Data.ContentStore.Digest + + build-depends: aeson >= 1.2.2.0 && < 1.3.0.0, + base >= 4.9 && < 5.0, + bytestring >= 0.10 && < 0.11, + cond >= 0.4.1.1 && < 0.5.0.0, + conduit >= 1.0.11 && < 1.3, + conduit-combinators >= 1.1.0 && < 1.2, + conduit-extra >= 1.1.0 && < 1.2, + cryptonite >= 0.22 && < 0.30, + directory >= 1.3.0.0 && < 1.4.0.0, + filepath >= 1.4.1.1 && < 1.5.0.0, + htoml >= 1.0.0.0 && < 1.1.0.0, + monad-control >= 1.0.2.2 && < 1.1.0.0, + memory >= 0.14.3 && < 0.15.0, + mtl >= 2.2.1 && < 2.3, + resourcet >= 1.1.9 && < 1.2, + temporary >= 1.2.1.1 && < 1.3.0.0, + text >= 1.2.2.2 && < 1.3, + transformers >= 0.5.2.0 && < 0.6.0.0, + transformers-base >= 0.4.4 && < 0.5.0, + unix >= 2.7.2.1 && < 2.8.0.0 + + default-language: Haskell2010 + ghc-options: -Wall + +test-suite spec + type: exitcode-stdio-1.0 + main-is: Spec.hs + hs-source-dirs: tests + build-depends: base == 4.*, + bytestring >= 0.10 && < 0.11, + hspec == 2.*, + memory >= 0.14.3 && < 0.15.0, + content-store + + default-language: Haskell2010 + ghc-options: -Wall diff --git a/tests/Data/ContentStore/DigestSpec.hs b/tests/Data/ContentStore/DigestSpec.hs new file mode 100644 --- /dev/null +++ b/tests/Data/ContentStore/DigestSpec.hs @@ -0,0 +1,52 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Data.ContentStore.DigestSpec(spec) where + +import Test.Hspec +import Data.Maybe(fromJust) +import Data.ContentStore.Digest +import qualified Data.ByteString as B +import qualified Data.ByteArray as BA + +testInput :: B.ByteString +testInput = "The Dude abides." + +testSHA256Digest :: B.ByteString +testSHA256Digest = "\xcd\x9c\xf3\x08\x62\x61\x24\xa7\x81\x81\xc0\x22\xfb\x9d\x0d\x51\x1a\xf1\xc1\x5d\x32\x20\x12\xf0\xa6\x9d\xfe\x86\x40\xc3\x40\xaa" + +testSHA256Hex :: String +testSHA256Hex = "cd9cf308626124a78181c022fb9d0d511af1c15d322012f0a69dfe8640c340aa" + +spec :: Spec +spec = do + describe "Digest.DigestAlgorithm" $ do + it "knows about SHA256" $ + digestName <$> getDigestAlgorithm "SHA256" `shouldBe` Just "SHA256" + + let daSHA256 = fromJust $ getDigestAlgorithm "SHA256" + it "has the correct size for SHA256" $ + digestSize daSHA256 `shouldBe` 32 + + let od = digestByteString daSHA256 testInput + let hex = toHex od + + it "does SHA256 correctly" $ + BA.convert od `shouldBe` testSHA256Digest + + it "converts ObjectDigest to hex" $ + hex `shouldBe` testSHA256Hex + + describe "Digest.DigestContext" $ do + let da = fromJust $ getDigestAlgorithm "SHA256" + let ctx = digestInit da + it "can do digests piece by piece" $ do + let hex = toHex $ digestFinalize $ digestUpdate ctx testInput + hex `shouldBe` testSHA256Hex + + describe "fromByteString" $ do + let da = fromJust $ getDigestAlgorithm "SHA256" + let od = digestByteString da testInput + it "accepts a 32-byte ByteString" $ + fromByteString da testSHA256Digest `shouldBe` Just od + it "rejects wrong-sized ByteString" $ + fromByteString da (B.take 20 testSHA256Digest) `shouldBe` Nothing diff --git a/tests/Data/ContentStoreSpec.hs b/tests/Data/ContentStoreSpec.hs new file mode 100644 --- /dev/null +++ b/tests/Data/ContentStoreSpec.hs @@ -0,0 +1,10 @@ +module Data.ContentStoreSpec(spec) where + +import Test.Hspec +import Data.ContentStore + +spec :: Spec +spec = + describe "ContentStore" $ + it "has dummy test" $ + () `shouldBe` () diff --git a/tests/Spec.hs b/tests/Spec.hs new file mode 100644 --- /dev/null +++ b/tests/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-}