blob: 5f48c6e9ec4f269ca8146d374867d8fb9dae6fd8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
# tor-hscrypto
`tor-hscrypto`: Basic cryptography used by onion services
## Overview
This crate is part of
[Arti](https://gitlab.torproject.org/tpo/core/arti/), a project to
implement [Tor](https://www.torproject.org/) in Rust.
Onion services and the clients that connect to them need a few cryptographic
operations not used by the rest of Tor. These include:
* A set of key-blinding operations to derive short-term public keys
from long-term public keys.
* An ad-hoc SHA3-based message authentication code.
* Operations to encode and decode public keys as `.onion` addresses.
* A set of operations to divide time into different "periods". These periods
are used as inputs to the DHT-style hash ring, and to the key-blinding
operations.
* Proof of work schemes for resisting denial of service attacks
This crate implements those operations, along with a set of wrapper types to
keep us from getting confused about the numerous keys and nonces used for the
onion services.
## Compile-time features
* `memquota-memcost` -- implement `tor_memquota::HasMemoryCost` for many types.
(Does not actually force compiling in memory quota tracking;
that's `memquota` in `tor-memquota` and higher-level crates.)
* `ope` -- support for Order Preserving Encryption
* `full` -- Enable all features above.
### 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.
* `hs-pow-full` -- Tor Hidden Services Proof of Work.
* `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
When the `pow` feature is used, we link with LGPL licensed dependencies.
|
