[tor-bugs] #17299 [DirAuth]: Standardize comment in dirauth-conf

[Tor Bug Tracker & Wiki]

#17299: Standardize comment in dirauth-conf
-------------------------+---------------------
 Reporter:  dgoulet      |          Owner:
     Type:  enhancement  |         Status:  new
 Priority:  normal       |      Milestone:
Component:  DirAuth      |        Version:
 Keywords:               |  Actual Points:
Parent ID:               |         Points:
  Sponsor:               |
-------------------------+---------------------
 After discussions in Berlin, I would like to propose a standard format for
 the comment of an entry(ies). Benefits are that we can validate the format
 of the file easily with a verifier script and also automatically cleanup
 on a regular basis the file of old entries with a simple script.

 Furthermore, it makes it much more readable and traceable for each rules.

 Format would look like this:

 {{{
 # Reported-by: Gargamel <gargamel at smurf.com>
 # Date: Tue, 5 May 1987 20:45:57
 # Time-Period: 3 months
 # MessageID: <ID of first email on bad-relays@>
 # Reason: <why was it blocked. add any relevant data about this>
 #         [...] (as many line as we need for this)
 # Fingerprints: FP1[,FP2,FP3,...]
 AuthDirBadExit 0.0.0.0
 }}}

 `Date`: the UTC timestamp of when the bad relay was detected.

 `Time-Period`: time period for which we keep blocking this entry. In this
 example, it would be OK to remove the entry on August 5th (3 months
 later).

 `Reason`: description on why it was blocked. Can be multiple lines.

 `Fingerprints`: [optional] fingerprint of the blocked relay (or list
 seperated by comma) if applicable. If we blacklist a whole network because
 we got 1000+ relays, we can omit it.

 The rest is self explainable.

 phw already uses a nice format in the latest commit, this just makes it
 more formal. I'll attach a small script to the ticket that we can at some
 point add to the repository that will print to the user the template with
 some defaults for which the user can only fill in the blanks.

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