pub mod error; use argon2::{Config, Variant}; use cmp::Ordering; use rand::prelude::*; use ring::digest; use ruma::{ api::{ client::{error::ErrorKind, sync::sync_events::StrippedState}, federation::membership::RawStrippedState, }, canonical_json::try_from_json_map, events::{AnyStateEvent, StateEventType}, room_version_rules::RoomVersionRules, serde::Raw, CanonicalJsonError, CanonicalJsonObject, CanonicalJsonValue, RoomId, }; use serde_json::value::to_raw_value; use std::{ cmp, fmt, str::FromStr, time::{SystemTime, UNIX_EPOCH}, }; use crate::{service::pdu::gen_event_id_canonical_json, Result}; pub fn millis_since_unix_epoch() -> u64 { SystemTime::now() .duration_since(UNIX_EPOCH) .expect("time is valid") .as_millis() as u64 } pub fn secs_since_unix_epoch() -> u64 { SystemTime::now() .duration_since(UNIX_EPOCH) .expect("time is valid") .as_secs() } pub fn increment(old: Option<&[u8]>) -> Option> { let number = match old.map(|bytes| bytes.try_into()) { Some(Ok(bytes)) => { let number = u64::from_be_bytes(bytes); number + 1 } _ => 1, // Start at one. since 0 should return the first event in the db }; Some(number.to_be_bytes().to_vec()) } pub fn generate_keypair() -> Vec { let mut value = random_string(8).as_bytes().to_vec(); value.push(0xff); value.extend_from_slice( &ruma::signatures::Ed25519KeyPair::generate() .expect("Ed25519KeyPair generation always works (?)"), ); value } /// Parses the bytes into an u64. pub fn u64_from_bytes(bytes: &[u8]) -> Result { let array: [u8; 8] = bytes.try_into()?; Ok(u64::from_be_bytes(array)) } /// Parses the bytes into a string. /// /// If `&str` is enough please use [str::from_utf8] to avoid unnecessary /// allocation. pub fn string_from_bytes(bytes: &[u8]) -> Result { str::from_utf8(bytes).map(ToOwned::to_owned) } pub fn random_string(length: usize) -> String { rand::rng() .sample_iter(&rand::distr::Alphanumeric) .take(length) .map(char::from) .collect() } /// Calculate a new hash for the given password pub fn calculate_password_hash(password: &str) -> Result { let hashing_config = Config { variant: Variant::Argon2id, ..Default::default() }; let salt = random_string(32); argon2::hash_encoded(password.as_bytes(), salt.as_bytes(), &hashing_config) } #[tracing::instrument(skip(keys))] pub fn calculate_hash(keys: &[&[u8]]) -> Vec { // We only hash the pdu's event ids, not the whole pdu let bytes = keys.join(&0xff); let hash = digest::digest(&digest::SHA256, &bytes); hash.as_ref().to_owned() } pub fn common_elements( mut iterators: impl Iterator>>, check_order: impl Fn(&[u8], &[u8]) -> Ordering, ) -> Option>> { let first_iterator = iterators.next()?; let mut other_iterators = iterators.map(|i| i.peekable()).collect::>(); Some(first_iterator.filter(move |target| { other_iterators.iter_mut().all(|it| { while let Some(element) = it.peek() { match check_order(element, target) { Ordering::Greater => return false, // We went too far Ordering::Equal => return true, // Element is in both iters Ordering::Less => { // Keep searching it.next(); } } } false }) })) } /// Fallible conversion from any value that implements `Serialize` to a `CanonicalJsonObject`. /// /// `value` must serialize to an `serde_json::Value::Object`. pub fn to_canonical_object( value: T, ) -> Result { use serde::ser::Error; match serde_json::to_value(value).map_err(CanonicalJsonError::SerDe)? { serde_json::Value::Object(map) => try_from_json_map(map), _ => Err(CanonicalJsonError::SerDe(serde_json::Error::custom( "Value must be an object", ))), } } pub fn deserialize_from_str< 'de, D: serde::de::Deserializer<'de>, T: FromStr, E: fmt::Display, >( deserializer: D, ) -> Result { struct Visitor, E>(std::marker::PhantomData); impl, Err: fmt::Display> serde::de::Visitor<'_> for Visitor { type Value = T; fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { write!(formatter, "a parsable string") } fn visit_str(self, v: &str) -> Result where E: serde::de::Error, { v.parse().map_err(serde::de::Error::custom) } } deserializer.deserialize_str(Visitor(std::marker::PhantomData)) } // Copied from librustdoc: // https://github.com/rust-lang/rust/blob/cbaeec14f90b59a91a6b0f17fc046c66fa811892/src/librustdoc/html/escape.rs /// Wrapper struct which will emit the HTML-escaped version of the contained /// string when passed to a format string. pub struct HtmlEscape<'a>(pub &'a str); impl fmt::Display for HtmlEscape<'_> { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { // Because the internet is always right, turns out there's not that many // characters to escape: http://stackoverflow.com/questions/7381974 let HtmlEscape(s) = *self; let pile_o_bits = s; let mut last = 0; for (i, ch) in s.char_indices() { let s = match ch { '>' => ">", '<' => "<", '&' => "&", '\'' => "'", '"' => """, _ => continue, }; fmt.write_str(&pile_o_bits[last..i])?; fmt.write_str(s)?; // NOTE: we only expect single byte characters here - which is fine as long as we // only match single byte characters last = i + 1; } if last < s.len() { fmt.write_str(&pile_o_bits[last..])?; } Ok(()) } } /// Converts `RawStrippedState` (federation format) into `Raw` (client format) pub fn convert_stripped_state( stripped_state: Vec, rules: &RoomVersionRules, ) -> Result>> { stripped_state .into_iter() .map(|stripped_state| match stripped_state { RawStrippedState::Stripped(state) => Ok(state.cast()), RawStrippedState::Pdu(state) => { let (event_id, mut event) = gen_event_id_canonical_json(&state, rules)?; event.retain(|k, _| { matches!( k.as_str(), "content" | "event_id" | "origin_server_ts" | "room_id" | "sender" | "state_key" | "type" | "unsigned" ) }); event.insert("event_id".to_owned(), event_id.as_str().into()); let raw_value = to_raw_value(&CanonicalJsonValue::Object(event)) .expect("To raw json should not fail since only change was adding signature"); Ok(Raw::::from_json(raw_value).cast()) } }) .collect() } pub fn check_stripped_state( stripped_state: &Vec, room_id: &RoomId, rules: &RoomVersionRules, ) -> Result<()> { // Nothing needs to be done for legacy room ids if room_id.server_name().is_some() && !rules.authorization.room_create_event_id_as_room_id { return Ok(()); } let mut seen_create_event = false; #[cfg(feature = "enforce_msc4311")] let mut seen_valid_create_event = false; for state in stripped_state { match state { RawStrippedState::Pdu(pdu) => { let Ok((event_id, value)) = gen_event_id_canonical_json(pdu, rules) else { continue; }; let Some(event_type) = value.get("type").and_then(|t| t.as_str()) else { continue; }; if event_type != "m.room.create" { continue; } if seen_create_event { return Err(error::Error::BadRequest( ErrorKind::InvalidParam, "Stripped state has multiple create events", )); } if event_id.localpart() != room_id.strip_sigil() { return Err(error::Error::BadRequest( ErrorKind::InvalidParam, "Room ID generated from create event does not match that from the request", )); } seen_create_event = true; #[cfg(feature = "enforce_msc4311")] { seen_valid_create_event = true; } } RawStrippedState::Stripped(event) => { let Ok(event) = event.deserialize() else { continue; }; if event.event_type() != StateEventType::RoomCreate { continue; } if seen_create_event { return Err(error::Error::BadRequest( ErrorKind::InvalidParam, "Stripped state has multiple create events", )); } seen_create_event = true; } } } #[cfg(feature = "enforce_msc4311")] if !seen_valid_create_event { return Err(error::Error::BadRequest( ErrorKind::InvalidParam, "Stripped state contained no valid create PDUs", )); } Ok(()) }