mirrors/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2025-02-23 22:47:12 +01:00
Code Issues Projects Releases Wiki Activity

Address points by arma and points not by arma in new control-spec.txt

Browse source 
svn:r4451
This commit is contained in:
Nick Mathewson 2005-06-18 01:49:03 +00:00
parent bc3c578576
commit c1e91ff493
1 changed files with 18 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
doc/control-spec.txt
View file

@ -76,8 +76,7 @@ $Id$
; Identifiers for servers. ; Identifiers for servers.
ServerID = Nickname / Fingerprint ServerID = Nickname / Fingerprint
Nickname = 1*NicknameChar Nickname = 1*19 NicknameChar
[XXX perhaps this should be 1*19 NicknameChar ? -RD]
NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9" NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9"
Fingerprint = "$" 40*HEXDIG Fingerprint = "$" 40*HEXDIG
@ -202,7 +201,8 @@ about dns resolves, etc, so the controller can keep synced. -RD]
"SIGNAL" SP Signal CRLF "SIGNAL" SP Signal CRLF
Signal = "RELOAD" / "SHUTDOWN" / "DUMP" / "DEBUG" / "TERM" Signal = "RELOAD" / "SHUTDOWN" / "DUMP" / "DEBUG" / "HALT" /
"HUP" / "INT" / "USR1" / "USR2" / "TERM"
The meaning of the signals are: The meaning of the signals are:
@ -213,7 +213,7 @@ about dns resolves, etc, so the controller can keep synced. -RD]
DUMP -- Dump stats: log information about open connections and DUMP -- Dump stats: log information about open connections and
circuits. (like USR1) circuits. (like USR1)
DEBUG -- Debug: switch all open logs to loglevel debug. (like USR2) DEBUG -- Debug: switch all open logs to loglevel debug. (like USR2)
TERM -- Immediate shutdown: clean up and exit now. (like TERM) HALT -- Immediate shutdown: clean up and exit now. (like TERM)
The server responds with "250 OK" if the signal is recognized (or simply The server responds with "250 OK" if the signal is recognized (or simply
closes the socket if it was asked to close immediately), or "552 closes the socket if it was asked to close immediately), or "552
@ -344,11 +344,9 @@ about dns resolves, etc, so the controller can keep synced. -RD]
request for the server to extend an existing circuit with that ID according request for the server to extend an existing circuit with that ID according
to the specified path. to the specified path.
If the request is successful, the server sends a "250 OK" message containing If the request is successful, the server sends a "250 OK" message
a message body consisting of the four-octet Circuit ID of the (maybe containing a message body consisting of the Circuit ID of the (maybe newly
newly created) circuit. created) circuit.
[XXX four-octet? that sounds binary to me, yes? -RD]
3.10 ATTACHSTREAM 3.10 ATTACHSTREAM
@ -359,7 +357,7 @@ about dns resolves, etc, so the controller can keep synced. -RD]
associated with the specified circuit. Each stream may be associated with associated with the specified circuit. Each stream may be associated with
at most one circuit, and multiple streams may share the same circuit. at most one circuit, and multiple streams may share the same circuit.
Streams can only be attached to completed circuits (that is, circuits that Streams can only be attached to completed circuits (that is, circuits that
have sent a circuit status 'built' event or are listed as built in a have sent a circuit status 'BUILT' event or are listed as built in a
GETINFO circuit-status request). GETINFO circuit-status request).
If the circuit ID is 0, responsibility for attaching the given stream is If the circuit ID is 0, responsibility for attaching the given stream is
@ -385,12 +383,11 @@ about dns resolves, etc, so the controller can keep synced. -RD]
The descriptor, when parsed, must contain a number of well-specified The descriptor, when parsed, must contain a number of well-specified
fields, including fields for its nickname and identity. fields, including fields for its nickname and identity.
If there is an error in parsing the descriptor, the server must send an If there is an error in parsing the descriptor, the server must send a "554
appropriate error message. Invalid descriptor" reply. If the descriptor is well-formed but the server
[XXX let's specify the status code here too -RD] chooses not to add it, it must reply with a 251 message whose body explains
If the descriptor is well-formed but the server why the server was not added. If the descriptor is added, Tor replies with
chooses not to add it, it must reply with a 251 message whose body "250 OK".
explains why the server was not added.
3.12 REDIRECTSTREAM 3.12 REDIRECTSTREAM
@ -492,8 +489,13 @@ about dns resolves, etc, so the controller can keep synced. -RD]
[The client tried to set a configuration option to an [The client tried to set a configuration option to an
incorrect, ill-formed, or impossible value.] incorrect, ill-formed, or impossible value.]
554 Invalid descriptor
650 Asynchronous event notification 650 Asynchronous event notification
Unless specified to have specific contents, the human-readable messages
in error replies should not be relied upon to match those in this document.
4.1 Asynchronous events 4.1 Asynchronous events
These replies can be sent after a corresponding SETEVENTS command has been These replies can be sent after a corresponding SETEVENTS command has been