diff options
| -rw-r--r-- | Log.hs | 2 | ||||
| -rw-r--r-- | Serialization.hs (renamed from Json.hs) | 4 | ||||
| -rw-r--r-- | TODO | 6 | ||||
| -rw-r--r-- | Types.hs | 20 | ||||
| -rw-r--r-- | Val.hs | 4 | ||||
| -rw-r--r-- | debug-me.cabal | 9 | ||||
| -rw-r--r-- | protocol.txt | 4 |
7 files changed, 35 insertions, 14 deletions
@@ -5,7 +5,7 @@ module Log where import Types import Hash import Memory -import Json +import Serialization import Data.Char import Data.Either diff --git a/Json.hs b/Serialization.hs index 4486d21..6940550 100644 --- a/Json.hs +++ b/Serialization.hs @@ -1,10 +1,12 @@ -module Json ( +module Serialization ( module Data.Aeson, + Serialize, Generic, sumOptions ) where import GHC.Generics (Generic) +import Data.Serialize import Data.Aeson import qualified Data.Aeson.Types as Aeson @@ -1,7 +1,5 @@ -* JSON serialization of signatures uses base64, and - does not compress well. gzip -9 of just the base64 signature - is 113 bytes, double the 64 byte actual size. Find a more efficient - encoding for bytestrings in JSON. +* Use protobuf for serialization, to make non-haskell implementations + easier? * Leave the prevMessage out of Activity serialization to save BW. Do include it in the data that gets signed, so it can be recovered by trying each likely (recently seen) Activity as the prevMessage, and @@ -2,8 +2,9 @@ {- | Main types for debug-me - - - Note that changing types in ways that change the JSON serialization - - changes debug-me's wire format. + - Note that changing types in ways that change the cereal serialization + - changes debug-me's wire format. Changing types in ways that change the + - aeson serialization changes debug-me's log format. -} module Types ( @@ -13,7 +14,7 @@ module Types ( import Val import Memory -import Json +import Serialization -- | Things that the developer sees. data Seen = Seen @@ -135,43 +136,56 @@ newtype GpgSig = GpgSig Val instance DataSize GpgSig where dataSize (GpgSig s) = dataSize s +instance Serialize Seen instance ToJSON Seen instance FromJSON Seen +instance Serialize Entered instance ToJSON Entered instance FromJSON Entered +instance Serialize (Activity Seen) instance ToJSON (Activity Seen) instance FromJSON (Activity Seen) +instance Serialize (Activity Entered) instance ToJSON (Activity Entered) instance FromJSON (Activity Entered) +instance Serialize Control instance ToJSON Control instance FromJSON Control +instance Serialize Hash instance ToJSON Hash instance FromJSON Hash +instance Serialize HashMethod instance ToJSON HashMethod instance FromJSON HashMethod +instance Serialize PublicKey instance ToJSON PublicKey instance FromJSON PublicKey +instance Serialize GpgSig instance ToJSON GpgSig instance FromJSON GpgSig +instance Serialize (Message Seen) instance ToJSON (Message Seen) where toJSON = genericToJSON sumOptions toEncoding = genericToEncoding sumOptions instance FromJSON (Message Seen) where parseJSON = genericParseJSON sumOptions +instance Serialize (Message Entered) instance ToJSON (Message Entered) where toJSON = genericToJSON sumOptions toEncoding = genericToEncoding sumOptions instance FromJSON (Message Entered) where parseJSON = genericParseJSON sumOptions +instance Serialize Signature instance ToJSON Signature where toJSON = genericToJSON sumOptions toEncoding = genericToEncoding sumOptions instance FromJSON Signature where parseJSON = genericParseJSON sumOptions +instance Serialize ControlAction instance ToJSON ControlAction where toJSON = genericToJSON sumOptions toEncoding = genericToEncoding sumOptions @@ -3,9 +3,9 @@ module Val where import Memory +import Serialization import GHC.Generics (Generic) -import Data.Aeson import Data.Aeson.Types import qualified Codec.Binary.Base64 as B64 import qualified Data.Text as T @@ -19,6 +19,8 @@ newtype Val = Val { val :: B.ByteString } instance DataSize Val where dataSize (Val b) = fromIntegral (B.length b) +instance Serialize Val + -- | JSON instances for Val, using base64 encoding when the value -- is not utf-8 encoded, and otherwise using a more efficient encoding. instance ToJSON Val where diff --git a/debug-me.cabal b/debug-me.cabal index 05ab1e9..5042ee3 100644 --- a/debug-me.cabal +++ b/debug-me.cabal @@ -22,7 +22,7 @@ Executable debug-me Main-Is: debug-me.hs GHC-Options: -threaded -Wall -fno-warn-tabs -O2 Build-Depends: - base (>= 4.5 && < 5.0) + base (>= 4.9 && < 5.0) , bytestring == 0.10.* , cryptonite (>= 0.20) , unix (>= 2.7) @@ -33,24 +33,27 @@ Executable debug-me , terminal-size (>= 0.3) , aeson (>= 0.11 && < 1.1) , sandi (>= 0.4) - , text (>= 1.2) + , text (>= 1.2.2) + , cereal (>= 0.5) , optparse-applicative (>= 0.12) , graphviz (== 2999.18.*) , time (>= 1.6) , unbounded-delays (>= 0.1) , memory (>= 0.13) + --, websockets (>= 0.9) + --, wai-websockets (>= 3.0) Other-Modules: CmdLine Crypto Graphviz Hash - Json Log Memory Pty Replay Session Types + Serialization Val source-repository head diff --git a/protocol.txt b/protocol.txt index c71a84f..687c085 100644 --- a/protocol.txt +++ b/protocol.txt @@ -3,7 +3,9 @@ the two participants, known as the user and the developer. (The exact composition of the JSON objects is not described here; see Types.hs for the data types that JSON serialization instances are derived -from.) +from. Also, debug-me uses a binary format instead of sending JSON +over the wire. The wire format is currently implemented using the +Haskell cereal library, and is not specified.) The Activity type is the main message type. The user sends Activity Seen messages, and the developer responds with Activity Entered. |