vincenzopalazzo
/
arti
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
arti/crates/tor-dirmgr
History
Nick Mathewson 3acdf102c7 Increment patchlevel versions of crates with minor changes 
These crates are at version 0.x.y, so we don't need to distinguish
new-feature changes from other changes:

```
tor-basic-utils
fs-mistrust
tor-error
tor-geoip
tor-checkable
tor-linkspec
tor-netdoc
tor-netdir
tor-persist
tor-ptmgr
tor-hsservice
```

This crate has a breaking change, but only when the semver-breaking
feature `experimental-api` is enabled:

```
tor-config
```

This crate is at version 1.x.y, but has no new public APIs, and
therefore does not need a minor version bump:

```
arti
```
 		2023-08-01 10:57:55 -04:00
..
src Merge branch 'clippy-allow' into 'main' 2023-07-11 09:37:42 +00:00
testdata Copy tor-netdoc/testdata/routerdesc1.txt into tor-dirmgr 2022-11-03 11:37:05 +00:00
Cargo.toml Increment patchlevel versions of crates with minor changes 2023-08-01 10:57:55 -04: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 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 information before it is used.

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