4841b50c9f
I found these versions empirically, by using the following process:
First, I used `cargo tree --depth 1 --kind all` to get a list of
every immediate dependency we had.
Then, I used `cargo upgrade --workspace package@version` to change
each dependency to the earliest version with which (in theory) the
current version is semver-compatible. IOW, if the current version
was 3.2.3, I picked "3". If the current version was 0.12.8, I
picked "0.12".
Then, I used `cargo +nightly upgrade -Z minimal-versions` to
downgrade Cargo.lock to the minimal listed version for each
dependency. (I had to override a few packages; see .gitlab-ci.yml
for details).
Finally, I repeatedly increased the version of each of our
dependencies until our code compiled and the tests passed. Here's
what I found that we need:
anyhow >= 1.0.5: Earlier versions break our hyper example.
async-broadcast >= 0.3.2: Earlier versions fail our tests.
async-compression 0.3.5: Earlier versions handled futures and tokio
differently.
async-trait >= 0.1.2: Earlier versions are too buggy to compile our
code.
clap 2.33.0: For Arg::default_value_os().
coarsetime >= 0.1.20: exposed as_ticks() function.
curve25519-dalek >= 3.2: For is_identity().
generic-array 0.14.3: Earlier versions don't implement
From<&[T; 32]>
httparse >= 1.2: Earlier versions didn't implement Error.
itertools at 0.10.1: For at_most_once.
rusqlite >= 0.26.3: for backward compatibility with older rustc.
serde 1.0.103: Older versions break our code.
serde_json >= 1.0.50: Since we need its Value type to implement Eq.
shellexpand >= 2.1: To avoid a broken dirs crate version.
tokio >= 1.4: For Handle::block_on().
tracing >= 0.1.18: Previously, tracing_core and tracing had separate
LevelFilter types.
typenum >= 1.12: Compatibility with rust-crypto crates
x25519-dalek >= 1.2.0: For was_contributory().
Closes #275.
|
||
|---|---|---|
| .. | ||
| src | ||
| testdata | ||
| Cargo.toml | ||
| README.md | ||
README.md
tor-proto
Implementations for the core Tor protocol
Overview
The tor-proto crate lies at the core of
Arti, a project to
implement Tor in Rust.
Most people shouldn't use this crate directly,
since its APIs are needlessly low-level for most purposes, and it is
easy to misuse them in an insecure or privacy-violating way.
Most people should use the [arti-client] crate instead. This crate is
of interest mainly for those that want to access the Tor protocols at
a low level.
Core concepts
At its essence, Tor makes connections called "channels" to other Tor instances. These channels are implemented using TLS. Each of these channels multiplexes a number of anonymized multihop "circuits" that act as reliable transports for "relay messages" that are sent between clients and the different relays on the circuits. Finally, each circuit multiplexes a number of "streams", each corresponding roughly to an application-level request.
This crate implements the logic, protocols, and cryptography that
implement these [channel::Channel]s, [circuit::ClientCirc]s, and
[stream::DataStream]s. It uses rust async code and future-related
traits, and is intended to work with (nearly) any executor
implementation that complies with the futures API. It should also
work with nearly any TLS implementation that exposes AsyncRead and
AsyncWrite traits.
Not in this crate
This crate does not implement higher level protocols, like onion services or the Tor directory protocol, that are based on the Tor protocol here. Nor does it decide when, how, or where to build channels and circuits: that's the role of higher-level crates.
This crate also has no support for timeouts, so every network operation here has the potential to block the current task indefinitely. Timeouts are another necessary piece that gets added at a higher level.
In order to create channels and circuits, you'll need to know
about some Tor relays, and expose their information via
[tor_linkspec::ChanTarget] and [tor_linkspec::CircTarget].
Currently, the [tor-netdir] crate is the easiest way to do so.
For an example of this crate in action, see the [arti-client]
library, or the arti CLI.
Design notes
This crate's APIs are structured to explicitly avoid any usage of
an asynchronous runtime: It doesn't launch tasks or include
timeouts. Those are done at a higher level in Arti, via the
[tor-rtcompat] crate.
To the extent possible, this crate avoids doing public-key cryptography in the same functions it uses for network activity. This makes it easier for higher-level code to parallelize or yield around public-key operations.
Limitations
This is all a work in progress, and will need severe refactoring before it's done.
This is a client-only implementation; there is no support the operations that Relays need.
There are too many missing features to list.
There isn't enough documentation or examples.
This crate was my first attempt to use async in rust, and is probably pretty kludgy.
I bet that there are deadlocks somewhere in this code. I fixed all the ones I could find or think of, but it would be great to find a good way to eliminate every lock that we have.
This crate doesn't work with rusttls because of a limitation in the webpki crate.
License: MIT OR Apache-2.0