#tor #download #arti #async

tor-dirmgr

Bootstrap and update an accurate Tor network directory

37 releases (24 breaking)

new 0.24.0 Oct 31, 2024
0.22.0 Sep 3, 2024
0.20.0 Jun 27, 2024
0.16.0 Mar 4, 2024
0.0.0 Jun 24, 2021

#1512 in Network programming

Download history 189/week @ 2024-07-11 796/week @ 2024-07-18 846/week @ 2024-07-25 1526/week @ 2024-08-01 1069/week @ 2024-08-08 753/week @ 2024-08-15 1062/week @ 2024-08-22 1276/week @ 2024-08-29 1533/week @ 2024-09-05 640/week @ 2024-09-12 861/week @ 2024-09-19 1566/week @ 2024-09-26 892/week @ 2024-10-03 606/week @ 2024-10-10 598/week @ 2024-10-17 561/week @ 2024-10-24

2,790 downloads per month
Used in 24 crates (2 directly)

MIT/Apache and maybe LGPL-3.0-only

5MB
78K SLoC

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[^1] 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.

[^1]: 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.

License: MIT OR Apache-2.0

Dependencies

~57MB
~1M SLoC