Safe Haskell | None |
---|---|
Language | Haskell2010 |
Hackage.Security.Server
Contents
- Re-exports
- Key types
- Types abstracting over key types
- Key types in isolation
- Hiding key types
- Operations on keys
- Key IDs
- Signing
- Types
- Utility
- Cache layout
- Repository layout
- Repository layout
- TUF types
- Repository
- Index
- Cache
- Datatypes
- TUF types
- Construction and verification
- JSON aids
- Avoid interpreting signatures
- TUF types
Description
Main entry point into the Hackage Security framework for clients
- module Hackage.Security.JSON
- data Ed25519
- data Key a where
- KeyEd25519 :: PublicKey -> SecretKey -> Key Ed25519
- data PublicKey a where
- data PrivateKey a where
- data KeyType typ where
- somePublicKey :: Some Key -> Some PublicKey
- somePublicKeyType :: Some PublicKey -> Some KeyType
- someKeyId :: 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 {}
- class HasKeyId key where
- sign :: PrivateKey typ -> ByteString -> ByteString
- verify :: PublicKey typ -> ByteString -> ByteString -> Bool
- newtype FileLength = FileLength {
- fileLength :: Int54
- newtype Hash = Hash String
- newtype KeyThreshold = KeyThreshold Int54
- data FileInfo = FileInfo {}
- data HashFn
- newtype Hash = Hash String
- fileInfo :: ByteString -> FileInfo
- computeFileInfo :: FsRoot root => Path root -> IO FileInfo
- compareTrustedFileInfo :: FileInfo -> FileInfo -> Bool
- knownFileInfoEqual :: FileInfo -> FileInfo -> Bool
- fileInfoSHA256 :: FileInfo -> Maybe Hash
- data Int54
- module Hackage.Security.TUF.FileMap
- class HasHeader a where
- newtype FileVersion = FileVersion Int54
- newtype FileExpires = FileExpires (Maybe UTCTime)
- data Header = Header {}
- expiresInDays :: UTCTime -> Integer -> FileExpires
- expiresNever :: FileExpires
- isExpired :: UTCTime -> FileExpires -> Bool
- versionInitial :: FileVersion
- versionIncrement :: FileVersion -> FileVersion
- data CacheLayout = CacheLayout {}
- cabalCacheLayout :: CacheLayout
- data IndexLayout = IndexLayout {
- indexFileToPath :: forall dec. IndexFile dec -> IndexPath
- indexFileFromPath :: IndexPath -> Maybe (Some IndexFile)
- data IndexFile :: * -> * where
- IndexPkgMetadata :: PackageIdentifier -> IndexFile (Signed Targets)
- IndexPkgCabal :: PackageIdentifier -> IndexFile ()
- IndexPkgPrefs :: PackageName -> IndexFile ()
- hackageIndexLayout :: IndexLayout
- indexLayoutPkgMetadata :: IndexLayout -> PackageIdentifier -> IndexPath
- indexLayoutPkgCabal :: IndexLayout -> PackageIdentifier -> IndexPath
- indexLayoutPkgPrefs :: IndexLayout -> PackageName -> IndexPath
- data RepoLayout = RepoLayout {}
- hackageRepoLayout :: RepoLayout
- cabalLocalRepoLayout :: RepoLayout
- data Mirrors = Mirrors {}
- data Mirror = Mirror {}
- 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 Root = Root {}
- data RootRoles = RootRoles {}
- data RoleSpec a = RoleSpec {}
- data Signed a = Signed {
- signed :: a
- signatures :: Signatures
- newtype Signatures = Signatures [Signature]
- data Signature = 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 {}
- data PreSignature = PreSignature {}
- fromPreSignature :: MonadKeys m => PreSignature -> m Signature
- fromPreSignatures :: MonadKeys m => [PreSignature] -> m Signatures
- toPreSignature :: Signature -> PreSignature
- toPreSignatures :: Signatures -> [PreSignature]
- data Snapshot = Snapshot {}
- data Targets = Targets {}
- data Delegations = Delegations {}
- data DelegationSpec = DelegationSpec {}
- data Delegation = Delegation (Pattern a) (Replacement a)
- targetsLookup :: TargetPath -> Targets -> Maybe FileInfo
- data Timestamp = Timestamp {}
Re-exports
module Hackage.Security.JSON
Key types
Types abstracting over key types
Constructors
KeyEd25519 :: PublicKey -> SecretKey -> Key Ed25519 |
Constructors
PublicKeyEd25519 :: PublicKey -> PublicKey Ed25519 |
data PrivateKey a where #
Constructors
PrivateKeyEd25519 :: SecretKey -> PrivateKey Ed25519 |
Instances
SomeShow PrivateKey # | |
SomeEq PrivateKey # | |
Eq (PrivateKey typ) # | |
Show (PrivateKey typ) # | |
Key types in isolation
Constructors
KeyTypeEd25519 :: KeyType Ed25519 |
Hiding key types
Operations on keys
privateKey :: Key a -> PrivateKey a #
Key IDs
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 ntentially omitted. Use writeKeyAsId instead.
Constructors
KeyId | |
Fields |
Compute the key ID of a key
Minimal complete definition
Signing
sign :: PrivateKey typ -> ByteString -> ByteString #
Sign a bytestring and return the signature
TODO: It is unfortunate that we have to convert to a strict bytestring for ed25519
verify :: PublicKey typ -> ByteString -> ByteString -> Bool #
Types
newtype FileLength #
File length
Having verified file length information means we can protect against endless data attacks and similar.
Constructors
FileLength | |
Fields
|
Instances
Eq FileLength # | |
Ord FileLength # | |
Show FileLength # | |
ReportSchemaErrors m => FromJSON m FileLength # | |
Monad m => ToJSON m FileLength # | |
File hash
newtype KeyThreshold #
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
Eq KeyThreshold # | |
Ord KeyThreshold # | |
Show KeyThreshold # | |
ReportSchemaErrors m => FromJSON m KeyThreshold # | |
Monad m => ToJSON m KeyThreshold # | |
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 |
Constructors
HashFnSHA256 | |
HashFnMD5 |
File hash
Utility
fileInfo :: ByteString -> FileInfo #
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.
knownFileInfoEqual :: FileInfo -> FileInfo -> Bool #
Re-exports
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.
module Hackage.Security.TUF.FileMap
Minimal complete definition
Methods
fileExpires :: Lens' a FileExpires #
File expiry date
fileVersion :: Lens' a FileVersion #
File version (monotonically increasing counter)
newtype FileVersion #
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 use for example by hackage during the backup process).
Constructors
FileVersion Int54 |
Instances
Eq FileVersion # | |
Ord FileVersion # | |
Read FileVersion # | |
Show FileVersion # | |
ReportSchemaErrors m => FromJSON m FileVersion # | |
Monad m => ToJSON m FileVersion # | |
newtype FileExpires #
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
Eq FileExpires # | |
Ord FileExpires # | |
Show FileExpires # | |
ReportSchemaErrors m => FromJSON m FileExpires # | |
Monad m => ToJSON m FileExpires # | |
Occassionally it is useful to read only a header from a file.
HeaderOnly
intentionally only has a FromJSON
instance (no ToJSON
).
Constructors
Header | |
Fields |
Utility
expiresInDays :: UTCTime -> Integer -> FileExpires #
isExpired :: UTCTime -> FileExpires -> Bool #
Cache layout
data CacheLayout #
Location of the various files we cache
Although the generic TUF algorithms do not care how we organize the cache,
we nonetheless specity 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
|
cabalCacheLayout :: CacheLayout #
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).
Repository layout
data IndexLayout #
Layout of the files within the index tarball
Constructors
IndexLayout | |
Fields
|
data IndexFile :: * -> * where #
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 () |
hackageIndexLayout :: IndexLayout #
The layout of the index as maintained on Hackage
Utility
indexLayoutPkgPrefs :: IndexLayout -> PackageName -> IndexPath #
Repository layout
data RepoLayout #
Layout of a repository
Constructors
RepoLayout | |
Fields
|
hackageRepoLayout :: RepoLayout #
The layout used on Hackage
cabalLocalRepoLayout :: RepoLayout #
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.
TUF types
Constructors
Mirrors | |
Fields |
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 |
data MirrorContent #
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
Utility
type MirrorDescription = String #
describeMirror :: Mirror -> MirrorDescription #
Give a human-readable description of a particular mirror
(for use in error messages)
Repository
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.
anchorRepoPathLocally :: Path root -> RepoPath -> Path root #
Index
Cache
anchorCachePath :: Path root -> CachePath -> Path root #
Anchor a cache path to the location of the cache
Datatypes
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
|
Constructors
RootRoles | |
Role specification
The phantom type indicates what kind of type this role is meant to verify.
Constructors
RoleSpec | |
Fields |
TUF types
Constructors
Signed | |
Fields
|
Instances
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 (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. |
(Monad m, ToJSON m a) => ToJSON m (Signed a) # | |
newtype Signatures #
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
MonadKeys m => FromJSON m Signatures # | |
Monad m => ToJSON m Signatures # | |
Constructors
Signature | |
Fields |
Construction and verification
withSignatures :: ToJSON WriteJSON a => RepoLayout -> [Some Key] -> a -> Signed a #
Sign a document
withSignatures' :: ToJSON Identity a => [Some Key] -> a -> Signed a #
Variation on withSignatures
that doesn't need the repo layout
signRendered :: [Some Key] -> ByteString -> Signatures #
Construct signatures for already rendered value
verifySignature :: ByteString -> Signature -> Bool #
JSON aids
signedFromJSON :: (MonadKeys m, FromJSON m a) => JSValue -> m (Signed a) #
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 #
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.
Avoid interpreting signatures
data UninterpretedSignatures a #
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 |
Instances
(ReportSchemaErrors m, FromJSON m a) => FromJSON m (UninterpretedSignatures a) # | |
(Monad m, ToJSON m a) => ToJSON m (UninterpretedSignatures a) # | |
Show a => Show (UninterpretedSignatures a) # | |
data PreSignature #
A signature with a key ID (rather than an actual key)
This corresponds precisely to the TUF representation of a signature.
Constructors
PreSignature | |
Fields |
Instances
Show PreSignature # | |
ReportSchemaErrors m => FromJSON m PreSignature # | |
Monad m => ToJSON m PreSignature # | |
Utility
fromPreSignature :: MonadKeys m => PreSignature -> m Signature #
Convert a pre-signature to a signature
Verifies that the key type matches the advertised method.
fromPreSignatures :: MonadKeys m => [PreSignature] -> m Signatures #
Convert a list of PreSignature
s to a list of Signature
s
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 #
Convert signature to pre-signature
toPreSignatures :: Signatures -> [PreSignature] #
Convert list of pre-signatures to a list of signatures
Constructors
Snapshot | |
Fields
|
Instances
HasHeader Snapshot # | |
VerifyRole Snapshot # | |
(MonadReader RepoLayout m, MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Snapshot # | |
MonadReader RepoLayout m => ToJSON m Snapshot # | |
(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Snapshot) # | |
TUF types
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 | |
data Delegations #
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 |
Instances
Show Delegations # | |
MonadKeys m => FromJSON m Delegations # | |
Monad m => ToJSON m Delegations # | |
data DelegationSpec #
Delegation specification
NOTE: This is a close analogue of RoleSpec
.
Constructors
DelegationSpec | |
Fields |
Instances
Show DelegationSpec # | |
MonadKeys m => FromJSON m DelegationSpec # | |
Monad m => ToJSON m DelegationSpec # | |
data Delegation #
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
Util
targetsLookup :: TargetPath -> Targets -> Maybe FileInfo #
Constructors
Timestamp | |
Instances
HasHeader Timestamp # | |
VerifyRole Timestamp # | |
(MonadReader RepoLayout m, MonadError DeserializationError m, ReportSchemaErrors m) => FromJSON m Timestamp # | |
MonadReader RepoLayout m => ToJSON m Timestamp # | |
(MonadKeys m, MonadReader RepoLayout m) => FromJSON m (Signed Timestamp) # | |