adhoc-network-1.0.3: Ad-hoc P2P network protocol Source code Contents Index

Network.AdHoc.Message Maintainer Henning Guenther

Description

This module contains types representing the different kinds of messages defined by the protocol.

Synopsis

data CipherType = CipherDES_CBC | CipherNone | CipherUnknown String type TTL = Word16 type Delay = Word data Attachment = Attachment { attachmentFilename :: String attachmentAppType :: String attachmentContent :: ByteString } data EncryptedAttachment = EncryptedAttachment { encryptedAttachmentFilename :: Encrypted String encryptedAttachmentAppType :: Encrypted String encryptedAttachmentContent :: Encrypted ByteString } encryptAttachment :: Word64 -> Word64 -> Attachment -> EncryptedAttachment decryptAttachment :: Word64 -> EncryptedAttachment -> Maybe Attachment data Routed a sign = Routed { routedTTL :: TTL routedUserID :: UserID routedMsgID :: MessageID routedContent :: a routedSignature :: sign } type UnsignedMessage = ProtocolMessage NoSignature type InternalMessage = ProtocolMessage InternalSignature type ExternalMessage = ProtocolMessage ExternalSignature data ProtocolMessage sign = Hello { helloSenders :: [UserID] helloVersion :: Int helloGreeting :: Maybe String } | Ack { ackSender :: UserID ackMsgId :: MessageID } | Routing { routingRoutes :: [(UserID, Int)] } | Target (Routed TargetContent sign) | Flood (Routed FloodContent sign) | Obscure (Routed (RSAEncrypted String) ()) data TargetContent = Nack (Routed TargetContent ExternalSignature) | GetCertificate { getCertificateFor :: UserID } | Certificate { certificateReceivers :: [UserID] certificateFor :: UserID certificateData :: ByteString } | Message { messageReceivers :: [UserID] messageChannelName :: ChannelName messageChannelID :: ChannelID messageContent :: MessageContent messageTime :: UTCTime messageDelay :: Delay } | GetKey { getKeyReceiver :: UserID getKeyChannelName :: ChannelName getKeyChannelID :: ChannelID } | Key { keyReceiver :: UserID keyChannelName :: ChannelName keyChannelID :: ChannelID keyCipherType :: CipherType keyKey :: RSAEncrypted Word64 } data FloodContent = Channel { channelChannelName :: ChannelName channelChannelID :: ChannelID channelChannelTitle :: String channelUsers :: [UserID] channelPrivate :: Bool } | Join { joinChannelName :: ChannelName joinChannelID :: ChannelID } | Leave { leaveChannelName :: ChannelName leaveChannelID :: ChannelID } | Anonymous { anonymousText :: String anonymousAttachments :: [Attachment] anonymousTime :: UTCTime anonymousDelay :: Delay } data MessageContent = EncryptedMessage (Encrypted String) [EncryptedAttachment] | UnencryptedMessage String [Attachment] decrementTTL :: Routed a sign -> Maybe (Routed a sign) routeTo :: Routed TargetContent sign -> [UserID]

Documentation

data CipherType Source

Specifies the encryption algorithm used to encrypt a message Constructors CipherDES_CBC CipherNone CipherUnknown String An unknown cipher was used Instances Eq CipherType Show CipherType

type TTL = Word16 Source

TimeToLive has a maximum of 360, so 16 bit unsigned is enough to hold it

type Delay = Word Source

The message-delay can be represented by this type.

data Attachment Source

An attachmet as defined in the protocoll. Constructors Attachment attachmentFilename :: String Name of the attached file attachmentAppType :: String Mime-type of the very same attachmentContent :: ByteString The actual content of the file Instances Eq Attachment Show Attachment

data EncryptedAttachment Source

An attachment that has been encrypted. Constructors EncryptedAttachment encryptedAttachmentFilename :: Encrypted String Encrypted filename encryptedAttachmentAppType :: Encrypted String Encrypted mime-type encryptedAttachmentContent :: Encrypted ByteString Encrypted content Instances Eq EncryptedAttachment Show EncryptedAttachment

encryptAttachment Source

:: Word64 Key -> Word64 IV -> Attachment Attachment to be encrypted -> EncryptedAttachment Uses DES to encrypt an Attachment.

decryptAttachment Source

:: Word64 Key -> EncryptedAttachment Encrypted attachment -> Maybe Attachment Nothing at failure, Just when successful Uses DES to decrypt an EncryptedAttachment.

data Routed a sign Source

A class of messages that can be routed. Constructors Routed routedTTL :: TTL The time-to-live of the message routedUserID :: UserID Receiver of the routed message routedMsgID :: MessageID ID of the routed message routedContent :: a The actual content of the message routedSignature :: sign Signature of the message Instances Functor (Routed a) (Eq a, Eq sign) => Eq (Routed a sign) (Show a, Show sign) => Show (Routed a sign) Addressed (Routed (RSAEncrypted String) sign) Addressed (Routed TargetContent sign)

type UnsignedMessage = ProtocolMessage NoSignature Source

An unsigned message.

type InternalMessage = ProtocolMessage InternalSignature Source

An internal message that is subject to internal signature guidelines.

type ExternalMessage = ProtocolMessage ExternalSignature Source

An external message.

data ProtocolMessage sign Source

Basic protocol message representation. Constructors Hello Informs about a user on the sending node, giving the user-id, the protocol version and a friendly greeting helloSenders :: [UserID] helloVersion :: Int helloGreeting :: Maybe String Ack Sender of the original message and the sended message-id ackSender :: UserID ackMsgId :: MessageID Routing Routing informations, a list of users and how much hops it takes to reach them routingRoutes :: [(UserID, Int)] Target (Routed TargetContent sign) Messages with one specified receiver Flood (Routed FloodContent sign) Messages flooded through the network Obscure (Routed (RSAEncrypted String) ()) Obscure messages Instances Functor ProtocolMessage Eq sign => Eq (ProtocolMessage sign) Show sign => Show (ProtocolMessage sign)

data TargetContent Source

Messages directed to a specified receiver. Constructors Nack (Routed TargetContent ExternalSignature) Negative ACK GetCertificate Requesting a certificate getCertificateFor :: UserID Certificate Transmitting a certificate certificateReceivers :: [UserID] certificateFor :: UserID certificateData :: ByteString Message A chat message messageReceivers :: [UserID] messageChannelName :: ChannelName messageChannelID :: ChannelID messageContent :: MessageContent messageTime :: UTCTime messageDelay :: Delay GetKey Key request for a private channel getKeyReceiver :: UserID getKeyChannelName :: ChannelName getKeyChannelID :: ChannelID Key Key message for a private channel keyReceiver :: UserID keyChannelName :: ChannelName keyChannelID :: ChannelID keyCipherType :: CipherType keyKey :: RSAEncrypted Word64 Instances Eq TargetContent Show TargetContent Addressed (Routed TargetContent sign)

data FloodContent Source

Messages flooded throughout the entire network. Constructors Channel Channel announcements channelChannelName :: ChannelName channelChannelID :: ChannelID channelChannelTitle :: String channelUsers :: [UserID] channelPrivate :: Bool Join Join message for a channel joinChannelName :: ChannelName joinChannelID :: ChannelID Leave The users leaves a channel leaveChannelName :: ChannelName leaveChannelID :: ChannelID Anonymous An anonymous message that has been unpacked and will be flooded anonymousText :: String anonymousAttachments :: [Attachment] anonymousTime :: UTCTime anonymousDelay :: Delay Instances Eq FloodContent Show FloodContent

data MessageContent Source

A messages content can either be encrypted or not. Constructors EncryptedMessage (Encrypted String) [EncryptedAttachment] UnencryptedMessage String [Attachment] Instances Eq MessageContent Show MessageContent

decrementTTL :: Routed a sign -> Maybe (Routed a sign) Source

Decrements the time-to-live of a message. If it sinks under zero, Nothing is returned. Just msg otherwise, where msg has a decremented ttl.

routeTo :: Routed TargetContent sign -> [UserID] Source

Extracts the information from a message, that indicates, where to route it.

Produced by Haddock version 2.6.1