ruma_identifiers_validation/
user_id.rs

Help
1use crate::{localpart_is_backwards_compatible, parse_id, Error, ID_MAX_BYTES};
2
3/// Validate a [user ID] as used by clients.
4///
5/// [user ID]: https://spec.matrix.org/latest/appendices/#user-identifiers
6pub fn validate(s: &str) -> Result<(), Error> {
7    let colon_idx = parse_id(s, b'@')?;
8    let localpart = &s[1..colon_idx];
9
10    localpart_is_backwards_compatible(localpart)?;
11
12    Ok(())
13}
14
15/// Validate a [user ID] to follow the spec recommendations when generating them.
16///
17/// [user ID]: https://spec.matrix.org/latest/appendices/#user-identifiers
18pub fn validate_strict(s: &str) -> Result<(), Error> {
19    // Since the length check can be disabled with `compat-arbitrary-length-ids`, check it again
20    // here.
21    if s.len() > ID_MAX_BYTES {
22        return Err(Error::MaximumLengthExceeded);
23    }
24
25    let colon_idx = parse_id(s, b'@')?;
26    let localpart = &s[1..colon_idx];
27
28    if !localpart_is_fully_conforming(localpart)? {
29        return Err(Error::InvalidCharacters);
30    }
31
32    Ok(())
33}
34
35/// Check whether the given [user ID] localpart is valid and fully conforming.
36///
37/// Returns an `Err` for invalid user ID localparts, `Ok(false)` for historical user ID localparts
38/// and `Ok(true)` for fully conforming user ID localparts.
39///
40/// [user ID]: https://spec.matrix.org/latest/appendices/#user-identifiers
41pub fn localpart_is_fully_conforming(localpart: &str) -> Result<bool, Error> {
42    if localpart.is_empty() {
43        return Err(Error::Empty);
44    }
45
46    // See https://spec.matrix.org/latest/appendices/#user-identifiers
47    let is_fully_conforming = localpart
48        .bytes()
49        .all(|b| matches!(b, b'0'..=b'9' | b'a'..=b'z' | b'-' | b'.' | b'=' | b'_' | b'/' | b'+'));
50
51    if !is_fully_conforming {
52        // If it's not fully conforming, check if it contains characters that are also disallowed
53        // for historical user IDs, or is empty. If that's the case, return an error.
54        // See https://spec.matrix.org/latest/appendices/#historical-user-ids
55        let is_invalid_historical = localpart.bytes().any(|b| b < 0x21 || b == b':' || b > 0x7E);
56
57        if is_invalid_historical {
58            return Err(Error::InvalidCharacters);
59        }
60    }
61
62    Ok(is_fully_conforming)
63}
ruma_identifiers_validation/user_id.rs

ruma_identifiers_validation/
user_id.rs
