[tor-commits] [torspec/master] Add HSFETCH controller response QUERY_RATE_LIMITED

[nickm at torproject.org]

commit bd80679c770772a34ce98f4a0d76afea088a61fc
Author: Neel Chauhan <neel at neelc.org>
Date:   Thu Apr 11 15:19:41 2019 -0400

    Add HSFETCH controller response QUERY_RATE_LIMITED
---
 control-spec.txt | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/control-spec.txt b/control-spec.txt
index 78a842f..44a5a76 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -3186,7 +3186,7 @@
     HsDir = LongName / Fingerprint / "UNKNOWN"
     DescriptorID = 32*Base32Character / 43*Base64Character
     Reason = "BAD_DESC" / "QUERY_REJECTED" / "UPLOAD_REJECTED" / "NOT_FOUND" /
-             "UNEXPECTED" / "QUERY_NO_HSDIR"
+             "UNEXPECTED" / "QUERY_NO_HSDIR" / "QUERY_RATE_LIMITED"
     Replica = 1*DIGIT
     HSDirIndex = 64*HEXDIG
 
@@ -3213,9 +3213,10 @@
        - "NOT_FOUND" - HS descriptor with given identifier was not found.
        - "UNEXPECTED" - nature of failure is unknown.
        - "QUERY_NO_HSDIR" - No suitable HSDir were found for the query.
+       - "QUERY_RATE_LIMITED" - query for this service is rate-limited
 
-    For "QUERY_NO_HSDIR", the HsDir will be set to "UNKNOWN" which was
-    introduced in tor 0.3.1.0-alpha.
+    For "QUERY_NO_HSDIR" or "QUERY_RATE_LIMITED", the HsDir will be set to
+    "UNKNOWN" which was introduced in tor 0.3.1.0-alpha.
 
     If Action is "CREATED", Tor SHOULD send Replica field as well. The Replica
     field contains the replica number of the generated descriptor. The Replica
@@ -3261,8 +3262,9 @@
   to "UNKNOWN". The HS_DESC event should be used to get more information on
   the failed request.
 
-  If the fetch fails for the QUERY_NO_HSDIR reason from the HS_DESC event, the
-  HsDir is set to "UNKNOWN". This was introduced in 0.3.1.0-alpha.
+  If the fetch fails for the QUERY_NO_HSDIR or QUERY_RATE_LIMITED reason from
+  the HS_DESC event, the HsDir is set to "UNKNOWN". This was introduced in
+  0.3.1.0-alpha.
 
   It's expected to receive a reply relatively fast as in it's the time it
   takes to fetch something over the Tor network. This can be between a