Module openmls::prelude

Single place, re-exporting the most used public functions. Prelude for OpenMLS. Include this to get access to all the public functions of OpenMLS.

Re-exports

pub use crate::group::errors::*;

pub use crate::group::*;

pub use crate::ciphersuite::hash_ref::KeyPackageRef;

pub use crate::ciphersuite::signable::*;

pub use crate::ciphersuite::signature::*;

pub use crate::ciphersuite::*;

pub use crate::messages::proposals::*;

pub use crate::messages::public_group_state::*;

pub use crate::messages::*;

pub use crate::credentials::errors::*;

pub use crate::credentials::*;

pub use crate::versions::*;

pub use crate::extensions::errors::*;

pub use crate::extensions::*;

pub use crate::key_packages::errors::*;

pub use crate::key_packages::*;

pub use crate::treesync::errors::ApplyUpdatePathError;

pub use crate::treesync::errors::PublicTreeError;

pub use crate::error::*;

Structs

ApplicationMessage

Application message received through a ProcessedMessage.

HpkeCiphertext

7.7. Update Paths

HpkeConfig

Convenience tuple struct for an HPKE configuration.

HpkeKeyPair

Helper holding a (private, public) key pair as byte vectors.

LeafNode

This struct implements the MLS leaf node and contains a KeyPackage and potentially a corresponding HpkePrivateKey.

MlsMessageIn

Unified message type for incoming MLS messages.

MlsMessageOut

Unified message type for outgoing MLS messages.

ParentNode

This struct implements the MLS parent node. It contains its public key, parent hash and unmerged leaves. Additionally, it may contain the private key corresponding to the public key.

SenderRatchetConfiguration

Stores the configuration parameters for DecryptionRatchets.

UnverifiedMessage

Partially checked and potentially decrypted message (if it was originally encrypted). Use this to inspect the Credential of the message sender and the optional aad if the original message was encrypted.

Enums

AeadType

AEAD types

Ciphersuite

MLS ciphersuites.

CryptoError

Crypto errors.

Error

Trait errors.

HashType

Hash types

HpkeAeadType

AEAD Types for HPKE.

HpkeKdfType

KDF Types for HPKE

HpkeKemType

KEM Types for HPKE

Node

Container enum for leaf and parent nodes.

ProcessedMessage

A message that has passed all syntax and semantics checks.

Sender

All possible sender types according to the MLS protocol spec.

SignatureScheme

SignatureScheme according to IANA TLS parameters

Traits

OpenMlsCrypto

OpenMlsCryptoProvider

The OpenMLS Crypto Provider Trait

OpenMlsKeyStore

The Key Store trait

OpenMlsRand

TlsDeserializeTrait

The Deserialize trait defines functions to deserialize a byte slice to a struct or enum.

TlsSerializeTrait

The Serialize trait provides functions to serialize a struct or enum.

TlsSizeTrait

The Size trait needs to be implemented by any struct that should be efficiently serialized. This allows to collect the length of a serialized structure before allocating memory.

Type Definitions

ExporterSecret

KemOutput