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 60 61 62 63 64 65 66
// Copyright 2022 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use serde::{Deserialize, Serialize};
/// A struct to configure how Megolm sessions should work under the hood.
/// Currently only the MAC truncation behaviour can be configured.
#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq)]
pub struct SessionConfig {
pub(super) version: Version,
}
#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq)]
pub(super) enum Version {
V1 = 1,
V2 = 2,
}
impl SessionConfig {
/// Get the numeric version of this `SessionConfig`.
pub const fn version(&self) -> u8 {
self.version as u8
}
/// Create a `SessionConfig` for the Megolm version 1. This version of
/// Megolm uses AES-256 and HMAC with a truncated MAC to encrypt individual
/// messages. The MAC will be truncated to 8 bytes.
pub const fn version_1() -> Self {
SessionConfig { version: Version::V1 }
}
/// Create a `SessionConfig` for the Megolm version 2. This version of
/// Megolm uses AES-256 and HMAC to encrypt individual messages. The MAC
/// won't be truncated.
pub const fn version_2() -> Self {
SessionConfig { version: Version::V2 }
}
}
impl Default for SessionConfig {
fn default() -> Self {
Self::version_2()
}
}
#[cfg(test)]
mod test {
use crate::megolm::{session_config::Version, SessionConfig};
#[test]
fn version() {
assert_eq!(SessionConfig::version_1().version(), Version::V1 as u8);
assert_eq!(SessionConfig::version_2().version(), Version::V2 as u8);
}
}