Add Tor support to Cuprate (Arti, Tor Daemon, Dandelion router) by SyntheticBird45 · Pull Request #509 · Cuprate/cuprate

SyntheticBird45 · 2025-06-10T22:03:14Z

What

Part of ongoing Tor support development for Cuprate

Follows: #446 and #481

Changelog

In workspace:

New dependencies: arti_client, Cuprate/tokio-socks.git, tor-cell, tor-config-path, tor-hsservice, tor-persist, tor-proto, tor-rtcompat (yes nothing was exported).
In deny.toml, whitelisted Unlicense license for arti_client.

In cuprate-p2p-transport:

Implemented Transport<ClearNet> and Transport<Tor> for Arti. New ArtiClientConfig, ArtiServerConfig configuration. New OnionListener for accepting inbound connections from arti's generated onion service.
Implemented Transport<Tor> for Daemon. New DaemonClientConfig, DaemonServerConfig configuration. New DaemonInboundStream listening for incoming TCP connections from the tor daemon.
DisabledListener as a polyfill for transports with inbound disabled, such as Transport<ClearNet> for Arti and in the future Transport<ClearNet> for Socks5.

In cuprate-p2p-core:

Removed Default and Debug bound from Transport::ClientConfig and Transport::ServerConfig.
Removed Clone bound from Transport::ServerConfig.

In cuprate-p2p:

Changed some function visibility to pub(super) instead of pub.

In cuprate-wire:

Added borsh dependency and BorshSerialize and BorshDeserialize derived implementation to OnionAddr for BorshNetworkZone requirement in address book.

In cuprated:

New tor module containing the initialization of Arti, config helpers and context structure TorContext to pass down to p2p initialization function and other helpers.
New config/tor module containing the [tor] configuration table. It define tor daemon related variables, as well as arti settings.
Added enable_inbound field to ClearNetConfig to disable incoming listener by default.
Added proxy field to ClearNetConfig for enabling clearnet over arti and in the future proxy urls.
Added TorNetConfig for setting Tor network zone parameters such as listening ports, enabling arti inbound server, or setting an anonymous inbound onion address from an external daemon.
Modified initialize_zones_p2p to now start Tor network zone and use the correct transport depending on user configuration.
In txpool/*, generalized DiffuseService, OutboundPeerStream and ConcreteDandelionRouter for Z: NetworkZone. Created a new MainDandelionRouter service that will route local txs to a Tor router instead of clearnet if available. Adapted initialization to the changes.

binarybaron · 2025-06-11T14:13:53Z

very cool!

In `workspace`: - New dependencies: `arti_client`, `Cuprate/tokio-socks.git`, `tor-cell`, `tor-config-path`, `tor-hsservice`, `tor-persist`, `tor-proto`, `tor-rtcompat` (yes nothing was exported). - In `deny.toml`, whitelisted `Unlicense` license for `arti_client`. In `cuprate-p2p-transport`: - Implemented `Transport<ClearNet>` and `Transport<Tor>` for `Arti`. New `ArtiClientConfig`, `ArtiServerConfig` configuration. New `OnionListener` for accepting inbound connections from arti's generated onion service. - Implemented `Transport<Tor>` for `Daemon`. New `DaemonClientConfig`, `DaemonServerConfig` configuration. New `DaemonInboundStream` listening for incoming TCP connections from the tor daemon. - `DisabledListener` as a polyfill for transports with inbound disabled, such as `Transport<ClearNet> for Arti` and in the future `Transport<ClearNet> for Socks5`. In `cuprate-p2p-core`: - Removed `Default` and `Debug` bound from `Transport::ClientConfig` and `Transport::ServerConfig`. - Removed `Clone` bound from `Transport::ServerConfig`. In `cuprate-p2p`: - Changed some function visibility to `pub(super)` instead of `pub`. In `cuprate-wire`: - Added `borsh` dependency and `BorshSerialize` and `BorshDeserialize` derived implementation to `OnionAddr` for `BorshNetworkZone` requirement in address book. In `cuprated`: - New `tor` module containing the initialization of Arti, config helpers and context structure `TorContext` to pass down to p2p initialization function and other helpers. - New `config/tor` module containing the `[tor]` configuration table. It define tor daemon related variables, as well as arti settings. - Added `enable_inbound` field to `ClearNetConfig` to disable incoming listener by default. - Added `proxy` field to `ClearNetConfig` for enabling clearnet over arti and in the future proxy urls. - Added `TorNetConfig` for setting `Tor` network zone parameters such as listening ports, enabling arti inbound server, or setting an anonymous inbound onion address from an external daemon. - Modified `initialize_zones_p2p` to now start Tor network zone and use the correct transport depending on user configuration. - In `txpool/*`, generalized `DiffuseService`, `OutboundPeerStream` and `ConcreteDandelionRouter` for `Z: NetworkZone`. Created a new `MainDandelionRouter` service that will route local txs to a Tor router instead of clearnet if available. Adapted initialization to the changes.

Boog900

first pass, good work!

Cargo.toml

binaries/cuprated/src/config.rs

binaries/cuprated/src/config/p2p.rs

Boog900 · 2025-06-18T17:13:44Z

binaries/cuprated/src/tor.rs

+/// clearnet as a proxy.
+pub async fn initialize_tor_if_enabled(config: &Config) -> TorContext {
+    let mode = config.tor.mode;
+    let anonymize_clearnet = config.p2p.clear_net.proxy.to_lowercase() == "Tor";


to_lowercase Tor :)

Do you think it might be good idea to make proxy an enum?

to_lowercase Tor :)

lol

Do you think it might be good idea to make proxy an enum?

It might be but I prefer to think about it in the SOCKS5 PR that comes just after (with docs PR) because fwiw I haven't decided if we should just support SOCKS5 and not SOCKS5H or 4. And therefore if we should rely on some URI library with serde support. we could handroll too. I prefer to think of String as a placeholder atm.

the enum I was thinking would be something like:

enum { Tor, Socks(String) }

with the socks being a catch all, this is a nit but does improve the code over string matching 🤷

I agree. thx for clarifying

Boog900 · 2025-06-18T17:18:14Z

binaries/cuprated/src/tor.rs

+    let Some(bootstrapped_client) = ctx.bootstrapped_client else {
+        panic!("Arti client should be initialized");
+    };
+    let Some(client_config) = ctx.arti_client_config else {
+        panic!("Arti client should be initialized");
+    };


bit of nit but these can be combined:

Suggested change

let Some(bootstrapped_client) = ctx.bootstrapped_client else {

panic!("Arti client should be initialized");

};

let Some(client_config) = ctx.arti_client_config else {

panic!("Arti client should be initialized");

};

let (Some(bootstrapped_client), Some(client_config)) = (ctx.bootstrapped_client, ctx.arti_client_config) else {

panic!("Arti client should be initialized");

};

I don't like having for conditions for one panic on the same line. If it panic I'll wonder what was uninitialized.

well then the comments should be different and mention the field IMO

Boog900 · 2025-06-18T17:19:34Z

binaries/cuprated/src/tor.rs

+        client_config: DaemonClientConfig {
+            tor_daemon: config.tor.daemon.address,
+        },
+        server_config: (!config.tor.daemon.anonymous_inbound.is_empty()).then_some(


should this instead check the bool field?

It should check bool and warn if anonymous_inbound is empty

binaries/cuprated/src/txpool/dandelion.rs

Boog900 · 2025-06-18T17:25:27Z

deny.toml

 allow = [
    # Nothing required - free to use without permission.
    "CC0-1.0", # https://creativecommons.org/publicdomain/zero/1.0/
+    "Unlicense",


is it possible to instead list the crates to allow?

There are quite a lot of them. Every subcrates of arti is Unlicense

binaries/cuprated/src/config/p2p.rs

binaries/cuprated/src/tor.rs

Boog900 · 2025-08-01T00:28:23Z

Still have some changes I want to make, will put a comment when I am done.

Boog900 · 2025-08-02T01:30:09Z

@SyntheticBird45 If you can review my changes I'll merge

binaries/cuprated/src/config.rs

SyntheticBird45 · 2025-08-04T13:52:39Z

@SyntheticBird45 If you can review my changes I'll merge

Approved. (I can't approve my own PR) No comments, changes are clear and reasonable. Thanks for taking finishing it.

If you could rebase and update this commit message e66d550 (and also add yourself as co author) that would be perfect.

SyntheticBird45 force-pushed the tor branch 3 times, most recently from 8faf6ef to 8c14140 Compare June 10, 2025 22:59

github-actions bot removed the A-storage Area: Related to storage. label Jun 10, 2025

SyntheticBird45 force-pushed the tor branch 4 times, most recently from 83ee8dc to cf16130 Compare June 11, 2025 13:26

SyntheticBird45 force-pushed the tor branch from f1e83f5 to 27142b5 Compare June 13, 2025 20:51

SyntheticBird45 force-pushed the tor branch from 27142b5 to e66d550 Compare June 13, 2025 21:32

SyntheticBird45 marked this pull request as ready for review June 13, 2025 21:45

SyntheticBird45 requested review from Boog900 and hinto-janai June 13, 2025 21:45

hinto-janai mentioned this pull request Jun 16, 2025

helper: cleanup #511

Draft

addressing config review

1cb1fa6

Boog900 requested changes Jun 18, 2025

View reviewed changes

SyntheticBird45 force-pushed the tor branch from 5b699b0 to 415ac73 Compare June 30, 2025 20:41

review

2928255

SyntheticBird45 force-pushed the tor branch from 415ac73 to 2928255 Compare July 1, 2025 08:46

1.88 clippy fix

83a97ad

github-actions bot added A-cryptonight Area: Related to Cryptonight. A-rpc Area: Related to RPC. labels Jul 1, 2025

hinto-janai added this to the cuprated v0.0.6 milestone Jul 15, 2025

Addressing review

ceaebc7

SyntheticBird45 requested a review from Boog900 July 24, 2025 09:10

Boog900 requested changes Jul 25, 2025

View reviewed changes

binaries/cuprated/src/config/p2p.rs Show resolved Hide resolved

binaries/cuprated/src/tor.rs Outdated Show resolved Hide resolved

changes to dandelion + misc changes

0b487a4

Boog900 force-pushed the tor branch from 995a317 to 0b487a4 Compare August 1, 2025 12:37

Boog900 added 2 commits August 1, 2025 20:29

add some docs

e6b9fb2

Merge branch 'main' into tor

fb241ec

github-actions bot added A-consensus Area: Related to consensus. and removed A-cryptonight Area: Related to Cryptonight. labels Aug 1, 2025

Boog900 added 2 commits August 1, 2025 22:02

fix deny

3e5a556

make builds static + update tor deps

a926465

github-actions bot added the A-ci Area: Related to CI. label Aug 1, 2025

Boog900 force-pushed the tor branch from 60c55d4 to c2c3abb Compare August 1, 2025 21:36

install fedora deps

0b663f8

Boog900 force-pushed the tor branch from c2c3abb to 0b663f8 Compare August 1, 2025 21:44

Boog900 added 2 commits August 2, 2025 01:47

fix p2p proxy with Tor

c6ccc4c

sort imports

6aedec4

Boog900 approved these changes Aug 2, 2025

View reviewed changes

Boog900 added 2 commits August 2, 2025 02:55

add static feature to cuprate-p2p-transport

c2a9a96

debian add pkg-config to deps

1bf2e48

SyntheticBird45 commented Aug 4, 2025

View reviewed changes

binaries/cuprated/src/config.rs Show resolved Hide resolved

Boog900 merged commit 9c2c942 into main Aug 4, 2025
20 checks passed

Boog900 deleted the tor branch August 23, 2025 15:38

This was referenced Sep 6, 2025

Add Tor section to User Book and Architecture Book #546

Open

cuprated: Generic SOCKS5 proxy support + ClearNet over Daemon #549

Merged

OBITOONDEADO1MZ approved these changes Sep 30, 2025

View reviewed changes

Comments

Conversation

SyntheticBird45 commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Changelog

Uh oh!

binarybaron commented Jun 11, 2025

Uh oh!

Boog900 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SyntheticBird45 Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Boog900 commented Aug 1, 2025

Uh oh!

Boog900 commented Aug 2, 2025

Uh oh!

Uh oh!

SyntheticBird45 commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

SyntheticBird45 commented Jun 10, 2025 •

edited

Loading

SyntheticBird45 Jun 30, 2025 •

edited

Loading

SyntheticBird45 commented Aug 4, 2025 •

edited

Loading