aboutsummaryrefslogtreecommitdiff
path: root/spec/control-spec/implementation-notes.md
diff options
context:
space:
mode:
Diffstat (limited to 'spec/control-spec/implementation-notes.md')
-rw-r--r--spec/control-spec/implementation-notes.md27
1 files changed, 19 insertions, 8 deletions
diff --git a/spec/control-spec/implementation-notes.md b/spec/control-spec/implementation-notes.md
index 8340a94..b93f5d6 100644
--- a/spec/control-spec/implementation-notes.md
+++ b/spec/control-spec/implementation-notes.md
@@ -1,7 +1,9 @@
<a id="control-spec.txt-5"></a>
+
# Implementation notes
<a id="control-spec.txt-5.1"></a>
+
## Authentication
If the control port is open and no authentication operation is enabled, Tor
@@ -50,6 +52,7 @@ This is then encoded in hexadecimal, prefixed by the indicator sequence
```
You can generate the salt of a password by calling
+
```
'tor --hash-password <password>'
```
@@ -60,7 +63,8 @@ secret that was used to generate the password, either as a quoted string
or encoded in hexadecimal.
<a id="control-spec.txt-5.2"></a>
-## Don't let the buffer get too big.
+
+## Don't let the buffer get too big
With old versions of Tor (before 0.2.0.16-alpha), if you ask for
lots of events, and 16MB of them queue up on the buffer, the Tor
@@ -71,7 +75,8 @@ if you leave huge numbers of events unread, Tor may still run out
of memory, so you should still be careful about buffer size.
<a id="control-spec.txt-5.3"></a>
-## Backward compatibility with v0 control protocol.
+
+## Backward compatibility with v0 control protocol
The 'version 0' control protocol was replaced in Tor 0.1.1.x. Support
was removed in Tor 0.2.0.x. Every non-obsolete version of Tor now
@@ -84,6 +89,7 @@ Tor used to check whether the third octet of the first command is zero.
This compatibility was removed in Tor 0.1.2.16 and 0.2.0.4-alpha.
<a id="control-spec.txt-5.4"></a>
+
## Tor config options for use by controllers
Tor provides a few special configuration options for use by controllers.
@@ -181,7 +187,8 @@ __AllDirActionsPrivate
```
<a id="control-spec.txt-5.5"></a>
-## Phases from the Bootstrap status event.
+
+## Phases from the Bootstrap status event
```text
[For the bootstrap phases reported by Tor prior to 0.4.0.x, see
@@ -201,7 +208,8 @@ Future Tors MAY revisit earlier phases, for example, if the network
fails.
<a id="control-spec.txt-5.5.1"></a>
-### Overview of Bootstrap reporting.
+
+### Overview of Bootstrap reporting
Bootstrap phases can be viewed as belonging to one of three stages:
@@ -235,7 +243,8 @@ connections to relays or bridges that it did not connect to in Stage
1.
<a id="control-spec.txt-5.5.2"></a>
-### Phases in Bootstrap Stage 1.
+
+### Phases in Bootstrap Stage 1
Phase 0:
tag=starting summary="Starting"
@@ -311,7 +320,8 @@ established.
```
<a id="control-spec.txt-5.5.3"></a>
-### Phases in Bootstrap Stage 2.
+
+### Phases in Bootstrap Stage 2
```text
Phase 20:
@@ -397,7 +407,8 @@ indicate partial steps.
```
<a id="control-spec.txt-5.5.4"></a>
-### Phases in Bootstrap Stage 3.
+
+### Phases in Bootstrap Stage 3
```text
Phase 76:
@@ -509,6 +520,7 @@ application connections now.
```
<a id="control-spec.txt-5.6"></a>
+
## Bootstrap phases reported by older versions of Tor
These phases were reported by Tor older than 0.4.0.x. For newer
@@ -707,4 +719,3 @@ application requesting an internal circuit to hidden services at ".onion"
addresses.
If a future consensus contains Exits, exit circuits may become available.]
-