Hackage.Security.JSON

Hackage-specific wrappers around the Util.JSON module

Deserialization errors

data DeserializationError

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

Show DeserializationError

Exception DeserializationError

Pretty DeserializationError

Typeable * DeserializationError

MonadError DeserializationError ReadJSON_NoKeys_NoLayout

MonadError DeserializationError ReadJSON_Keys_NoLayout

MonadError DeserializationError ReadJSON_Keys_Layout

validate :: MonadError DeserializationError m => String -> Bool -> m ()

verifyType :: (ReportSchemaErrors m, MonadError DeserializationError m) => JSValue -> String -> m ()

MonadKeys

class (ReportSchemaErrors m, MonadError DeserializationError m) => MonadKeys m where

MonadReader-like monad, specialized to key environments

Methods

localKeys :: (KeyEnv -> KeyEnv) -> m a -> m a

askKeys :: m KeyEnv

Instances

MonadKeys ReadJSON_Keys_NoLayout

MonadKeys ReadJSON_Keys_Layout

addKeys :: MonadKeys m => KeyEnv -> m a -> m a

withKeys :: MonadKeys m => KeyEnv -> m a -> m a

lookupKey :: MonadKeys m => KeyId -> m (Some PublicKey)

readKeyAsId :: MonadKeys m => JSValue -> m (Some PublicKey)

Reader monads

data ReadJSON_Keys_Layout a

Instances

Monad ReadJSON_Keys_Layout

Functor ReadJSON_Keys_Layout

Applicative ReadJSON_Keys_Layout

ReportSchemaErrors ReadJSON_Keys_Layout

MonadKeys ReadJSON_Keys_Layout

MonadError DeserializationError ReadJSON_Keys_Layout

MonadReader RepoLayout ReadJSON_Keys_Layout

data ReadJSON_Keys_NoLayout a

Instances

Monad ReadJSON_Keys_NoLayout

Functor ReadJSON_Keys_NoLayout

Applicative ReadJSON_Keys_NoLayout

ReportSchemaErrors ReadJSON_Keys_NoLayout

MonadKeys ReadJSON_Keys_NoLayout

MonadError DeserializationError ReadJSON_Keys_NoLayout

data ReadJSON_NoKeys_NoLayout a

Instances

Monad ReadJSON_NoKeys_NoLayout

Functor ReadJSON_NoKeys_NoLayout

Applicative ReadJSON_NoKeys_NoLayout

ReportSchemaErrors ReadJSON_NoKeys_NoLayout

MonadError DeserializationError ReadJSON_NoKeys_NoLayout

runReadJSON_Keys_Layout :: KeyEnv -> RepoLayout -> ReadJSON_Keys_Layout a -> Either DeserializationError a

runReadJSON_Keys_NoLayout :: KeyEnv -> ReadJSON_Keys_NoLayout a -> Either DeserializationError a

runReadJSON_NoKeys_NoLayout :: ReadJSON_NoKeys_NoLayout a -> Either DeserializationError a

Utility

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 :: (IsFileSystemRoot root, FromJSON ReadJSON_Keys_Layout a) => KeyEnv -> RepoLayout -> Path (Rooted root) -> IO (Either DeserializationError a)

readJSON_Keys_NoLayout :: (IsFileSystemRoot root, FromJSON ReadJSON_Keys_NoLayout a) => KeyEnv -> Path (Rooted root) -> IO (Either DeserializationError a)

readJSON_NoKeys_NoLayout :: (IsFileSystemRoot root, FromJSON ReadJSON_NoKeys_NoLayout a) => Path (Rooted root) -> IO (Either DeserializationError a)

Writing

data WriteJSON a

Instances

Monad WriteJSON

Functor WriteJSON

Applicative WriteJSON

MonadReader RepoLayout WriteJSON

runWriteJSON :: RepoLayout -> WriteJSON a -> a

Utility

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

Render to canonical JSON format

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

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

writeJSON :: ToJSON WriteJSON a => RepoLayout -> AbsolutePath -> a -> IO ()

writeJSON_NoLayout :: ToJSON Identity a => AbsolutePath -> a -> IO ()

writeKeyAsId :: Some PublicKey -> JSValue

Re-exports

Type classes

class ToJSON m a where

Methods

toJSON :: a -> m JSValue

Instances

Monad m => ToJSON m URI

Monad m => ToJSON m UTCTime

Monad m => ToJSON m Int

Monad m => ToJSON m String

Monad m => ToJSON m JSValue

Monad m => ToJSON m KeyEnv

Monad m => ToJSON m Hash

Monad m => ToJSON m FileLength

Monad m => ToJSON m KeyThreshold

Monad m => ToJSON m FileInfo

Monad m => ToJSON m FileMap

Monad m => ToJSON m FileExpires

Monad m => ToJSON m FileVersion

Monad m => ToJSON m PreSignature

Monad m => ToJSON m Signatures

Monad m => ToJSON m Mirrors

Monad m => ToJSON m Mirror

MonadReader RepoLayout m => ToJSON m Snapshot

Monad m => ToJSON m Targets

Monad m => ToJSON m Delegations

Monad m => ToJSON m DelegationSpec

MonadReader RepoLayout m => ToJSON m Timestamp

Monad m => ToJSON m Root

Monad m => ToJSON m RootRoles

(Monad m, ToJSON m a) => ToJSON m [a]

Monad m => ToJSON m (KeyType typ)

Monad m => ToJSON m (Some KeyType)

Monad m => ToJSON m (Some PublicKey)

Monad m => ToJSON m (Some Key)

Monad m => ToJSON m (PublicKey typ)

Monad m => ToJSON m (Key typ)

Monad m => ToJSON m (Some Replacement)

Monad m => ToJSON m (Some Pattern)

Monad m => ToJSON m (Replacement typ)

Monad m => ToJSON m (Pattern typ)

(Monad m, ToJSON m a) => ToJSON m (UninterpretedSignatures a)

(Monad m, ToJSON m a) => ToJSON m (Signed a)

Monad m => ToJSON m (RoleSpec a)

(Monad m, ToObjectKey m k, ToJSON m a) => ToJSON m (Map k a)

class FromJSON m a where

Methods

fromJSON :: JSValue -> m a

Instances

ReportSchemaErrors m => FromJSON m URI

ReportSchemaErrors m => FromJSON m UTCTime

ReportSchemaErrors m => FromJSON m Int

ReportSchemaErrors m => FromJSON m String

Monad m => FromJSON m JSValue

ReportSchemaErrors m => FromJSON m KeyEnv

ReportSchemaErrors m => FromJSON m Hash

ReportSchemaErrors m => FromJSON m FileLength

ReportSchemaErrors m => FromJSON m KeyThreshold

ReportSchemaErrors m => FromJSON m FileInfo

ReportSchemaErrors m => FromJSON m FileMap

ReportSchemaErrors m => FromJSON m Header

ReportSchemaErrors m => FromJSON m FileExpires

ReportSchemaErrors m => FromJSON m FileVersion

ReportSchemaErrors m => FromJSON m PreSignature

MonadKeys m => FromJSON m Signatures

(MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Mirrors

ReportSchemaErrors m => FromJSON m Mirror

(MonadReader RepoLayout m, MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Snapshot

MonadKeys m => FromJSON m Targets

MonadKeys m => FromJSON m Delegations

MonadKeys m => FromJSON m DelegationSpec

(MonadReader RepoLayout m, MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Timestamp

MonadKeys m => FromJSON m RootRoles

(ReportSchemaErrors m, FromJSON m a) => FromJSON m [a]

ReportSchemaErrors m => FromJSON m (Some KeyType)

ReportSchemaErrors m => FromJSON m (Some PublicKey)

ReportSchemaErrors m => FromJSON m (Some Key)

ReportSchemaErrors m => FromJSON m (Some Replacement)

ReportSchemaErrors m => FromJSON m (Some Pattern)

(ReportSchemaErrors m, FromJSON m a) => FromJSON m (UninterpretedSignatures a)

MonadKeys m => FromJSON m (Signed Mirrors)

(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Snapshot)

MonadKeys m => FromJSON m (Signed Targets)

(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Timestamp)

MonadKeys m => FromJSON m (RoleSpec a)

MonadKeys m => FromJSON m (Signed Root)

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.

(ReportSchemaErrors m, Ord k, FromObjectKey m k, FromJSON m a) => FromJSON m (Map k a)

class ToObjectKey m a where

Used in the ToJSON instance for Map

Methods

toObjectKey :: a -> m String

Instances

Monad m => ToObjectKey m String

Monad m => ToObjectKey m KeyId

Monad m => ToObjectKey m HashFn

Monad m => ToObjectKey m TargetPath

Monad m => ToObjectKey m (Path (Rooted root))

Monad m => ToObjectKey m (Path Unrooted)

class FromObjectKey m a where

Used in the FromJSON instance for Map

Methods

fromObjectKey :: String -> m a

Instances

Monad m => FromObjectKey m String

Monad m => FromObjectKey m KeyId

ReportSchemaErrors m => FromObjectKey m HashFn

ReportSchemaErrors m => FromObjectKey m TargetPath

Monad m => FromObjectKey m (Path (Rooted root))

Monad m => FromObjectKey m (Path Unrooted)

class (Applicative m, Monad m) => ReportSchemaErrors m where

Monads in which we can report schema errors

Methods

expected :: Expected -> Maybe Got -> m a

Instances

ReportSchemaErrors ReadJSON_NoKeys_NoLayout

ReportSchemaErrors ReadJSON_Keys_NoLayout

ReportSchemaErrors ReadJSON_Keys_Layout

type Expected = String

type Got = String

expected' :: ReportSchemaErrors m => Expected -> JSValue -> m a

Utility

fromJSObject :: ReportSchemaErrors m => JSValue -> m [(String, JSValue)]

fromJSField :: (ReportSchemaErrors m, FromJSON m a) => JSValue -> String -> m a

Extract a field from a JSON object

fromJSOptField :: (ReportSchemaErrors m, FromJSON m a) => JSValue -> String -> m (Maybe a)

mkObject :: forall m. Monad m => [(String, m JSValue)] -> m JSValue

Re-exports

data JSValue

Constructors

JSNull

JSBool !Bool

JSNum !Int

JSString String

JSArray [JSValue]

JSObject [(String, JSValue)]

Instances

Eq JSValue

Ord JSValue

Read JSValue

Show JSValue

Monad m => FromJSON m JSValue

Monad m => ToJSON m JSValue