9db748e8dd
* Improve SDK rustdoc and add ARCHITECTURE.md files - Rewrite lib.rs module docs with quick-start example and module overview - Add stream example and include_str! ARCHITECTURE.md to mixnet module - Add ARCHITECTURE.md for mixnet, client_pool, and stream modules - Add rustdoc to MixnetClientBuilder, MixnetClientSender, MixnetMessageSender - Add cancel safety and drop behavior annotations to async methods - Add TcpProxy deprecation notice pointing to stream module * Fix rustdoc errors and add stepwise comments to remaining examples Rustdoc fixes: - Add missing .unwrap() on connect_new example - Replace broken turbofish intra-doc link in MixnetClientBuilder - Fix NymProxyServer::new args in tcp_proxy example - Wrap BandwidthImporter example in scoped block to fix borrow-then-move - Change misleading "5-hop routing" to "multi-hop routing" - Fix copy-paste "forget me" in send_remember_me error message - Fix wrong cargo run command in stream_simple_read_write - Fix DecayWrapper description * Cut down doc comment length * Trimmed down SDK ARCHITECTURE files * Slim Rust SDK docs and rename opener to dialer - Merge tour page into SDK landing page, delete tour.mdx - Trim all three tutorials: cut boilerplate, duplicated code, and misplaced content - Make FFI page evergreen with Go and C++ snippets, link to repo examples - Rename "opener" to "dialer" in stream docs, source ARCHITECTURE.md, and rustdoc - Add reply-to-open arrow in stream mermaid diagram - Replace remaining Unicode dashes in mermaid flowchart * - elevate streams in rustdoc: examples on lib.rs, MixnetClient, open_stream, listener - add stream quick reference to mixnet ARCHITECTURE.md - add stream types to key types list in ARCHITECTURE.md - add docs.rs links for AsyncRead/AsyncWrite and stream submodule - tcp_proxy: replace bold deprecation with warning box * - replace individual example doc pages with GitHub-linked tables - add step-by-step inline comments to all SDK example source files - add doc comments to examples missing them (simple, surb_reply, builder, etc.) - expand mixnet tutorial with persistent identity and split_sender sections - add tcpproxy tutorial - rename "API Reference" to "TypeDoc Reference" in TS SDK sidebar - rename "Misc" to "Extras" in developer sidebar, move VPN CLI up - remove echo server from tools - update message-queue callout to reference actual modules - fix mixnet/examples redirect collision * Add missing mut to example code * Update ARCHITECTURE.md with LP Framing + stream examples with sequencing * Update doc comment in utils.rs * Standardise commenting style across Rust SDK examples * Fix inline doc examples and trim re-export boilerplate * Update sdk/rust/nym-sdk/examples/bandwidth.rs Co-authored-by: Simon Wicky <simon@nymtech.net> * Fix review comments --------- Co-authored-by: Simon Wicky <simon@nymtech.net>
55 lines
2.0 KiB
Rust
55 lines
2.0 KiB
Rust
//! SOCKS5 proxy client that routes HTTP requests through the mixnet.
|
|
//!
|
|
//! Connects a `Socks5MixnetClient` to a receiving `MixnetClient` acting
|
|
//! as the service provider, then sends an HTTP GET via the SOCKS5 proxy.
|
|
//!
|
|
//! Run with: cargo run --example socks5
|
|
|
|
use nym_sdk::mixnet;
|
|
|
|
#[tokio::main]
|
|
async fn main() {
|
|
nym_bin_common::logging::setup_tracing_logger();
|
|
|
|
// Connect a receiving client (acts as the "network requester").
|
|
println!("Connecting receiver");
|
|
let mut receiving_client = mixnet::MixnetClient::connect_new().await.unwrap();
|
|
|
|
// Build and connect a SOCKS5 sending client pointed at the receiver.
|
|
let socks5_config = mixnet::Socks5::new(receiving_client.nym_address().to_string());
|
|
let sending_client = mixnet::MixnetClientBuilder::new_ephemeral()
|
|
.socks5_config(socks5_config)
|
|
.build()
|
|
.unwrap();
|
|
|
|
println!("Connecting sender");
|
|
let sending_client = sending_client.connect_to_mixnet_via_socks5().await.unwrap();
|
|
|
|
// Configure an HTTP client to use the SOCKS5 proxy.
|
|
let proxy = reqwest::Proxy::all(sending_client.socks5_url()).unwrap();
|
|
let reqwest_client = reqwest::Client::builder().proxy(proxy).build().unwrap();
|
|
|
|
// Send an HTTP request through the mixnet via SOCKS5.
|
|
// No network requester is running on the other end, so we won't
|
|
// get a real HTTP response — but the receiver sees the raw bytes.
|
|
tokio::spawn(async move {
|
|
println!("Sending socks5-wrapped http request");
|
|
reqwest_client.get("https://nymtech.net").send().await.ok()
|
|
});
|
|
|
|
// The receiver sees the raw SOCKS5/HTTP bytes arrive.
|
|
println!("Waiting for message");
|
|
if let Some(received) = receiving_client.wait_for_messages().await {
|
|
for r in received {
|
|
println!(
|
|
"Received socks5 message requesting for endpoint: {}",
|
|
String::from_utf8_lossy(&r.message[10..27])
|
|
);
|
|
}
|
|
}
|
|
|
|
// Disconnect both clients.
|
|
receiving_client.disconnect().await;
|
|
sending_client.disconnect().await;
|
|
}
|