diff options
Diffstat (limited to 'spec/control-spec/commands.md')
| -rw-r--r-- | spec/control-spec/commands.md | 82 |
1 files changed, 41 insertions, 41 deletions
diff --git a/spec/control-spec/commands.md b/spec/control-spec/commands.md index f59a548..d087473 100644 --- a/spec/control-spec/commands.md +++ b/spec/control-spec/commands.md @@ -52,7 +52,7 @@ its default value (if any), and then assign the String provided. Typically the String is left empty, to simply set an option back to its default. The syntax is: -"RESETCONF" 1*(SP keyword ["=" String]) CRLF +"RESETCONF" 1\*(SP keyword \["=" String\]) CRLF Otherwise it behaves like SETCONF above. @@ -63,7 +63,7 @@ Otherwise it behaves like SETCONF above. Request the value of zero or more configuration variable(s). The syntax is: -"GETCONF" *(SP keyword) CRLF +"GETCONF" \*(SP keyword) CRLF If all of the listed keywords exist in the Tor configuration, Tor replies with a series of reply lines of the form: @@ -101,9 +101,9 @@ HiddenServiceVersion, and HiddenserviceAuthorizeClient option settings. Request the server to inform the client about interesting events. The syntax is: -"SETEVENTS" [SP "EXTENDED"] *(SP EventCode) CRLF +"SETEVENTS" \[SP "EXTENDED"\] \*(SP EventCode) CRLF -EventCode = 1*(ALPHA / "_") (see section 4.1.x for event types) +EventCode = 1\*(ALPHA / "\_") (see section 4.1.x for event types) Any events _not_ listed in the SETEVENTS line are turned off; thus, sending SETEVENTS with an empty body turns off all event reporting. @@ -127,7 +127,7 @@ Each event is described in more detail in Section 4.1. Sent from the client to the server. The syntax is: -"AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF +"AUTHENTICATE" \[ SP 1\*HEXDIG / QuotedString \] CRLF This command is used to authenticate to the server. The provided string is one of the following: @@ -174,7 +174,7 @@ connection after an authentication failure.) Sent from the client to the server. The syntax is: -"SAVECONF" [SP "FORCE"] CRLF +"SAVECONF" \[SP "FORCE"\] CRLF Instructs the server to write out its config options into its torrc. Server returns "250 OK" if successful, or "551 Unable to write configuration @@ -252,7 +252,7 @@ signal that have them. Sent from the client to the server. The syntax is: -"MAPADDRESS" 1*(Address "=" Address SP) CRLF +"MAPADDRESS" 1\*(Address "=" Address SP) CRLF The first address in each pair is an "original" address; the second is a "replacement" address. The client sends this message to the server in @@ -339,7 +339,7 @@ Example: Sent from the client to the server. The syntax is as for GETCONF: -"GETINFO" 1*(SP keyword) CRLF +"GETINFO" 1\*(SP keyword) CRLF Unlike GETCONF, this message is used for data that are not stored in the Tor configuration file, and that may be longer than a single line. On success, @@ -1034,7 +1034,7 @@ historical interest. Sent from the client to the server. The syntax is: -"ATTACHSTREAM" SP StreamID SP CircuitID [SP "HOP=" HopNum] CRLF +"ATTACHSTREAM" SP StreamID SP CircuitID \[SP "HOP=" HopNum\] CRLF This message informs the server that the specified stream should be associated with the specified circuit. Each stream may be associated with @@ -1061,8 +1061,8 @@ that turns out to be a problem.} {Implementation note: By default, Tor automatically attaches streams to circuits itself, unless the configuration variable -"__LeaveStreamsUnattached" is set to "1". Attempting to attach streams -via TC when "__LeaveStreamsUnattached" is false may cause a race between +"\_\_LeaveStreamsUnattached" is set to "1". Attempting to attach streams +via TC when "\_\_LeaveStreamsUnattached" is false may cause a race between Tor and the controller, as both attempt to attach streams to circuits.} {Implementation note: You can try to attachstream to a stream that @@ -1105,7 +1105,7 @@ is added, Tor replies with "250 OK". Sent from the client to the server. The syntax is: -"REDIRECTSTREAM" SP StreamID SP Address [SP Port] CRLF +"REDIRECTSTREAM" SP StreamID SP Address \[SP Port\] CRLF Tells the server to change the exit address on the specified stream. If Port is specified, changes the destination port as well. No remapping @@ -1123,7 +1123,7 @@ Tor replies with "250 OK" on success. Sent from the client to the server. The syntax is: -"CLOSESTREAM" SP StreamID SP Reason *(SP Flag) CRLF +"CLOSESTREAM" SP StreamID SP Reason \*(SP Flag) CRLF Tells the server to close the specified stream. The reason should be one of the Tor RELAY_END reasons given in tor-spec.txt, as a decimal. Flags is @@ -1227,7 +1227,7 @@ request (or reverse lookup if "mode=reverse" is specified). Note that the request is done in the background: to see the answers, your controller will need to listen for ADDRMAP events; see 4.1.7 below. -[Added in Tor 0.2.0.3-alpha] +\[Added in Tor 0.2.0.3-alpha\] <a id="control-spec.txt-3.21"></a> @@ -1235,11 +1235,11 @@ need to listen for ADDRMAP events; see 4.1.7 below. The syntax is: -"PROTOCOLINFO" *(SP PIVERSION) CRLF +"PROTOCOLINFO" \*(SP PIVERSION) CRLF The server reply format is: -"250-PROTOCOLINFO" SP PIVERSION CRLF *InfoLine "250 OK" CRLF +"250-PROTOCOLINFO" SP PIVERSION CRLF \*InfoLine "250 OK" CRLF InfoLine = AuthLine / VersionLine / OtherLine @@ -1301,10 +1301,10 @@ a future version of Tor. The VERSION line contains the Tor version. -[Unlike other commands besides AUTHENTICATE, PROTOCOLINFO may be used (but -only once!) before AUTHENTICATE.] +\[Unlike other commands besides AUTHENTICATE, PROTOCOLINFO may be used (but +only once!) before AUTHENTICATE.\] -[PROTOCOLINFO was not supported before Tor 0.2.0.5-alpha.] +\[PROTOCOLINFO was not supported before Tor 0.2.0.5-alpha.\] <a id="control-spec.txt-3.22"></a> @@ -1318,7 +1318,7 @@ This command allows a controller to upload the text of a config file to Tor over the control port. This config file is then loaded as if it had been read from disk. -[LOADCONF was added in Tor 0.2.1.1-alpha.] +\[LOADCONF was added in Tor 0.2.1.1-alpha.\] <a id="control-spec.txt-3.23"></a> @@ -1340,7 +1340,7 @@ want to ensure a clean shutdown--and you should!--then send "SIGNAL SHUTDOWN" and wait for the Tor process to close.) This command is intended to be used with the -__OwningControllerProcess configuration option. A controller that +\_\_OwningControllerProcess configuration option. A controller that starts a Tor process which the user cannot easily control or stop should 'own' that Tor process: @@ -1422,10 +1422,10 @@ will accept is: CookieString | ClientNonce | ServerNonce) ``` -[Unlike other commands besides AUTHENTICATE, AUTHCHALLENGE may be -used (but only once!) before AUTHENTICATE.] +\[Unlike other commands besides AUTHENTICATE, AUTHCHALLENGE may be +used (but only once!) before AUTHENTICATE.\] -[AUTHCHALLENGE was added in Tor 0.2.3.13-alpha.] +\[AUTHCHALLENGE was added in Tor 0.2.3.13-alpha.\] <a id="control-spec.txt-3.25"></a> @@ -1440,7 +1440,7 @@ lightly; it can increase vulnerability to tracking attacks over time. Tor replies with "250 OK" on success. -[DROPGUARDS was added in Tor 0.2.5.2-alpha.] +\[DROPGUARDS was added in Tor 0.2.5.2-alpha.\] <a id="control-spec.txt-3.26"></a> @@ -1496,8 +1496,8 @@ Examples are: S: 250 OK ``` -[HSFETCH was added in Tor 0.2.7.1-alpha] -[HS v3 support added 0.4.1.1-alpha] +\[HSFETCH was added in Tor 0.2.7.1-alpha\] +\[HS v3 support added 0.4.1.1-alpha\] <a id="control-spec.txt-3.27"></a> @@ -1620,14 +1620,14 @@ RSAPrivateKey, with all newlines removed. For a "ED25519-V3" key is the Base64 encoding of the concatenation of the 32-byte ed25519 secret scalar in little-endian and the 32-byte ed25519 PRF secret.) -[Note: The ED25519-V3 format is not the same as, e.g., SUPERCOP +\[Note: The ED25519-V3 format is not the same as, e.g., SUPERCOP ed25519/ref, which stores the concatenation of the 32-byte ed25519 hash seed concatenated with the 32-byte public key, and which derives the secret scalar and PRF secret by expanding the hash seed with SHA-512. Our key blinding scheme is incompatible with storing private keys as seeds, so we store the secret scalar alongside the PRF secret, and just pay the cost of recomputing the public key when -importing an ED25519-V3 key.] +importing an ED25519-V3 key.\] Examples: @@ -1675,12 +1675,12 @@ Examples: S: 250 OK ``` -[ADD_ONION was added in Tor 0.2.7.1-alpha.] -[MaxStreams and MaxStreamsCloseCircuit were added in Tor 0.2.7.2-alpha] -[ClientAuth was added in Tor 0.2.9.1-alpha. It is v2 only.] -[NonAnonymous was added in Tor 0.2.9.3-alpha.] -[HS v3 support added 0.3.3.1-alpha] -[ClientV3Auth support added 0.4.6.1-alpha] +\[ADD_ONION was added in Tor 0.2.7.1-alpha.\] +\[MaxStreams and MaxStreamsCloseCircuit were added in Tor 0.2.7.2-alpha\] +\[ClientAuth was added in Tor 0.2.9.1-alpha. It is v2 only.\] +\[NonAnonymous was added in Tor 0.2.9.3-alpha.\] +\[HS v3 support added 0.3.3.1-alpha\] +\[ClientV3Auth support added 0.4.6.1-alpha\] <a id="control-spec.txt-3.28"></a> @@ -1711,8 +1711,8 @@ removed via "DEL_ONION". Tor replies with "250 OK" on success, or a 512 if there are an invalid number of arguments, or a 552 if it doesn't recognize the ServiceID. -[DEL_ONION was added in Tor 0.2.7.1-alpha.] -[HS v3 support added 0.3.3.1-alpha] +\[DEL_ONION was added in Tor 0.2.7.1-alpha.\] +\[HS v3 support added 0.3.3.1-alpha\] <a id="control-spec.txt-3.29"></a> @@ -1836,7 +1836,7 @@ On success "250 OK" is returned. Otherwise, the following error codes exist: The syntax is: -"ONION_CLIENT_AUTH_VIEW" [SP HSAddress] CRLF +"ONION_CLIENT_AUTH_VIEW" \[SP HSAddress\] CRLF Tells the connected Tor to list all the stored client-side v3 client auth credentials for "HSAddress". If no "HSAddress" is provided, list all the @@ -1869,7 +1869,7 @@ On success "250 OK" is returned. Otherwise, the following error codes exist: 512 - Syntax error in "HSAddress". -[ONION_CLIENT_AUTH_VIEW was added in Tor 0.4.3.1-alpha] +\[ONION_CLIENT_AUTH_VIEW was added in Tor 0.4.3.1-alpha\] <a id="control-spec.txt-3.33"></a> @@ -1890,7 +1890,7 @@ does nothing. The controller can call TAKEOWNERSHIP again to re-establish ownership. -[DROPOWNERSHIP was added in Tor 0.4.0.0-alpha] +\[DROPOWNERSHIP was added in Tor 0.4.0.0-alpha\] <a id="control-spec.txt-3.34"></a> @@ -1907,4 +1907,4 @@ lightly; it can increase vulnerability to tracking attacks over time. Tor replies with "250 OK" on success. Tor also emits the BUILDTIMEOUT_SET RESET event right after this "250 OK". -[DROPTIMEOUTS was added in Tor 0.4.5.0-alpha.] +\[DROPTIMEOUTS was added in Tor 0.4.5.0-alpha.\] |