aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2022-09-09 20:42:56 +0200
committermetamuffin <metamuffin@disroot.org>2022-09-09 20:42:56 +0200
commit95041256f86745832df42423e889d50d2cff35e7 (patch)
treef24f378c383e7e1b6ac9c779a58570befb7d6367
parent705fef72485ad11f20a38223e3de4ffa05a0bbd4 (diff)
downloadkeks-meet-95041256f86745832df42423e889d50d2cff35e7.tar
keks-meet-95041256f86745832df42423e889d50d2cff35e7.tar.bz2
keks-meet-95041256f86745832df42423e889d50d2cff35e7.tar.zst
update readme
-rw-r--r--readme.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/readme.md b/readme.md
index c6f4a2b..67927d8 100644
--- a/readme.md
+++ b/readme.md
@@ -12,18 +12,19 @@ a web conferencing application
- Multiple streams
- Noise suppression (rnnoise)
- End-to-end-encryption
+- Chat
## Licence
-GNU Affero General Public License version 3 only; See [COPYING](./COPYING).
+Licensed under the terms of the GNU Affero General Public License version 3 only. See [COPYING](./COPYING).
## Security
keks-meet _tries_ to be secure. However I am not a security expert. The current system works as follows:
-- The room name is set in the section of the URL (-> not sent to the server)
-- The server receives a salted SHA-256 hash of the room name to group client of a room
-- We use PBKDF2 (constant salt; 250000 iterations) to derive a 256-bit AES-GCM key
+- The room name is set in the section of the URL which is not sent to the server.
+- The server receives a salted SHA-256 hash of the room name to group clients of a room.
+- The client uses PBKDF2 (constant salt; 250000 iterations) to derive a 256-bit AES-GCM key from the room name.
- All relayed message contents are encrypted with this key.
- Message recipient is visible to the server
- The server assigns user ids
@@ -41,6 +42,8 @@ cd server
cargo run --release
```
+Because of a current compiler bug, the nightly rustc crashes during codegen - use the stable channel instead.
+
## Parameters
Configuration parameters are added like query params but **after** the section. (e.g `/room#mymeeting?username=alice`)
@@ -65,7 +68,6 @@ Booleans can be either `1`, `true`, `yes` or their opposites.
## Todo-List
-- Chat
- Optionally enable video streams
- Settings menu
- Native client