History

Ian Jackson f69d7f96ac tor-netdoc: Change fill_from_previous_netdir * Remove the return value, which was not used anywhere. Also remove the code to calculate the return value. * Take an Arc<NetDir> rather than a reference. We are going to want this for HS support. This has no overall effect on the lifetime of the4 Arc, which was owned at the one call site and then imediately dropped. * Change the documentation to explain what the function's role is in the netdir API, rather than the fiddly details of what it actually does internally. Relegate the latter to a code comment. (When we have HS, this will do more, or, at least, make further arrangements.)		2023-02-09 12:56:18 +00:00
..
src	tor-netdoc: Change fill_from_previous_netdir	2023-02-09 12:56:18 +00:00
testdata	Copy tor-netdoc/testdata/routerdesc1.txt into tor-dirmgr	2022-11-03 11:37:05 +00:00
Cargo.toml	Bump the patch version of every crate that had API additions	2023-02-01 10:36:29 -05:00
README.md	doc: consistent summary line for the READMEs	2022-12-20 14:31:47 +01:00

README.md

tor-dirmgr

Code to fetch, store, and update Tor directory information.

Overview

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

In its current design, Tor requires a set of up-to-date authenticated directory documents in order to build multi-hop anonymized circuits through the network.

This directory manager crate is responsible for figuring out which directory information we lack, downloading what we're missing, and keeping a cache of it on disk.

Compile-time features

mmap (default) -- Use memory mapping to reduce the memory load for reading large directory objects from disk.
routerdesc -- (Incomplete) support for downloading and storing router descriptors.
compression (default) -- Build support for downloading compressed documents. Requires a C compiler.
bridge-client: Provide APIs used to fetch and use bridge information.
full -- Enable all features above.

Non-additive features

static -- Try to link with a static copy of sqlite3.

Experimental and unstable features

Note that the APIs enabled by these features are NOT covered by semantic versioning¹ guarantees: we might break them or remove them between patch versions.

experimental-api: Add additional non-stable APIs to our public interfaces.
dirfilter: enable an experimental mechanism to modify incoming directory information before it is used.
experimental: Enable all the above experimental features.

License: MIT OR Apache-2.0

Remember, semantic versioning is what makes various cargo features work reliably. To be explicit: if you want cargo update to only make safe changes, then you cannot enable these features. ↩︎