type ProtoCommand BrokerMsg
Instance details Defined in Simplex.Messaging.Protocol type ProtoCommand BrokerMsg = Cmd
type ProtoType BrokerMsg
Instance details Defined in Simplex.Messaging.Protocol type ProtoType BrokerMsg = 'PSMP

Methods

protocolClientHandshake :: Transport c => c 'TClient -> Maybe KeyPairX25519 -> KeyHash -> VersionRange SMPVersion -> Bool -> Maybe (ServiceCredentials, KeyPairEd25519) -> ExceptT TransportError IO (THandle SMPVersion c 'TClient) Source #

useServiceAuth :: ProtoCommand BrokerMsg -> Bool Source #

protocolPing :: ProtoCommand BrokerMsg Source #

protocolError :: BrokerMsg -> Maybe ErrorType Source #

ProtocolEncoding SMPVersion ErrorType BrokerMsg Source #

Instance details

Defined in Simplex.Messaging.Protocol

Associated Types

type Tag BrokerMsg
Instance details Defined in Simplex.Messaging.Protocol type Tag BrokerMsg = BrokerMsgTag

Methods

encodeProtocol :: Version SMPVersion -> BrokerMsg -> ByteString Source #

protocolP :: Version SMPVersion -> Tag BrokerMsg -> Parser BrokerMsg Source #

fromProtocolError :: ProtocolErrorType -> ErrorType Source #

checkCredentials :: Maybe TAuthorizations -> EntityId -> BrokerMsg -> Either ErrorType BrokerMsg Source #

ProtocolEncoding SMPVersion ErrorType Cmd Source #

Instance details

Defined in Simplex.Messaging.Protocol

Associated Types

type Tag Cmd
Instance details Defined in Simplex.Messaging.Protocol type Tag Cmd

Methods

encodeProtocol :: Version SMPVersion -> Cmd -> ByteString Source #

protocolP :: Version SMPVersion -> Tag Cmd -> Parser Cmd Source #

fromProtocolError :: ProtocolErrorType -> ErrorType Source #

checkCredentials :: Maybe TAuthorizations -> EntityId -> Cmd -> Either ErrorType Cmd Source #

PartyI p => ProtocolEncoding SMPVersion ErrorType (Command p) Source #

Instance details

Defined in Simplex.Messaging.Protocol

Associated Types

type Tag (Command p)
Instance details Defined in Simplex.Messaging.Protocol type Tag (Command p) = CommandTag p

Methods

encodeProtocol :: Version SMPVersion -> Command p -> ByteString Source #

protocolP :: Version SMPVersion -> Tag (Command p) -> Parser (Command p) Source #

fromProtocolError :: ProtocolErrorType -> ErrorType Source #

checkCredentials :: Maybe TAuthorizations -> EntityId -> Command p -> Either ErrorType (Command p) Source #

type VersionSMP = Version SMPVersion Source #

type VersionRangeSMP = VersionRange SMPVersion Source #

type THandleSMP (c :: TransportPeer -> Type) (p :: TransportPeer) = THandle SMPVersion c p Source #

alpnSupportedSMPHandshakes :: [ALPN] Source #

supportedClientSMPRelayVRange :: VersionRangeSMP Source #

supportedServerSMPRelayVRange :: VersionRangeSMP Source #

supportedProxyClientSMPRelayVRange :: VersionRangeSMP Source #

proxiedSMPRelayVRange :: VersionRangeSMP Source #

minClientSMPRelayVersion :: VersionSMP Source #

minServerSMPRelayVersion :: VersionSMP Source #

currentClientSMPRelayVersion :: VersionSMP Source #

currentServerSMPRelayVersion :: VersionSMP Source #

authCmdsSMPVersion :: VersionSMP Source #

sendingProxySMPVersion :: VersionSMP Source #

sndAuthKeySMPVersion :: VersionSMP Source #

deletedEventSMPVersion :: VersionSMP Source #

encryptedBlockSMPVersion :: VersionSMP Source #

blockedEntitySMPVersion :: VersionSMP Source #

shortLinksSMPVersion :: VersionSMP Source #

serviceCertsSMPVersion :: VersionSMP Source #

newNtfCredsSMPVersion :: VersionSMP Source #

clientNoticesSMPVersion :: VersionSMP Source #

simplexMQVersion :: String Source #

smpBlockSize :: Int Source #

data TransportConfig Source #

Constructors

TransportConfig
Fields logTLSErrors :: Bool transportTimeout :: Maybe Int

Transport connection class

class Typeable c => Transport (c :: TransportPeer -> Type) where Source #

Minimal complete definition

transportName, transportConfig, getTransportConnection, certificateSent, getPeerCertChain, tlsUnique, getSessionALPN, closeConnection, cGet, cPut, getLn

Methods

transport :: forall (p :: TransportPeer). ATransport p Source #

transportName :: forall (p :: TransportPeer). TProxy c p -> String Source #

transportConfig :: forall (p :: TransportPeer). c p -> TransportConfig Source #

getTransportConnection :: forall (p :: TransportPeer). TransportPeerI p => TransportConfig -> Bool -> CertificateChain -> Context -> IO (c p) Source #

Upgrade TLS context to connection

certificateSent :: forall (p :: TransportPeer). c p -> Bool Source #

Whether TLS certificate chain was provided to peer It is always True for the server. It is True for the client when server requested it AND non-empty chain is sent.

getPeerCertChain :: forall (p :: TransportPeer). c p -> CertificateChain Source #

TLS certificate chain, server's in the client, client's in the server (empty chain for non-service clients)

tlsUnique :: forall (p :: TransportPeer). c p -> SessionId Source #

tls-unique channel binding per RFC5929

getSessionALPN :: forall (p :: TransportPeer). c p -> Maybe ALPN Source #

ALPN value negotiated for the session

closeConnection :: forall (p :: TransportPeer). c p -> IO () Source #

Close connection

cGet :: forall (p :: TransportPeer). c p -> Int -> IO ByteString Source #

Read fixed number of bytes from connection

cPut :: forall (p :: TransportPeer). c p -> ByteString -> IO () Source #

Write bytes to connection

getLn :: forall (p :: TransportPeer). c p -> IO ByteString Source #

Receive ByteString from connection, allowing LF or CRLF termination.

putLn :: forall (p :: TransportPeer). c p -> ByteString -> IO () Source #

Send ByteString to connection terminating it with CRLF.

Instances

Instances details

Transport TLS Source #
Instance details Defined in Simplex.Messaging.Transport Methods transport :: forall (p :: TransportPeer). ATransport p Source # transportName :: forall (p :: TransportPeer). TProxy TLS p -> String Source # transportConfig :: forall (p :: TransportPeer). TLS p -> TransportConfig Source # getTransportConnection :: forall (p :: TransportPeer). TransportPeerI p => TransportConfig -> Bool -> CertificateChain -> Context -> IO (TLS p) Source # certificateSent :: forall (p :: TransportPeer). TLS p -> Bool Source # getPeerCertChain :: forall (p :: TransportPeer). TLS p -> CertificateChain Source # tlsUnique :: forall (p :: TransportPeer). TLS p -> SessionId Source # getSessionALPN :: forall (p :: TransportPeer). TLS p -> Maybe ALPN Source # closeConnection :: forall (p :: TransportPeer). TLS p -> IO () Source # cGet :: forall (p :: TransportPeer). TLS p -> Int -> IO ByteString Source # cPut :: forall (p :: TransportPeer). TLS p -> ByteString -> IO () Source # getLn :: forall (p :: TransportPeer). TLS p -> IO ByteString Source # putLn :: forall (p :: TransportPeer). TLS p -> ByteString -> IO () Source #
Transport WS Source #
Instance details Defined in Simplex.Messaging.Transport.WebSockets Methods transport :: forall (p :: TransportPeer). ATransport p Source # transportName :: forall (p :: TransportPeer). TProxy WS p -> String Source # transportConfig :: forall (p :: TransportPeer). WS p -> TransportConfig Source # getTransportConnection :: forall (p :: TransportPeer). TransportPeerI p => TransportConfig -> Bool -> CertificateChain -> Context -> IO (WS p) Source # certificateSent :: forall (p :: TransportPeer). WS p -> Bool Source # getPeerCertChain :: forall (p :: TransportPeer). WS p -> CertificateChain Source # tlsUnique :: forall (p :: TransportPeer). WS p -> SessionId Source # getSessionALPN :: forall (p :: TransportPeer). WS p -> Maybe ALPN Source # closeConnection :: forall (p :: TransportPeer). WS p -> IO () Source # cGet :: forall (p :: TransportPeer). WS p -> Int -> IO ByteString Source # cPut :: forall (p :: TransportPeer). WS p -> ByteString -> IO () Source # getLn :: forall (p :: TransportPeer). WS p -> IO ByteString Source # putLn :: forall (p :: TransportPeer). WS p -> ByteString -> IO () Source #

data TProxy (c :: TransportPeer -> Type) (p :: TransportPeer) Source #

Constructors

TProxy

data ATransport (p :: TransportPeer) Source #

Constructors

Transport c => ATransport (TProxy c p)

type ASrvTransport = ATransport 'TServer Source #

data TransportPeer Source #

Constructors

TClient
TServer

Instances

Instances details

Show TransportPeer Source #
Instance details Defined in Simplex.Messaging.Transport Methods showsPrec :: Int -> TransportPeer -> ShowS show :: TransportPeer -> String showList :: [TransportPeer] -> ShowS
Eq TransportPeer Source #
Instance details Defined in Simplex.Messaging.Transport Methods (==) :: TransportPeer -> TransportPeer -> Bool (/=) :: TransportPeer -> TransportPeer -> Bool

data STransportPeer (p :: TransportPeer) where Source #

Constructors

STClient :: STransportPeer 'TClient
STServer :: STransportPeer 'TServer

class TransportPeerI (p :: TransportPeer) where Source #

Methods

sTransportPeer :: STransportPeer p Source #

Instances

Instances details

TransportPeerI 'TClient Source #
Instance details Defined in Simplex.Messaging.Transport Methods sTransportPeer :: STransportPeer 'TClient Source #
TransportPeerI 'TServer Source #
Instance details Defined in Simplex.Messaging.Transport Methods sTransportPeer :: STransportPeer 'TServer Source #

getServerVerifyKey :: Transport c => c 'TClient -> Either String APublicVerifyKey Source #

TLS Transport

data TLS (p :: TransportPeer) Source #

Constructors

TLS
Fields tlsContext :: Context tlsUniq :: ByteString tlsBuffer :: TBuffer tlsALPN :: Maybe ALPN tlsCertSent :: Bool tlsPeerCert :: CertificateChain tlsTransportConfig :: TransportConfig

Instances

Instances details

Transport TLS Source #

Instance details

Defined in Simplex.Messaging.Transport

Methods

transport :: forall (p :: TransportPeer). ATransport p Source #

transportName :: forall (p :: TransportPeer). TProxy TLS p -> String Source #

transportConfig :: forall (p :: TransportPeer). TLS p -> TransportConfig Source #

getTransportConnection :: forall (p :: TransportPeer). TransportPeerI p => TransportConfig -> Bool -> CertificateChain -> Context -> IO (TLS p) Source #

certificateSent :: forall (p :: TransportPeer). TLS p -> Bool Source #

getPeerCertChain :: forall (p :: TransportPeer). TLS p -> CertificateChain Source #

tlsUnique :: forall (p :: TransportPeer). TLS p -> SessionId Source #

getSessionALPN :: forall (p :: TransportPeer). TLS p -> Maybe ALPN Source #

closeConnection :: forall (p :: TransportPeer). TLS p -> IO () Source #

cGet :: forall (p :: TransportPeer). TLS p -> Int -> IO ByteString Source #

cPut :: forall (p :: TransportPeer). TLS p -> ByteString -> IO () Source #

getLn :: forall (p :: TransportPeer). TLS p -> IO ByteString Source #

putLn :: forall (p :: TransportPeer). TLS p -> ByteString -> IO () Source #

type SessionId = ByteString Source #

TLS-unique channel binding

type ServiceId = EntityId Source #

newtype EntityId Source #

Constructors

EntityId
Fields unEntityId :: ByteString

Instances

Instances details

Show EntityId Source #
Instance details Defined in Simplex.Messaging.Transport Methods showsPrec :: Int -> EntityId -> ShowS show :: EntityId -> String showList :: [EntityId] -> ShowS
Eq EntityId Source #
Instance details Defined in Simplex.Messaging.Transport Methods (==) :: EntityId -> EntityId -> Bool (/=) :: EntityId -> EntityId -> Bool
Ord EntityId Source #
Instance details Defined in Simplex.Messaging.Transport Methods compare :: EntityId -> EntityId -> Ordering (<) :: EntityId -> EntityId -> Bool (<=) :: EntityId -> EntityId -> Bool (>) :: EntityId -> EntityId -> Bool (>=) :: EntityId -> EntityId -> Bool max :: EntityId -> EntityId -> EntityId min :: EntityId -> EntityId -> EntityId
Encoding EntityId Source #
Instance details Defined in Simplex.Messaging.Transport Methods smpEncode :: EntityId -> ByteString Source # smpDecode :: ByteString -> Either String EntityId Source # smpP :: Parser EntityId Source #
StrEncoding EntityId Source #
Instance details Defined in Simplex.Messaging.Transport Methods strEncode :: EntityId -> ByteString Source # strDecode :: ByteString -> Either String EntityId Source # strP :: Parser EntityId Source #
FromField EntityId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods fromField :: FieldParser EntityId #
ToField EntityId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods toField :: EntityId -> SQLData #

pattern NoEntity :: EntityId Source #

type ALPN = ByteString Source #

connectTLS :: TLSParams p => Maybe HostName -> TransportConfig -> p -> Socket -> IO Context Source #

closeTLS :: Context -> IO () Source #

defaultSupportedParams :: Supported Source #

defaultSupportedParamsHTTPS :: Supported Source #

A selection of extra parameters to accomodate browser chains

withTlsUnique :: forall c (p :: TransportPeer). TransportPeerI p => Context -> (ByteString -> IO (c p)) -> IO (c p) Source #

SMP transport

data THandle v (c :: TransportPeer -> Type) (p :: TransportPeer) Source #

The handle for SMP encrypted transport connection over Transport.

Constructors

THandle
Fields connection :: c p params :: THandleParams v p

data THandleParams v (p :: TransportPeer) Source #

Constructors

THandleParams

Fields

sessionId :: SessionId
blockSize :: Int
thServerVRange :: VersionRange v
server protocol version range
thVersion :: Version v
agreed server protocol version
thAuth :: Maybe (THandleAuth p)
peer public key for command authorization and shared secrets for entity ID encryption
implySessId :: Bool
do NOT send session ID in transmission, but include it into signed message based on protocol version
encryptBlock :: Maybe TSbChainKeys
keys for additional transport encryption
batch :: Bool
send multiple transmissions in a single block based on protocol version
serviceAuth :: Bool
include service signature (or '0' if it is absent), based on protocol version

data THandleAuth (p :: TransportPeer) where Source #

Constructors

THAuthClient
Fields :: { peerServerPubKey :: PublicKeyX25519 , peerServerCertKey :: CertChainPubKey , clientService :: Maybe THClientService , sessSecret :: Maybe DhSecretX25519 } -> THandleAuth 'TClient
THAuthServer
Fields :: { serverPrivKey :: PrivateKeyX25519 , peerClientService :: Maybe THPeerClientService , sessSecret' :: Maybe DhSecretX25519 } -> THandleAuth 'TServer

data CertChainPubKey Source #

Constructors

CertChainPubKey
Fields certChain :: CertificateChain signedPubKey :: SignedExact PubKey

Instances

Instances details

Show CertChainPubKey Source #
Instance details Defined in Simplex.Messaging.Transport Methods showsPrec :: Int -> CertChainPubKey -> ShowS show :: CertChainPubKey -> String showList :: [CertChainPubKey] -> ShowS
Eq CertChainPubKey Source #
Instance details Defined in Simplex.Messaging.Transport Methods (==) :: CertChainPubKey -> CertChainPubKey -> Bool (/=) :: CertChainPubKey -> CertChainPubKey -> Bool
Encoding CertChainPubKey Source #
Instance details Defined in Simplex.Messaging.Transport Methods smpEncode :: CertChainPubKey -> ByteString Source # smpDecode :: ByteString -> Either String CertChainPubKey Source # smpP :: Parser CertChainPubKey Source #

data ServiceCredentials Source #

Constructors

ServiceCredentials
Fields serviceRole :: SMPServiceRole serviceCreds :: Credential serviceCertHash :: Fingerprint serviceSignKey :: APrivateSignKey

data THClientService' k Source #

Constructors

THClientService
Fields serviceId :: ServiceId serviceRole :: SMPServiceRole serviceCertHash :: Fingerprint serviceKey :: k

type THClientService = THClientService' PrivateKeyEd25519 Source #

type THPeerClientService = THClientService' PublicKeyEd25519 Source #

data SMPServiceRole Source #

Constructors

SRMessaging
SRNotifier
SRProxy

Instances

Instances details

Show SMPServiceRole Source #
Instance details Defined in Simplex.Messaging.Transport Methods showsPrec :: Int -> SMPServiceRole -> ShowS show :: SMPServiceRole -> String showList :: [SMPServiceRole] -> ShowS
Eq SMPServiceRole Source #
Instance details Defined in Simplex.Messaging.Transport Methods (==) :: SMPServiceRole -> SMPServiceRole -> Bool (/=) :: SMPServiceRole -> SMPServiceRole -> Bool
Encoding SMPServiceRole Source #
Instance details Defined in Simplex.Messaging.Transport Methods smpEncode :: SMPServiceRole -> ByteString Source # smpDecode :: ByteString -> Either String SMPServiceRole Source # smpP :: Parser SMPServiceRole Source #

data TSbChainKeys Source #

Constructors

TSbChainKeys
Fields sndKey :: TVar SbChainKey rcvKey :: TVar SbChainKey

data TransportError Source #

Error of SMP encrypted transport over TCP.

Constructors

TEBadBlock	error parsing transport block
TEVersion	incompatible client or server version
TELargeMsg	message does not fit in transport block
TEBadSession	incorrect session ID
TENoServerAuth	absent server key for v7 entity This error happens when the server did not provide a DH key to authorize commands for the queue that should be authorized with a DH key.
TEHandshake	transport handshake error
Fields handshakeErr :: HandshakeError

Instances

Instances details

FromJSON TransportError Source #
Instance details Defined in Simplex.Messaging.Transport Methods parseJSON :: Value -> Parser TransportError parseJSONList :: Value -> Parser [TransportError] omittedField :: Maybe TransportError
ToJSON TransportError Source #
Instance details Defined in Simplex.Messaging.Transport Methods toJSON :: TransportError -> Value toEncoding :: TransportError -> Encoding toJSONList :: [TransportError] -> Value toEncodingList :: [TransportError] -> Encoding omitField :: TransportError -> Bool
Exception TransportError Source #
Instance details Defined in Simplex.Messaging.Transport Methods toException :: TransportError -> SomeException fromException :: SomeException -> Maybe TransportError displayException :: TransportError -> String
Read TransportError Source #
Instance details Defined in Simplex.Messaging.Transport Methods readsPrec :: Int -> ReadS TransportError readList :: ReadS [TransportError] readPrec :: ReadPrec TransportError readListPrec :: ReadPrec [TransportError]
Show TransportError Source #
Instance details Defined in Simplex.Messaging.Transport Methods showsPrec :: Int -> TransportError -> ShowS show :: TransportError -> String showList :: [TransportError] -> ShowS
Eq TransportError Source #
Instance details Defined in Simplex.Messaging.Transport Methods (==) :: TransportError -> TransportError -> Bool (/=) :: TransportError -> TransportError -> Bool
Encoding TransportError Source #
Instance details Defined in Simplex.Messaging.Transport Methods smpEncode :: TransportError -> ByteString Source # smpDecode :: ByteString -> Either String TransportError Source # smpP :: Parser TransportError Source #

data HandshakeError Source #

Transport handshake error.

Constructors

PARSE	parsing error
IDENTITY	incorrect server identity
BAD_AUTH	v7 authentication failed
BAD_SERVICE	error reading/creating service record

Instances

Instances details

FromJSON HandshakeError Source #
Instance details Defined in Simplex.Messaging.Transport Methods parseJSON :: Value -> Parser HandshakeError parseJSONList :: Value -> Parser [HandshakeError] omittedField :: Maybe HandshakeError
ToJSON HandshakeError Source #
Instance details Defined in Simplex.Messaging.Transport Methods toJSON :: HandshakeError -> Value toEncoding :: HandshakeError -> Encoding toJSONList :: [HandshakeError] -> Value toEncodingList :: [HandshakeError] -> Encoding omitField :: HandshakeError -> Bool
Exception HandshakeError Source #
Instance details Defined in Simplex.Messaging.Transport Methods toException :: HandshakeError -> SomeException fromException :: SomeException -> Maybe HandshakeError displayException :: HandshakeError -> String
Read HandshakeError Source #
Instance details Defined in Simplex.Messaging.Transport Methods readsPrec :: Int -> ReadS HandshakeError readList :: ReadS [HandshakeError] readPrec :: ReadPrec HandshakeError readListPrec :: ReadPrec [HandshakeError]
Show HandshakeError Source #
Instance details Defined in Simplex.Messaging.Transport Methods showsPrec :: Int -> HandshakeError -> ShowS show :: HandshakeError -> String showList :: [HandshakeError] -> ShowS
Eq HandshakeError Source #
Instance details Defined in Simplex.Messaging.Transport Methods (==) :: HandshakeError -> HandshakeError -> Bool (/=) :: HandshakeError -> HandshakeError -> Bool

smpServerHandshake :: Transport c => CertificateChain -> APrivateSignKey -> c 'TServer -> KeyPairX25519 -> KeyHash -> VersionRangeSMP -> (SMPServiceRole -> CertificateChain -> Fingerprint -> ExceptT TransportError IO ServiceId) -> ExceptT TransportError IO (THandleSMP c 'TServer) Source #

Server SMP transport handshake.

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

smpClientHandshake :: Transport c => c 'TClient -> Maybe KeyPairX25519 -> KeyHash -> VersionRangeSMP -> Bool -> Maybe (ServiceCredentials, KeyPairEd25519) -> ExceptT TransportError IO (THandleSMP c 'TClient) Source #

Client SMP transport handshake.

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

tPutBlock :: forall (c :: TransportPeer -> Type) v (p :: TransportPeer). Transport c => THandle v c p -> ByteString -> IO (Either TransportError ()) Source #

Pad and send block to SMP transport.

tGetBlock :: forall (c :: TransportPeer -> Type) v (p :: TransportPeer). Transport c => THandle v c p -> IO (Either TransportError ByteString) Source #

Receive block from SMP transport.

sendHandshake :: forall (c :: TransportPeer -> Type) smp v (p :: TransportPeer). (Transport c, Encoding smp) => THandle v c p -> smp -> ExceptT TransportError IO () Source #

getHandshake :: forall (c :: TransportPeer -> Type) smp v (p :: TransportPeer). (Transport c, Encoding smp) => THandle v c p -> ExceptT TransportError IO smp Source #

smpTHParamsSetVersion :: forall (p :: TransportPeer). VersionSMP -> THandleParams SMPVersion p -> THandleParams SMPVersion p Source #