Crate mpc_protocol

Relay service protocol types, encoding and helper functions.

Size Limitations

The maximum size of a noise protocol message is 65535 and we further limit the size of buffers for encoding to 32KB.

Re-exports

• pub use hex;
• pub use http;
• pub use log;
• pub use pem;
• pub use snow;
• pub use uuid;

Structs

• Chunk
  Chunk is used to respect the 65535 limit for noise protocol messages.
• Keypair
  Key pair used by the noise protocol.
• Meeting
  Meeting point information.
• MeetingManager
  Manages a collection of meeting points.
• MeetingState
  Response from creating a meeting point.
• Parameters
  Parameters used during key generation.
• SealedEnvelope
  Sealed envelope is an encrypted message.
• Session
  Session is a namespace for a group of participants to communicate for a series of rounds.
• SessionManager
  Manages a collection of sessions.
• SessionRequest
  Request to create a new session.
• SessionState
  Response from creating new session.
• UserId
  User identifier wraps an SHA-256 hash of a unique arbitrary value.

Enums

• Encoding
  Encoding for message payloads.
• Error
  Errors generated by the relay protocol.
• HandshakeMessage
  Handshake messages.
• OpaqueMessage
  Opaque messaages are encrypted.
• ProtocolState
  Enumeration of protocol states.
• RequestMessage
  Request message sent to the server or another peer.
• ResponseMessage
  Response message sent by the server or a peer.
• ServerMessage
  Message sent between the server and a client.
• TransparentMessage
  Transparent messages are not encrypted.

Constants

• PATTERN
  Noise protocol pattern.
• PEM_PATTERN
  Tag for PEM encoding of noise pattern.
• PEM_PRIVATE
  Tag for PEM encoding of private key.
• PEM_PUBLIC
  Tag for PEM encoding of public key.
• TAGLEN
  Tag length for the noise protocol.
• VERSION
  Version for binary encoding.

Functions

• decode
  Decode from a binary buffer.
• decode_keypair
  Decode from a PEM-encoded string into a keypair.
• encode
  Encode to a binary buffer.
• encode_keypair
  Encode a keypair into a PEM-encoded string.
• generate_keypair
  Generate a keypair for the noise protocol using the standard pattern.

Type Aliases

• MeetingId
  Identifier for meeting points.
• PartyNumber
  Party number.
• Result
  Result type for the protocol library.
• RoundNumber
  Round number.
• SessionId
  Identifier for sessions.