ETSI TS 118 108 V1.1.0 (2016-03)

ETSI TS 118 108 V1.1.0 (2016-03)






TECHNICAL SPECIFICATION
oneM2M;
CoAP Protocol Binding
(oneM2M TS-0008 version 1.3.2 Release 1)

---------------------- Page: 1 ----------------------
oneM2M TS-0008 version 1.3.2 Release 1 2 ETSI TS 118 108 V1.1.0 (2016-03)



Reference
RTS/oneM2M-000008v110
Keywords
IoT, M2M, protocol

ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: +33 4 92 94 42 00  Fax: +33 4 93 65 47 16

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the
print of the Portable Document Format (PDF) version kept on a specific network drive within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2016.
All rights reserved.

TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members.
TM
3GPP and LTE™ are Trade Marks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
GSM® and the GSM logo are Trade Marks registered and owned by the GSM Association.
ETSI

---------------------- Page: 2 ----------------------
oneM2M TS-0008 version 1.3.2 Release 1 3 ETSI TS 118 108 V1.1.0 (2016-03)
Contents
Intellectual Property Rights . 5
Foreword . 5
1 Scope . 6
2 References . 6
2.1 Normative references . 6
2.2 Informative references . 6
3 Abbreviations . 6
4 Conventions . 7
5 Overview . 7
5.0 Introduction . 7
5.1 Required Features . 7
5.2 Introduction of CoAP . 7
5.2.0 Introduction. 7
5.2.1 Message Format . 7
5.2.2 Caching . 8
5.2.2.0 Introduction . 8
5.2.2.1 Freshness . 8
5.2.2.2 Validity . 8
5.2.3 Blockwise Transfers . 8
6 CoAP Message Mapping . 8
6.1 Introduction . 8
6.2 Primitive Mapping to CoAP Message . 9
6.2.0 Introduction. 9
6.2.1 Header . 9
6.2.2 Configuration of Token and Options . 9
6.2.2.0 Introduction . 9
6.2.2.1 Token . 9
6.2.2.2 Content Format Negotiation Options . 9
6.2.2.3 URI Options . 10
6.2.2.4 Definition of New Options . 10
6.2.2.4.0 Introduction . 10
6.2.2.4.1 From . 11
6.2.2.4.2 Request Identifier . 11
6.2.2.4.3 Void . 11
6.2.2.4.4 Originating Timestamp . 11
6.2.2.4.5 Request Expiration Timestamp . 11
6.2.2.4.6 Result Expiration Timestamp . 11
6.2.2.4.7 Operation Execution Time. 11
6.2.2.4.8 notificationURI of Response Type . 11
6.2.2.4.9 Event Category . 11
6.2.2.4.10 Response Status Code . 11
6.2.2.4.11 Group Request Identifier . 11
6.2.2.4.12 Resource Type . 11
6.2.3 Payload . 12
6.2.4 Response Codes Mapping . 12
6.3 Accessing Resources in CSEs . 13
6.3.0 Introduction. 13
6.3.1 Blocking case . 13
6.3.2 Non-Blocking Asynchronous case . 13
6.3.3 Non-Blocking Synchronous case . 13
6.4 Mapping rules of caching . 13
6.5 Usage of Blockwise Transfers . 14
7 Security Consideration . 14
ETSI

---------------------- Page: 3 ----------------------
oneM2M TS-0008 version 1.3.2 Release 1 4 ETSI TS 118 108 V1.1.0 (2016-03)
Annex A (informative): Example Procedures . 15
A.1 AE Registration . 15
History . 16

ETSI

---------------------- Page: 4 ----------------------
oneM2M TS-0008 version 1.3.2 Release 1 5 ETSI TS 118 108 V1.1.0 (2016-03)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (https://ipr.etsi.org/).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This Technical Specification (TS) has been produced by ETSI Partnership Project oneM2M (oneM2M).
ETSI

---------------------- Page: 5 ----------------------
oneM2M TS-0008 version 1.3.2 Release 1 6 ETSI TS 118 108 V1.1.0 (2016-03)
1 Scope
The present document will cover the protocol specific part of communication protocol used by oneM2M compliant
systems as 'RESTful CoAP binding'.
The scope of the present document is (not limited to as shown below):
• Binding oneM2M primitives to CoAP messages
• Binding oneM2M Response Status Codes to CoAP Response Codes
• Defining behaviour of a CoAP Client and Server depending on oneM2M parameters
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
The following referenced documents are necessary for the application of the present document.
[1] IETF RFC 7252: "The Constrained Application Protocol (CoAP)".
[2] ETSI TS 118 104: "oneM2M; Service Layer Core Protocol Specification (oneM2M TS-0004)".
[3] IETF draft-ietf-core-block-15: "Blockwise transfers in CoAP".
[4] ETSI TS 118 103: "oneM2M; Security solutions (oneM2M TS-0003)".
[5] IETF RFC 6347: "Datagram Transport Layer Security Version 1.2".
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
The following referenced documents are not necessary for the application of the present document but they assist the
user with regard to a particular subject area.
[i.1] oneM2M Drafting Rules.
NOTE: Available http://member.onem2m.org/Static_pages/Others/Rules_Pages/oneM2M-Drafting-Rules-
V1_0.doc.
3 Abbreviations
For the purposes of the present document, the following abbreviations apply:
AE Application Entity
CSE Common Service Entity
DTLS Datagram Transport Layer Security
HTTP Hyper Text Transfer Protocol
IP Internet Protocol
RST CoAP Reset message
TCP Transport Control Protocol
TLS Transport Layer Security
TLV Tag - Length - Value (data structure)
UDP User Datagram Protocol
ETSI

---------------------- Page: 6 ----------------------
oneM2M TS-0008 version 1.3.2 Release 1 7 ETSI TS 118 108 V1.1.0 (2016-03)
URI Uniform Resource Identifier
4 Conventions
The keywords "Shall", "Shall not", "May", "Need not", "Should", "Should not" in the present document are to be
interpreted as described in the oneM2M Drafting Rules [i.1].
5 Overview
5.0 Introduction
The clause describes which features need to be supported in CoAP layer and introduces a message format and several
features of CoAP used in this procotol binding specification.
5.1 Required Features
This clause explicitely specifies the required features of the CoAP layer for oneM2M to properly bind oneM2M
primitives into CoAP messages.
• The 4-byte binary CoAP message header is defined in Section 3 of [1].
• Confirmable (CON), Acknowledgement (ACK) and Reset (RST) messages shall be supported. The Reset
message is used to send a error message in response to a malformed Confirmable message in CoAP layer.
• GET, PUT, POST and DELETE methods shall be supported. oneM2M primitives map to these methods.
• A subset of Response Code specified in clause 6.2.4 shall be supported for oneM2M Response Status Code
parameter mapping.
• The Uri-Host, Uri-Port, Uri-Path, and Uri-Query shall be supported.
• The Content-Type Option shall be used to indicate the media types of the payload.
• The Token Option may be used.
• Block-wise transfers feature may be supported to carry large payloads.
• Caching feature may be supported.
5.2 Introduction of CoAP
5.2.0 Introduction
This clause describes a message format, and caching and block-wise transfers features which may be used to map
oneM2M primitives to CoAP messages.
5.2.1 Message Format
This clause specifies details about the CoAP [1] message format:
• CoAP message occupies the data section of one UDP datagram.
• CoAP message format supports a 4-byte fixed-size header.
• Fixed-size header is followed by a Token value of length 0 to 8 bytes.
• The Token value is followed by a sequence of zero or more CoAP Options in TLV format.
• CoAP Options are followed by the payload part.
For more details on the CoAP message format and the supported header fields, refer to [1].
ETSI

---------------------- Page: 7 ----------------------
oneM2M TS-0008 version 1.3.2 Release 1 8 ETSI TS 118 108 V1.1.0 (2016-03)
5.2.2 Caching
5.2.2.0 Introduction
CoAP [1] supports caching of responses to fulfill future equivalent requests to the same resource. Caching is supported
using freshness and validity information carried with CoAP [1] responses.
5.2.2.1 Freshness
• CoAP server shall use Max-Age CoAP Option to specify the explicit expiration time for the CoAP Response's
resource representation. This indicates that the response is not fresh after its age is greater than the specified
number of seconds.
• Max-Age Option defaults to a value of 60 (seconds). In case, Max-Age Option is not present in the cacheable
response, the response shall not be considered fresh after its age is greater than 60 seconds.
• The CoAP server shall set the Max-Age Option value to 0 (zero) to prevent or disable caching.
• The CoAP client, having a fres
...