[tor-commits] [torspec/master] Add descriptions for the commands of the Extended ORPort.

[nickm at torproject.org]

commit 3fe179789a9c0e86fe69240cf183fd7a196f3a5f
Author: George Kadianakis <desnacked at riseup.net>
Date:   Wed Feb 6 00:42:23 2013 +0000

    Add descriptions for the commands of the Extended ORPort.
---
 proposals/196-transport-control-ports.txt |   26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/proposals/196-transport-control-ports.txt b/proposals/196-transport-control-ports.txt
index 0488934..db97ea7 100644
--- a/proposals/196-transport-control-ports.txt
+++ b/proposals/196-transport-control-ports.txt
@@ -55,6 +55,8 @@ Target: 0.2.4.x
 
 3.1. The new extended ORPort protocol
 
+3.1.1. Protocol
+
   The extended server port protocol is as follows:
 
      COMMAND [2 bytes, big-endian]
@@ -68,7 +70,7 @@ Target: 0.2.4.x
        (body ignored)
 
      [0x0001] USERADDR: an address:port string that represents the
-       user's address.
+       client's address.
 
      [0x0002] TRANSPORT: a string of the name of the pluggable
        transport currently in effect on the connection.
@@ -90,6 +92,28 @@ Target: 0.2.4.x
   If the server receives a recognized command that does not parse, it
   MUST close the connection to the client.
 
+3.1.2. Command descriptions
+
+3.1.2.1. USERADDR
+
+  An ASCII string holding the TCP/IP address of the client of the
+  pluggable transport proxy. A Tor bridge SHOULD use that address to
+  collect statistics about its clients.
+
+  The string MUST not be NUL-terminated.
+
+3.1.2.2. TRANSPORT
+
+  An ASCII string holding the name of the pluggable transport used by
+  the client of the pluggable transport proxy. A Tor bridge that
+  supports multiple transports SHOULD use that information to collect
+  statistics about the popularity of individual pluggable transports.
+
+  The string MUST not be NUL-terminated.
+
+  Pluggable transport names are C-identifiers and Tor MUST check them
+  for correctness.
+
 3.2. The new TransportControlPort protocol
 
   The TransportControlPort protocol is as follows: