Opened 3 years ago

Closed 3 years ago

#16081 closed defect (fixed)

Document status code consistency for multiple lines in a single reply

Reported by: solatis Owned by: atagar
Priority: Medium Milestone: Tor: 0.2.8.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: tor-spec, 028-triage
Cc: gk Actual Points:
Parent ID: Points: small
Reviewer: Sponsor: SponsorS

Description

(Opening ticket after discussion in #tor-dev)

The tor control service sends replies in multiple lines from Tor to the controller, each line starting with a status code. The documentation, however, says nothing about the consistency guarantees of these status codes over multiple lines.

If it is indeed correct that these status codes are not supposed to change within a single reply from Tor to controller, the documentation at https://gitweb.torproject.org/torspec.git/tree/control-spec.txt should be improved.

Child Tickets

Attachments (1)

0001-Bug-16081-Document-status-code-consistency-in-single.patch (879 bytes) - added by gk 3 years ago.

Download all attachments as: .zip

Change History (10)

comment:1 Changed 3 years ago by atagar

Component: DocTorTor

Hi solatis. I'm a tad puzzled why this is assigned to DocTor (status monitoring for the tor consensus). Sounds like a general spec request.

What in particular would you like to see improved? If the wording of some particular part is confusing then patches welcome.

comment:2 Changed 3 years ago by solatis

Ah sorry, I thought DocTor was about tor documentation. That's what you get for making assumptions.

What I have in mind is a small improvement to section 2.3 of this spec:

https://gitweb.torproject.org/torspec.git/tree/control-spec.txt#n158

A little note below the grammar saying "Multiple lines in a single Reply from Tor to the controller are guaranteed to share the same status code." would suffice. As long as this is actually the case, of course.

This would allow implementations to just look at the first line for the status code of the entire reply and be compliant (I have no idea what an implementation should do when it encounters multiple different status codes anyway).

comment:3 Changed 3 years ago by nickm

Milestone: Tor: 0.2.7.x-final

Sounds good; patch welcome. :)

comment:4 Changed 3 years ago by nickm

Milestone: Tor: 0.2.7.x-finalTor: 0.2.8.x-final

comment:5 Changed 3 years ago by nickm

Keywords: 028-triage added

comment:6 Changed 3 years ago by nickm

Points: small
Sponsor: SponsorS

comment:7 Changed 3 years ago by gk

Cc: gk added
Severity: Normal

comment:8 Changed 3 years ago by gk

Status: newneeds_review

Attached is a patch along the lines of comment:2. I decided to us "reply" instead of "Reply" as I am not a big fan of this kind of language mixing, especially as we are using "replies" in the sentence following immediately afterwards.

comment:9 Changed 3 years ago by nickm

Resolution: fixed
Status: needs_reviewclosed

Applied; thanks!

Note: See TracTickets for help on using tickets.