Opened 2 years ago

Last modified 16 months ago

#26113 new defect

Control spec is ambiguous whether a GETCONF error message is specified

Reported by: dmr Owned by:
Priority: Medium Milestone: Tor: unspecified
Component: Core Tor/Tor Version:
Severity: Normal Keywords: tor-spec, easy, 035-removed-20180711, tor-control
Cc: arma, meejah, sysrqb, catalyst Actual Points:
Parent ID: Points:
Reviewer: Sponsor:


The control spec for `GETCONF` response says:

  If some of the listed keywords can't be found, Tor replies with a
  "552 unknown configuration keyword" message.

The spec also has a clause about error messages:

  Unless specified to have specific contents, the human-readable messages
  in error replies should not be relied upon to match those in this document.

Unfortunately, it's unclear what specified to have specific contents means here. The message for GETCONF is quoted, which at least in cursory read made me think it was specified.
But I suppose it's ambiguous.

Expected change

In discussion over IRC, arma suggested it...

might be even better to change the spec to be like "replies with a 552 message because of the unrecognized configuration key."

Overall, it was agreed upon amongst arma, meejah, sysrqb, and myself that the spec shouldn't be denoting a specific message here, and that controllers shouldn't rely on a specific message. Only the numeric code 552 should be relied upon.

Child Tickets

Change History (4)

comment:1 Changed 2 years ago by dmr

Related ticket(s)

See also stem ticket #26112 which brought up this discussion, over #tor-dev.
(At time of writing, Stem is relying on the message tor emits, although neither matches what the spec says.)

comment:2 Changed 2 years ago by nickm

Milestone: Tor: 0.3.5.x-final

comment:3 Changed 2 years ago by nickm

Keywords: 035-removed-20180711 added
Milestone: Tor: 0.3.5.x-finalTor: unspecified

These tickets are being triaged out of 0.3.5. The ones marked "035-roadmap-proposed" may return.

comment:4 Changed 16 months ago by catalyst

Cc: catalyst added
Keywords: tor-control added
Note: See TracTickets for help on using tickets.