blob: 2307f6b3cc1df63ff4f0a375ba17e6c31f461fb8 (
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
|
# Style notes
Most code style questions are dealt with by rustfmt and clippy.
Here we document some other style issues commonly arising in Arti.
## Avoid abbreviating Onion Service (Hidden Service) to just "Onion"
In the Tor protocols and codebase the word "Onion" can mean (at least):
* The Onion Router - the whole protocol suite
* Relating to Hidden Services
* A router's medium-term circuit extension key KP\_onion\_*
* An "onion handshake", the hop-by-hop circuit handshake
* An "onion proxy", which is a Tor client presenting a SOCKS (or
similar) proxy to (mostly)-naive local clients
It is a fundamental principle of naming that a name should always
refer to the same thing. This principle can reasonably be violated in
informal and more marketing-y context, perhaps; or, when the name is
used for different aspects of the same thing, or isomorphic things,
and there is no risk of confusion.
But in most cases, using just "onion" to mean "hidden service" is
ambiguous and therefore wrong.
Examples of deprecated uses:
* "onion proxy" to mean a hidden service reverse proxy
* "onion tunnel" to mean a tunnel to a hidden service
* "onion" to mean HS identity (KP\_hs\_id, `.onion` domain),
for example "if this is the same onion"
In lower-level crates and APIs, prefer "hs" (short for hidden service).
In higher-level user-facing code, write out "onion service" in full.
When referring to specifically the `.onion` domain name for an HS,
prefer "onion address". `.onion` is also OK.
|
