matrix-org / matrix-org/matrix-spec

"session key", "room key", "megolm key" and "megolm session" are used interchangeably throughout the spec

Open
#935 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clarification help wanted
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

There are a number of instances in the spec were we use the terms "session key" and "room key" interchangeably to mean the symmetric key used to encrypt a set of events within a megolm session.

We also use "session key" to describe the ID for a UISI session, etc.

We should pick one. And as for UISI etc. sessions: use "session ID" instead.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the specification for “session key,” “room key,” “megolm key,” “megolm session,” and UISI uses of “session key.” Review each occurrence, choose consistent terminology for the Megolm symmetric key, use “session ID” for UISI sessions, and confirm the terms are consistent throughout the spec.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.