summaryrefslogtreecommitdiffhomepage
path: root/Types.hs
blob: 2be82a85e682fe738bfa2fade72cdf1cd6ae3f1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
{-# LANGUAGE OverloadedStrings #-}

module Types where

import qualified Data.ByteString as B
import qualified Data.ByteString.Char8 as B8
import Raaz.Core.Encode
import Data.Monoid
import Data.Word
import Data.Time.Clock
import Text.Read

-- | A password used to encrypt a key stored in keysafe.
newtype Password = Password B.ByteString

-- | A name associated with a key stored in keysafe.
newtype Name = Name B.ByteString
	deriving (Show)

-- | The type of the key that is stored in keysafe.
newtype KeyType = KeyType B.ByteString
	deriving (Show)

gpgKey :: KeyType
gpgKey = KeyType "gpg"

-- | Enough information to uniquely identify a key stored in keysafe.
data KeyIdent = KeyIdent KeyType Name
	deriving (Show)

-- | A KeyIdent is serialized in the form "keytype name".
-- For example "gpg Joey Hess"
instance Encodable KeyIdent where
	toByteString (KeyIdent (KeyType t) (Name n)) =
		t <> B.singleton identSepChar <> n
	fromByteString b = case B.break (== identSepChar) b of
		(t, n)
			| B.null n -> Nothing
			| otherwise -> Just $
				KeyIdent (KeyType t) (Name (B.drop 1 n))

identSepChar :: Word8
identSepChar = 32

newtype ShardNum = ShardNum Int
	deriving (Show)

-- | Enough information to uniquely identify an object stored on a keysafe
-- server for a key.
data ObjectIdent = ObjectIdent ShardNum KeyIdent
	deriving (Show)

-- | An ObjectIdent is serialied in the form "shardnum keytype name"
-- For example "1 gpg Joey Hess"
instance Encodable ObjectIdent where
	toByteString (ObjectIdent (ShardNum n) keyident) =
		B8.pack (show n) <> B.singleton identSepChar <> toByteString keyident
	fromByteString b = case B.break (== identSepChar) b of
		(ns, rest)
			| B.null ns -> Nothing
			| otherwise -> do
				keyident <- fromByteString (B.drop 1 rest)
				n <- readMaybe (B8.unpack ns)
				return $ ObjectIdent (ShardNum n) keyident

-- | An estimated cost to perform an operation.
data Cost = CPUCost Seconds | GPUCost Seconds
	deriving (Show)

newtype Seconds = Seconds NominalDiffTime
	deriving (Show)

data Benchmark t = Benchmark { expectedBenchmark :: t, actualBenchmark :: t }
	deriving (Show)

-- | In testing mode, the cryptographic difficulty is dialed back.
data RunMode = SecureMode | TestingMode
	deriving (Show)