Skip to content

README.md

Latest commit

 

History

History
71 lines (50 loc) · 2.6 KB

README.md

File metadata and controls

71 lines (50 loc) · 2.6 KB
Raw

Firefly MLS (Client & Core Libraries)

Firefly MLS is an open-source suite of client-side libraries for end-to-end encrypted messaging, group management, and key state persistence using the Message Layer Security (MLS) protocol (RFC 9420).

Repository Structure

This repository contains the client-side crates and language bindings:

  • crates/core (firefly-core): Core MLS protocol rules, custom proposals, identity provider implementation, and group extension handlers.
  • crates/protos (firefly-protos): Protocol buffer definitions for wire messages, group structures, and user payloads.
  • crates/client (firefly-client): High-level async client engine managing WebSocket connectivity, local SQLite persistence (for messages, group state, and key material), address rotation, and group management.
  • crates/client-node (firefly-client-node): Node.js / TypeScript native N-API bindings for firefly-client.
  • crates/firefly-client-js (firefly-client-js): Web / JS bindings for client integration.

Getting Started

Prerequisites

  • Rust toolchain (edition 2024 / 1.85+)
  • Node.js & pnpm (optional, for Node.js client bindings)

Building

To verify and compile all workspace crates:

cargo check

To build release artifacts:

cargo build --release

Running Tests

1. Client Unit Tests

All client-side unit tests, cryptographic rules, SQLite stores, cursor advances, and key material storage providers run in-memory and require no running external dependencies:

cargo test --lib

2. Running All Workspace Tests

cargo test

3. End-to-End Server Integration Tests

Client integration tests can be executed against a running Firefly MLS server instance:

  1. Start the backend PostgreSQL database and server in the firefly-mls repository: 
    cd ../firefly-mls
docker compose up -d
cargo run -p firefly-server
  2. Run client integration tests pointing to the test server: 
    FIREFLY_BASE_URL=http://127.0.0.1:39205 FIREFLY_WS_URL=ws://127.0.0.1:39205/ RUST_LOG=info cargo test --features firefly-client/test-hooks
    test-hooks compiles in the test-only environment overrides (FIREFLY_WT_CERT_SHA256, FIREFLY_WT_INSECURE, WT_HOST) so tests can trust a local server's certificate. Apps never enable it, so release builds always verify WebTransport certificates.

If FIREFLY_BASE_URL is not specified, server integration tests skip gracefully so offline CI/CD pipelines run standard unit tests quickly.

License

MIT