Description: oasis

MQTT Version 3.1.1 Errata 01

OASIS Approved Errata

10 December 2015

Specification URIs

This version:

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os.doc (Authoritative)

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os.html

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os.pdf

Previous version:

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/csprd01/mqtt-v3.1.1-errata01-csprd01.doc (Authoritative)

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/csprd01/mqtt-v3.1.1-errata01-csprd01.html

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/csprd01/mqtt-v3.1.1-errata01-csprd01.pdf

Latest version:

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/mqtt-v3.1.1-errata01.doc (Authoritative)

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/mqtt-v3.1.1-errata01.html

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/mqtt-v3.1.1-errata01.pdf

Technical Committee:

OASIS Message Queuing Telemetry Transport (MQTT) TC

Chairs:

Raphael J Cohn (raphael.cohn@stormmq.com), Individual

Richard J Coppen (coppen@uk.ibm.com), IBM

Editors:

Andrew Banks (Andrew_Banks@uk.ibm.com), IBM

Rahul Gupta (rahul.gupta@us.ibm.com), IBM

Additional artifacts:

This prose specification is one component of a Work Product that also includes:

·         MQTT Version 3.1.1 Plus Errata 01. Edited by Andrew Banks and Rahul Gupta. 10 December 2015. OASIS Standard Incorporating Approved Errata 01. http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os-complete.html.

Related work:

This specification is related to:

·         MQTT and the NIST Cybersecurity Framework Version 1.0. Edited by Geoff Brown and Louis-Philippe Lamoureux. Latest version: http://docs.oasis-open.org/mqtt/mqtt-nist-cybersecurity/v1.0/mqtt-nist-cybersecurity-v1.0.html.

Abstract:

This document lists errata for MQTT Version 3.1.1.

Status:

This document was last revised or approved by the OASIS Message Queuing Telemetry Transport (MQTT) TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=mqtt#technical.

TC members should send comments on this specification to the TC’s email list. Others should send comments to the TC’s public comment list, after subscribing to it by following the instructions at the “Send A Comment” button on the TC’s web page at https://www.oasis-open.org/committees/mqtt/.

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s web page (https://www.oasis-open.org/committees/mqtt/ipr.php).

Citation format:

When referencing this specification the following citation format should be used:

[MQTT-v3.1.1-Errata01]

MQTT Version 3.1.1 Errata 01. Edited by Andrew Banks and Rahul Gupta. 10 December 2015. OASIS Approved Errata. http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os.html. Latest version: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/mqtt-v3.1.1-errata01.html.

 

Notices

Copyright © OASIS Open 2015. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.

Table of Contents

1        Introduction. 5

1.1 Terminology. 5

1.2 Normative References. 5

2        Approved Errata. 6

2.1 Remaining length range check. 6

3        Conformance. 7

Appendix A. Acknowledgments. 8

Appendix B. Revision History. 10

 

 


1      Introduction

This document lists the approved errata to the MQTT V3.1.1 OASIS Standard.

Each one is listed as a subsection of Approved Errata (Section 2), in order of their insertion.

As required by the OASIS Technical Committee Process, the approved errata represent changes that are not “substantive”.

 

Text to be removed from or added to the original specification is marked as follows:

 

Remove:

The text to be removed.

 

Add:

Text to be added.

 

 

1.1 Terminology

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC2119].

1.2 Normative References

[RFC2119]               Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels”, BCP 14, RFC 2119, March 1997. http://www.ietf.org/rfc/rfc2119.txt.

[MQTT311]              MQTT Version 3.1.1. Edited by Andrew Banks and Rahul Gupta. 29 October 2014. OASIS Standard. http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html.

2      Approved Errata

The following are approved errata to the OASIS MQTT Version 3.1.1 standard and its related works.

2.1 Remaining length range check.

The pseudocode in section 2.2.3 of the MQTT V3.1.1 specification [MQTT311], does not correctly detect a fixed header remaining length greater than 2,097,151 bytes. To correct the pseudocode move the range check so that it precedes the multiplier update.

Remove:

multiplier = 1

value = 0

do

     encodedByte = 'next byte from stream'

     value += (encodedByte AND 127) * multiplier

     multiplier *= 128

     if (multiplier > 128*128*128)

        throw Error(Malformed Remaining Length)

while ((encodedByte AND 128) != 0)

 

 

Add:

multiplier = 1

value = 0

do

     encodedByte = 'next byte from stream'

     value += (encodedByte AND 127) * multiplier

     if (multiplier > 128*128*128)

        throw Error(Malformed Remaining Length)

     multiplier *= 128

while ((encodedByte AND 128) != 0)

3      Conformance

No changes to conformance.

Appendix A. Acknowledgments

The following individuals have participated in the creation of these errata and are gratefully acknowledged:

Participants:

·         Sanjay Aiyagari (VMware, Inc.)

·         Ben Bakowski (IBM)

·         Andrew Banks (IBM)

·         Arthur Barr (IBM)

·         William Bathurst (Machine-to-Machine Intelligence (M2MI) Corporation)

·         Ken Borgendale (IBM)

·         Geoff Brown (Machine-to-Machine Intelligence (M2MI) Corporation)

·         James Butler (Cimetrics Inc.)

·         Marco Carrer (Eurotech S.p.A.)

·         Raphael Cohn (Individual)

·         Sarah Cooper (Machine-to-Machine Intelligence (M2MI) Corporation)

·         Richard Coppen (IBM)

·         AJ Dalola (Telit Communications S.p.A.)

·         Mark Darbyshire (TIBCO Software Inc.)

·         Scott deDeugd  (IBM)

·         Paul Duffy (Cisco Systems)

·         Phili DesAutels (LogMeIn Inc.)

·         John Fallows (Kaazing)

·         Pradeep Fernando (WSO2)

·         Paul Fremantle (WSO2)

·         Thomas Glover (Cognizant Technology Solutions)

·         Rahul Gupta (IBM)

·         Steve Huston (Individual)

·         Wes Johnson (Eurotech S.p.A.)

·         Christopher Kelley (Cisco Systems)

·         David Kemper (TIBCO Software Inc.)

·         James Kirkland (Red Hat)

·         Alex Kritikos (Software AG, Inc.)

·         Louis-P. Lamoureux (Machine-to-Machine Intelligence (M2MI) Corporation)

·         David Locke (IBM)

·         Shawn McAllister (Solace Systems)

·         Dale Moberg (Axway Software)

·         Manu Namboodiri (Machine-to-Machine Intelligence (M2MI) Corporation)

·         Peter Niblett (IBM)

·         Arlen Nipper (Individual)

·         Julien Niset (Machine-to-Machine Intelligence (M2MI) Corporation)

·         Mark Nixon (Emerson Process Management)

·         Nicholas O'Leary (IBM)

·         Sandor Palfy (LogMeIn Inc.)

·         Dominik Obermaier (dc-square GmbH)

·         Pavan Reddy (Cisco Systems)

·         Andrew Schofield (IBM)

·         Wadih Shaib (BlackBerry)

·         Ian Skerrett (Eclipse Foundation)

·         Joe Speed (IBM)

·         Allan Stockdill-Mander (IBM)

·         Gary Stuebing (Cisco Systems)

·         Steve Upton (IBM)

·         James Wert jr. (Telit Communications S.p.A.)

·         T. Wyatt (Individual)

·         SHAWN XIE (Machine-to-Machine Intelligence (M2MI) Corporation)

·         Dominik Zajac (dc-square GmbH)

·         Ed Briggs, Microsoft

Appendix B. Revision History

Revision

Date

Editor

Changes Made

01

26 August 2015

Andrew Banks, Rahul Gupta

Initial Version.

Add errata 1, remaining length range check.