History

Nick Mathewson 6fa821238d Revise all XXXXs from fixup-features		2023-05-15 11:00:28 -04:00
..
src	Use an Enum for the description request	2023-04-10 18:37:45 +00:00
Cargo.toml	Revise all XXXXs from fixup-features	2023-05-15 11:00:28 -04:00
README.md	doc: consistent summary line for the READMEs	2022-12-20 14:31:47 +01:00

README.md

tor-dirclient

Implements a minimal directory client for Tor.

Overview

Tor makes its directory requests as HTTP/1.0 requests tunneled over Tor circuits. For most objects, Tor uses a one-hop tunnel. Tor also uses a few strange and ad-hoc HTTP headers to select particular functionality, such as asking for diffs, compression, or multiple documents.

This crate provides an API for downloading Tor directory resources over a Tor circuit.

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

Features

xz -- enable XZ compression. This can be expensive in RAM and CPU, but it saves a lot of bandwidth. (On by default.)

zstd -- enable ZSTD compression. (On by default.)

routerdesc -- Add support for downloading router descriptors.

License: MIT OR Apache-2.0