History

Nick Mathewson 85284ef847 Merge branch 'factory_redux' into 'main' chanmgr: Build and use chanmgr factory APIs See merge request tpo/core/arti!769		2022-10-13 12:58:28 +00:00
..
src	Merge branch 'factory_redux' into 'main'	2022-10-13 12:58:28 +00:00
Cargo.toml	Bump minor version of tor-rtcompat and most of its dependents	2022-10-03 10:01:46 -04:00
README.md	Add the skeleton of a tor-ptmgr crate	2022-09-23 14:08:24 -04:00

README.md

tor-ptmgr

tor-ptmgr: Manage a set of anti-censorship pluggable transports.

Overview

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

In Tor, a "transport" is a mechanism used to avoid censorship by disguising the Tor protocol as some other kind of traffic.

A "pluggable transport" is one that is not implemented by default as part of the Tor protocol, but which can instead be added later on by the packager or the user. Pluggable transports are typically provided as external binaries that implement a SOCKS proxy, along with certain other configuration protocols.

This crate provides a means to manage a set of configured pluggable transports

Limitations

TODO pt-client: Currently, the APIs for this crate make it quite tor-specific. Notably, it can only return Channels! It would be good instead to adapt it so that it was more generally useful by other projects that want to use pluggable transports in rust. For now, I have put the Tor-channel-specific stuff behind a tor-channel-factory feature, but there are no APIs for using PTs without that feature currently. That should change.

TODO pt-client: Nothing in this crate is actually implemented yet.

TODO pt-client: The first version of this crate will probably only conform to the old Tor pluggable transport protocol, and not to more recent variants as documented at pluggabletransports.info

License: MIT OR Apache-2.0