41 releases (breaking)

0.28.0 Mar 3, 2025
0.26.0 Jan 7, 2025
0.25.0 Dec 2, 2024
0.24.0 Oct 31, 2024
0.0.0 Jun 24, 2021

#1881 in Network programming

Download history 1667/week @ 2024-12-04 1872/week @ 2024-12-11 1295/week @ 2024-12-18 682/week @ 2024-12-25 822/week @ 2025-01-01 1059/week @ 2025-01-08 1222/week @ 2025-01-15 1147/week @ 2025-01-22 814/week @ 2025-01-29 2712/week @ 2025-02-05 1204/week @ 2025-02-12 825/week @ 2025-02-19 1235/week @ 2025-02-26 922/week @ 2025-03-05 1276/week @ 2025-03-12 735/week @ 2025-03-19

4,311 downloads per month
Used in 28 crates (2 directly)

MIT/Apache and maybe LGPL-3.0-only

5.5MB
83K 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

~58MB
~1M SLoC