Cargo.toml

[package]
name = "openmls"
version = "0.9.0"
authors = ["OpenMLS Authors"]
edition = "2021"
rust-version.workspace = true
description = "A Rust implementation of the Messaging Layer Security (MLS) protocol, as defined in RFC 9420."
license = "MIT"
documentation = "https://docs.rs/openmls"
repository = "https://github.com/openmls/openmls/"
readme = "../README.md"
keywords = ["MLS", "IETF", "RFC9420", "Encryption", "E2EE"]
exclude = ["/test_vectors"]

[dependencies]
openmls_traits = { workspace = true }
openmls_rust_crypto = { workspace = true, optional = true }
openmls_basic_credential = { workspace = true, optional = true, features = [
    "clonable",
    "test-utils",
] }
openmls_memory_storage = { workspace = true, features = [
    "test-utils",
], optional = true }
openmls_sqlite_storage = { workspace = true, optional = true }
openmls_test = { workspace = true, optional = true }
openmls_serialization_helpers = { workspace = true }
openmls_libcrux_crypto = { workspace = true, optional = true }

serde = { workspace = true, features = ["derive"] }
log = { version = "0.4", features = ["std"] }
tls_codec = { workspace = true }
rayon = "^1.12.0"
thiserror = { workspace = true }
# Only required for tests.
rand = { version = "0.10", optional = true }
serde_json = { version = "1.0", optional = true }
# Crypto providers required for KAT and testing - "test-utils" feature
itertools = { version = "0.14", optional = true }
getrandom = { version = "0.4.2", optional = true }
getrandom_old = { package = "getrandom", version = "0.2.15", optional = true }
web-time = { version = "1.1", optional = true, features = ["serde"] }
zeroize = "1.8.1"
serde_bytes = "0.11.17"

[features]
# enable for compatibility with openmls=0.8.1
0-8-1-storage-format = []
# import a group (and the group-associated data it owns) exported from a previous
# OpenMLS version; mirror of the previous version's `migration-export`
migration-import = []
test-utils = [
    "dep:serde_json",
    "dep:itertools",
    "openmls_rust_crypto/test-utils",
    "dep:rand",
    "dep:openmls_basic_credential",
    "dep:openmls_memory_storage",
    "dep:openmls_test",
    "backtrace",
]
backtrace = []
libcrux-provider = [
    "dep:openmls_libcrux_crypto",
    "openmls_test?/libcrux-provider",
]
sqlite-provider = [
    "dep:openmls_sqlite_storage",
    "openmls_test?/sqlite-provider",
]
# Expand every `#[openmls_test]` over all ciphersuites supported by each
# enabled provider. Without this feature, each provider emits a single
# test per source function using the MTI ciphersuite. Opt in for nightly
# CI or release validation.
all-ciphersuites = ["openmls_test?/all-ciphersuites"]
# Compile the KAT regenerators. Opt in when refreshing the bundled JSON test
# vectors.
generate-kats = []
crypto-debug = [
    "openmls_traits/crypto-debug",
] # ☣️ Enable logging of sensitive cryptographic information
content-debug = [] # ☣️ Enable logging of sensitive message content
js = [
    "dep:getrandom",
    "dep:web-time",

    # enable randomness source
    "getrandom/wasm_js",
]

js-test = [
    "dep:getrandom_old",

    # enable randomness source
    "getrandom_old/js",

]

virtual-clients-draft = [
    "extensions-draft",
    "dep:web-time",
    "openmls_traits/virtual-clients-draft",
    # The crypto providers implement the trait's FF1 small-space PRP, so
    # their `OpenMlsCrypto` impls only compile against a
    # `virtual-clients-draft` `openmls_traits` with their own feature on.
    "openmls_rust_crypto?/virtual-clients-draft",
    "openmls_libcrux_crypto?/virtual-clients-draft",
]

# Same XXX as for `extensions-draft-test-dependencies`: the storage-backend
# crates only know about the `virtual-clients-draft` trait methods if they
# enable their own `virtual-clients-draft` feature, but enabling it directly
# from `virtual-clients-draft` would force them in even when not used. So we
# expose a separate feature that tests turn on alongside `virtual-clients-draft`.
# The backends' own `virtual-clients-draft` feature pulls in their
# `extensions-draft` impls transitively, so we don't need to chain
# `extensions-draft-test-dependencies` here.
virtual-clients-draft-test-dependencies = [
    "openmls_sqlite_storage?/virtual-clients-draft",
    "openmls_memory_storage?/virtual-clients-draft",
]

extensions-draft = [
    "openmls_traits/extensions-draft",
    # XXX: to avoid enabling the `openmls_sqlite_storage` dependency
    # and other dependencies used for testing
    # when enabling this feature, these optional dependencies
    # are not explicitly included in this feature.
    #
    # See https://github.com/rust-lang/cargo/issues/10801
    # "openmls_sqlite_storage?/extensions-draft",
    # "openmls_libcrux_crypto?/extensions-draft",
    # "openmls_memory_storage?/extensions-draft",
]

extensions-draft-test-dependencies = [
    "openmls_sqlite_storage?/extensions-draft",
    "openmls_libcrux_crypto?/extensions-draft",
    "openmls_memory_storage?/extensions-draft",
]
# Implementation of the targeted messages draft:
# https://datatracker.ietf.org/doc/draft-ietf-mls-targeted-messages/
targeted-messages-draft = [
    "openmls_traits/targeted-messages-draft",
    "openmls_rust_crypto?/targeted-messages-draft",
    "openmls_libcrux_crypto?/targeted-messages-draft",
]
draft-ietf-mls-pq-ciphersuites = [
    "openmls_traits/draft-ietf-mls-pq-ciphersuites",
    "openmls_memory_storage?/draft-ietf-mls-pq-ciphersuites",
    "openmls_sqlite_storage?/draft-ietf-mls-pq-ciphersuites",
    "openmls_libcrux_crypto?/draft-ietf-mls-pq-ciphersuites",
    "openmls_rust_crypto?/draft-ietf-mls-pq-ciphersuites",
    "openmls_basic_credential?/draft-ietf-mls-pq-ciphersuites",
    "openmls_test?/draft-ietf-mls-pq-ciphersuites",
]
# enable randomness source
fork-resolution = []

# Enable unchecked conversions for types that need to be verified or validated.
unchecked-conversions = []

[dev-dependencies]
criterion = { version = "^0.8", default-features = false, features = [
    "plotters",
    "html_reports",
] }
hex = { version = "0.4", features = ["serde"] }
openmls_traits = { workspace = true, features = ["test-utils"] }
pretty_env_logger = "0.5"
clap = { version = "4", features = ["derive"] }
base64 = "0.22.1"
flate2 = "1.0"
indicatif = "0.18.3"

# Default test build is rustcrypto-only and MTI-ciphersuite-only.
# Enable `sqlite-provider`, `libcrux-provider`, and/or `all-ciphersuites`
# explicitly (for example on a nightly CI run) to exercise more of the
# matrix.
[dev-dependencies.openmls]
path = "."
features = ["test-utils"]

[target.'cfg(target_arch = "wasm32")'.dev-dependencies]
web-time = "1.1"

[[bench]]
name = "benchmark"
harness = false

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]