[tor-bugs] #25237 [Core Tor/Tor]: spec: Document our circuit close reasons

[Tor Bug Tracker & Wiki]

#25237: spec: Document our circuit close reasons
-------------------------------------------------+-------------------------
 Reporter:  dgoulet                              |          Owner:  rl1987
     Type:  defect                               |         Status:
                                                 |  needs_review
 Priority:  Medium                               |      Milestone:  Tor:
                                                 |  unspecified
Component:  Core Tor/Tor                         |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  tor-spec, 034-triage-20180328,       |  Actual Points:
  034-removed-20180328                           |
Parent ID:                                       |         Points:
 Reviewer:                                       |        Sponsor:
-------------------------------------------------+-------------------------
Changes (by rl1987):

 * status:  accepted => needs_review


Comment:

 The circuit closing reason codes are actually documented in tor-spec.txt:
 {{{
 1337    The error codes are:
 1338      0 -- NONE            (No reason given.)
 1339      1 -- PROTOCOL        (Tor protocol violation.)
 1340      2 -- INTERNAL        (Internal error.)
 1341      3 -- REQUESTED       (A client sent a TRUNCATE command.)
 1342      4 -- HIBERNATING     (Not currently operating; trying to save
 bandwidth.)
 1343      5 -- RESOURCELIMIT   (Out of memory, sockets, or circuit IDs.)
 1344      6 -- CONNECTFAILED   (Unable to reach relay.)
 1345      7 -- OR_IDENTITY     (Connected to relay, but its OR identity
 was not
 1346                            as expected.)
 1347      8 -- OR_CONN_CLOSED  (The OR connection that was carrying this
 circuit
 1348                            died.)
 1349      9 -- FINISHED        (The circuit has expired for being dirty or
 old.)
 1350     10 -- TIMEOUT         (Circuit construction took too long)
 1351     11 -- DESTROYED       (The circuit was destroyed w/o client
 TRUNCATE)
 1352     12 -- NOSUCHSERVICE   (Request for unknown hidden service)
 }}}

 I updated the comment to let the reader know where to look:
 * https://github.com/torproject/tor/pull/128

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/25237#comment:5>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online