Skip to content

Server API: mls:person:publish and personKeyBinding (GRYT-1515) #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sivert-io merged 1 commit into from
Sep 28, 2026
Merged

Server API: mls:person:publish and personKeyBinding (GRYT-1515) #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions content/docs/build/server-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@ MLS bytes go as binary both ways.

| Event | Direction | Notes |
|-------|-----------|-------|
| `mls:person:publish` | client → server | `{ binding }`. Your person key binding, or `null` to take it back. Send `dm:key:publish` first |
| `mls:keypackages:publish` | client → server | `{ deviceId, keyPackages, lastResort? }`. The first publish registers the device. Five devices per member. See [KeyPackages](#keypackages) for what gets refused |
| `mls:keypackages:claim` | client → server | `{ conversationId, deviceId, devices? }`. One KeyPackage for each device, and each is handed out once. Expired ones never are |
| `mls:devices` | client → server | `{ conversationId? }`. Your own devices, or everybody's in the conversation |
Expand All @@ -280,6 +281,16 @@ MLS bytes go as binary both ways.
The server keeps the log for 30 days, or fewer if whoever runs it sets
`MLS_RETENTION_DAYS`.

A person key binding has to be signed by the same identity key, for the same
scope, as the DM key binding you published. That's the key people have already
pinned for you. Anything else gets `wrong_identity`. If there's no DM key
binding yet you get `no_dm_key`, and since `dm:key:publish` has no
acknowledgement, the person key can occasionally land first. Retry once.

Once it's stored, the binding shows up as `personKeyBinding` on your row in
`members:list`, next to `dmKeyBinding`. It's `null` for anybody who hasn't
published one.

#### KeyPackages

A KeyPackage lasts 30 days, from `notBefore` to `notAfter`, and both ends count.
Expand Down
Loading