Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Commit 8cb7c34

Browse files
committed
start adding resigning_active to hello payload
1 parent a40506c commit 8cb7c34

File tree

1 file changed

+16
-4
lines changed
  • docs/Protocol Specifications

1 file changed

+16
-4
lines changed

docs/Protocol Specifications/core.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,17 @@ the server.
319319

320320
The "Hello" event is sent by the server to the client upon establishing a connection. The `d` payload
321321
for a "Hello" event is an object containing a `heartbeat_interval` field, which specifies the interval
322-
in milliseconds at which the client should send heartbeat events to the server.
322+
in milliseconds at which the client should send heartbeat events to the server. The payload might also
323+
contain a `resigning_active` key with a `boolean` value, indicating whether there is an unfinished
324+
message re-signing process which can be resumed.
325+
326+
!!! danger
327+
328+
User-operated clients must not automatically continue
329+
re-signing messages when receiving this property with a `true` value. Instead, the user should be
330+
prompted whether they intend to continue re-signing messages. The reason for this is that servers
331+
could theoretically send this property even though the user has not previously enabled re-signing
332+
in a malicious identity takeover attempt.
323333

324334
!!! example "Example hello event payload"
325335

@@ -334,9 +344,11 @@ in milliseconds at which the client should send heartbeat events to the server.
334344
}
335345
```
336346

337-
| Field | Type | Description |
338-
| -------------------- | ------ | ---------------------------------------------------------------------------------------- |
339-
| `heartbeat_interval` | uint32 | Interval in milliseconds at which the client should send heartbeat events to the server. |
347+
<!-->// TODO maybe resigning_active should be an object containing information about which keys are allowed for re-signing, and which keys still need confirmation<-->
348+
| Field | Type | Description |
349+
| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
350+
| `heartbeat_interval` | uint32 | Interval in milliseconds at which the client should send heartbeat events to the server. |
351+
| `resigning_active` | boolean? | If present and `true`, indicates that there is an unfinished message re-signing process active, which can be resumed. |
340352

341353
##### 3.2.3.2 Identify event
342354

0 commit comments

Comments
 (0)