de-mls 3.0.0

Decentralized MLS — end-to-end encrypted group messaging with consensus-based membership management over gossipsub-like networks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! Storage abstraction for DE-MLS persistence. The reference in-memory
//! backend lives in [`crate::defaults`]; integrators with persistence
//! requirements implement their own.

use std::error::Error;
use std::sync::Arc;

use openmls_traits::storage::StorageProvider;

use crate::mls_crypto::MlsError;

/// Storage backend for DE-MLS.
///
/// Implementations must provide:
/// - Key package reference tracking (to detect welcomes for us)
/// - OpenMLS storage delegation (groups, key packages, etc.)
pub trait DeMlsStorage {
    /// The OpenMLS storage provider type.
    /// VERSION is the OpenMLS storage version (currently 1).
    type MlsStorage: StorageProvider<1, Error = Self::StorageError>;

    /// Storage error type (must be compatible with OpenMLS).
    type StorageError: Error + Send + Sync + 'static;

    // ─────────────────────────────────────────────────────────
    // Key Package Tracking
    // ─────────────────────────────────────────────────────────

    fn store_key_package_ref(&self, hash_ref: &[u8]) -> Result<(), MlsError>;
    fn is_our_key_package(&self, hash_ref: &[u8]) -> Result<bool, MlsError>;
    fn remove_key_package_ref(&self, hash_ref: &[u8]) -> Result<(), MlsError>;

    fn mls_storage(&self) -> &Self::MlsStorage;
}

/// Sharing impl: every `Arc<S>` over a [`DeMlsStorage`] is itself a
/// [`DeMlsStorage`]. Lets one storage backend back many MLS services
/// (one per group) so key-package refs and OpenMLS state remain
/// reachable from whichever service receives a welcome.
impl<S: DeMlsStorage + ?Sized> DeMlsStorage for Arc<S> {
    type MlsStorage = S::MlsStorage;
    type StorageError = S::StorageError;

    fn store_key_package_ref(&self, hash_ref: &[u8]) -> Result<(), MlsError> {
        (**self).store_key_package_ref(hash_ref)
    }

    fn is_our_key_package(&self, hash_ref: &[u8]) -> Result<bool, MlsError> {
        (**self).is_our_key_package(hash_ref)
    }

    fn remove_key_package_ref(&self, hash_ref: &[u8]) -> Result<(), MlsError> {
        (**self).remove_key_package_ref(hash_ref)
    }

    fn mls_storage(&self) -> &Self::MlsStorage {
        (**self).mls_storage()
    }
}