Safe Haskell	Safe-Inferred
Language	Haskell2010

Simplex.RemoteControl.Types

Synopsis

data RCErrorType
- = RCEInternal {
  - internalErr :: String
  }
- | RCEIdentity
- | RCENoLocalAddress
- | RCENewController
- | RCENotDiscovered
- | RCETLSStartFailed
- | RCEException {
  - exception :: String
  }
- | RCECtrlAuth
- | RCECtrlNotFound
- | RCECtrlError {
  - ctrlErr :: String
  }
- | RCEInvitation
- | RCEVersion
- | RCEEncrypt
- | RCEDecrypt
- | RCEBlockSize
- | RCESyntax {
  - syntaxErr :: String
  }
data RCPVersion
type VersionRCP = Version RCPVersion
type VersionRangeRCP = VersionRange RCPVersion
data RCHostHello = RCHostHello {
- v :: VersionRCP
- ca :: KeyHash
- app :: Value
- kem :: KEMPublicKey
}
data RCCtrlHello = RCCtrlHello {
}
data RCHostPairing = RCHostPairing {
- caKey :: APrivateSignKey
- caCert :: SignedCertificate
- idPrivKey :: PrivateKeyEd25519
- knownHost :: Maybe KnownHostPairing
}
data KnownHostPairing = KnownHostPairing {
- hostFingerprint :: KeyHash
- hostDhPubKey :: PublicKeyX25519
}
data RCCtrlAddress = RCCtrlAddress {
- address :: TransportHost
- interface :: Text
}
data RCCtrlPairing = RCCtrlPairing {
- caKey :: APrivateSignKey
- caCert :: SignedCertificate
- ctrlFingerprint :: KeyHash
- idPubKey :: PublicKeyEd25519
- dhPrivKey :: PrivateKeyX25519
- prevDhPrivKey :: Maybe PrivateKeyX25519
}
data RCHostKeys = RCHostKeys {
- sessKeys :: KeyPairEd25519
- dhKeys :: KeyPairX25519
}
data RCHostSession = RCHostSession {
- tls :: TLS 'TServer
- sessionKeys :: HostSessKeys
}
data HostSessKeys = HostSessKeys {
- chainKeys :: TSbChainKeys
- idPrivKey :: PrivateKeyEd25519
- sessPrivKey :: PrivateKeyEd25519
}
data RCCtrlSession = RCCtrlSession {
- tls :: TLS 'TClient
- sessionKeys :: CtrlSessKeys
}
data CtrlSessKeys = CtrlSessKeys {
- chainKeys :: TSbChainKeys
- idPubKey :: PublicKeyEd25519
- sessPubKey :: PublicKeyEd25519
}
data RCHostEncHello = RCHostEncHello {
- dhPubKey :: PublicKeyX25519
- nonce :: CbNonce
- encBody :: ByteString
}
data RCCtrlEncHello
- = RCCtrlEncHello {
  - kem :: KEMCiphertext
  - encBody :: ByteString
  }
- | RCCtrlEncError {
  - nonce :: CbNonce
  - encMessage :: ByteString
  }
type SessionCode = ByteString
type RCStepTMVar a = TMVar (Either RCErrorType a)
currentRCPVersion :: VersionRCP
supportedRCPVRange :: VersionRangeRCP

Documentation

data RCErrorType Source #

Constructors

RCEInternal
Fields internalErr :: String
RCEIdentity
RCENoLocalAddress
RCENewController
RCENotDiscovered
RCETLSStartFailed
RCEException
Fields exception :: String
RCECtrlAuth
RCECtrlNotFound
RCECtrlError
Fields ctrlErr :: String
RCEInvitation
RCEVersion
RCEEncrypt
RCEDecrypt
RCEBlockSize
RCESyntax
Fields syntaxErr :: String

Instances

Instances details

FromJSON RCErrorType Source #
Instance details Defined in Simplex.RemoteControl.Types Methods parseJSON :: Value -> Parser RCErrorType parseJSONList :: Value -> Parser [RCErrorType] omittedField :: Maybe RCErrorType
ToJSON RCErrorType Source #
Instance details Defined in Simplex.RemoteControl.Types Methods toJSON :: RCErrorType -> Value toEncoding :: RCErrorType -> Encoding toJSONList :: [RCErrorType] -> Value toEncodingList :: [RCErrorType] -> Encoding omitField :: RCErrorType -> Bool
Exception RCErrorType Source #
Instance details Defined in Simplex.RemoteControl.Types Methods toException :: RCErrorType -> SomeException fromException :: SomeException -> Maybe RCErrorType displayException :: RCErrorType -> String
Show RCErrorType Source #
Instance details Defined in Simplex.RemoteControl.Types Methods showsPrec :: Int -> RCErrorType -> ShowS show :: RCErrorType -> String showList :: [RCErrorType] -> ShowS
Eq RCErrorType Source #
Instance details Defined in Simplex.RemoteControl.Types Methods (==) :: RCErrorType -> RCErrorType -> Bool (/=) :: RCErrorType -> RCErrorType -> Bool
StrEncoding RCErrorType Source #
Instance details Defined in Simplex.RemoteControl.Types Methods strEncode :: RCErrorType -> ByteString Source # strDecode :: ByteString -> Either String RCErrorType Source # strP :: Parser RCErrorType Source #
AnyError RCErrorType Source #
Instance details Defined in Simplex.RemoteControl.Types Methods fromSomeException :: SomeException -> RCErrorType Source #

data RCPVersion Source #

Instances

Instances details

VersionScope RCPVersion Source #
Instance details Defined in Simplex.RemoteControl.Types

type VersionRCP = Version RCPVersion Source #

type VersionRangeRCP = VersionRange RCPVersion Source #

data RCHostHello Source #

Constructors

RCHostHello
Fields v :: VersionRCP ca :: KeyHash app :: Value kem :: KEMPublicKey

Instances

Instances details

FromJSON RCHostHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods parseJSON :: Value -> Parser RCHostHello parseJSONList :: Value -> Parser [RCHostHello] omittedField :: Maybe RCHostHello
ToJSON RCHostHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods toJSON :: RCHostHello -> Value toEncoding :: RCHostHello -> Encoding toJSONList :: [RCHostHello] -> Value toEncodingList :: [RCHostHello] -> Encoding omitField :: RCHostHello -> Bool
Show RCHostHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods showsPrec :: Int -> RCHostHello -> ShowS show :: RCHostHello -> String showList :: [RCHostHello] -> ShowS

data RCCtrlHello Source #

Constructors

RCCtrlHello

Instances

Instances details

FromJSON RCCtrlHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods parseJSON :: Value -> Parser RCCtrlHello parseJSONList :: Value -> Parser [RCCtrlHello] omittedField :: Maybe RCCtrlHello
ToJSON RCCtrlHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods toJSON :: RCCtrlHello -> Value toEncoding :: RCCtrlHello -> Encoding toJSONList :: [RCCtrlHello] -> Value toEncodingList :: [RCCtrlHello] -> Encoding omitField :: RCCtrlHello -> Bool
Show RCCtrlHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods showsPrec :: Int -> RCCtrlHello -> ShowS show :: RCCtrlHello -> String showList :: [RCCtrlHello] -> ShowS

data RCHostPairing Source #

Long-term part of controller (desktop) connection to host (mobile)

Constructors

RCHostPairing
Fields caKey :: APrivateSignKey caCert :: SignedCertificate idPrivKey :: PrivateKeyEd25519 knownHost :: Maybe KnownHostPairing

data KnownHostPairing Source #

Constructors

KnownHostPairing
Fields hostFingerprint :: KeyHash hostDhPubKey :: PublicKeyX25519

data RCCtrlAddress Source #

Constructors

RCCtrlAddress
Fields address :: TransportHost interface :: Text

Instances

Instances details

FromJSON RCCtrlAddress Source #
Instance details Defined in Simplex.RemoteControl.Types Methods parseJSON :: Value -> Parser RCCtrlAddress parseJSONList :: Value -> Parser [RCCtrlAddress] omittedField :: Maybe RCCtrlAddress
ToJSON RCCtrlAddress Source #
Instance details Defined in Simplex.RemoteControl.Types Methods toJSON :: RCCtrlAddress -> Value toEncoding :: RCCtrlAddress -> Encoding toJSONList :: [RCCtrlAddress] -> Value toEncodingList :: [RCCtrlAddress] -> Encoding omitField :: RCCtrlAddress -> Bool
Show RCCtrlAddress Source #
Instance details Defined in Simplex.RemoteControl.Types Methods showsPrec :: Int -> RCCtrlAddress -> ShowS show :: RCCtrlAddress -> String showList :: [RCCtrlAddress] -> ShowS
Eq RCCtrlAddress Source #
Instance details Defined in Simplex.RemoteControl.Types Methods (==) :: RCCtrlAddress -> RCCtrlAddress -> Bool (/=) :: RCCtrlAddress -> RCCtrlAddress -> Bool

data RCCtrlPairing Source #

Long-term part of host (mobile) connection to controller (desktop)

Constructors

RCCtrlPairing
Fields caKey :: APrivateSignKey caCert :: SignedCertificate ctrlFingerprint :: KeyHash idPubKey :: PublicKeyEd25519 dhPrivKey :: PrivateKeyX25519 prevDhPrivKey :: Maybe PrivateKeyX25519

data RCHostKeys Source #

Constructors

RCHostKeys
Fields sessKeys :: KeyPairEd25519 dhKeys :: KeyPairX25519

data RCHostSession Source #

Constructors

RCHostSession
Fields tls :: TLS 'TServer sessionKeys :: HostSessKeys

data HostSessKeys Source #

Constructors

HostSessKeys
Fields chainKeys :: TSbChainKeys idPrivKey :: PrivateKeyEd25519 sessPrivKey :: PrivateKeyEd25519

data RCCtrlSession Source #

Constructors

RCCtrlSession
Fields tls :: TLS 'TClient sessionKeys :: CtrlSessKeys

data CtrlSessKeys Source #

Constructors

CtrlSessKeys
Fields chainKeys :: TSbChainKeys idPubKey :: PublicKeyEd25519 sessPubKey :: PublicKeyEd25519

data RCHostEncHello Source #

Constructors

RCHostEncHello
Fields dhPubKey :: PublicKeyX25519 nonce :: CbNonce encBody :: ByteString

Instances

Instances details

Show RCHostEncHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods showsPrec :: Int -> RCHostEncHello -> ShowS show :: RCHostEncHello -> String showList :: [RCHostEncHello] -> ShowS
Encoding RCHostEncHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods smpEncode :: RCHostEncHello -> ByteString Source # smpDecode :: ByteString -> Either String RCHostEncHello Source # smpP :: Parser RCHostEncHello Source #

data RCCtrlEncHello Source #

Constructors

RCCtrlEncHello
Fields kem :: KEMCiphertext encBody :: ByteString
RCCtrlEncError
Fields nonce :: CbNonce encMessage :: ByteString

Instances

Instances details

Show RCCtrlEncHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods showsPrec :: Int -> RCCtrlEncHello -> ShowS show :: RCCtrlEncHello -> String showList :: [RCCtrlEncHello] -> ShowS
Encoding RCCtrlEncHello Source #
Instance details Defined in Simplex.RemoteControl.Types Methods smpEncode :: RCCtrlEncHello -> ByteString Source # smpDecode :: ByteString -> Either String RCCtrlEncHello Source # smpP :: Parser RCCtrlEncHello Source #

type SessionCode = ByteString Source #

tlsunique channel binding

type RCStepTMVar a = TMVar (Either RCErrorType a) Source #

currentRCPVersion :: VersionRCP Source #

supportedRCPVRange :: VersionRangeRCP Source #