[tor-bugs] #29136 [Core Tor/Tor]: PT_LOG and PT_STATUS event fields unspecifed

[Tor Bug Tracker & Wiki]

#29136: PT_LOG and PT_STATUS event fields unspecifed
------------------------------+------------------------------------
 Reporter:  atagar            |          Owner:  atagar
     Type:  defect            |         Status:  needs_revision
 Priority:  High              |      Milestone:  Tor: 0.4.0.x-final
Component:  Core Tor/Tor      |        Version:
 Severity:  Normal            |     Resolution:
 Keywords:  tor-spec, tor-pt  |  Actual Points:
Parent ID:                    |         Points:
 Reviewer:  ahf               |        Sponsor:  Sponsor19-can
------------------------------+------------------------------------
Changes (by ahf):

 * status:  needs_review => needs_revision


Comment:

 Thanks for working on this, atagar!

 Going to try to answer your three questions here:

 * Do PT_STATUS events exist or not? The prior spec confusingly said
 they're both a thing and unimplemented. We should either implement
 PT_STATUS or remove it from this specification (and tor's codebase, if
 present).

 They exist, but as a reserved keyword right now. We still don't use them
 yet, so the spec will need revision as we add items here.

 * Are other severities permissible? And are we sure we want the 'severity'
 to be lowercase? Other events use upercase enumerations. Changing this
 would probably require a change in tor.

 I think lowercase is fine here.

 * I've defined all PT_LOG and PT_STATUS attributes to be optional. Should
 any of them be mandatory? If so then please drop their square brackets.

 For `PT_LOG` all 3 of the keys are mandatory: SEVERITY, PT, and MESSAGE.
 The MESSAGE value could be empty, but most likely wont be.

 For `PT_STATUS` the `PT` and `TRANSPORT` is mandatory. Everything else is
 optional.

 Does this help for clarification?

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