From 8b0eafe50f96dc501e22efd828de3d56ff584ff1 Mon Sep 17 00:00:00 2001 From: "J. Ryan Stinnett" Date: Fri, 14 Aug 2020 13:03:04 +0100 Subject: [PATCH 1/3] Document new .well-known for E2EE settings This updates documentation about the new key in `.well-known` that we'll check for E2EE settings: `im.vector.e2ee`. Part of https://github.com/vector-im/element-web/issues/14954 --- docs/e2ee.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/e2ee.md b/docs/e2ee.md index fe4931f56f..f7a32dfcc0 100644 --- a/docs/e2ee.md +++ b/docs/e2ee.md @@ -9,8 +9,14 @@ Set the following on your homeserver's `/.well-known/matrix/client` config: ```json { - "im.vector.riot.e2ee": { + "im.vector.e2ee": { "default": false } } ``` + +# Compatibility + +The settings above were first proposed under a `im.vector.riot.e2ee` key, which +is now deprecated. Element will check for either key, preferring +`im.vector.e2ee` if both exist. From fa265e498f1800f3c822e8f54f318fadfd4549b4 Mon Sep 17 00:00:00 2001 From: "J. Ryan Stinnett" Date: Fri, 14 Aug 2020 13:31:57 +0100 Subject: [PATCH 2/3] Document new setting to require secure backup This adds notes on configuring the new `.well-known` setting to require Element users to set up secure backup before continuing into the app. Part of https://github.com/vector-im/element-web/issues/14954 --- docs/e2ee.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/e2ee.md b/docs/e2ee.md index f7a32dfcc0..d42fe9cc05 100644 --- a/docs/e2ee.md +++ b/docs/e2ee.md @@ -7,6 +7,7 @@ For private room creation, Element will default to encryption on but give you th Set the following on your homeserver's `/.well-known/matrix/client` config: + ```json { "im.vector.e2ee": { @@ -15,6 +16,25 @@ Set the following on your homeserver's } ``` +# Secure backup + +By default, Element strongly encourages (but does not require) users to set up +Secure Backup so that cross-signing identity key and message keys can be +recovered in case of a disaster where you lose access to all active devices. + +## Requiring secure backup + +To require Secure Backup to be configured before Element can be used, set the +following on your homeserver's `/.well-known/matrix/client` config: + +```json +{ + "im.vector.e2ee": { + "secureBackupRequired": true + } +} +``` + # Compatibility The settings above were first proposed under a `im.vector.riot.e2ee` key, which From 3800fe0c9be7472d218aec216ed3e47cbd7ecfbd Mon Sep 17 00:00:00 2001 From: "J. Ryan Stinnett" Date: Mon, 24 Aug 2020 16:34:58 +0100 Subject: [PATCH 3/3] Use `io.element` instead of `im.vector` This also fixes casing as well to match the latest thinking. --- docs/e2ee.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/e2ee.md b/docs/e2ee.md index d42fe9cc05..eca5557fb2 100644 --- a/docs/e2ee.md +++ b/docs/e2ee.md @@ -10,7 +10,7 @@ Set the following on your homeserver's ```json { - "im.vector.e2ee": { + "io.element.e2ee": { "default": false } } @@ -29,8 +29,8 @@ following on your homeserver's `/.well-known/matrix/client` config: ```json { - "im.vector.e2ee": { - "secureBackupRequired": true + "io.element.e2ee": { + "secure_backup_required": true } } ``` @@ -39,4 +39,4 @@ following on your homeserver's `/.well-known/matrix/client` config: The settings above were first proposed under a `im.vector.riot.e2ee` key, which is now deprecated. Element will check for either key, preferring -`im.vector.e2ee` if both exist. +`io.element.e2ee` if both exist.