aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2015-08-20 10:12:19 +0100
committerMark Haines <mark.haines@matrix.org>2015-08-20 10:12:19 +0100
commitf58b71a14e17a3760fd1ce8baabc57a1afa3522a (patch)
tree4dab8f1fd9948cd19c5e546f132366fe84c43b7c
parenteee46a549ca3caa397bdbd3396e27c4d8d7c1b89 (diff)
Clarify that only the public parts of keys are sent over the wire
-rw-r--r--docs/olm.rst12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/olm.rst b/docs/olm.rst
index d07dc1d..51a38bd 100644
--- a/docs/olm.rst
+++ b/docs/olm.rst
@@ -186,7 +186,8 @@ significant bits are stored in the first byte.
=========== ===== ======== ================================================
Name Tag Type Meaning
=========== ===== ======== ================================================
-Ratchet-Key 0x0A String The ratchet key, :math:`T_{i}`, of the message
+Ratchet-Key 0x0A String The public part of the ratchet key, :math:`T_{i}`,
+ of the message
Chain-Index 0x10 Integer The chain index, :math:`j`, of the message
Cipher-Text 0x22 String The cipher-text, :math:`X_{i,j}`, of the message
=========== ===== ======== ================================================
@@ -213,9 +214,12 @@ The payload uses the same key-value format as for normal messages.
============ ===== ======== ================================================
Name Tag Type Meaning
============ ===== ======== ================================================
-One-Time-Key 0x0A String Bob's single-use key, :math:`E_b`.
-Base-Key 0x12 String Alice's single-use key, :math:`E_a`.
-Identity-Key 0x1A String Alice's identity key, :math:`I_a`.
+One-Time-Key 0x0A String The public part of Bob's single-use key,
+ :math:`E_b`.
+Base-Key 0x12 String The public part of Alice's single-use key,
+ :math:`E_a`.
+Identity-Key 0x1A String The public part of Alice's identity key,
+ :math:`I_a`.
Message 0x22 String An embedded Olm message with its own version and
MAC.
============ ===== ======== ================================================