p2panda-rs 0.7.0

All the things a panda needs
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

// SPDX-License-Identifier: AGPL-3.0-or-later

use openmls::framing::{MlsMessageIn, MlsMessageOut};
use openmls::messages::Welcome;
use tls_codec::{TlsDeserialize, TlsSerialize, TlsSize};

use crate::secret_group::error::SecretGroupError;
use crate::secret_group::SecretGroupMessage;

/// Plaintext commit message which is published on the network to announce group changes.
///
/// A `SecretGroupCommit` always contains an MLS Commit message and the current, encrypted
/// long-term secrets for this group. Optionally it contains another MLS Welcome message in case
/// this commit invites new members into the group.
#[derive(Debug, Clone, TlsSerialize, TlsDeserialize, TlsSize)]
pub struct SecretGroupCommit {
    mls_commit_message: MlsMessageOut,
    mls_welcome_message: Option<Welcome>,
    encrypted_long_term_secrets: SecretGroupMessage,
}

impl SecretGroupCommit {
    /// Returns a new instance of a [SecretGroupCommit] message.
    pub(crate) fn new(
        mls_commit_message: MlsMessageOut,
        mls_welcome_message: Option<Welcome>,
        encrypted_long_term_secrets: SecretGroupMessage,
    ) -> Result<Self, SecretGroupError> {
        Ok(Self {
            mls_commit_message,
            mls_welcome_message,
            encrypted_long_term_secrets,
        })
    }

    /// Returns the MLS Commit message.
    pub(crate) fn commit(&self) -> MlsMessageIn {
        self.mls_commit_message.to_owned().into()
    }

    /// Returns an MLS Welcome message when given.
    pub(crate) fn welcome(&self) -> Option<Welcome> {
        self.mls_welcome_message.clone()
    }

    /// Returns the encrypted and encoded long-term secrets.
    pub(crate) fn long_term_secrets(&self) -> SecretGroupMessage {
        self.encrypted_long_term_secrets.clone()
    }
}