aboutsummaryrefslogtreecommitdiff
path: root/p2p/README.md
diff options
context:
space:
mode:
authorhozan23 <hozan23@proton.me>2023-11-28 22:41:33 +0300
committerhozan23 <hozan23@proton.me>2023-11-28 22:41:33 +0300
commit98a1de91a2dae06323558422c239e5a45fc86e7b (patch)
tree38c640248824fcb3b4ca5ba12df47c13ef26ccda /p2p/README.md
parentca2a5f8bbb6983d9555abd10eaaf86950b794957 (diff)
implement TLS for inbound and outbound connections
Diffstat (limited to 'p2p/README.md')
-rw-r--r--p2p/README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/p2p/README.md b/p2p/README.md
index 5bdaf63..edc5fcd 100644
--- a/p2p/README.md
+++ b/p2p/README.md
@@ -115,11 +115,12 @@ impl Protocol for NewProtocol {
Whenever a new peer is added to the PeerPool, all the protocols, including
your custom protocols, will automatically start running with the newly connected peer.
-## Network Security
+## Network Security
-It's obvious that connections in karyons p2p are not secure at the moment, as
-it currently only supports TCP connections. However, we are currently working
-on adding support for TLS connections.
+Using TLS is possible for all inbound and outbound connections by enabling the
+boolean `enable_tls` field in the configuration. However, implementing TLS for
+a P2P network is not trivial and is still unstable, requiring a comprehensive
+audit.
## Usage
@@ -129,5 +130,5 @@ If you have tmux installed, you can run the network simulation script in the
examples directory to run 12 peers simultaneously.
```bash
-$ RUST_LOG=karyons=debug ./net_simulation.sh
+$ RUST_LOG=karyons=info ./net_simulation.sh
```