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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
{-# LANGUAGE DeriveGeneric, FlexibleInstances #-}
{- | Main types for debug-me
-
- Note that changing types in ways that change the JSON serialization
- changes debug-me's wire format.
-}
module Types (
module Types,
Val(..)
) where
import Val
import GHC.Generics (Generic)
import Data.Aeson
import Data.Time.Clock.POSIX
-- | Things that the developer sees.
data Seen = Seen
{ seenData :: Val
}
deriving (Show, Generic)
instance ToJSON Seen
instance FromJSON Seen
-- | Things that the developer enters.
data Entered = Entered
{ enteredData :: Val
, echoData :: Val
-- ^ Data that is expected to be Seen, but has not been received
-- at the time this was entered.
}
deriving (Show, Generic)
instance ToJSON Entered
instance FromJSON Entered
-- | High level protocol.
data Proto a
= Proto a
-- ^ either Entered or Seen
| Rejected (Activity Entered)
-- ^ sent by user to indicate when an Entered value was rejected.
deriving (Show, Generic)
instance ToJSON (Proto Seen)
instance FromJSON (Proto Seen)
instance ToJSON (Proto Entered)
instance FromJSON (Proto Entered)
-- | A Proto activity (either Entered or Seen) with a pointer
-- to the Activity before this one.
--
-- The Signature is over both the data in the activity, and its pointer.
data Activity a = Activity
{ activity :: Proto a
, prevActivity :: (Maybe Hash)
, signature :: Signature
}
deriving (Show, Generic)
instance ToJSON (Activity Seen)
instance FromJSON (Activity Seen)
instance ToJSON (Activity Entered)
instance FromJSON (Activity Entered)
data SomeActivity
= ActivitySeen (Activity Seen)
| ActivityEntered (Activity Entered)
deriving (Show, Generic)
instance ToJSON (SomeActivity)
instance FromJSON (SomeActivity)
-- | A log of Activity both Entered and Seen, which can be recorded to
-- prove what happened in a debug-me session.
--
-- Note that the time stamp is included to allow replaying logs, but
-- it's not part of the provable session.
data ActivityLog = ActivityLog
{ loggedActivity :: SomeActivity
, loggedHash :: Hash
, loggedTimestamp :: Timestamp
}
deriving (Show, Generic)
instance ToJSON (ActivityLog)
instance FromJSON (ActivityLog)
type Timestamp = POSIXTime
newtype Signature = Signature Val
deriving (Show, Generic)
instance ToJSON Signature
instance FromJSON Signature
data Hash = Hash
{ hashMethod :: HashMethod
, hashValue :: Val
}
deriving (Show, Generic, Eq)
instance ToJSON Hash
instance FromJSON Hash
-- | We use SHA256. (SHA3 is included to future proof, and because it
-- improves the generated JSON.)
data HashMethod = SHA256 | SHA3
deriving (Show, Generic, Eq)
instance ToJSON HashMethod
instance FromJSON HashMethod
|
