Uploaded image for project: 'OASIS Message Queuing Telemetry Transport (MQTT) TC'
  1. OASIS Message Queuing Telemetry Transport (MQTT) TC
  2. MQTT-486

RFC 2119 scan for MAYs

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 5, wd14
    • Fix Version/s: wd15
    • Component/s: core
    • Labels:
      None
    • Proposal:
      Hide

      a) 3.3.2.3.8, replace with "Multiple Subscription Identifiers will be included if the publication is the result of a match to more than one subscription, in this case their order is not significant."

      b) 3.4.2.1, 3.5.2.1, 3.6.2.1, 3.7.2.1, 3.14.2.1, 3.14.2.2.4,3.15.2.2.4 replace with "The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success) and there are no Properties. In this case the PUBxxx (DISCONNECT) has a Remaining Length of 2."

      c) 3.5.2.2.3, 3.6.2.2.3, 3.7.2.2.3, 3.9.2.1.3, 3.11.2.1.3 replace with "This property can be used to provide additional diagnostic information"

      d) 4.4 Replace with "However, the receiver needs to perform all checks for conditions which might result in a forwarding failure"

      e) 4.10.1 Replace 3 instances of "may" with "could"

      f) 4.13.2 Replace with "the receiver might have constraints which it has not communicated to the sender.

      Show
      a) 3.3.2.3.8, replace with "Multiple Subscription Identifiers will be included if the publication is the result of a match to more than one subscription, in this case their order is not significant." b) 3.4.2.1, 3.5.2.1, 3.6.2.1, 3.7.2.1, 3.14.2.1, 3.14.2.2.4,3.15.2.2.4 replace with "The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success) and there are no Properties. In this case the PUBxxx (DISCONNECT) has a Remaining Length of 2." c) 3.5.2.2.3, 3.6.2.2.3, 3.7.2.2.3, 3.9.2.1.3, 3.11.2.1.3 replace with "This property can be used to provide additional diagnostic information" d) 4.4 Replace with "However, the receiver needs to perform all checks for conditions which might result in a forwarding failure" e) 4.10.1 Replace 3 instances of "may" with "could" f) 4.13.2 Replace with "the receiver might have constraints which it has not communicated to the sender.
    • Resolution:
      Hide

      As proposed

      Show
      As proposed

      Description

      I have scanned WD14 for all cases of may or MAY. This is the list of occurrences that I found that I think are problematic. There are a number of lower case mays in Non-Normative text, and I am ignoring most of them here.

      1. Lower case mays which should be upper case MAYs
      None

      2. Lower case mays which aren't RFC 2119 MAYs. For the avoidance of doubt I recommend these get changed to an alternative, as shown in the proposal

      • 3.3.2.3.8
      • 3.4.2.1, 3.5.2.1, 3.6.2.1, 3.7.2.1, 3.14.2.1
      • 3.5.2.2.3, 3.6.2.2.3, 3.7.2.2.3, 3.9.2.1.3, 3.11.2.1.3, 3.14.2.2.4, 3.15.2.2.4 (User Property)
      • 4.4 footnote
      • 4.10.1
      • 4.13.2

      3. Upper case MAYs which should not be.

      • 3.14 "The Client or Server MAY send a DISCONNECT packet before closing the Network Connection". This is borderline, but it's not really an optional implementation thing, so I think this could be a "can"

      -----------------------

      In passing, one thing I found a bit surprising was "The Server MAY check that the contents of the CONNECT packet meet any further restrictions" in 3.1.4. This is ok regarding RFC 2119, but it means that, for example, a server that doesn't like the Will Topic can choose to ignore it and reply with a 0 return code, so the client is none the wiser

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              PeterNiblett Peter Niblett
            • Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: