Skip to content

docs: locality names have Top_ prefix #20

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: locality names have Top_ prefix #20

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Suppose you want to extract the protocol in `protocol.owl`, which contains local
This should output one `.owl_config` file for each of the localities in the protocol (in this example, `loc_alice.owl_config`, `loc_bob.owl_config`, `loc_charlie.owl_config`). These files contain all the pre-initialized names for the protocol (such as pre-shared symmetric keys, public keys for other localities, shared salt for the KDF, etc).
4. Open one shell for each of the localities in the protocol (in this example, three shells). In all of them, `cd` to the `extraction` subdirectory.
5. In each of the shells, run `cargo run -- run LOCALITY PATH-TO-LOCALITY-CONFIG`. In this example, you would run:
- Shell 1: `cargo run -- run alice loc_alice.owl_config`
- Shell 2: `cargo run -- run bob loc_bob.owl_config`
- Shell 3: `cargo run -- run charlie loc_charlie.owl_config`
- Shell 1: `cargo run -- run Top_alice loc_Top_alice.owl_config`
- Shell 2: `cargo run -- run Top_bob loc_Top_bob.owl_config`
- Shell 3: `cargo run -- run Top_charlie loc_Top_charlie.owl_config`
These should all be started within 5 seconds of each other. The extraction harness waits 5 seconds before beginning execution of the locality; this is to ensure that the user has time to start the other localities. Otherwise, the protocol code may fail because another locality's TCP socket is not ready to receive yet.
6. You should see the return values of each of the localities printed in their corresponding shells.

Expand Down