Safe Haskell	None
Language	Haskell2010

Hackage.Security.Server

Contents

Re-exports

Description

Main entry point into the Hackage Security framework for clients

Synopsis

data DeserializationError
- = DeserializationErrorMalformed String
- | DeserializationErrorSchema String
- | DeserializationErrorUnknownKey KeyId
- | DeserializationErrorValidation String
- | DeserializationErrorFileType String String
data ReadJSON_Keys_Layout a
data ReadJSON_Keys_NoLayout a
data ReadJSON_NoKeys_NoLayout a
parseJSON_Keys_Layout :: FromJSON ReadJSON_Keys_Layout a => KeyEnv -> RepoLayout -> ByteString -> Either DeserializationError a
parseJSON_Keys_NoLayout :: FromJSON ReadJSON_Keys_NoLayout a => KeyEnv -> ByteString -> Either DeserializationError a
parseJSON_NoKeys_NoLayout :: FromJSON ReadJSON_NoKeys_NoLayout a => ByteString -> Either DeserializationError a
readJSON_Keys_Layout :: (FsRoot root, FromJSON ReadJSON_Keys_Layout a) => KeyEnv -> RepoLayout -> Path root -> IO (Either DeserializationError a)
readJSON_Keys_NoLayout :: (FsRoot root, FromJSON ReadJSON_Keys_NoLayout a) => KeyEnv -> Path root -> IO (Either DeserializationError a)
readJSON_NoKeys_NoLayout :: (FsRoot root, FromJSON ReadJSON_NoKeys_NoLayout a) => Path root -> IO (Either DeserializationError a)
data WriteJSON a
renderJSON :: ToJSON WriteJSON a => RepoLayout -> a -> ByteString
renderJSON_NoLayout :: ToJSON Identity a => a -> ByteString
writeJSON :: ToJSON WriteJSON a => RepoLayout -> Path Absolute -> a -> IO ()
writeJSON_NoLayout :: ToJSON Identity a => Path Absolute -> a -> IO ()
class ToJSON (m :: Type -> Type) a where
- toJSON :: a -> m JSValue
class FromJSON (m :: Type -> Type) a where
- fromJSON :: JSValue -> m a
data Key a where
- KeyEd25519 :: PublicKey -> SecretKey -> Key Ed25519
sign :: PrivateKey typ -> ByteString -> ByteString
data Ed25519
data PublicKey a where
- PublicKeyEd25519 :: PublicKey -> PublicKey Ed25519
data PrivateKey a where
- PrivateKeyEd25519 :: SecretKey -> PrivateKey Ed25519
data KeyType typ where
- KeyTypeEd25519 :: KeyType Ed25519
somePublicKey :: Some Key -> Some PublicKey
somePublicKeyType :: Some PublicKey -> Some KeyType
someKeyId :: forall (key :: Type -> Type). HasKeyId key => Some key -> KeyId
publicKey :: Key a -> PublicKey a
privateKey :: Key a -> PrivateKey a
createKey :: KeyType key -> IO (Key key)
createKey' :: KeyType key -> IO (Some Key)
newtype KeyId = KeyId {
- keyIdString :: String
}
class HasKeyId (key :: Type -> Type) where
- keyId :: key typ -> KeyId
verify :: PublicKey typ -> ByteString -> ByteString -> Bool
data Signed a = Signed {
- signed :: a
- signatures :: Signatures
}
data Signature = Signature {
- signature :: ByteString
- signatureKey :: Some PublicKey
}
data IndexFile a where
- IndexPkgMetadata :: PackageIdentifier -> IndexFile (Signed Targets)
- IndexPkgCabal :: PackageIdentifier -> IndexFile ()
- IndexPkgPrefs :: PackageName -> IndexFile ()
data FileMap
data TargetPath
- = TargetPathRepo RepoPath
- | TargetPathIndex IndexPath
data FileChange
- = FileChanged FileInfo
- | FileDeleted
fileMapChanges :: FileMap -> FileMap -> Map TargetPath FileChange
data FileInfo = FileInfo {
- fileInfoLength :: FileLength
- fileInfoHashes :: Map HashFn Hash
}
data Int54
data Header = Header {
- headerExpires :: FileExpires
- headerVersion :: FileVersion
}
data Mirrors = Mirrors {
- mirrorsVersion :: FileVersion
- mirrorsExpires :: FileExpires
- mirrorsMirrors :: [Mirror]
}
data Root = Root {
- rootVersion :: FileVersion
- rootExpires :: FileExpires
- rootKeys :: KeyEnv
- rootRoles :: RootRoles
}
data Snapshot = Snapshot {
- snapshotVersion :: FileVersion
- snapshotExpires :: FileExpires
- snapshotInfoRoot :: FileInfo
- snapshotInfoMirrors :: FileInfo
- snapshotInfoTarGz :: FileInfo
- snapshotInfoTar :: Maybe FileInfo
}
data Targets = Targets {
- targetsVersion :: FileVersion
- targetsExpires :: FileExpires
- targetsTargets :: FileMap
- targetsDelegations :: Maybe Delegations
}
data Timestamp = Timestamp {
- timestampVersion :: FileVersion
- timestampExpires :: FileExpires
- timestampInfoSnapshot :: FileInfo
}
newtype FileLength = FileLength {
- fileLength :: Int54
}
newtype Hash = Hash String
newtype KeyThreshold = KeyThreshold Int54
data HashFn
- = HashFnSHA256
- | HashFnMD5
fileInfo :: ByteString -> FileInfo
computeFileInfo :: FsRoot root => Path root -> IO FileInfo
compareTrustedFileInfo :: FileInfo -> FileInfo -> Bool
knownFileInfoEqual :: FileInfo -> FileInfo -> Bool
fileInfoSHA256 :: FileInfo -> Maybe Hash
class HasHeader a where
- fileExpires :: Lens' a FileExpires
- fileVersion :: Lens' a FileVersion
newtype FileVersion = FileVersion Int54
newtype FileExpires = FileExpires (Maybe UTCTime)
expiresInDays :: UTCTime -> Integer -> FileExpires
expiresNever :: FileExpires
isExpired :: UTCTime -> FileExpires -> Bool
versionInitial :: FileVersion
versionIncrement :: FileVersion -> FileVersion
data CacheLayout = CacheLayout {
- cacheLayoutRoot :: CachePath
- cacheLayoutTimestamp :: CachePath
- cacheLayoutSnapshot :: CachePath
- cacheLayoutMirrors :: CachePath
- cacheLayoutIndexTar :: CachePath
- cacheLayoutIndexIdx :: CachePath
- cacheLayoutIndexTarGz :: CachePath
}
cabalCacheLayout :: CacheLayout
data IndexLayout = IndexLayout {
- indexFileToPath :: forall dec. IndexFile dec -> IndexPath
- indexFileFromPath :: IndexPath -> Maybe (Some IndexFile)
}
hackageIndexLayout :: IndexLayout
indexLayoutPkgMetadata :: IndexLayout -> PackageIdentifier -> IndexPath
indexLayoutPkgCabal :: IndexLayout -> PackageIdentifier -> IndexPath
indexLayoutPkgPrefs :: IndexLayout -> PackageName -> IndexPath
data RepoLayout = RepoLayout {
- repoLayoutRoot :: RepoPath
- repoLayoutTimestamp :: RepoPath
- repoLayoutSnapshot :: RepoPath
- repoLayoutMirrors :: RepoPath
- repoLayoutIndexTarGz :: RepoPath
- repoLayoutIndexTar :: RepoPath
- repoLayoutPkgTarGz :: PackageIdentifier -> RepoPath
}
hackageRepoLayout :: RepoLayout
cabalLocalRepoLayout :: RepoLayout
data Mirror = Mirror {
- mirrorUrlBase :: URI
- mirrorContent :: MirrorContent
}
data MirrorContent = MirrorFull
type MirrorDescription = String
describeMirror :: Mirror -> MirrorDescription
data RepoRoot
type RepoPath = Path RepoRoot
anchorRepoPathLocally :: Path root -> RepoPath -> Path root
anchorRepoPathRemotely :: Path Web -> RepoPath -> Path Web
data IndexRoot
type IndexPath = Path IndexRoot
data CacheRoot
type CachePath = Path CacheRoot
anchorCachePath :: Path root -> CachePath -> Path root
data Delegation = Delegation (Pattern a) (Replacement a)
data RootRoles = RootRoles {
- rootRolesRoot :: RoleSpec Root
- rootRolesSnapshot :: RoleSpec Snapshot
- rootRolesTargets :: RoleSpec Targets
- rootRolesTimestamp :: RoleSpec Timestamp
- rootRolesMirrors :: RoleSpec Mirrors
}
data RoleSpec a = RoleSpec {
- roleSpecKeys :: [Some PublicKey]
- roleSpecThreshold :: KeyThreshold
}
newtype Signatures = Signatures [Signature]
unsigned :: a -> Signed a
withSignatures :: ToJSON WriteJSON a => RepoLayout -> [Some Key] -> a -> Signed a
withSignatures' :: ToJSON Identity a => [Some Key] -> a -> Signed a
signRendered :: [Some Key] -> ByteString -> Signatures
verifySignature :: ByteString -> Signature -> Bool
signedFromJSON :: (MonadKeys m, FromJSON m a) => JSValue -> m (Signed a)
verifySignatures :: JSValue -> Signatures -> Bool
data UninterpretedSignatures a = UninterpretedSignatures {
- uninterpretedSigned :: a
- uninterpretedSignatures :: [PreSignature]
}
data PreSignature = PreSignature {
- presignature :: ByteString
- presigMethod :: Some KeyType
- presigKeyId :: KeyId
}
fromPreSignature :: MonadKeys m => PreSignature -> m Signature
fromPreSignatures :: MonadKeys m => [PreSignature] -> m Signatures
toPreSignature :: Signature -> PreSignature
toPreSignatures :: Signatures -> [PreSignature]
data Delegations = Delegations {
- delegationsKeys :: KeyEnv
- delegationsRoles :: [DelegationSpec]
}
data DelegationSpec = DelegationSpec {
- delegationSpecKeys :: [Some PublicKey]
- delegationSpecThreshold :: KeyThreshold
- delegation :: Delegation
}
targetsLookup :: TargetPath -> Targets -> Maybe FileInfo

Re-exports

data DeserializationError Source #

Constructors

DeserializationErrorMalformed String	Malformed JSON has syntax errors in the JSON itself (i.e., we cannot even parse it to a JSValue)
DeserializationErrorSchema String	Invalid JSON has valid syntax but invalid structure The string gives a hint about what we expected instead
DeserializationErrorUnknownKey KeyId	The JSON file contains a key ID of an unknown key
DeserializationErrorValidation String	Some verification step failed
DeserializationErrorFileType String String	Wrong file type Records actual and expected types.

Instances

Instances details

Exception DeserializationError Source #
Instance details Defined in Hackage.Security.JSON Methods toException :: DeserializationError -> SomeException # fromException :: SomeException -> Maybe DeserializationError # displayException :: DeserializationError -> String #
Show DeserializationError Source #
Instance details Defined in Hackage.Security.JSON Methods showsPrec :: Int -> DeserializationError -> ShowS # show :: DeserializationError -> String # showList :: [DeserializationError] -> ShowS #
Pretty DeserializationError Source #
Instance details Defined in Hackage.Security.JSON Methods pretty :: DeserializationError -> String Source #
MonadError DeserializationError ReadJSON_Keys_Layout Source #
Instance details Defined in Hackage.Security.JSON Methods throwError :: DeserializationError -> ReadJSON_Keys_Layout a # catchError :: ReadJSON_Keys_Layout a -> (DeserializationError -> ReadJSON_Keys_Layout a) -> ReadJSON_Keys_Layout a #
MonadError DeserializationError ReadJSON_Keys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods throwError :: DeserializationError -> ReadJSON_Keys_NoLayout a # catchError :: ReadJSON_Keys_NoLayout a -> (DeserializationError -> ReadJSON_Keys_NoLayout a) -> ReadJSON_Keys_NoLayout a #
MonadError DeserializationError ReadJSON_NoKeys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods throwError :: DeserializationError -> ReadJSON_NoKeys_NoLayout a # catchError :: ReadJSON_NoKeys_NoLayout a -> (DeserializationError -> ReadJSON_NoKeys_NoLayout a) -> ReadJSON_NoKeys_NoLayout a #

data ReadJSON_Keys_Layout a Source #

Instances

Instances details

Applicative ReadJSON_Keys_Layout Source #
Instance details Defined in Hackage.Security.JSON Methods pure :: a -> ReadJSON_Keys_Layout a # (<>) :: ReadJSON_Keys_Layout (a -> b) -> ReadJSON_Keys_Layout a -> ReadJSON_Keys_Layout b # liftA2 :: (a -> b -> c) -> ReadJSON_Keys_Layout a -> ReadJSON_Keys_Layout b -> ReadJSON_Keys_Layout c # (>) :: ReadJSON_Keys_Layout a -> ReadJSON_Keys_Layout b -> ReadJSON_Keys_Layout b # (<*) :: ReadJSON_Keys_Layout a -> ReadJSON_Keys_Layout b -> ReadJSON_Keys_Layout a #
Functor ReadJSON_Keys_Layout Source #
Instance details Defined in Hackage.Security.JSON Methods fmap :: (a -> b) -> ReadJSON_Keys_Layout a -> ReadJSON_Keys_Layout b # (<$) :: a -> ReadJSON_Keys_Layout b -> ReadJSON_Keys_Layout a #
Monad ReadJSON_Keys_Layout Source #
Instance details Defined in Hackage.Security.JSON Methods (>>=) :: ReadJSON_Keys_Layout a -> (a -> ReadJSON_Keys_Layout b) -> ReadJSON_Keys_Layout b # (>>) :: ReadJSON_Keys_Layout a -> ReadJSON_Keys_Layout b -> ReadJSON_Keys_Layout b # return :: a -> ReadJSON_Keys_Layout a #
MonadKeys ReadJSON_Keys_Layout Source #
Instance details Defined in Hackage.Security.JSON Methods localKeys :: (KeyEnv -> KeyEnv) -> ReadJSON_Keys_Layout a -> ReadJSON_Keys_Layout a Source # askKeys :: ReadJSON_Keys_Layout KeyEnv Source #
ReportSchemaErrors ReadJSON_Keys_Layout Source #
Instance details Defined in Hackage.Security.JSON Methods expected :: Expected -> Maybe Got -> ReadJSON_Keys_Layout a Source #
MonadError DeserializationError ReadJSON_Keys_Layout Source #
Instance details Defined in Hackage.Security.JSON Methods throwError :: DeserializationError -> ReadJSON_Keys_Layout a # catchError :: ReadJSON_Keys_Layout a -> (DeserializationError -> ReadJSON_Keys_Layout a) -> ReadJSON_Keys_Layout a #
MonadReader RepoLayout ReadJSON_Keys_Layout Source #
Instance details Defined in Hackage.Security.JSON Methods ask :: ReadJSON_Keys_Layout RepoLayout # local :: (RepoLayout -> RepoLayout) -> ReadJSON_Keys_Layout a -> ReadJSON_Keys_Layout a # reader :: (RepoLayout -> a) -> ReadJSON_Keys_Layout a #

data ReadJSON_Keys_NoLayout a Source #

Instances

Instances details

Applicative ReadJSON_Keys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods pure :: a -> ReadJSON_Keys_NoLayout a # (<>) :: ReadJSON_Keys_NoLayout (a -> b) -> ReadJSON_Keys_NoLayout a -> ReadJSON_Keys_NoLayout b # liftA2 :: (a -> b -> c) -> ReadJSON_Keys_NoLayout a -> ReadJSON_Keys_NoLayout b -> ReadJSON_Keys_NoLayout c # (>) :: ReadJSON_Keys_NoLayout a -> ReadJSON_Keys_NoLayout b -> ReadJSON_Keys_NoLayout b # (<*) :: ReadJSON_Keys_NoLayout a -> ReadJSON_Keys_NoLayout b -> ReadJSON_Keys_NoLayout a #
Functor ReadJSON_Keys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods fmap :: (a -> b) -> ReadJSON_Keys_NoLayout a -> ReadJSON_Keys_NoLayout b # (<$) :: a -> ReadJSON_Keys_NoLayout b -> ReadJSON_Keys_NoLayout a #
Monad ReadJSON_Keys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods (>>=) :: ReadJSON_Keys_NoLayout a -> (a -> ReadJSON_Keys_NoLayout b) -> ReadJSON_Keys_NoLayout b # (>>) :: ReadJSON_Keys_NoLayout a -> ReadJSON_Keys_NoLayout b -> ReadJSON_Keys_NoLayout b # return :: a -> ReadJSON_Keys_NoLayout a #
MonadKeys ReadJSON_Keys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods localKeys :: (KeyEnv -> KeyEnv) -> ReadJSON_Keys_NoLayout a -> ReadJSON_Keys_NoLayout a Source # askKeys :: ReadJSON_Keys_NoLayout KeyEnv Source #
ReportSchemaErrors ReadJSON_Keys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods expected :: Expected -> Maybe Got -> ReadJSON_Keys_NoLayout a Source #
MonadError DeserializationError ReadJSON_Keys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods throwError :: DeserializationError -> ReadJSON_Keys_NoLayout a # catchError :: ReadJSON_Keys_NoLayout a -> (DeserializationError -> ReadJSON_Keys_NoLayout a) -> ReadJSON_Keys_NoLayout a #

data ReadJSON_NoKeys_NoLayout a Source #

Instances

Instances details

Applicative ReadJSON_NoKeys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods pure :: a -> ReadJSON_NoKeys_NoLayout a # (<>) :: ReadJSON_NoKeys_NoLayout (a -> b) -> ReadJSON_NoKeys_NoLayout a -> ReadJSON_NoKeys_NoLayout b # liftA2 :: (a -> b -> c) -> ReadJSON_NoKeys_NoLayout a -> ReadJSON_NoKeys_NoLayout b -> ReadJSON_NoKeys_NoLayout c # (>) :: ReadJSON_NoKeys_NoLayout a -> ReadJSON_NoKeys_NoLayout b -> ReadJSON_NoKeys_NoLayout b # (<*) :: ReadJSON_NoKeys_NoLayout a -> ReadJSON_NoKeys_NoLayout b -> ReadJSON_NoKeys_NoLayout a #
Functor ReadJSON_NoKeys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods fmap :: (a -> b) -> ReadJSON_NoKeys_NoLayout a -> ReadJSON_NoKeys_NoLayout b # (<$) :: a -> ReadJSON_NoKeys_NoLayout b -> ReadJSON_NoKeys_NoLayout a #
Monad ReadJSON_NoKeys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods (>>=) :: ReadJSON_NoKeys_NoLayout a -> (a -> ReadJSON_NoKeys_NoLayout b) -> ReadJSON_NoKeys_NoLayout b # (>>) :: ReadJSON_NoKeys_NoLayout a -> ReadJSON_NoKeys_NoLayout b -> ReadJSON_NoKeys_NoLayout b # return :: a -> ReadJSON_NoKeys_NoLayout a #
ReportSchemaErrors ReadJSON_NoKeys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods expected :: Expected -> Maybe Got -> ReadJSON_NoKeys_NoLayout a Source #
MonadError DeserializationError ReadJSON_NoKeys_NoLayout Source #
Instance details Defined in Hackage.Security.JSON Methods throwError :: DeserializationError -> ReadJSON_NoKeys_NoLayout a # catchError :: ReadJSON_NoKeys_NoLayout a -> (DeserializationError -> ReadJSON_NoKeys_NoLayout a) -> ReadJSON_NoKeys_NoLayout a #

parseJSON_Keys_Layout :: FromJSON ReadJSON_Keys_Layout a => KeyEnv -> RepoLayout -> ByteString -> Either DeserializationError a Source #

parseJSON_Keys_NoLayout :: FromJSON ReadJSON_Keys_NoLayout a => KeyEnv -> ByteString -> Either DeserializationError a Source #

parseJSON_NoKeys_NoLayout :: FromJSON ReadJSON_NoKeys_NoLayout a => ByteString -> Either DeserializationError a Source #

readJSON_Keys_Layout :: (FsRoot root, FromJSON ReadJSON_Keys_Layout a) => KeyEnv -> RepoLayout -> Path root -> IO (Either DeserializationError a) Source #

readJSON_Keys_NoLayout :: (FsRoot root, FromJSON ReadJSON_Keys_NoLayout a) => KeyEnv -> Path root -> IO (Either DeserializationError a) Source #

readJSON_NoKeys_NoLayout :: (FsRoot root, FromJSON ReadJSON_NoKeys_NoLayout a) => Path root -> IO (Either DeserializationError a) Source #

data WriteJSON a Source #

Instances

Instances details

Applicative WriteJSON Source #
Instance details Defined in Hackage.Security.JSON Methods pure :: a -> WriteJSON a # (<>) :: WriteJSON (a -> b) -> WriteJSON a -> WriteJSON b # liftA2 :: (a -> b -> c) -> WriteJSON a -> WriteJSON b -> WriteJSON c # (>) :: WriteJSON a -> WriteJSON b -> WriteJSON b # (<*) :: WriteJSON a -> WriteJSON b -> WriteJSON a #
Functor WriteJSON Source #
Instance details Defined in Hackage.Security.JSON Methods fmap :: (a -> b) -> WriteJSON a -> WriteJSON b # (<$) :: a -> WriteJSON b -> WriteJSON a #
Monad WriteJSON Source #
Instance details Defined in Hackage.Security.JSON Methods (>>=) :: WriteJSON a -> (a -> WriteJSON b) -> WriteJSON b # (>>) :: WriteJSON a -> WriteJSON b -> WriteJSON b # return :: a -> WriteJSON a #
MonadReader RepoLayout WriteJSON Source #
Instance details Defined in Hackage.Security.JSON Methods ask :: WriteJSON RepoLayout # local :: (RepoLayout -> RepoLayout) -> WriteJSON a -> WriteJSON a # reader :: (RepoLayout -> a) -> WriteJSON a #

renderJSON :: ToJSON WriteJSON a => RepoLayout -> a -> ByteString Source #

Render to canonical JSON format

renderJSON_NoLayout :: ToJSON Identity a => a -> ByteString Source #

Variation on renderJSON for files that don't require the repo layout

writeJSON :: ToJSON WriteJSON a => RepoLayout -> Path Absolute -> a -> IO () Source #

writeJSON_NoLayout :: ToJSON Identity a => Path Absolute -> a -> IO () Source #

class ToJSON (m :: Type -> Type) a where Source #

Methods

toJSON :: a -> m JSValue Source #

Instances

Instances details

Monad m => ToJSON m KeyEnv Source #
Instance details Defined in Hackage.Security.Key.Env Methods toJSON :: KeyEnv -> m JSValue Source #
Monad m => ToJSON m FileLength Source #
Instance details Defined in Hackage.Security.TUF.Common Methods toJSON :: FileLength -> m JSValue Source #
Monad m => ToJSON m Hash Source #
Instance details Defined in Hackage.Security.TUF.Common Methods toJSON :: Hash -> m JSValue Source #
Monad m => ToJSON m KeyThreshold Source #
Instance details Defined in Hackage.Security.TUF.Common Methods toJSON :: KeyThreshold -> m JSValue Source #
Monad m => ToJSON m FileInfo Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods toJSON :: FileInfo -> m JSValue Source #
Monad m => ToJSON m FileMap Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods toJSON :: FileMap -> m JSValue Source #
Monad m => ToJSON m FileExpires Source #
Instance details Defined in Hackage.Security.TUF.Header Methods toJSON :: FileExpires -> m JSValue Source #
Monad m => ToJSON m FileVersion Source #
Instance details Defined in Hackage.Security.TUF.Header Methods toJSON :: FileVersion -> m JSValue Source #
Monad m => ToJSON m Mirror Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods toJSON :: Mirror -> m JSValue Source #
Monad m => ToJSON m Mirrors Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods toJSON :: Mirrors -> m JSValue Source #
Monad m => ToJSON m Root Source #
Instance details Defined in Hackage.Security.TUF.Root Methods toJSON :: Root -> m JSValue Source #
Monad m => ToJSON m RootRoles Source #
Instance details Defined in Hackage.Security.TUF.Root Methods toJSON :: RootRoles -> m JSValue Source #
Monad m => ToJSON m PreSignature Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods toJSON :: PreSignature -> m JSValue Source #
Monad m => ToJSON m Signatures Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods toJSON :: Signatures -> m JSValue Source #
MonadReader RepoLayout m => ToJSON m Snapshot Source #
Instance details Defined in Hackage.Security.TUF.Snapshot Methods toJSON :: Snapshot -> m JSValue Source #
Monad m => ToJSON m DelegationSpec Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods toJSON :: DelegationSpec -> m JSValue Source #
Monad m => ToJSON m Delegations Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods toJSON :: Delegations -> m JSValue Source #
Monad m => ToJSON m Targets Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods toJSON :: Targets -> m JSValue Source #
MonadReader RepoLayout m => ToJSON m Timestamp Source #
Instance details Defined in Hackage.Security.TUF.Timestamp Methods toJSON :: Timestamp -> m JSValue Source #
Monad m => ToJSON m Int54 Source #
Instance details Defined in Hackage.Security.Util.JSON Methods toJSON :: Int54 -> m JSValue Source #
Monad m => ToJSON m JSValue Source #
Instance details Defined in Hackage.Security.Util.JSON Methods toJSON :: JSValue -> m JSValue Source #
Monad m => ToJSON m URI Source #
Instance details Defined in Hackage.Security.Util.JSON Methods toJSON :: URI -> m JSValue Source #
Monad m => ToJSON m UTCTime Source #
Instance details Defined in Hackage.Security.Util.JSON Methods toJSON :: UTCTime -> m JSValue Source #
Monad m => ToJSON m String Source #
Instance details Defined in Hackage.Security.Util.JSON Methods toJSON :: String -> m JSValue Source #
Monad m => ToJSON m (Key typ) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: Key typ -> m JSValue Source #
Monad m => ToJSON m (KeyType typ) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: KeyType typ -> m JSValue Source #
Monad m => ToJSON m (PublicKey typ) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: PublicKey typ -> m JSValue Source #
Monad m => ToJSON m (RoleSpec a) Source #
Instance details Defined in Hackage.Security.TUF.Root Methods toJSON :: RoleSpec a -> m JSValue Source #
(Monad m, ToJSON m a) => ToJSON m (Signed a) Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods toJSON :: Signed a -> m JSValue Source #
(Monad m, ToJSON m a) => ToJSON m (UninterpretedSignatures a) Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods toJSON :: UninterpretedSignatures a -> m JSValue Source #
Monad m => ToJSON m (Some Key) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: Some Key -> m JSValue Source #
Monad m => ToJSON m (Some KeyType) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: Some KeyType -> m JSValue Source #
Monad m => ToJSON m (Some PublicKey) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: Some PublicKey -> m JSValue Source #
(Monad m, ToJSON m a) => ToJSON m [a] Source #
Instance details Defined in Hackage.Security.Util.JSON Methods toJSON :: [a] -> m JSValue Source #
(Monad m, ToObjectKey m k, ToJSON m a) => ToJSON m (Map k a) Source #
Instance details Defined in Hackage.Security.Util.JSON Methods toJSON :: Map k a -> m JSValue Source #

class FromJSON (m :: Type -> Type) a where Source #

Methods

fromJSON :: JSValue -> m a Source #

Instances

Instances details

ReportSchemaErrors m => FromJSON m KeyEnv Source #
Instance details Defined in Hackage.Security.Key.Env Methods fromJSON :: JSValue -> m KeyEnv Source #
ReportSchemaErrors m => FromJSON m FileLength Source #
Instance details Defined in Hackage.Security.TUF.Common Methods fromJSON :: JSValue -> m FileLength Source #
ReportSchemaErrors m => FromJSON m Hash Source #
Instance details Defined in Hackage.Security.TUF.Common Methods fromJSON :: JSValue -> m Hash Source #
ReportSchemaErrors m => FromJSON m KeyThreshold Source #
Instance details Defined in Hackage.Security.TUF.Common Methods fromJSON :: JSValue -> m KeyThreshold Source #
ReportSchemaErrors m => FromJSON m FileInfo Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods fromJSON :: JSValue -> m FileInfo Source #
ReportSchemaErrors m => FromJSON m FileMap Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods fromJSON :: JSValue -> m FileMap Source #
ReportSchemaErrors m => FromJSON m FileExpires Source #
Instance details Defined in Hackage.Security.TUF.Header Methods fromJSON :: JSValue -> m FileExpires Source #
ReportSchemaErrors m => FromJSON m FileVersion Source #
Instance details Defined in Hackage.Security.TUF.Header Methods fromJSON :: JSValue -> m FileVersion Source #
ReportSchemaErrors m => FromJSON m Header Source #
Instance details Defined in Hackage.Security.TUF.Header Methods fromJSON :: JSValue -> m Header Source #
ReportSchemaErrors m => FromJSON m Mirror Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods fromJSON :: JSValue -> m Mirror Source #
(MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Mirrors Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods fromJSON :: JSValue -> m Mirrors Source #
MonadKeys m => FromJSON m RootRoles Source #
Instance details Defined in Hackage.Security.TUF.Root Methods fromJSON :: JSValue -> m RootRoles Source #
ReportSchemaErrors m => FromJSON m PreSignature Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods fromJSON :: JSValue -> m PreSignature Source #
MonadKeys m => FromJSON m Signatures Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods fromJSON :: JSValue -> m Signatures Source #
(MonadReader RepoLayout m, MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Snapshot Source #
Instance details Defined in Hackage.Security.TUF.Snapshot Methods fromJSON :: JSValue -> m Snapshot Source #
MonadKeys m => FromJSON m DelegationSpec Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fromJSON :: JSValue -> m DelegationSpec Source #
MonadKeys m => FromJSON m Delegations Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fromJSON :: JSValue -> m Delegations Source #
MonadKeys m => FromJSON m Targets Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fromJSON :: JSValue -> m Targets Source #
(MonadReader RepoLayout m, MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Timestamp Source #
Instance details Defined in Hackage.Security.TUF.Timestamp Methods fromJSON :: JSValue -> m Timestamp Source #
ReportSchemaErrors m => FromJSON m Int54 Source #
Instance details Defined in Hackage.Security.Util.JSON Methods fromJSON :: JSValue -> m Int54 Source #
Monad m => FromJSON m JSValue Source #
Instance details Defined in Hackage.Security.Util.JSON Methods fromJSON :: JSValue -> m JSValue Source #
ReportSchemaErrors m => FromJSON m URI Source #
Instance details Defined in Hackage.Security.Util.JSON Methods fromJSON :: JSValue -> m URI Source #
ReportSchemaErrors m => FromJSON m UTCTime Source #
Instance details Defined in Hackage.Security.Util.JSON Methods fromJSON :: JSValue -> m UTCTime Source #
ReportSchemaErrors m => FromJSON m String Source #
Instance details Defined in Hackage.Security.Util.JSON Methods fromJSON :: JSValue -> m String Source #
MonadKeys m => FromJSON m (RoleSpec a) Source #
Instance details Defined in Hackage.Security.TUF.Root Methods fromJSON :: JSValue -> m (RoleSpec a) Source #
MonadKeys m => FromJSON m (Signed Mirrors) Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods fromJSON :: JSValue -> m (Signed Mirrors) Source #
MonadKeys m => FromJSON m (Signed Root) Source #	We give an instance for Signed Root rather than Root because the key environment from the root data is necessary to resolve the explicit sharing in the signatures.
Instance details Defined in Hackage.Security.TUF.Root Methods fromJSON :: JSValue -> m (Signed Root) Source #
(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Snapshot) Source #
Instance details Defined in Hackage.Security.TUF.Snapshot Methods fromJSON :: JSValue -> m (Signed Snapshot) Source #
MonadKeys m => FromJSON m (Signed Targets) Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fromJSON :: JSValue -> m (Signed Targets) Source #
(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Timestamp) Source #
Instance details Defined in Hackage.Security.TUF.Timestamp Methods fromJSON :: JSValue -> m (Signed Timestamp) Source #
(ReportSchemaErrors m, FromJSON m a) => FromJSON m (UninterpretedSignatures a) Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods fromJSON :: JSValue -> m (UninterpretedSignatures a) Source #
ReportSchemaErrors m => FromJSON m (Some Key) Source #
Instance details Defined in Hackage.Security.Key Methods fromJSON :: JSValue -> m (Some Key) Source #
ReportSchemaErrors m => FromJSON m (Some KeyType) Source #
Instance details Defined in Hackage.Security.Key Methods fromJSON :: JSValue -> m (Some KeyType) Source #
ReportSchemaErrors m => FromJSON m (Some PublicKey) Source #
Instance details Defined in Hackage.Security.Key Methods fromJSON :: JSValue -> m (Some PublicKey) Source #
(ReportSchemaErrors m, FromJSON m a) => FromJSON m [a] Source #
Instance details Defined in Hackage.Security.Util.JSON Methods fromJSON :: JSValue -> m [a] Source #
(ReportSchemaErrors m, Ord k, FromObjectKey m k, FromJSON m a) => FromJSON m (Map k a) Source #
Instance details Defined in Hackage.Security.Util.JSON Methods fromJSON :: JSValue -> m (Map k a) Source #

data Key a where Source #

Constructors

KeyEd25519 :: PublicKey -> SecretKey -> Key Ed25519

Instances

Instances details

HasKeyId Key Source #
Instance details Defined in Hackage.Security.Key Methods keyId :: Key typ -> KeyId Source #
SomeEq Key Source #
Instance details Defined in Hackage.Security.Key Methods someEq :: DictEq (Key a) Source #
SomeShow Key Source #
Instance details Defined in Hackage.Security.Key Methods someShow :: DictShow (Key a) Source #
ReportSchemaErrors m => FromJSON m (Some Key) Source #
Instance details Defined in Hackage.Security.Key Methods fromJSON :: JSValue -> m (Some Key) Source #
Monad m => ToJSON m (Key typ) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: Key typ -> m JSValue Source #
Monad m => ToJSON m (Some Key) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: Some Key -> m JSValue Source #
Show (Key typ) Source #
Instance details Defined in Hackage.Security.Key Methods showsPrec :: Int -> Key typ -> ShowS # show :: Key typ -> String # showList :: [Key typ] -> ShowS #
Eq (Key typ) Source #
Instance details Defined in Hackage.Security.Key Methods (==) :: Key typ -> Key typ -> Bool # (/=) :: Key typ -> Key typ -> Bool #

sign :: PrivateKey typ -> ByteString -> ByteString Source #

Sign a bytestring and return the signature

TODO: It is unfortunate that we have to convert to a strict bytestring for ed25519

data Ed25519 Source #

data PublicKey a where Source #

Constructors

PublicKeyEd25519 :: PublicKey -> PublicKey Ed25519

Instances

Instances details

HasKeyId PublicKey Source #
Instance details Defined in Hackage.Security.Key Methods keyId :: PublicKey typ -> KeyId Source #
SomeEq PublicKey Source #
Instance details Defined in Hackage.Security.Key Methods someEq :: DictEq (PublicKey a) Source #
SomeShow PublicKey Source #
Instance details Defined in Hackage.Security.Key Methods someShow :: DictShow (PublicKey a) Source #
ReportSchemaErrors m => FromJSON m (Some PublicKey) Source #
Instance details Defined in Hackage.Security.Key Methods fromJSON :: JSValue -> m (Some PublicKey) Source #
Monad m => ToJSON m (PublicKey typ) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: PublicKey typ -> m JSValue Source #
Monad m => ToJSON m (Some PublicKey) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: Some PublicKey -> m JSValue Source #
Show (PublicKey typ) Source #
Instance details Defined in Hackage.Security.Key Methods showsPrec :: Int -> PublicKey typ -> ShowS # show :: PublicKey typ -> String # showList :: [PublicKey typ] -> ShowS #
Eq (PublicKey typ) Source #
Instance details Defined in Hackage.Security.Key Methods (==) :: PublicKey typ -> PublicKey typ -> Bool # (/=) :: PublicKey typ -> PublicKey typ -> Bool #

data PrivateKey a where Source #

Constructors

PrivateKeyEd25519 :: SecretKey -> PrivateKey Ed25519

Instances

Instances details

SomeEq PrivateKey Source #
Instance details Defined in Hackage.Security.Key Methods someEq :: DictEq (PrivateKey a) Source #
SomeShow PrivateKey Source #
Instance details Defined in Hackage.Security.Key Methods someShow :: DictShow (PrivateKey a) Source #
Show (PrivateKey typ) Source #
Instance details Defined in Hackage.Security.Key Methods showsPrec :: Int -> PrivateKey typ -> ShowS # show :: PrivateKey typ -> String # showList :: [PrivateKey typ] -> ShowS #
Eq (PrivateKey typ) Source #
Instance details Defined in Hackage.Security.Key Methods (==) :: PrivateKey typ -> PrivateKey typ -> Bool # (/=) :: PrivateKey typ -> PrivateKey typ -> Bool #

data KeyType typ where Source #

Constructors

KeyTypeEd25519 :: KeyType Ed25519

Instances

Instances details

SomeEq KeyType Source #
Instance details Defined in Hackage.Security.Key Methods someEq :: DictEq (KeyType a) Source #
SomeShow KeyType Source #
Instance details Defined in Hackage.Security.Key Methods someShow :: DictShow (KeyType a) Source #
ReportSchemaErrors m => FromJSON m (Some KeyType) Source #
Instance details Defined in Hackage.Security.Key Methods fromJSON :: JSValue -> m (Some KeyType) Source #
Monad m => ToJSON m (KeyType typ) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: KeyType typ -> m JSValue Source #
Monad m => ToJSON m (Some KeyType) Source #
Instance details Defined in Hackage.Security.Key Methods toJSON :: Some KeyType -> m JSValue Source #
Show (KeyType typ) Source #
Instance details Defined in Hackage.Security.Key Methods showsPrec :: Int -> KeyType typ -> ShowS # show :: KeyType typ -> String # showList :: [KeyType typ] -> ShowS #
Eq (KeyType typ) Source #
Instance details Defined in Hackage.Security.Key Methods (==) :: KeyType typ -> KeyType typ -> Bool # (/=) :: KeyType typ -> KeyType typ -> Bool #

somePublicKey :: Some Key -> Some PublicKey Source #

somePublicKeyType :: Some PublicKey -> Some KeyType Source #

someKeyId :: forall (key :: Type -> Type). HasKeyId key => Some key -> KeyId Source #

publicKey :: Key a -> PublicKey a Source #

privateKey :: Key a -> PrivateKey a Source #

createKey :: KeyType key -> IO (Key key) Source #

createKey' :: KeyType key -> IO (Some Key) Source #

newtype KeyId Source #

The key ID of a key, by definition, is the hexdigest of the SHA-256 hash of the canonical JSON form of the key where the private object key is excluded.

NOTE: The FromJSON and ToJSON instances for KeyId are intentionally omitted. Use writeKeyAsId instead.

Constructors

KeyId
Fields keyIdString :: String

Instances

Instances details

Show KeyId Source #
Instance details Defined in Hackage.Security.Key Methods showsPrec :: Int -> KeyId -> ShowS # show :: KeyId -> String # showList :: [KeyId] -> ShowS #
Eq KeyId Source #
Instance details Defined in Hackage.Security.Key Methods (==) :: KeyId -> KeyId -> Bool # (/=) :: KeyId -> KeyId -> Bool #
Ord KeyId Source #
Instance details Defined in Hackage.Security.Key Methods compare :: KeyId -> KeyId -> Ordering # (<) :: KeyId -> KeyId -> Bool # (<=) :: KeyId -> KeyId -> Bool # (>) :: KeyId -> KeyId -> Bool # (>=) :: KeyId -> KeyId -> Bool # max :: KeyId -> KeyId -> KeyId # min :: KeyId -> KeyId -> KeyId #
Monad m => FromObjectKey m KeyId Source #
Instance details Defined in Hackage.Security.Key Methods fromObjectKey :: String -> m (Maybe KeyId) Source #
Monad m => ToObjectKey m KeyId Source #
Instance details Defined in Hackage.Security.Key Methods toObjectKey :: KeyId -> m String Source #

class HasKeyId (key :: Type -> Type) where Source #

Compute the key ID of a key

Methods

keyId :: key typ -> KeyId Source #

Instances

Instances details

HasKeyId Key Source #
Instance details Defined in Hackage.Security.Key Methods keyId :: Key typ -> KeyId Source #
HasKeyId PublicKey Source #
Instance details Defined in Hackage.Security.Key Methods keyId :: PublicKey typ -> KeyId Source #

verify :: PublicKey typ -> ByteString -> ByteString -> Bool Source #

data Signed a Source #

Constructors

Signed
Fields signed :: a signatures :: Signatures

Instances

Instances details

MonadKeys m => FromJSON m (Signed Mirrors) Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods fromJSON :: JSValue -> m (Signed Mirrors) Source #
MonadKeys m => FromJSON m (Signed Root) Source #	We give an instance for Signed Root rather than Root because the key environment from the root data is necessary to resolve the explicit sharing in the signatures.
Instance details Defined in Hackage.Security.TUF.Root Methods fromJSON :: JSValue -> m (Signed Root) Source #
(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Snapshot) Source #
Instance details Defined in Hackage.Security.TUF.Snapshot Methods fromJSON :: JSValue -> m (Signed Snapshot) Source #
MonadKeys m => FromJSON m (Signed Targets) Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fromJSON :: JSValue -> m (Signed Targets) Source #
(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Timestamp) Source #
Instance details Defined in Hackage.Security.TUF.Timestamp Methods fromJSON :: JSValue -> m (Signed Timestamp) Source #
(Monad m, ToJSON m a) => ToJSON m (Signed a) Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods toJSON :: Signed a -> m JSValue Source #

data Signature Source #

Constructors

Signature
Fields signature :: ByteString signatureKey :: Some PublicKey

data IndexFile a where Source #

Files that we might request from the index

The type index tells us the type of the decoded file, if any. For files for which the library does not support decoding this will be (). NOTE: Clients should NOT rely on this type index being (), or they might break if we add support for parsing additional file formats in the future.

TODO: If we wanted to support legacy Hackage, we should also have a case for the global preferred-versions file. But supporting legacy Hackage will probably require more work anyway..

Constructors

IndexPkgMetadata :: PackageIdentifier -> IndexFile (Signed Targets)
IndexPkgCabal :: PackageIdentifier -> IndexFile ()
IndexPkgPrefs :: PackageName -> IndexFile ()

Instances

Instances details

SomePretty IndexFile Source #
Instance details Defined in Hackage.Security.TUF.Layout.Index Methods somePretty :: DictPretty (IndexFile a) Source #
SomeShow IndexFile Source #
Instance details Defined in Hackage.Security.TUF.Layout.Index Methods someShow :: DictShow (IndexFile a) Source #
Show (IndexFile dec) Source #
Instance details Defined in Hackage.Security.TUF.Layout.Index Methods showsPrec :: Int -> IndexFile dec -> ShowS # show :: IndexFile dec -> String # showList :: [IndexFile dec] -> ShowS #
Pretty (IndexFile dec) Source #
Instance details Defined in Hackage.Security.TUF.Layout.Index Methods pretty :: IndexFile dec -> String Source #

data FileMap Source #

Mapping from paths to file info

File maps are used in target files; the paths are relative to the location of the target files containing the file map.

Instances

Instances details

Show FileMap Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods showsPrec :: Int -> FileMap -> ShowS # show :: FileMap -> String # showList :: [FileMap] -> ShowS #
ReportSchemaErrors m => FromJSON m FileMap Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods fromJSON :: JSValue -> m FileMap Source #
Monad m => ToJSON m FileMap Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods toJSON :: FileMap -> m JSValue Source #

data TargetPath Source #

Entries in FileMap either talk about the repository or the index

Constructors

TargetPathRepo RepoPath
TargetPathIndex IndexPath

Instances

Instances details

Show TargetPath Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods showsPrec :: Int -> TargetPath -> ShowS # show :: TargetPath -> String # showList :: [TargetPath] -> ShowS #
Eq TargetPath Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods (==) :: TargetPath -> TargetPath -> Bool # (/=) :: TargetPath -> TargetPath -> Bool #
Ord TargetPath Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods compare :: TargetPath -> TargetPath -> Ordering # (<) :: TargetPath -> TargetPath -> Bool # (<=) :: TargetPath -> TargetPath -> Bool # (>) :: TargetPath -> TargetPath -> Bool # (>=) :: TargetPath -> TargetPath -> Bool # max :: TargetPath -> TargetPath -> TargetPath # min :: TargetPath -> TargetPath -> TargetPath #
Pretty TargetPath Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods pretty :: TargetPath -> String Source #
ReportSchemaErrors m => FromObjectKey m TargetPath Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods fromObjectKey :: String -> m (Maybe TargetPath) Source #
Monad m => ToObjectKey m TargetPath Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods toObjectKey :: TargetPath -> m String Source #

data FileChange Source #

Constructors

FileChanged FileInfo	File got added or modified; we record the new file info
FileDeleted	File got deleted

Instances

Instances details

Show FileChange Source #
Instance details Defined in Hackage.Security.TUF.FileMap Methods showsPrec :: Int -> FileChange -> ShowS # show :: FileChange -> String # showList :: [FileChange] -> ShowS #

fileMapChanges Source #

Arguments

:: FileMap	Old
-> FileMap	New
-> Map TargetPath FileChange

data FileInfo Source #

File information

This intentionally does not have an Eq instance; see knownFileInfoEqual and verifyFileInfo instead.

NOTE: Throughout we compute file information always over the raw bytes. For example, when timestamp.json lists the hash of snapshot.json, this hash is computed over the actual snapshot.json file (as opposed to the canonical form of the embedded JSON). This brings it in line with the hash computed over target files, where that is the only choice available.

Constructors

FileInfo
Fields fileInfoLength :: FileLength fileInfoHashes :: Map HashFn Hash

Instances

Instances details

Show FileInfo Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods showsPrec :: Int -> FileInfo -> ShowS # show :: FileInfo -> String # showList :: [FileInfo] -> ShowS #
ReportSchemaErrors m => FromJSON m FileInfo Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods fromJSON :: JSValue -> m FileInfo Source #
Monad m => ToJSON m FileInfo Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods toJSON :: FileInfo -> m JSValue Source #

data Int54 Source #

54-bit integer values

JavaScript can only safely represent numbers between -(2^53 - 1) and 2^53 - 1.

TODO: Although we introduce the type here, we don't actually do any bounds checking and just inherit all type class instance from Int64. We should probably define fromInteger to do bounds checking, give different instances for type classes such as Bounded and FiniteBits, etc.

Instances

Instances details

Data Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Int54 -> c Int54 # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Int54 # toConstr :: Int54 -> Constr # dataTypeOf :: Int54 -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Int54) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Int54) # gmapT :: (forall b. Data b => b -> b) -> Int54 -> Int54 # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Int54 -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Int54 -> r # gmapQ :: (forall d. Data d => d -> u) -> Int54 -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Int54 -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Int54 -> m Int54 # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Int54 -> m Int54 # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Int54 -> m Int54 #
Storable Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods sizeOf :: Int54 -> Int # alignment :: Int54 -> Int # peekElemOff :: Ptr Int54 -> Int -> IO Int54 # pokeElemOff :: Ptr Int54 -> Int -> Int54 -> IO () # peekByteOff :: Ptr b -> Int -> IO Int54 # pokeByteOff :: Ptr b -> Int -> Int54 -> IO () # peek :: Ptr Int54 -> IO Int54 # poke :: Ptr Int54 -> Int54 -> IO () #
Bits Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods (.&.) :: Int54 -> Int54 -> Int54 # (.\|.) :: Int54 -> Int54 -> Int54 # xor :: Int54 -> Int54 -> Int54 # complement :: Int54 -> Int54 # shift :: Int54 -> Int -> Int54 # rotate :: Int54 -> Int -> Int54 # zeroBits :: Int54 # bit :: Int -> Int54 # setBit :: Int54 -> Int -> Int54 # clearBit :: Int54 -> Int -> Int54 # complementBit :: Int54 -> Int -> Int54 # testBit :: Int54 -> Int -> Bool # bitSizeMaybe :: Int54 -> Maybe Int # bitSize :: Int54 -> Int # isSigned :: Int54 -> Bool # shiftL :: Int54 -> Int -> Int54 # unsafeShiftL :: Int54 -> Int -> Int54 # shiftR :: Int54 -> Int -> Int54 # unsafeShiftR :: Int54 -> Int -> Int54 # rotateL :: Int54 -> Int -> Int54 # rotateR :: Int54 -> Int -> Int54 # popCount :: Int54 -> Int #
FiniteBits Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods finiteBitSize :: Int54 -> Int # countLeadingZeros :: Int54 -> Int # countTrailingZeros :: Int54 -> Int #
Bounded Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods minBound :: Int54 # maxBound :: Int54 #
Enum Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods succ :: Int54 -> Int54 # pred :: Int54 -> Int54 # toEnum :: Int -> Int54 # fromEnum :: Int54 -> Int # enumFrom :: Int54 -> [Int54] # enumFromThen :: Int54 -> Int54 -> [Int54] # enumFromTo :: Int54 -> Int54 -> [Int54] # enumFromThenTo :: Int54 -> Int54 -> Int54 -> [Int54] #
Ix Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods range :: (Int54, Int54) -> [Int54] # index :: (Int54, Int54) -> Int54 -> Int # unsafeIndex :: (Int54, Int54) -> Int54 -> Int # inRange :: (Int54, Int54) -> Int54 -> Bool # rangeSize :: (Int54, Int54) -> Int # unsafeRangeSize :: (Int54, Int54) -> Int #
Num Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods (+) :: Int54 -> Int54 -> Int54 # (-) :: Int54 -> Int54 -> Int54 # (*) :: Int54 -> Int54 -> Int54 # negate :: Int54 -> Int54 # abs :: Int54 -> Int54 # signum :: Int54 -> Int54 # fromInteger :: Integer -> Int54 #
Read Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods readsPrec :: Int -> ReadS Int54 # readList :: ReadS [Int54] # readPrec :: ReadPrec Int54 # readListPrec :: ReadPrec [Int54] #
Integral Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods quot :: Int54 -> Int54 -> Int54 # rem :: Int54 -> Int54 -> Int54 # div :: Int54 -> Int54 -> Int54 # mod :: Int54 -> Int54 -> Int54 # quotRem :: Int54 -> Int54 -> (Int54, Int54) # divMod :: Int54 -> Int54 -> (Int54, Int54) # toInteger :: Int54 -> Integer #
Real Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods toRational :: Int54 -> Rational #
Show Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods showsPrec :: Int -> Int54 -> ShowS # show :: Int54 -> String # showList :: [Int54] -> ShowS #
PrintfArg Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods formatArg :: Int54 -> FieldFormatter # parseFormat :: Int54 -> ModifierParser #
Eq Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods (==) :: Int54 -> Int54 -> Bool # (/=) :: Int54 -> Int54 -> Bool #
Ord Int54 Source #
Instance details Defined in Text.JSON.Canonical Methods compare :: Int54 -> Int54 -> Ordering # (<) :: Int54 -> Int54 -> Bool # (<=) :: Int54 -> Int54 -> Bool # (>) :: Int54 -> Int54 -> Bool # (>=) :: Int54 -> Int54 -> Bool # max :: Int54 -> Int54 -> Int54 # min :: Int54 -> Int54 -> Int54 #
ReportSchemaErrors m => FromJSON m Int54 Source #
Instance details Defined in Hackage.Security.Util.JSON Methods fromJSON :: JSValue -> m Int54 Source #
Monad m => ToJSON m Int54 Source #
Instance details Defined in Hackage.Security.Util.JSON Methods toJSON :: Int54 -> m JSValue Source #

data Header Source #

Occasionally it is useful to read only a header from a file.

HeaderOnly intentionally only has a FromJSON instance (no ToJSON).

Constructors

Header
Fields headerExpires :: FileExpires headerVersion :: FileVersion

Instances

data Mirrors Source #

Constructors

Mirrors
Fields mirrorsVersion :: FileVersion mirrorsExpires :: FileExpires mirrorsMirrors :: [Mirror]

Instances

Instances details

HasHeader Mirrors Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods fileExpires :: Lens' Mirrors FileExpires Source # fileVersion :: Lens' Mirrors FileVersion Source #
VerifyRole Mirrors Source #
Instance details Defined in Hackage.Security.Trusted Methods verifyRole :: Trusted Root -> TargetPath -> Maybe FileVersion -> Maybe UTCTime -> Signed Mirrors -> Either VerificationError (SignaturesVerified Mirrors) Source #
(MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Mirrors Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods fromJSON :: JSValue -> m Mirrors Source #
Monad m => ToJSON m Mirrors Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods toJSON :: Mirrors -> m JSValue Source #
MonadKeys m => FromJSON m (Signed Mirrors) Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods fromJSON :: JSValue -> m (Signed Mirrors) Source #

data Root Source #

The root metadata

NOTE: We must have the invariant that ALL keys (apart from delegation keys) must be listed in rootKeys. (Delegation keys satisfy a similar invariant, see Targets.)

Constructors

Root
Fields rootVersion :: FileVersion rootExpires :: FileExpires rootKeys :: KeyEnv rootRoles :: RootRoles

Instances

Instances details

HasHeader Root Source #
Instance details Defined in Hackage.Security.TUF.Root Methods fileExpires :: Lens' Root FileExpires Source # fileVersion :: Lens' Root FileVersion Source #
VerifyRole Root Source #
Instance details Defined in Hackage.Security.Trusted Methods verifyRole :: Trusted Root -> TargetPath -> Maybe FileVersion -> Maybe UTCTime -> Signed Root -> Either VerificationError (SignaturesVerified Root) Source #
Monad m => ToJSON m Root Source #
Instance details Defined in Hackage.Security.TUF.Root Methods toJSON :: Root -> m JSValue Source #
MonadKeys m => FromJSON m (Signed Root) Source #	We give an instance for Signed Root rather than Root because the key environment from the root data is necessary to resolve the explicit sharing in the signatures.
Instance details Defined in Hackage.Security.TUF.Root Methods fromJSON :: JSValue -> m (Signed Root) Source #

data Snapshot Source #

Constructors

Snapshot

Fields

snapshotVersion :: FileVersion
snapshotExpires :: FileExpires
snapshotInfoRoot :: FileInfo
File info for the root metadata
We list this explicitly in the snapshot so that we can check if we need to update the root metadata without first having to download the entire index tarball.
snapshotInfoMirrors :: FileInfo
File info for the mirror metadata
snapshotInfoTarGz :: FileInfo
Compressed index tarball
snapshotInfoTar :: Maybe FileInfo
Uncompressed index tarball
Repositories are not required to provide this.

Instances

Instances details

HasHeader Snapshot Source #
Instance details Defined in Hackage.Security.TUF.Snapshot Methods fileExpires :: Lens' Snapshot FileExpires Source # fileVersion :: Lens' Snapshot FileVersion Source #
VerifyRole Snapshot Source #
Instance details Defined in Hackage.Security.Trusted Methods verifyRole :: Trusted Root -> TargetPath -> Maybe FileVersion -> Maybe UTCTime -> Signed Snapshot -> Either VerificationError (SignaturesVerified Snapshot) Source #
(MonadReader RepoLayout m, MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Snapshot Source #
Instance details Defined in Hackage.Security.TUF.Snapshot Methods fromJSON :: JSValue -> m Snapshot Source #
MonadReader RepoLayout m => ToJSON m Snapshot Source #
Instance details Defined in Hackage.Security.TUF.Snapshot Methods toJSON :: Snapshot -> m JSValue Source #
(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Snapshot) Source #
Instance details Defined in Hackage.Security.TUF.Snapshot Methods fromJSON :: JSValue -> m (Signed Snapshot) Source #

data Targets Source #

Target metadata

Most target files do not need expiry dates because they are not subject to change (and hence attacks like freeze attacks are not a concern).

Constructors

Targets
Fields targetsVersion :: FileVersion targetsExpires :: FileExpires targetsTargets :: FileMap targetsDelegations :: Maybe Delegations

Instances

Instances details

Show Targets Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods showsPrec :: Int -> Targets -> ShowS # show :: Targets -> String # showList :: [Targets] -> ShowS #
HasHeader Targets Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fileExpires :: Lens' Targets FileExpires Source # fileVersion :: Lens' Targets FileVersion Source #
MonadKeys m => FromJSON m Targets Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fromJSON :: JSValue -> m Targets Source #
Monad m => ToJSON m Targets Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods toJSON :: Targets -> m JSValue Source #
MonadKeys m => FromJSON m (Signed Targets) Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fromJSON :: JSValue -> m (Signed Targets) Source #

data Timestamp Source #

Constructors

Timestamp
Fields timestampVersion :: FileVersion timestampExpires :: FileExpires timestampInfoSnapshot :: FileInfo

Instances

Instances details

HasHeader Timestamp Source #
Instance details Defined in Hackage.Security.TUF.Timestamp Methods fileExpires :: Lens' Timestamp FileExpires Source # fileVersion :: Lens' Timestamp FileVersion Source #
VerifyRole Timestamp Source #
Instance details Defined in Hackage.Security.Trusted Methods verifyRole :: Trusted Root -> TargetPath -> Maybe FileVersion -> Maybe UTCTime -> Signed Timestamp -> Either VerificationError (SignaturesVerified Timestamp) Source #
(MonadReader RepoLayout m, MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Timestamp Source #
Instance details Defined in Hackage.Security.TUF.Timestamp Methods fromJSON :: JSValue -> m Timestamp Source #
MonadReader RepoLayout m => ToJSON m Timestamp Source #
Instance details Defined in Hackage.Security.TUF.Timestamp Methods toJSON :: Timestamp -> m JSValue Source #
(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Timestamp) Source #
Instance details Defined in Hackage.Security.TUF.Timestamp Methods fromJSON :: JSValue -> m (Signed Timestamp) Source #

newtype FileLength Source #

File length

Having verified file length information means we can protect against endless data attacks and similar.

Constructors

FileLength
Fields fileLength :: Int54

Instances

Instances details

Show FileLength Source #
Instance details Defined in Hackage.Security.TUF.Common Methods showsPrec :: Int -> FileLength -> ShowS # show :: FileLength -> String # showList :: [FileLength] -> ShowS #
Eq FileLength Source #
Instance details Defined in Hackage.Security.TUF.Common Methods (==) :: FileLength -> FileLength -> Bool # (/=) :: FileLength -> FileLength -> Bool #
Ord FileLength Source #
Instance details Defined in Hackage.Security.TUF.Common Methods compare :: FileLength -> FileLength -> Ordering # (<) :: FileLength -> FileLength -> Bool # (<=) :: FileLength -> FileLength -> Bool # (>) :: FileLength -> FileLength -> Bool # (>=) :: FileLength -> FileLength -> Bool # max :: FileLength -> FileLength -> FileLength # min :: FileLength -> FileLength -> FileLength #
ReportSchemaErrors m => FromJSON m FileLength Source #
Instance details Defined in Hackage.Security.TUF.Common Methods fromJSON :: JSValue -> m FileLength Source #
Monad m => ToJSON m FileLength Source #
Instance details Defined in Hackage.Security.TUF.Common Methods toJSON :: FileLength -> m JSValue Source #

newtype Hash Source #

File hash

Constructors

Hash String

Instances

Instances details

Show Hash Source #
Instance details Defined in Hackage.Security.TUF.Common Methods showsPrec :: Int -> Hash -> ShowS # show :: Hash -> String # showList :: [Hash] -> ShowS #
Eq Hash Source #
Instance details Defined in Hackage.Security.TUF.Common Methods (==) :: Hash -> Hash -> Bool # (/=) :: Hash -> Hash -> Bool #
Ord Hash Source #
Instance details Defined in Hackage.Security.TUF.Common Methods compare :: Hash -> Hash -> Ordering # (<) :: Hash -> Hash -> Bool # (<=) :: Hash -> Hash -> Bool # (>) :: Hash -> Hash -> Bool # (>=) :: Hash -> Hash -> Bool # max :: Hash -> Hash -> Hash # min :: Hash -> Hash -> Hash #
ReportSchemaErrors m => FromJSON m Hash Source #
Instance details Defined in Hackage.Security.TUF.Common Methods fromJSON :: JSValue -> m Hash Source #
Monad m => ToJSON m Hash Source #
Instance details Defined in Hackage.Security.TUF.Common Methods toJSON :: Hash -> m JSValue Source #

newtype KeyThreshold Source #

Key threshold

The key threshold is the minimum number of keys a document must be signed with. Key thresholds are specified in RoleSpec or DelegationsSpec.

Constructors

KeyThreshold Int54

Instances

Instances details

Show KeyThreshold Source #
Instance details Defined in Hackage.Security.TUF.Common Methods showsPrec :: Int -> KeyThreshold -> ShowS # show :: KeyThreshold -> String # showList :: [KeyThreshold] -> ShowS #
Eq KeyThreshold Source #
Instance details Defined in Hackage.Security.TUF.Common Methods (==) :: KeyThreshold -> KeyThreshold -> Bool # (/=) :: KeyThreshold -> KeyThreshold -> Bool #
Ord KeyThreshold Source #
Instance details Defined in Hackage.Security.TUF.Common Methods compare :: KeyThreshold -> KeyThreshold -> Ordering # (<) :: KeyThreshold -> KeyThreshold -> Bool # (<=) :: KeyThreshold -> KeyThreshold -> Bool # (>) :: KeyThreshold -> KeyThreshold -> Bool # (>=) :: KeyThreshold -> KeyThreshold -> Bool # max :: KeyThreshold -> KeyThreshold -> KeyThreshold # min :: KeyThreshold -> KeyThreshold -> KeyThreshold #
ReportSchemaErrors m => FromJSON m KeyThreshold Source #
Instance details Defined in Hackage.Security.TUF.Common Methods fromJSON :: JSValue -> m KeyThreshold Source #
Monad m => ToJSON m KeyThreshold Source #
Instance details Defined in Hackage.Security.TUF.Common Methods toJSON :: KeyThreshold -> m JSValue Source #

data HashFn Source #

Constructors

HashFnSHA256
HashFnMD5

Instances

Instances details

Show HashFn Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods showsPrec :: Int -> HashFn -> ShowS # show :: HashFn -> String # showList :: [HashFn] -> ShowS #
Eq HashFn Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods (==) :: HashFn -> HashFn -> Bool # (/=) :: HashFn -> HashFn -> Bool #
Ord HashFn Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods compare :: HashFn -> HashFn -> Ordering # (<) :: HashFn -> HashFn -> Bool # (<=) :: HashFn -> HashFn -> Bool # (>) :: HashFn -> HashFn -> Bool # (>=) :: HashFn -> HashFn -> Bool # max :: HashFn -> HashFn -> HashFn # min :: HashFn -> HashFn -> HashFn #
ReportSchemaErrors m => FromObjectKey m HashFn Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods fromObjectKey :: String -> m (Maybe HashFn) Source #
Monad m => ToObjectKey m HashFn Source #
Instance details Defined in Hackage.Security.TUF.FileInfo Methods toObjectKey :: HashFn -> m String Source #

fileInfo :: ByteString -> FileInfo Source #

Compute FileInfo

TODO: Currently this will load the entire input bytestring into memory. We need to make this incremental, by computing the length and all hashes in a single traversal over the input.

computeFileInfo :: FsRoot root => Path root -> IO FileInfo Source #

Compute FileInfo

compareTrustedFileInfo Source #

Arguments

:: FileInfo	expected (from trusted TUF files)
-> FileInfo	actual (from `fileInfo` on target file)
-> Bool

Compare the expected trusted file info against the actual file info of a target file.

This should be used only when the FileInfo is already known. If we want to compare known FileInfo against a file on disk we should delay until we have confirmed that the file lengths match (see downloadedVerify).

knownFileInfoEqual :: FileInfo -> FileInfo -> Bool Source #

fileInfoSHA256 :: FileInfo -> Maybe Hash Source #

Extract SHA256 hash from FileInfo (if present)

class HasHeader a where Source #

Methods

fileExpires :: Lens' a FileExpires Source #

File expiry date

fileVersion :: Lens' a FileVersion Source #

File version (monotonically increasing counter)

Instances

Instances details

HasHeader Header Source #
Instance details Defined in Hackage.Security.TUF.Header Methods fileExpires :: Lens' Header FileExpires Source # fileVersion :: Lens' Header FileVersion Source #
HasHeader Mirrors Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods fileExpires :: Lens' Mirrors FileExpires Source # fileVersion :: Lens' Mirrors FileVersion Source #
HasHeader Root Source #
Instance details Defined in Hackage.Security.TUF.Root Methods fileExpires :: Lens' Root FileExpires Source # fileVersion :: Lens' Root FileVersion Source #
HasHeader Snapshot Source #
Instance details Defined in Hackage.Security.TUF.Snapshot Methods fileExpires :: Lens' Snapshot FileExpires Source # fileVersion :: Lens' Snapshot FileVersion Source #
HasHeader Targets Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fileExpires :: Lens' Targets FileExpires Source # fileVersion :: Lens' Targets FileVersion Source #
HasHeader Timestamp Source #
Instance details Defined in Hackage.Security.TUF.Timestamp Methods fileExpires :: Lens' Timestamp FileExpires Source # fileVersion :: Lens' Timestamp FileVersion Source #

newtype FileVersion Source #

File version

The file version is a flat integer which must monotonically increase on every file update.

Show and Read instance are defined in terms of the underlying Int (this is used for example by Hackage during the backup process).

Constructors

FileVersion Int54

Instances

Instances details

Read FileVersion Source #
Instance details Defined in Hackage.Security.TUF.Header Methods readsPrec :: Int -> ReadS FileVersion # readList :: ReadS [FileVersion] # readPrec :: ReadPrec FileVersion # readListPrec :: ReadPrec [FileVersion] #
Show FileVersion Source #
Instance details Defined in Hackage.Security.TUF.Header Methods showsPrec :: Int -> FileVersion -> ShowS # show :: FileVersion -> String # showList :: [FileVersion] -> ShowS #
Eq FileVersion Source #
Instance details Defined in Hackage.Security.TUF.Header Methods (==) :: FileVersion -> FileVersion -> Bool # (/=) :: FileVersion -> FileVersion -> Bool #
Ord FileVersion Source #
Instance details Defined in Hackage.Security.TUF.Header Methods compare :: FileVersion -> FileVersion -> Ordering # (<) :: FileVersion -> FileVersion -> Bool # (<=) :: FileVersion -> FileVersion -> Bool # (>) :: FileVersion -> FileVersion -> Bool # (>=) :: FileVersion -> FileVersion -> Bool # max :: FileVersion -> FileVersion -> FileVersion # min :: FileVersion -> FileVersion -> FileVersion #
ReportSchemaErrors m => FromJSON m FileVersion Source #
Instance details Defined in Hackage.Security.TUF.Header Methods fromJSON :: JSValue -> m FileVersion Source #
Monad m => ToJSON m FileVersion Source #
Instance details Defined in Hackage.Security.TUF.Header Methods toJSON :: FileVersion -> m JSValue Source #

newtype FileExpires Source #

File expiry date

A Nothing value here means no expiry. That makes it possible to set some files to never expire. (Note that not having the Maybe in the type here still allows that, because you could set an expiry date 2000 years into the future. By having the Maybe here we avoid the _need_ for such encoding issues.)

Constructors

FileExpires (Maybe UTCTime)

Instances

Instances details

Show FileExpires Source #
Instance details Defined in Hackage.Security.TUF.Header Methods showsPrec :: Int -> FileExpires -> ShowS # show :: FileExpires -> String # showList :: [FileExpires] -> ShowS #
Eq FileExpires Source #
Instance details Defined in Hackage.Security.TUF.Header Methods (==) :: FileExpires -> FileExpires -> Bool # (/=) :: FileExpires -> FileExpires -> Bool #
Ord FileExpires Source #
Instance details Defined in Hackage.Security.TUF.Header Methods compare :: FileExpires -> FileExpires -> Ordering # (<) :: FileExpires -> FileExpires -> Bool # (<=) :: FileExpires -> FileExpires -> Bool # (>) :: FileExpires -> FileExpires -> Bool # (>=) :: FileExpires -> FileExpires -> Bool # max :: FileExpires -> FileExpires -> FileExpires # min :: FileExpires -> FileExpires -> FileExpires #
ReportSchemaErrors m => FromJSON m FileExpires Source #
Instance details Defined in Hackage.Security.TUF.Header Methods fromJSON :: JSValue -> m FileExpires Source #
Monad m => ToJSON m FileExpires Source #
Instance details Defined in Hackage.Security.TUF.Header Methods toJSON :: FileExpires -> m JSValue Source #

expiresInDays :: UTCTime -> Integer -> FileExpires Source #

expiresNever :: FileExpires Source #

isExpired :: UTCTime -> FileExpires -> Bool Source #

versionInitial :: FileVersion Source #

versionIncrement :: FileVersion -> FileVersion Source #

data CacheLayout Source #

Location of the various files we cache

Although the generic TUF algorithms do not care how we organize the cache, we nonetheless specify this here because as long as there are tools which access files in the cache directly we need to define the cache layout. See also comments for defaultCacheLayout.

Constructors

CacheLayout

Fields

cacheLayoutRoot :: CachePath
TUF root metadata
cacheLayoutTimestamp :: CachePath
TUF timestamp
cacheLayoutSnapshot :: CachePath
TUF snapshot
cacheLayoutMirrors :: CachePath
TUF mirrors list
cacheLayoutIndexTar :: CachePath
Uncompressed index tarball
cacheLayoutIndexIdx :: CachePath
Index to the uncompressed index tarball
cacheLayoutIndexTarGz :: CachePath
Compressed index tarball
We cache both the compressed and the uncompressed tarballs, because incremental updates happen through the compressed tarball, but reads happen through the uncompressed one (with the help of the tarball index).

cabalCacheLayout :: CacheLayout Source #

The cache layout cabal-install uses

We cache the index as cache/00-index.tar; this is important because `cabal-install` expects to find it there (and does not currently go through the hackage-security library to get files from the index).

data IndexLayout Source #

Layout of the files within the index tarball

Constructors

IndexLayout
Fields indexFileToPath :: forall dec. IndexFile dec -> IndexPath Translate an `IndexFile` to a path indexFileFromPath :: IndexPath -> Maybe (Some IndexFile) Parse an `FilePath`

hackageIndexLayout :: IndexLayout Source #

The layout of the index as maintained on Hackage

indexLayoutPkgMetadata :: IndexLayout -> PackageIdentifier -> IndexPath Source #

indexLayoutPkgCabal :: IndexLayout -> PackageIdentifier -> IndexPath Source #

indexLayoutPkgPrefs :: IndexLayout -> PackageName -> IndexPath Source #

data RepoLayout Source #

Layout of a repository

Constructors

RepoLayout
Fields repoLayoutRoot :: RepoPath TUF root metadata repoLayoutTimestamp :: RepoPath TUF timestamp repoLayoutSnapshot :: RepoPath TUF snapshot repoLayoutMirrors :: RepoPath TUF mirrors list repoLayoutIndexTarGz :: RepoPath Compressed index tarball repoLayoutIndexTar :: RepoPath Uncompressed index tarball repoLayoutPkgTarGz :: PackageIdentifier -> RepoPath Path to the package tarball

Instances

Instances details

MonadReader RepoLayout ReadJSON_Keys_Layout Source #
Instance details Defined in Hackage.Security.JSON Methods ask :: ReadJSON_Keys_Layout RepoLayout # local :: (RepoLayout -> RepoLayout) -> ReadJSON_Keys_Layout a -> ReadJSON_Keys_Layout a # reader :: (RepoLayout -> a) -> ReadJSON_Keys_Layout a #
MonadReader RepoLayout WriteJSON Source #
Instance details Defined in Hackage.Security.JSON Methods ask :: WriteJSON RepoLayout # local :: (RepoLayout -> RepoLayout) -> WriteJSON a -> WriteJSON a # reader :: (RepoLayout -> a) -> WriteJSON a #

hackageRepoLayout :: RepoLayout Source #

The layout used on Hackage

cabalLocalRepoLayout :: RepoLayout Source #

Layout used by cabal for ("legacy") local repos

Obviously, such repos do not normally contain any of the TUF files, so their location is more or less arbitrary here.

data Mirror Source #

Definition of a mirror

NOTE: Unlike the TUF specification, we require that all mirrors must have the same format. That is, we omit metapath and targetspath.

Constructors

Mirror
Fields mirrorUrlBase :: URI mirrorContent :: MirrorContent

Instances

Instances details

Show Mirror Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods showsPrec :: Int -> Mirror -> ShowS # show :: Mirror -> String # showList :: [Mirror] -> ShowS #
ReportSchemaErrors m => FromJSON m Mirror Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods fromJSON :: JSValue -> m Mirror Source #
Monad m => ToJSON m Mirror Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods toJSON :: Mirror -> m JSValue Source #

data MirrorContent Source #

Full versus partial mirrors

The TUF spec explicitly allows for partial mirrors, with the mirrors file specifying (through patterns) what is available from partial mirrors.

For now we only support full mirrors; if we wanted to add partial mirrors, we would add a second MirrorPartial constructor here with arguments corresponding to TUF's metacontent and targetscontent fields.

Constructors

MirrorFull

Instances

Instances details

Show MirrorContent Source #
Instance details Defined in Hackage.Security.TUF.Mirrors Methods showsPrec :: Int -> MirrorContent -> ShowS # show :: MirrorContent -> String # showList :: [MirrorContent] -> ShowS #

type MirrorDescription = String Source #

describeMirror :: Mirror -> MirrorDescription Source #

Give a human-readable description of a particular mirror

(for use in error messages)

data RepoRoot Source #

The root of the repository

Repository roots can be anchored at a remote URL or a local directory.

Note that even for remote repos RepoRoot is (potentially) different from Web -- for a repository located at, say, http://hackage.haskell.org they happen to coincide, but for one location at http://example.com/some/subdirectory they do not.

Instances

Instances details

Pretty (Path RepoRoot) Source #
Instance details Defined in Hackage.Security.TUF.Paths Methods pretty :: Path RepoRoot -> String Source #

type RepoPath = Path RepoRoot Source #

Paths relative to the root of the repository

anchorRepoPathLocally :: Path root -> RepoPath -> Path root Source #

anchorRepoPathRemotely :: Path Web -> RepoPath -> Path Web Source #

data IndexRoot Source #

The root of the index tarball

Instances

Instances details

Pretty (Path IndexRoot) Source #
Instance details Defined in Hackage.Security.TUF.Paths Methods pretty :: Path IndexRoot -> String Source #

type IndexPath = Path IndexRoot Source #

Paths relative to the root of the index tarball

data CacheRoot Source #

The cache directory

Instances

Instances details

Pretty (Path CacheRoot) Source #
Instance details Defined in Hackage.Security.TUF.Paths Methods pretty :: Path CacheRoot -> String Source #

type CachePath = Path CacheRoot Source #

anchorCachePath :: Path root -> CachePath -> Path root Source #

Anchor a cache path to the location of the cache

data Delegation Source #

A delegation

A delegation is a pair of a pattern and a replacement.

See match for an example.

Constructors

Delegation (Pattern a) (Replacement a)

Instances

Instances details

Show Delegation Source #
Instance details Defined in Hackage.Security.TUF.Patterns Methods showsPrec :: Int -> Delegation -> ShowS # show :: Delegation -> String # showList :: [Delegation] -> ShowS #
Lift Delegation Source #
Instance details Defined in Hackage.Security.TUF.Patterns Methods lift :: Quote m => Delegation -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Delegation -> Code m Delegation #

data RootRoles Source #

Constructors

RootRoles
Fields rootRolesRoot :: RoleSpec Root rootRolesSnapshot :: RoleSpec Snapshot rootRolesTargets :: RoleSpec Targets rootRolesTimestamp :: RoleSpec Timestamp rootRolesMirrors :: RoleSpec Mirrors

Instances

Instances details

MonadKeys m => FromJSON m RootRoles Source #
Instance details Defined in Hackage.Security.TUF.Root Methods fromJSON :: JSValue -> m RootRoles Source #
Monad m => ToJSON m RootRoles Source #
Instance details Defined in Hackage.Security.TUF.Root Methods toJSON :: RootRoles -> m JSValue Source #

data RoleSpec a Source #

Role specification

The phantom type indicates what kind of type this role is meant to verify.

Constructors

RoleSpec
Fields roleSpecKeys :: [Some PublicKey] roleSpecThreshold :: KeyThreshold

Instances

Instances details

MonadKeys m => FromJSON m (RoleSpec a) Source #
Instance details Defined in Hackage.Security.TUF.Root Methods fromJSON :: JSValue -> m (RoleSpec a) Source #
Monad m => ToJSON m (RoleSpec a) Source #
Instance details Defined in Hackage.Security.TUF.Root Methods toJSON :: RoleSpec a -> m JSValue Source #
Show (RoleSpec a) Source #
Instance details Defined in Hackage.Security.TUF.Root Methods showsPrec :: Int -> RoleSpec a -> ShowS # show :: RoleSpec a -> String # showList :: [RoleSpec a] -> ShowS #

newtype Signatures Source #

A list of signatures

Invariant: each signature must be made with a different key. We enforce this invariant for incoming untrusted data (fromPreSignatures) but not for lists of signatures that we create in code.

Constructors

Signatures [Signature]

Instances

Instances details

MonadKeys m => FromJSON m Signatures Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods fromJSON :: JSValue -> m Signatures Source #
Monad m => ToJSON m Signatures Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods toJSON :: Signatures -> m JSValue Source #

unsigned :: a -> Signed a Source #

Create a new document without any signatures

withSignatures :: ToJSON WriteJSON a => RepoLayout -> [Some Key] -> a -> Signed a Source #

Sign a document

withSignatures' :: ToJSON Identity a => [Some Key] -> a -> Signed a Source #

Variation on withSignatures that doesn't need the repo layout

signRendered :: [Some Key] -> ByteString -> Signatures Source #

Construct signatures for already rendered value

verifySignature :: ByteString -> Signature -> Bool Source #

signedFromJSON :: (MonadKeys m, FromJSON m a) => JSValue -> m (Signed a) Source #

General FromJSON instance for signed datatypes

We don't give a general FromJSON instance for Signed because for some datatypes we need to do something special (datatypes where we need to read key environments); for instance, see the "Signed Root" instance.

verifySignatures :: JSValue -> Signatures -> Bool Source #

Signature verification

NOTES: 1. By definition, the signature must be verified against the canonical JSON format. This means we _must_ parse and then pretty print (as we do here) because the document as stored may or may not be in canonical format. 2. However, it is important that we NOT translate from the JSValue to whatever internal datatype we are using and then back to JSValue, because that may not roundtrip: we must allow for additional fields in the JSValue that we ignore (and would therefore lose when we attempt to roundtrip). 3. We verify that all signatures are valid, but we cannot verify (here) that these signatures are signed with the right key, or that we have a sufficient number of signatures. This will be the responsibility of the calling code.

data UninterpretedSignatures a Source #

File with uninterpreted signatures

Sometimes we want to be able to read a file without interpreting the signatures (that is, resolving the key IDs) or doing any kind of checks on them. One advantage of this is that this allows us to read many file types without any key environment at all, which is sometimes useful.

Constructors

UninterpretedSignatures
Fields uninterpretedSigned :: a uninterpretedSignatures :: [PreSignature]

Instances

Instances details

(ReportSchemaErrors m, FromJSON m a) => FromJSON m (UninterpretedSignatures a) Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods fromJSON :: JSValue -> m (UninterpretedSignatures a) Source #
(Monad m, ToJSON m a) => ToJSON m (UninterpretedSignatures a) Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods toJSON :: UninterpretedSignatures a -> m JSValue Source #
Show a => Show (UninterpretedSignatures a) Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods showsPrec :: Int -> UninterpretedSignatures a -> ShowS # show :: UninterpretedSignatures a -> String # showList :: [UninterpretedSignatures a] -> ShowS #

data PreSignature Source #

A signature with a key ID (rather than an actual key)

This corresponds precisely to the TUF representation of a signature.

Constructors

PreSignature
Fields presignature :: ByteString presigMethod :: Some KeyType presigKeyId :: KeyId

Instances

Instances details

Show PreSignature Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods showsPrec :: Int -> PreSignature -> ShowS # show :: PreSignature -> String # showList :: [PreSignature] -> ShowS #
ReportSchemaErrors m => FromJSON m PreSignature Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods fromJSON :: JSValue -> m PreSignature Source #
Monad m => ToJSON m PreSignature Source #
Instance details Defined in Hackage.Security.TUF.Signed Methods toJSON :: PreSignature -> m JSValue Source #

fromPreSignature :: MonadKeys m => PreSignature -> m Signature Source #

Convert a pre-signature to a signature

Verifies that the key type matches the advertised method.

fromPreSignatures :: MonadKeys m => [PreSignature] -> m Signatures Source #

Convert a list of PreSignatures to a list of Signatures

This verifies the invariant that all signatures are made with different keys. We do this on the presignatures rather than the signatures so that we can do the check on key IDs, rather than keys (the latter don't have an Ord instance).

toPreSignature :: Signature -> PreSignature Source #

Convert signature to pre-signature

toPreSignatures :: Signatures -> [PreSignature] Source #

Convert list of pre-signatures to a list of signatures

data Delegations Source #

Delegations

Much like the Root datatype, this must have an invariant that ALL used keys (apart from the global keys, which are in the root key environment) must be listed in delegationsKeys.

Constructors

Delegations
Fields delegationsKeys :: KeyEnv delegationsRoles :: [DelegationSpec]

Instances

Instances details

Show Delegations Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods showsPrec :: Int -> Delegations -> ShowS # show :: Delegations -> String # showList :: [Delegations] -> ShowS #
MonadKeys m => FromJSON m Delegations Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fromJSON :: JSValue -> m Delegations Source #
Monad m => ToJSON m Delegations Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods toJSON :: Delegations -> m JSValue Source #

data DelegationSpec Source #

Delegation specification

NOTE: This is a close analogue of RoleSpec.

Constructors

DelegationSpec
Fields delegationSpecKeys :: [Some PublicKey] delegationSpecThreshold :: KeyThreshold delegation :: Delegation

Instances

Instances details

Show DelegationSpec Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods showsPrec :: Int -> DelegationSpec -> ShowS # show :: DelegationSpec -> String # showList :: [DelegationSpec] -> ShowS #
MonadKeys m => FromJSON m DelegationSpec Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods fromJSON :: JSValue -> m DelegationSpec Source #
Monad m => ToJSON m DelegationSpec Source #
Instance details Defined in Hackage.Security.TUF.Targets Methods toJSON :: DelegationSpec -> m JSValue Source #

targetsLookup :: TargetPath -> Targets -> Maybe FileInfo Source #