[tor-commits] [torspec/master] Writing down possible values of reason string for 13212.

[nickm at torproject.org]

commit 7908c8dc96897c26c445c5047f487e49e3447d9c
Author: rl1987 <rl1987 at sdf.lonestar.org>
Date:   Sun Nov 16 16:27:35 2014 +0200

    Writing down possible values of reason string for 13212.
---
 control-spec.txt |    8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/control-spec.txt b/control-spec.txt
index 70ddf3b..c17ce9b 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -2447,12 +2447,14 @@
   The syntax is:
 
     "650" SP "HS_DESC" SP Action SP HSAddress SP AuthType SP HsDir [SP DescriptorID]
+    [SP "REASON=" Reason]
 
     Action =  "REQUESTED" / "RECEIVED" / "IGNORE" / "FAILED"
     HSAddress = 16*Base32Character
     AuthType = "NO_AUTH" / "BASIC_AUTH" / "STEALTH_AUTH" / "UNKNOWN"
     HsDir = LongName / Fingerprint
     DescriptorID = 32*Base32Character
+    Reason = "BAD_DESC" / "QUERY_REJECTED" / "NOT_FOUND" / "UNEXPECTED"
 
     These events will be triggerred when required HiddenService descriptor is
     not found in the cache and a fetch from network is performed.
@@ -2463,6 +2465,12 @@
     For HsDir, LongName is always prefered. If HsDir cannot be found in node
     list at the time event is sent, Fingerprint will be used instead.
 
+    If Action is "FAILED", Tor SHOULD send Reason field as well. Possible 
+    values of Reason are:
+       - "BAD_DESC" - descriptor was retrieved, but found to be unparsable.
+       - "QUERY_REJECTED" - query was rejected by HS directory.
+       - "NOT_FOUND" - HS descriptor with given identifier was not found.
+       - "UNEXPECTED" - nature of failure is unknown.
 
 5. Implementation notes