c4aba8e032
Now it's run in VerifyStage. I thought about keeping the file handle open, and resuming reading where tailVerify left off. But that risks leaking open file handles, until the GC closes them, if the deferred verification does not get resumed. Since that could perhaps happen if there's an exception somewhere, I decided that was too unsafe. Instead, re-open the file, seek, and resume. Sponsored-by: Dartmouth College's DANDI project
61 lines
2.2 KiB
Haskell
61 lines
2.2 KiB
Haskell
{- git-annex key backend data type
|
|
-
|
|
- Most things should not need this, using Types instead
|
|
-
|
|
- Copyright 2010-2021 Joey Hess <id@joeyh.name>
|
|
-
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
|
-}
|
|
|
|
module Types.Backend where
|
|
|
|
import Types.Key
|
|
import Types.KeySource
|
|
import Utility.Metered
|
|
import Utility.FileSystemEncoding
|
|
|
|
import Data.ByteString (ByteString)
|
|
|
|
data BackendA a = Backend
|
|
{ backendVariety :: KeyVariety
|
|
, genKey :: Maybe (KeySource -> MeterUpdate -> a Key)
|
|
-- Verifies the content of a key, stored in a file, using a hash.
|
|
-- This does not need to be cryptographically secure.
|
|
, verifyKeyContent :: Maybe (Key -> RawFilePath -> a Bool)
|
|
-- Incrementally verifies the content of a key, using the same
|
|
-- hash as verifyKeyContent, but with the content provided
|
|
-- incrementally a peice at a time, until finalized.
|
|
, verifyKeyContentIncrementally :: Maybe (Key -> a IncrementalVerifier)
|
|
-- Checks if a key can be upgraded to a better form.
|
|
, canUpgradeKey :: Maybe (Key -> Bool)
|
|
-- Checks if there is a fast way to migrate a key to a different
|
|
-- backend (ie, without re-hashing).
|
|
, fastMigrate :: Maybe (Key -> BackendA a -> AssociatedFile -> a (Maybe Key))
|
|
-- Checks if a key is known (or assumed) to always refer to the
|
|
-- same data.
|
|
, isStableKey :: Key -> Bool
|
|
-- Checks if a key is verified using a cryptographically secure hash.
|
|
, isCryptographicallySecure :: Key -> Bool
|
|
}
|
|
|
|
instance Show (BackendA a) where
|
|
show backend = "Backend { name =\"" ++ decodeBS (formatKeyVariety (backendVariety backend)) ++ "\" }"
|
|
|
|
instance Eq (BackendA a) where
|
|
a == b = backendVariety a == backendVariety b
|
|
|
|
data IncrementalVerifier = IncrementalVerifier
|
|
{ updateIncremental :: ByteString -> IO ()
|
|
-- ^ Called repeatedly on each peice of the content.
|
|
, finalizeIncremental :: IO Bool
|
|
-- ^ Called once the full content has been sent, returns true
|
|
-- if the hash verified.
|
|
, failIncremental :: IO ()
|
|
-- ^ Call if the incremental verification needs to fail.
|
|
, positionIncremental :: IO (Maybe Integer)
|
|
-- ^ Returns the number of bytes that have been fed to this
|
|
-- incremental verifier so far. (Nothing if failIncremental was
|
|
-- called.)
|
|
, descVerify :: String
|
|
-- ^ A description of what is done to verify the content.
|
|
}
|