vincenzopalazzo
/
arti
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
arti/crates/tor-dirmgr
History
Ian Jackson f84d8777db cargo fmt to remove blank lines 
Apparently cargo fmt doesn't like these, which my perl rune didn't
delete.

This commit is precisely the result of `cargo fmt`.
 		2022-10-12 15:29:04 +01:00
..
src cargo fmt to remove blank lines 2022-10-12 15:29:04 +01:00
testdata Oops: add missing data files 2021-10-28 19:51:16 -04:00
Cargo.toml Bump minor version of tor-rtcompat and most of its dependents 2022-10-03 10:01:46 -04:00
README.md Update README.md files. 2022-09-30 15:19:48 -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.

Experimental features

Compile-time features

Experimental and unstable features

Note that the APIs enabled by these features are NOT covered by semantic versioning1 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 informatoin before it is used.

  • bridge-client: Provide (as yet unimplented) APIs used to fetch and use bridge information.

  • experimental: Enable all the above experimental features.

License: MIT OR Apache-2.0

  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. ↩︎