History

Nick Mathewson 67b88547c5 CircMgr: Add an accessor for the CircuitBuilder. Without this, actually building circuits manually is a pain. This API is behind the `experimental-api` feature, and so it does not require a semver.md entry.		2022-09-22 08:57:34 -04:00
..
src	CircMgr: Add an accessor for the CircuitBuilder.	2022-09-22 08:57:34 -04:00
Cargo.toml	Bump crate versions in preparation for Arti 1.0.0 release.	2022-09-01 08:59:49 -04:00
README.md	Update our disclaimers and limitations sections.	2021-10-27 11:13:46 -04:00

README.md

tor-circmgr

tor-circmgr: circuits through the Tor network on demand.

Overview

This crate is part of Arti, a project to implement Tor in Rust.

In Tor, a circuit is an encrypted multi-hop tunnel over multiple relays. This crate's purpose, long-term, is to manage a set of circuits for a client. It should construct circuits in response to a client's needs, and preemptively construct circuits so as to anticipate those needs. If a client request can be satisfied with an existing circuit, it should return that circuit instead of constructing a new one.

Limitations

But for now, this tor-circmgr code is extremely preliminary; its data structures are all pretty bad, and it's likely that the API is wrong too.

License: MIT OR Apache-2.0