2020-11-20 07:48:56 +00:00
|
|
|
# Tapir-rs: Tiny Anonymous Peer (in Rust)
|
|
|
|
|
2021-01-12 12:19:49 +00:00
|
|
|
Very WIP. Currently supports authentication over Tor v3 onion services aligned with https://cwtch.im
|
2020-11-20 07:48:56 +00:00
|
|
|
|
2021-01-12 12:19:49 +00:00
|
|
|
## Examples
|
2020-11-20 07:48:56 +00:00
|
|
|
|
2021-01-12 12:19:49 +00:00
|
|
|
Run an ephemeral server:
|
2020-11-20 07:48:56 +00:00
|
|
|
|
2021-01-14 01:46:28 +00:00
|
|
|
cargo run --example simple_server --features onionv3
|
2020-11-20 07:48:56 +00:00
|
|
|
|
2021-01-12 12:19:49 +00:00
|
|
|
Update `examples/simple_client.rs` to connect to the address generated by `simple_server` and then run:
|
2020-11-20 07:48:56 +00:00
|
|
|
|
2021-01-14 01:46:28 +00:00
|
|
|
cargo run --example simple_client --features onionv3
|
2021-01-12 12:19:49 +00:00
|
|
|
|
2021-01-14 01:46:28 +00:00
|
|
|
Both the server and client should authenticate each other.
|
|
|
|
|
|
|
|
## Using the Library
|
|
|
|
|
|
|
|
We recommend you build with the `onionv3` feature enabled (in the future Tapir may support other anonymous communication
|
|
|
|
networks, but for now only Tor onion v3 services are supported).
|
|
|
|
|
|
|
|
tapir-cwtch = {version="0.1.8", features=["onionv3"]}
|