[tor-bugs] #28067 [Core Tor/Tor]: Annotations should be documented in dir-spec.txt

[Tor Bug Tracker & Wiki]

#28067: Annotations should be documented in dir-spec.txt
--------------------------+----------------------------------
 Reporter:  rl1987        |          Owner:  (none)
     Type:  enhancement   |         Status:  new
 Priority:  Medium        |      Milestone:  Tor: unspecified
Component:  Core Tor/Tor  |        Version:
 Severity:  Normal        |     Resolution:
 Keywords:                |  Actual Points:
Parent ID:                |         Points:
 Reviewer:                |        Sponsor:
--------------------------+----------------------------------

Comment (by atagar):

 Sounds good to me!

 > They would never appear on the wire

 Yup, agreed. What I meant was that I'd like for us to loosen the
 specification a bit so these can be included in descriptors without making
 them invalid. For example, for the spec to say something like...

 {{{
 All descriptors MAY be proceeded by any number
 of the form...

   "@" Keyword SP 1*(VCHAR)

 For example...

   @type server-descriptor 1.0
   @downloaded-at 2012-03-14 16:31:05
   @source "145.53.65.130"

 These annotations MUST not have any behavioral
 impact for the descriptor. Annotations consist
 of ancillary cross-service data and MUST be
 ignoble.
 }}}

 With this the proper behavior of all parsers (tor, stem, metrics-lib, etc)
 would be to read, ignore, or strip these annotations as they see fit. The
 only thing that is disallowed is to reject annotations as making the
 descriptor invalid (ie, what all our implementations do right now since
 they *aren't* a valid part of the descriptor).

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