Skip to content

Commit e68205d

Browse files
committed
Update docs
1 parent de40a32 commit e68205d

2 files changed

Lines changed: 15 additions & 4 deletions

File tree

docs/figures/figures.pptx

-1 Bytes
Binary file not shown.

docs/protocol-guide.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ We say "inspired by" because:
4141
## Network topology
4242

4343
The following figure shows the topology that we use in all of our examples and which is specified
44-
in topology file `topology.yaml`:
44+
in file `topology.yaml`:
4545

4646
![Example network topology](figures/topology.png)
4747

@@ -77,7 +77,7 @@ The clients are responsible for:
7777
Below, we describe the concepts of PSRD and key shares and each of these steps in more detail.
7878

7979
In the example scenario, clients Carol and Conny are responsible for producing an encryption key
80-
and for delivering this key to encryptors Patrick and Porter respectively.
80+
and for delivering this key to encryptors Sam and Sofia respectively.
8181
The other clients are faded out because they play no role in our example.
8282

8383
In our implementation, each client runs in a separate process, listening on a separate
@@ -93,6 +93,9 @@ uses the term security hub.
9393

9494
There are five hubs in our example: Hank, Helen, Hilary, Holly, and Hugo.
9595

96+
In our example, the number of clients happens to be equal to the number of hubs.
97+
This is a coincidence; typically there are more clients than hubs.
98+
9699
The hubs are responsible for:
97100

98101
1. Allowing clients to register themselves with the hubs.
@@ -104,7 +107,7 @@ The hubs are responsible for:
104107
Once again, we describe these steps in more detail below.
105108

106109
In the example scenario, all five hubs are involved in relaying the key shares between clients Carol
107-
and Conny.
110+
and Conny to produce a key between encryptors Sam and Sofia.
108111

109112
In our implementation, each hub also runs in a separate process, listening on a separate HTTP port.
110113

@@ -127,7 +130,15 @@ Examples of encryptors include:
127130
[SSL](https://en.wikipedia.org/wiki/Secure_Sockets_Layer) encryptors, such as
128131
[F5 NGINX](https://www.f5.com/company/blog/nginx/nginx-ssl).
129132

130-
There are two encryptors in our example: Patrick and Porter.
133+
There are five encryptors in our example topology: Sam, Serena, Sofia, Sunny and Susan.
134+
135+
Each encryptor is connected to one client and each client can have zero or more encryptors
136+
connected to it.
137+
In the example, client Carol has one encryptor (Sam), client Celia has one encryptor (Serena),
138+
client Cindy has zero encryptors, client Connie has one encryptor (Sofia), and client Curtis
139+
has two encryptors (Sunny and Susan).
140+
141+
The example scenarios use encryptors Sam and Sofia; the other encryptors are faded out.
131142

132143
The encryptors are responsible for:
133144

0 commit comments

Comments
 (0)