Simplex.Messaging.Transport

This module defines basic TCP server and client and SMP protocol encrypted transport over TCP.

See https://github.com/simplex-chat/simplexmq/blob/master/protocol/simplex-messaging.md#appendix-a

Transport connection class

class Transport c where

Minimal complete definition

transportName, getServerConnection, getClientConnection, closeConnection, cGet, cPut, getLn

Methods

transport :: ATransport

transportName :: TProxy c -> String

getServerConnection :: Socket -> IO c

Upgrade client socket to connection (used in the server)

getClientConnection :: Socket -> IO c

Upgrade server socket to connection (used in the client)

closeConnection :: c -> IO ()

Close connection

cGet :: c -> Int -> IO ByteString

Read fixed number of bytes from connection

cPut :: c -> ByteString -> IO ()

Write bytes to connection

getLn :: c -> IO ByteString

Receive ByteString from connection, allowing LF or CRLF termination.

putLn :: c -> ByteString -> IO ()

Send ByteString to connection terminating it with CRLF.

Instances

Transport TCP

Defined in Simplex.Messaging.Transport

Methods

transport :: ATransport

transportName :: TProxy TCP -> String

getServerConnection :: Socket -> IO TCP

getClientConnection :: Socket -> IO TCP

closeConnection :: TCP -> IO ()

cGet :: TCP -> Int -> IO ByteString

cPut :: TCP -> ByteString -> IO ()

getLn :: TCP -> IO ByteString

putLn :: TCP -> ByteString -> IO ()

Transport WS

Defined in Simplex.Messaging.Transport.WebSockets

Methods

transport :: ATransport

transportName :: TProxy WS -> String

getServerConnection :: Socket -> IO WS

getClientConnection :: Socket -> IO WS

closeConnection :: WS -> IO ()

cGet :: WS -> Int -> IO ByteString

cPut :: WS -> ByteString -> IO ()

getLn :: WS -> IO ByteString

putLn :: WS -> ByteString -> IO ()

data TProxy c

Constructors

TProxy

data ATransport

Constructors

forall c.Transport c => ATransport (TProxy c)

Transport over TCP

runTransportServer :: (Transport c, MonadUnliftIO m) => TMVar Bool -> ServiceName -> (c -> m ()) -> m ()

Run transport server (plain TCP or WebSockets) on passed TCP port and signal when server started and stopped via passed TMVar.

All accepted connections are passed to the passed function.

runTransportClient :: Transport c => MonadUnliftIO m => HostName -> ServiceName -> (c -> m a) -> m a

Connect to passed TCP host:port and pass handle to the client.

TCP transport

newtype TCP

Constructors

TCP

Fields

• tcpHandle :: Handle

Instances

Transport TCP

Defined in Simplex.Messaging.Transport

Methods

transport :: ATransport

transportName :: TProxy TCP -> String

getServerConnection :: Socket -> IO TCP

getClientConnection :: Socket -> IO TCP

closeConnection :: TCP -> IO ()

cGet :: TCP -> Int -> IO ByteString

cPut :: TCP -> ByteString -> IO ()

getLn :: TCP -> IO ByteString

putLn :: TCP -> ByteString -> IO ()

SMP encrypted transport

data THandle c

The handle for SMP encrypted transport connection over Transport .

Constructors

THandle

Fields

• connection :: c
• sndKey :: SessionKey
• rcvKey :: SessionKey
• blockSize :: Int

data TransportError

Error of SMP encrypted transport over TCP.

Constructors

TEBadBlock

error parsing transport block

TEEncrypt

block encryption error

TEDecrypt

block decryption error

TEHandshake HandshakeError

transport handshake error

Instances

Eq TransportError

Defined in Simplex.Messaging.Transport

Methods

(==) :: TransportError -> TransportError -> Bool

(/=) :: TransportError -> TransportError -> Bool

Read TransportError

Defined in Simplex.Messaging.Transport

Methods

readsPrec :: Int -> ReadS TransportError

readList :: ReadS [TransportError]

readPrec :: ReadPrec TransportError

readListPrec :: ReadPrec [TransportError]

Show TransportError

Defined in Simplex.Messaging.Transport

Methods

showsPrec :: Int -> TransportError -> ShowS

show :: TransportError -> String

showList :: [TransportError] -> ShowS

Generic TransportError

Defined in Simplex.Messaging.Transport

Associated Types

type Rep TransportError :: Type -> Type

Methods

from :: TransportError -> Rep TransportError x

to :: Rep TransportError x -> TransportError

Arbitrary TransportError

Defined in Simplex.Messaging.Transport

Methods

arbitrary :: Gen TransportError

shrink :: TransportError -> [TransportError]

Exception TransportError

Defined in Simplex.Messaging.Transport

Methods

toException :: TransportError -> SomeException

fromException :: SomeException -> Maybe TransportError

displayException :: TransportError -> String

type Rep TransportError

Defined in Simplex.Messaging.Transport

type Rep TransportError

serverHandshake :: forall c. Transport c => c -> Int -> FullKeyPair -> ExceptT TransportError IO (THandle c)

Server SMP encrypted transport handshake.

See https://github.com/simplex-chat/simplexmq/blob/master/protocol/simplex-messaging.md#appendix-a

The numbers in function names refer to the steps in the document.

clientHandshake :: forall c. Transport c => c -> Maybe Int -> Maybe KeyHash -> ExceptT TransportError IO (THandle c)

Client SMP encrypted transport handshake.

See https://github.com/simplex-chat/simplexmq/blob/master/protocol/simplex-messaging.md#appendix-a

The numbers in function names refer to the steps in the document.

tPutEncrypted :: Transport c => THandle c -> ByteString -> IO (Either TransportError ())

Encrypt and send block to SMP encrypted transport.

tGetEncrypted :: Transport c => THandle c -> IO (Either TransportError ByteString)

Receive and decrypt block from SMP encrypted transport.

serializeTransportError :: TransportError -> ByteString

Serialize SMP encrypted transport error.

transportErrorP :: Parser TransportError

SMP encrypted transport error parser.

Trim trailing CR

trimCR :: ByteString -> ByteString

Trim trailing CR from ByteString.