[tor-commits] [torspec/master] Add clarifications to the authenticaiton mechanisms

[nickm at torproject.org]

commit 9e9d61ba48c5ec6a854eef730a6cca8323c7a5f9
Author: Tom Ritter <tom at ritter.vg>
Date:   Fri Oct 20 13:41:38 2017 -0500

    Add clarifications to the authenticaiton mechanisms
---
 control-spec.txt | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/control-spec.txt b/control-spec.txt
index 555e625..6b2c2eb 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -360,6 +360,12 @@
   Sent from the client to the server.  The syntax is:
      "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF
 
+  This command is used to authenticate to the server. The provided string is
+  either the original password represented as a QuotedString if HASHEDPASSWORD
+  is to be used, the contents of the cookie file formatted as hexidecimal if
+  COOKIE is to be used, or the resulting HMAC if AUTHCHALLENGE has been
+  previously sent (and therefore SAFECOOKIE is to be used).
+
   The server responds with "250 OK" on success or "515 Bad authentication" if
   the authentication cookie is incorrect.  Tor closes the connection on an
   authentication failure.
@@ -1377,6 +1383,9 @@
 
     ClientNonce = 2*HEXDIG / QuotedString
 
+  This command is used to begin the authentication routine for the
+  SAFECOOKIE method of authentication.
+
   If the server accepts the command, the server reply format is:
     "250 AUTHCHALLENGE"
             SP "SERVERHASH=" ServerHash