Module protocol

Source
Expand description

Lower level protocol methods. Use these if the higher-level Portal interface is too abstract.

Structs§

ConnectMessage
Information to correlate connections on the relay
EncryptedMessage
All encrypted messages must have associated state data (nonce, tag)
Metadata
Metadata about the transfer to be exchanged between peers after key derivation (encrypted)
NonceSequence
An abstraction around a nonce sequence. Safely ensures there is no nonce re-use during a session with a single key.
PortalConfirmation
A data format exchanged by each peer to confirm that they have each derived the same key
PortalKeyExchange
A data format exchanged by each peer to derive the shared session key
Protocol
Lower-level abstraction around the protocol. Use this directly if you’d like more control than what the higher-level Portal interface provides
TransferInfo
Contains the metadata for all files that will be sent during a particular transfer
TransferInfoBuilder
Builder for TransferInfo

Enums§

Direction
An enum to describe the direction of each file transfer participant (i.e Sender/Receiver)
PortalMessage
The wrapped message type for every exchanged message