matrix-org/synapse

default in encryption_enabled_by_default_for_room_type is misleading

Open

#9,794 opened on Apr 12, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (11,713 stars) (2,196 forks)batch import
T-Taskgood first issue

Description

Description

The option encryption_enabled_by_default_for_room_type as introduced in #7639 is misleading.

A default is something that has a value as long as it's not overwritten. In this case it would mean, that encryption is enabled for the specified room type as long as it is not disabled for a specific room/client/... The current implementation prevents creation of unencrypted DMs/rooms. This is clearly not a default, but forced encryption.

Expected Naming

force_encryption_enabled_for_room_type or similar.

Version information

v1.31.0 and current develop branch.

Contributor guide

Tech stack
python
Domain
backend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requests renaming the `encryption enabled by default for room type` configuration option to `force encryption enabled for room type` or similar, across the codebase. Check the Synapse repository for all occurrences of the current name in configuration files, documentation, and code. Update references accordingly and ensure backward compatibility if needed.