[tor-commits] [torspec/master] control-spex: Clarify v2 vs v3 for ADD_ONION command

[nickm at torproject.org]

commit a0321ecc75c646d86b27ce88680d78cd8bebbac4
Author: David Goulet <dgoulet at torproject.org>
Date:   Wed Oct 9 10:45:20 2019 -0400

    control-spex: Clarify v2 vs v3 for ADD_ONION command
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 control-spec.txt | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/control-spec.txt b/control-spec.txt
index c77c335..7fde9e0 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -1604,18 +1604,18 @@
     KeyType =
      "NEW"     / ; The server should generate a key of algorithm KeyBlob
      "RSA1024" / ; The server should use the 1024 bit RSA key provided
-                   in as KeyBlob
+                   in as KeyBlob (v2).
      "ED25519-V3"; The server should use the ed25519 v3 key provided in as
-                   KeyBlob
+                   KeyBlob (v3).
 
     KeyBlob =
      "BEST"    / ; The server should generate a key using the "best"
                    supported algorithm (KeyType == "NEW").
                    [As of 0.4.2.3-alpha, ED25519-V3 is used]
      "RSA1024" / ; The server should generate a 1024 bit RSA key
-                   (KeyType == "NEW")
+                   (KeyType == "NEW") (v2).
      "ED25519-V3"; The server should generate an ed25519 private key
-                   (KeyType == "NEW")
+                   (KeyType == "NEW") (v3).
      String      ; A serialized private key (without whitespace)
 
     Flag =
@@ -1642,10 +1642,10 @@
              optional HiddenServicePort "TARGET" argument).
 
     ClientName = An identifier 1 to 16 characters long, using only
-                 characters in A-Za-z0-9+-_ (no spaces).
+                 characters in A-Za-z0-9+-_ (no spaces) (v2 only).
 
     ClientBlob = Authorization data for the client, in an opaque format
-                 specific to the authorization method.
+                 specific to the authorization method (v2 only).
 
   The server reply format is:
     "250-ServiceID=" ServiceID CRLF
@@ -1712,7 +1712,7 @@
 
   Examples:
      C: ADD_ONION NEW:BEST Flags=DiscardPK Port=80
-     S: 250-ServiceID=exampleonion1234
+     S: 250-ServiceID=exampleoniont2pqglbny66wpovyvao3ylc23eileodtevc4b75ikpad
      S: 250 OK
 
      C: ADD_ONION RSA1024:[Blob Redacted] Port=80,192.168.1.1:8080
@@ -1720,8 +1720,8 @@
      S: 250 OK
 
      C: ADD_ONION NEW:BEST Port=22 Port=80,8080
-     S: 250-ServiceID=testonion1234567
-     S: 250-PrivateKey=RSA1024:[Blob Redacted]
+     S: 250-ServiceID=sampleonion4t2pqglbny66wpovyvao3ylc23eileodtevc4b75ikpad
+     S: 250-PrivateKey=ED25519-V3:[Blob Redacted]
      S: 250 OK
 
      C: ADD_ONION NEW:RSA1024 Flags=DiscardPK,BasicAuth Port=22
@@ -1733,7 +1733,7 @@
   Examples with Tor in anonymous onion service mode:
 
      C: ADD_ONION NEW:BEST Flags=DiscardPK Port=22
-     S: 250-ServiceID=testonion1234567
+     S: 250-ServiceID=exampleoniont2pqglbny66wpovyvao3ylc23eileodtevc4b75ikpad
      S: 250 OK
 
      C: ADD_ONION NEW:BEST Flags=DiscardPK,NonAnonymous Port=22
@@ -1745,13 +1745,13 @@
      S: 512 Tor is in non-anonymous hidden service mode
 
      C: ADD_ONION NEW:BEST Flags=DiscardPK,NonAnonymous Port=22
-     S: 250-ServiceID=testonion1234567
+     S: 250-ServiceID=exampleoniont2pqglbny66wpovyvao3ylc23eileodtevc4b75ikpad
      S: 250 OK
 
   [ADD_ONION was added in Tor 0.2.7.1-alpha.]
-  [ClientAuth was added in Tor 0.2.9.1-alpha.]
-  [NonAnonymous was added in Tor 0.2.9.3-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]
 
 3.28. DEL_ONION