Struct ExperimentalSessionLimitConfig 

pub struct ExperimentalSessionLimitConfig {
    pub soft_limit: NonZeroU64,
    pub hard_limit: NonZeroU64,
    pub dangerous_hard_limit_eviction: bool,
}

Configuration options for the session limit feature

Fields

soft_limit: NonZeroU64

Upon login in interactive contexts (like OAuth 2.0 sessions), if the soft limit is reached, it will display a policy violation screen (web UI) to remove sessions before creating the new session.

This is not enforced in non-interactive contexts (like the legacy compability login API) as there is no opportunity for us to show some UI for people remove some sessions. See hard_limit for enforcement on that side.

hard_limit: NonZeroU64

Upon login, when dangerous_hard_limit_eviction: false, will refuse the new login (policy violation error), otherwise, see dangerous_hard_limit_eviction.

The hard limit is enforced in all contexts (interactive/non-interactive).

dangerous_hard_limit_eviction: bool

Whether we should automatically choose the least recently used devices to remove when the Self::hard_limit is reached; in order to allow the new login to continue.

Disabled by default

WARNING: Removing sessions is a potentially damaging operation. Any end-to-end encrypted history on the device will be lost and can only be recovered if you have another verified active device or have a recovery key setup.

When using dangerous_hard_limit_eviction, the hard_limit must be at least 2 to avoid catastrophically losing encrypted history and digital identity in pathological cases. Keep in mind this is a bare minimum restriction and you can still run into trouble.

This is most applicable in scenarios where your homeserver has many legacy bots/scripts that login over and over (which ideally should be using personal access tokens) and you want to avoid breaking their operation while maintaining some level of sanity with the number of devices that people can have.

Trait Implementations

impl Clone for SessionLimitConfig

fn clone(&self) -> SessionLimitConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SessionLimitConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionLimitConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SessionLimitConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn always_inline_schema() -> bool

👎Deprecated: Use inline_schema() instead

Only included for backward-compatibility - use inline_schema() instead“.

impl Serialize for SessionLimitConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.