mirror of
https://github.com/simplex-chat/simplex-chat.git
synced 2024-12-17 17:20:21 +01:00
Rename edge-messaging to simplex messaging (#15)
* rename edge-messaging protocol related files * rename edge-messaging protocol to simplex messaging protocol * adjust wordings for simplex connections
This commit is contained in:
Efim Poberezkin
GitHub
+29
-29
@@ -1,6 +1,6 @@
|
||||
# Graph-chat protocol
|
||||
|
||||
A generic chat protocol for client applications that communicate via edge-messaging protocol
|
||||
A generic chat protocol for client applications that communicate via simplex messaging protocol
|
||||
|
||||
|
||||
## Problems of the existing chat platforms and protocols
|
||||
@@ -8,8 +8,8 @@ A generic chat protocol for client applications that communicate via edge-messag
|
||||
- Dependency on a single company/server to access and use chat. That creates implications for chat privacy, user profile resilience and data ownership.
|
||||
- Visiblity of user profile information to chat system and other chat users. Chat users have limited control as to who can see and find their profile.
|
||||
- Visibility of user contacts graph to chat server.
|
||||
- [E2EE][1] can be compromised by [MITM][2] attack (see [edge-messaging protocol][3]).
|
||||
- Identity related problems (also see [edge-messaging protocol][3]).
|
||||
- [E2EE][1] can be compromised by [MITM][2] attack (see [simplex messaging protocol][3]).
|
||||
- Identity related problems (also see [simplex messaging protocol][3]).
|
||||
|
||||
|
||||
## Graph-chat protocol abstract
|
||||
@@ -19,16 +19,16 @@ TODO
|
||||
|
||||
## Duplex connection
|
||||
|
||||
Majority of chat scenarios requires duplex (bi-directional) connections between participants. Graph-chat protocol uses multiple unidirectional connections (graph edges) created on multiple edge-messaging servers to implement duplex connections.
|
||||
Majority of chat scenarios requires duplex (bi-directional) connections between participants. Graph-chat protocol uses multiple simplex (unidirectional) connections created on multiple simplex messaging servers to implement duplex connections.
|
||||
|
||||
Each duplex connection consists of one or multiple, for redundancy, pairs of unidirectional connections to connect chat participants or devices of the same participant - it is used for "contacts", "devices", "group participants", etc. For practical purposes of redundancy, chat clients can use 2-4 pairs of unidirectional connections.
|
||||
Each duplex connection consists of one or multiple, for redundancy, pairs of simplex connections to connect chat participants or devices of the same participant - it is used for "contacts", "devices", "group participants", etc. For practical purposes of redundancy, chat clients can use 2-4 pairs of simplex connections.
|
||||
|
||||
The process described below establishes a duplex connection between Alice and Bob that has `n` unidirectional connections `CAi` (where `1 <= i <= n`) from Bob to Alice (created by Alice on her servers) and `n` unidirectional connections `CBi` (where `1 <= i <= n`) from Alice to Bob (created by Bob on his servers).
|
||||
The process described below establishes a duplex connection between Alice and Bob that has `n` simplex connections `CAi` (where `1 <= i <= n`) from Bob to Alice (created by Alice on her servers) and `n` simplex connections `CBi` (where `1 <= i <= n`) from Alice to Bob (created by Bob on his servers).
|
||||
|
||||
The following symbols are used below:
|
||||
- unidirectional edge-messaging connections:
|
||||
- `CAi` - Alice's edge-messaging connection number `i` (out of `n`) allowing Bob to send messages to Alice.
|
||||
- `CBi` - Bob's edge-messaging connection number `i` (out of `n`) allowing Alice to send messages to Bob.
|
||||
- simplex connections:
|
||||
- `CAi` - Alice's simplex connection number `i` (out of `n`) allowing Bob to send messages to Alice.
|
||||
- `CBi` - Bob's simplex connection number `i` (out of `n`) allowing Alice to send messages to Bob.
|
||||
- keys created for Alice's connections:
|
||||
- `EKAi` - Alice's assymetric key pair used:
|
||||
- by Bob to encrypt and by Alice to decrypt messages from Bob sent via `CAi`.
|
||||
@@ -54,7 +54,7 @@ The following symbols are used below:
|
||||
To create a duplex connection initiated by Alice, Alice's and Bob's apps follow these steps:
|
||||
|
||||
1. Alice's app initiates duplex connection:
|
||||
1. it creates `n` unidirectional connections ("edges") `CAi` (step 1 in [edge-messaging][3]) that are defined by:
|
||||
1. it creates `n` simplex connections `CAi` (step 1 in [simplex messaging][3]) that are defined by:
|
||||
- client-generated:
|
||||
- Alice's asymmetric key pairs `EKAi` to encrypt messages.
|
||||
- connection IDs `IDAi`.
|
||||
@@ -62,19 +62,19 @@ To create a duplex connection initiated by Alice, Alice's and Bob's apps follow
|
||||
- server-generated:
|
||||
- recipient URIs `RUAi`.
|
||||
- sender URIs `SUAi`.
|
||||
2. optionally, Alice's app subsribes to receive messages from these new connections `CAi` ([edge-messaging protocol implementation][4] defines protocol to be used for subscriptions).
|
||||
2. Alice's app sends a secure message to Bob's app (step 2 in [edge-messaging][3]):
|
||||
2. optionally, Alice's app subsribes to receive messages from these new connections `CAi` ([simplex messaging protocol implementation][4] defines protocol to be used for subscriptions).
|
||||
2. Alice's app sends a secure message to Bob's app (step 2 in [simplex messaging][3]):
|
||||
1. it prepares the message with the information needed to establish all connections `CAi`, including all encryption keys `EKAi` and sender connection URIs (`SUAi`).
|
||||
2. depending on the communication scenario, Alice's app sends this message to Bob's app in one of available secure ways (either out-of-band or via available secure duplex connection(s) - see [Duplex connection security level](#TODO)), depending on communication scenario:
|
||||
- if Bob is a new contact, the information is presented as a visual code (e.g. QR code(s)) to Bob's app - as out-of-band message needed to establish connections `CAi` (see [edge-messaging protocol][3] and [Adding direct contact](#adding-direct-contact)).
|
||||
- if Bob is a new contact, the information is presented as a visual code (e.g. QR code(s)) to Bob's app - as out-of-band message needed to establish connections `CAi` (see [simplex messaging protocol][3] and [Adding direct contact](#adding-direct-contact)).
|
||||
- if Bob is added to group chat with Alice by some contact of Alice or Bob, this information can be passed through all possible chains of contacts between Alice and Bob in the group (to minimise the risk of MITM attack) (see [Group chat](#TODO)).
|
||||
- if Alice adds Bob as a contact via Bob's trusted contact John, who also has Alice as a trusted contact, this information will be passed via John (who has secure duplex connections with both Alice and Bob), in the same way as with Group chat (see [Trusted contacts](#TODO)).
|
||||
- if Alice already has Bob as a contact, and she wants to create a separate off-the-record chat with him, this information will be passed via their existing connection (see [Off-the-record chat](#TODO)).
|
||||
- etc. In all cases, the protocol defines the most secure possible way to pass the out-of-band (from the point of view of the new connections) message required by [edge-messaging protocol][3] to create unidirectional connections.
|
||||
- etc. In all cases, the protocol defines the most secure possible way to pass the out-of-band (from the point of view of the new connections) message required by [simplex messaging protocol][3] to create simplex connections.
|
||||
3. Bob's app accepts duplex connection with Alice:
|
||||
1. it receives the message from Alice's app, in a way defined by a specific chat scenario.
|
||||
2. it interprets the received information as edge-messaging protocol out-of-band messages to accept all unidirectional connections `CAi`.
|
||||
3. it creates `n` new unidirectional connections `CBi` on Bob's servers defined by:
|
||||
2. it interprets the received information as simplex messaging protocol out-of-band messages to accept all simplex connections `CAi`.
|
||||
3. it creates `n` new simplex connections `CBi` on Bob's servers defined by:
|
||||
- client-generated:
|
||||
- Bob's asymmetric key pairs `EKBi` to encrypt messages.
|
||||
- connection IDs `IDBi`.
|
||||
@@ -82,26 +82,26 @@ To create a duplex connection initiated by Alice, Alice's and Bob's apps follow
|
||||
- server-generated:
|
||||
- recipient URIs `RUBi`.
|
||||
- sender URIs `SUBi`.
|
||||
4. optionally, Bob's app subsribes to receive messages from these new connection `CBi` (see [edge-messaging protocol implementation][4]).
|
||||
5. it proceeds with accepting Alice's app connections `CAi` (step 3 in [edge-messaging protocol][3]).
|
||||
4. optionally, Bob's app subsribes to receive messages from these new connection `CBi` (see [simplex messaging protocol implementation][4]).
|
||||
5. it proceeds with accepting Alice's app connections `CAi` (step 3 in [simplex messaging protocol][3]).
|
||||
6. in response to each connection `CAi`, as optional information, Bob's app includes:
|
||||
- Bob's user profile (that is only stored in graph-chat client and not visible to any server)
|
||||
- information to establish connection `CBi`:
|
||||
- encryption key `EKBi`.
|
||||
- sender connection URIs (`SUBi`).
|
||||
7. his app now sends the unsigned requests to Alice's connections `CAi` (step 3.4 in [edge-messaging protocol][3]), to both confirm the connections `CAi` and to propose the new connections `CBi`. As each message is encrypted by the key `EKAi` of the connection `CAi` that only Alice can decrypt, it is safe to send it - from edge-messaging server point of view it is an out-of-band message.
|
||||
7. his app now sends the unsigned requests to Alice's connections `CAi` (step 3.4 in [simplex messaging protocol][3]), to both confirm the connections `CAi` and to propose the new connections `CBi`. As each message is encrypted by the key `EKAi` of the connection `CAi` that only Alice can decrypt, it is safe to send it - from simplex messaging server point of view it is an out-of-band message.
|
||||
4. Alice's app adds Bob's duplex connection:
|
||||
1. it receives the messages from Bob via connections `CAi` (step 4 in [edge-messaging protocol][3]).
|
||||
1. it receives the messages from Bob via connections `CAi` (step 4 in [simplex messaging protocol][3]).
|
||||
2. depending on chat scenario, Bob is identified and confirmed:
|
||||
- for new contact, Alice may visually identify Bob's user profile and accepts Bob as a contact.
|
||||
- for group participant, Alice's app will match known Bob's user profile ID with received user profile ID (that is only visible to the clients apps that have this profile).
|
||||
3. it secures the connections `CAi` with keys `SKAi` received from Bob - the connections are now established (step 5 in [edge-messaging protocol][3]).
|
||||
4. it accepts the connections `CBi`, including in the response to Bob's server Alice's user profile and (as the additional information) the confirmation that the connections `CAi` are secured and can be used (step 3 in [edge-messaging protocol][3]).
|
||||
3. it secures the connections `CAi` with keys `SKAi` received from Bob - the connections are now established (step 5 in [simplex messaging protocol][3]).
|
||||
4. it accepts the connections `CBi`, including in the response to Bob's server Alice's user profile and (as the additional information) the confirmation that the connections `CAi` are secured and can be used (step 3 in [simplex messaging protocol][3]).
|
||||
5. it sends the unsigned messages via connections `CBi`.
|
||||
6. it adds Bob's duplex connection to the list of available duplex connections as "pending" (Alice cannot yet send messages to Bob, but Bob already can send messages to Alice). Possibly, the status of duplex connection can indicate that Bob already can send messages to Alice.
|
||||
5. Bob's app adds duplex connection with Alice:
|
||||
1. it receives the initial messages via connections `CBi`.
|
||||
2. it secures the connections `CBi` - they are now established as well (step 5 in [edge-messaging protocol][3]).
|
||||
2. it secures the connections `CBi` - they are now established as well (step 5 in [simplex messaging protocol][3]).
|
||||
3. it adds duplex connection with Alice in the list of available duplex connections as "pending" (to indicate that Alice cannot yet send messages). Possibly, the status of duplex connection can indicate that Bob already can send messages to Alice.
|
||||
4. it sends a special message (message type "welcome") to Alice's app via duplex connection (i.e., via all connections `CAi`) to confirm that adding Alice's contact is completed (see [Sending messages via duplex connection](#TODO)).
|
||||
6. Alice's app finalises adding duplex connection with Bob:
|
||||
@@ -159,7 +159,7 @@ When Alice sends the message to Bob via the duplex connection, they follow these
|
||||
|
||||
"Direct contact" is a term used for a duplex connection with another chat user established directly, not via another user. Establishing contact requires sending an out-of-band message - "visual code" (e.g. QR code(s)) is used for this purpose.
|
||||
|
||||
For example, Alice and Bob want to have a conversation in chat app, exchanging messages with each other. They both have graph-chat client and access to several edge-messaging servers (see [edge-messaging protocol][3]) that they can use to receive messages, and their graph-chat clients are configured to use these servers.
|
||||
For example, Alice and Bob want to have a conversation in chat app, exchanging messages with each other. They both have graph-chat client and access to several simplex messaging servers (see [simplex messaging protocol][3]) that they can use to receive messages, and their graph-chat clients are configured to use these servers.
|
||||
|
||||
To chat in the app Alice needs to add Bob as "direct contact" to her contacts in the app.
|
||||
|
||||
@@ -167,7 +167,7 @@ To chat in the app Alice needs to add Bob as "direct contact" to her contacts in
|
||||
2. Alice shares "visual code" (e.g. QR code(s)) with Bob:
|
||||
1. her app prepares secure message to establish duplex connection with Bob's app (step 1 in [Creating duplex connection](#creating-duplex-connection)).
|
||||
2. her app prepares and displays a visual code with this message (step 2 in [Creating duplex connection](#creating-duplex-connection)).
|
||||
3. Alice now can share this visual code with Bob, either in person or via a video call (see [edge-messaging protocol][3]).
|
||||
3. Alice now can share this visual code with Bob, either in person or via a video call (see [simplex messaging protocol][3]).
|
||||
3. Bob reads "visual code" that Alice prepared via his app:
|
||||
1. he initiates adding "direct contact" via visual code in his graph-chat client app.
|
||||
2. his app interprets this visual code as secure message required to accept duplex connection with Alice and proceeds with creating duplex connection (step 3 in [Creating duplex connection](#creating-duplex-connection)).
|
||||
@@ -205,8 +205,8 @@ Control messages:
|
||||
- "receipt" - acknowledging message receipt.
|
||||
- "contact: update" - changing "contact" profile .
|
||||
- "profile" - changing "contact
|
||||
- "gm: add" - sent to add unidirectional edge-messaging connection to graph-chat duplex connection.
|
||||
- "gm: remove" - sent to remove unidirectional edge-messaging connection from graph-chat duplex connection.
|
||||
- "gm: add" - sent to add simplex connection to graph-chat duplex connection.
|
||||
- "gm: remove" - sent to remove simplex connection from graph-chat duplex connection.
|
||||
|
||||
Content messages:
|
||||
|
||||
@@ -216,5 +216,5 @@ Content messages:
|
||||
|
||||
[1]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack
|
||||
[2]: https://en.wikipedia.org/wiki/End-to-end_encryption
|
||||
[3]: edge-messaging.md
|
||||
[4]: edge-messaging-implementation.md
|
||||
[3]: simplex-messaging.md
|
||||
[4]: simplex-messaging-implementation.md
|
||||
|
||||
Reference in New Issue
Block a user