Safe Haskell	None
Language	Haskell2010

Simplex.Messaging.Notifications.Transport

Synopsis

ntfBlockSize :: Int
data NTFVersion
type VersionNTF = Version NTFVersion
type VersionRangeNTF = VersionRange NTFVersion
pattern VersionNTF :: Word16 -> VersionNTF
initialNTFVersion :: VersionNTF
authBatchCmdsNTFVersion :: VersionNTF
invalidReasonNTFVersion :: VersionNTF
currentClientNTFVersion :: VersionNTF
currentServerNTFVersion :: VersionNTF
supportedClientNTFVRange :: VersionRangeNTF
legacyServerNTFVRange :: VersionRangeNTF
supportedServerNTFVRange :: VersionRangeNTF
alpnSupportedNTFHandshakes :: [ALPN]
type THandleNTF (c :: TransportPeer -> Type) (p :: TransportPeer) = THandle NTFVersion c p
data NtfServerHandshake = NtfServerHandshake {
- ntfVersionRange :: VersionRangeNTF
- sessionId :: SessionId
- authPubKey :: Maybe (SignedExact PubKey)
}
data NtfClientHandshake = NtfClientHandshake {
- ntfVersion :: VersionNTF
- keyHash :: KeyHash
}
encodeAuthEncryptCmds :: Encoding a => VersionNTF -> Maybe a -> ByteString
authEncryptCmdsP :: VersionNTF -> Parser a -> Parser (Maybe a)
ntfServerHandshake :: Transport c => APrivateSignKey -> c 'TServer -> KeyPairX25519 -> KeyHash -> VersionRangeNTF -> ExceptT TransportError IO (THandleNTF c 'TServer)
ntfClientHandshake :: Transport c => c 'TClient -> KeyHash -> VersionRangeNTF -> Bool -> Maybe (ServiceCredentials, KeyPairEd25519) -> ExceptT TransportError IO (THandleNTF c 'TClient)
ntfThHandleServer :: forall (c :: TransportPeer -> Type). THandleNTF c 'TServer -> VersionNTF -> VersionRangeNTF -> PrivateKeyX25519 -> THandleNTF c 'TServer
ntfThHandleClient :: forall (c :: TransportPeer -> Type). THandleNTF c 'TClient -> VersionNTF -> VersionRangeNTF -> Maybe (PublicKeyX25519, CertChainPubKey) -> THandleNTF c 'TClient
ntfThHandle_ :: forall (c :: TransportPeer -> Type) (p :: TransportPeer). THandleNTF c p -> VersionNTF -> VersionRangeNTF -> Maybe (THandleAuth p) -> THandleNTF c p
ntfTHandle :: forall c (p :: TransportPeer). Transport c => c p -> THandleNTF c p

Documentation

ntfBlockSize :: Int Source #

data NTFVersion Source #

Instances

Instances details

VersionScope NTFVersion Source #

Instance details

Defined in Simplex.Messaging.Notifications.Transport

Protocol NTFVersion ErrorType NtfResponse Source #

Instance details

Defined in Simplex.Messaging.Notifications.Protocol

Associated Types

type ProtoCommand NtfResponse
Instance details Defined in Simplex.Messaging.Notifications.Protocol type ProtoCommand NtfResponse = NtfCmd
type ProtoType NtfResponse
Instance details Defined in Simplex.Messaging.Notifications.Protocol type ProtoType NtfResponse = 'PNTF

Methods

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

useServiceAuth :: ProtoCommand NtfResponse -> Bool Source #

protocolPing :: ProtoCommand NtfResponse Source #

protocolError :: NtfResponse -> Maybe ErrorType Source #

ProtocolEncoding NTFVersion ErrorType NtfCmd Source #

Instance details

Defined in Simplex.Messaging.Notifications.Protocol

Associated Types

type Tag NtfCmd
Instance details Defined in Simplex.Messaging.Notifications.Protocol type Tag NtfCmd = NtfCmdTag

Methods

encodeProtocol :: Version NTFVersion -> NtfCmd -> ByteString Source #

protocolP :: Version NTFVersion -> Tag NtfCmd -> Parser NtfCmd Source #

fromProtocolError :: ProtocolErrorType -> ErrorType Source #

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

ProtocolEncoding NTFVersion ErrorType NtfResponse Source #

Instance details

Defined in Simplex.Messaging.Notifications.Protocol

Associated Types

type Tag NtfResponse
Instance details Defined in Simplex.Messaging.Notifications.Protocol type Tag NtfResponse = NtfResponseTag

Methods

encodeProtocol :: Version NTFVersion -> NtfResponse -> ByteString Source #

protocolP :: Version NTFVersion -> Tag NtfResponse -> Parser NtfResponse Source #

fromProtocolError :: ProtocolErrorType -> ErrorType Source #

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

NtfEntityI e => ProtocolEncoding NTFVersion ErrorType (NtfCommand e) Source #

Instance details

Defined in Simplex.Messaging.Notifications.Protocol

Associated Types

type Tag (NtfCommand e)
Instance details Defined in Simplex.Messaging.Notifications.Protocol type Tag (NtfCommand e) = NtfCommandTag e

Methods

encodeProtocol :: Version NTFVersion -> NtfCommand e -> ByteString Source #

protocolP :: Version NTFVersion -> Tag (NtfCommand e) -> Parser (NtfCommand e) Source #

fromProtocolError :: ProtocolErrorType -> ErrorType Source #

checkCredentials :: Maybe TAuthorizations -> EntityId -> NtfCommand e -> Either ErrorType (NtfCommand e) Source #

type VersionNTF = Version NTFVersion Source #

type VersionRangeNTF = VersionRange NTFVersion Source #

pattern VersionNTF :: Word16 -> VersionNTF Source #

initialNTFVersion :: VersionNTF Source #

authBatchCmdsNTFVersion :: VersionNTF Source #

invalidReasonNTFVersion :: VersionNTF Source #

currentClientNTFVersion :: VersionNTF Source #

currentServerNTFVersion :: VersionNTF Source #

supportedClientNTFVRange :: VersionRangeNTF Source #

legacyServerNTFVRange :: VersionRangeNTF Source #

supportedServerNTFVRange :: VersionRangeNTF Source #

alpnSupportedNTFHandshakes :: [ALPN] Source #

type THandleNTF (c :: TransportPeer -> Type) (p :: TransportPeer) = THandle NTFVersion c p Source #

data NtfServerHandshake Source #

Constructors

NtfServerHandshake
Fields ntfVersionRange :: VersionRangeNTF sessionId :: SessionId authPubKey :: Maybe (SignedExact PubKey)

Instances

Instances details

Encoding NtfServerHandshake Source #
Instance details Defined in Simplex.Messaging.Notifications.Transport Methods smpEncode :: NtfServerHandshake -> ByteString Source # smpDecode :: ByteString -> Either String NtfServerHandshake Source # smpP :: Parser NtfServerHandshake Source #

data NtfClientHandshake Source #

Constructors

NtfClientHandshake
Fields ntfVersion :: VersionNTF agreed SMP notifications server protocol version keyHash :: KeyHash server identity - CA certificate fingerprint

Instances

Instances details

Encoding NtfClientHandshake Source #
Instance details Defined in Simplex.Messaging.Notifications.Transport Methods smpEncode :: NtfClientHandshake -> ByteString Source # smpDecode :: ByteString -> Either String NtfClientHandshake Source # smpP :: Parser NtfClientHandshake Source #

encodeAuthEncryptCmds :: Encoding a => VersionNTF -> Maybe a -> ByteString Source #

authEncryptCmdsP :: VersionNTF -> Parser a -> Parser (Maybe a) Source #

ntfServerHandshake :: Transport c => APrivateSignKey -> c 'TServer -> KeyPairX25519 -> KeyHash -> VersionRangeNTF -> ExceptT TransportError IO (THandleNTF c 'TServer) Source #

Notifcations server transport handshake.

ntfClientHandshake :: Transport c => c 'TClient -> KeyHash -> VersionRangeNTF -> Bool -> Maybe (ServiceCredentials, KeyPairEd25519) -> ExceptT TransportError IO (THandleNTF c 'TClient) Source #

Notifcations server client transport handshake.

ntfThHandleServer :: forall (c :: TransportPeer -> Type). THandleNTF c 'TServer -> VersionNTF -> VersionRangeNTF -> PrivateKeyX25519 -> THandleNTF c 'TServer Source #

ntfThHandleClient :: forall (c :: TransportPeer -> Type). THandleNTF c 'TClient -> VersionNTF -> VersionRangeNTF -> Maybe (PublicKeyX25519, CertChainPubKey) -> THandleNTF c 'TClient Source #

ntfThHandle_ :: forall (c :: TransportPeer -> Type) (p :: TransportPeer). THandleNTF c p -> VersionNTF -> VersionRangeNTF -> Maybe (THandleAuth p) -> THandleNTF c p Source #

ntfTHandle :: forall c (p :: TransportPeer). Transport c => c p -> THandleNTF c p Source #