History

trinity-1686a 426a59b2ba add feature annotation not added by doc_auto_cfg		2022-08-24 18:22:41 +02:00
..
src	add feature annotation not added by doc_auto_cfg	2022-08-24 18:22:41 +02:00
testdata	Oops: add missing data files	2021-10-28 19:51:16 -04:00
Cargo.toml	enable doc_auto_cfg feature on every crate when documenting for docs.rs	2022-08-24 18:22:41 +02:00
README.md	run ./maint/readmes.sh	2021-11-29 21:29:28 +10:00
semver.md	Add params() method to NetDirProvider, and partial implementation	2022-08-02 09:50:39 -04:00

README.md

tor-dirmgr

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.

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

routerdesc -- (Incomplete) support for downloading and storing router descriptors.

License: MIT OR Apache-2.0