History

Ian Jackson 87801dd4c0 Apply 1 suggestion(s) to 1 file(s)		2022-07-13 13:13:13 +00:00
..
src	Apply 1 suggestion(s) to 1 file(s)	2022-07-13 13:13:13 +00:00
Cargo.toml	Bump crate and dependency versions.	2022-06-24 12:00:22 -04:00
README.md	Update our disclaimers and limitations sections.	2021-10-27 11:13:46 -04:00
semver.md	tor-circmgr: Clarify and improve Protocol error.	2022-07-12 10:01:56 -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