hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
d0275cfa012b563611bd35833e616d99 | 118 110 | 3 Definition of terms, symbols and abbreviations | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 3.1 Terms | For the purposes of the present document, the terms given in ETSI TS 118 101 [2] and the following apply: originator: actor that initiates a Request NOTE: An Originator can either be an Application or a CSE. receiver: actor that receives the Request NOTE: A Receiver can be a CSE or an Application. resource: uniquely addressable entity in oneM2M System such as by the use of a Uniform Resource Identifier (URI) NOTE: A resource can be accessed and manipulated by using the specified procedures. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 3.2 Symbols | Void. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 3.3 Abbreviations | For the purposes of the present document, the abbreviations given in ETSI TS 118 101 [2] and the following apply: ADN Application Dedicated Node ADN-AE Application Entity which resides in the Application Dedicated Node AE Application Entity ASN Application Service Node CSE Common Service Entity IN Infrastructure Node IN-AE Application Entity that is registered with the CSE in the Infrastructure Node IN-CSE Common Service Entity which resides in the Infrastructure Node MN Middle Node MN-CSE Common Service Entity which resides in the Middle Node TLS Transport Level Security |
d0275cfa012b563611bd35833e616d99 | 118 110 | 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]. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5 Introduction | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.1 Use of MQTT | This binding makes use of MQTT to provide reliable two-way communications between two parties (AEs and CSEs). It uses the following features of MQTT: • Durable Sessions, providing Store and Forward in cases where network connectivity is not available. • MQTT's "QoS 1" message reliability level. This provides reliability without incurring the overhead implied by QoS 2. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 8 oneM2M TS-0010 version 4.0.1 Release 4 • NAT traversal (neither of the two parties is required to have prior knowledge of the other party's IP address). • Dynamic topic creation and wild-carded subscription filters. It does not use the following features: • One-to-many publish/subscribe. • Retained Messages. • Will Messages. • QoS 0 or QoS 2 message reliability levels. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2 Binding overview | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.1 Introduction | The MQTT protocol binding specifies how the Mca or Mcc request and response messages are transported across the MQTT protocol. Both communicating parties (AEs and CSEs) typically make use of an MQTT client library, and the communications are mediated via the MQTT server. There is no need for the client libraries or the server to be provided by the same supplier, since the protocol they use to talk to each other is defined by the MQTT specification [1]. Furthermore, the binding does not assume that the MQTT client libraries or server implementations are necessarily aware that they are being used to carry Mca, Mcc or any other oneM2M-defined primitives. The binding is defined in terms of the MQTT protocol flows that take place between the client libraries and the MQTT server in order to effect the transport of an Mca or Mcc message. There are two scenarios depending on the location of MQTT server: MQTT server co-located within a node, and MQTT server located independently from nodes. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 9 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.2 Scenarios | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.2.1 MQTT server co-located scenario | Mca ADN AE ADN AE ASN AE CSE AE CSE MN AE CSE MN AE CSE IN AE CSE M QTT Client PS1 Mca PS2 Mcc PS3 PS4 Mcc PS5 Mcc PS6 Mcc PS7 Mca M QTT Client M QTT Client Mcc Mcc’ M QTT Server M QTT Client M QTT Client M QTT Server M QTT Client M QTT Client M QTT Client M QTT Server M QTT Client ASN Figure 5.2.2.1-1: MQTT server co-located scenario Figure 5.2.2.1-1 shows a protocol segment view of the MQTT server co-located scenario. In this scenario, all oneM2M nodes (ADN, ASN, MN, IN) include one or more MQTT clients. MQTT servers are provided within MN and IN. In this scenario, the protocol segments are illustrated as follows. Table 5.2.2.1-1: Protocol segment for MQTT server co-located scenario Protocol Segment oneM2M Message Transported MQTT Interaction PS1 Mca (AE of ADN to CSE of IN) Client in ADN to Server in IN PS2 Mca (AE of ADN to CSE of MN) Client in ADN to Server in MN PS3 Mcc (CSE of ASN to CSE of MN) Client in ASN to Server in MN PS4 Mcc (CSE of ASN to CSE of IN) Client in ASN to Server in IN PS5 Mcc (CSE of MN to CSE of MN) Client in MN to Server in MN PS6 Mcc (CSE of MN to CSE of IN) Client in MN to Server in IN PS7 Mcc' (CSE of IN to CSE of IN) Client in IN to Server in IN ETSI ETSI TS 118 110 V4.0.1 (2023-08) 10 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.2.2 MQTT server independently-located scenario | Mca ADN AE ADN AE ASN AE CSE AE CSE MN AE CSE MN AE CSE IN AE CSE M QTT Client PS1 Mca PS2 Mcc PS3 PS4 Mcc PS5 Mcc PS6 Mcc PS7 Mca M QTT Client M QTT Client Mcc Mcc' M QTT Client M QTT Client MQTT Server M QTT Client M QTT Client M QTT Client M QTT Client ASN Mcc or Mca Figure 5.2.2.2-1: MQTT server independently-located scenario Figure 5.2.2.2-1 shows a protocol segment view in which the MQTT server is located independently from the oneM2M nodes. In this scenario, all oneM2M nodes (ADN, ASN, MN, IN) include one or more MQTT clients. MQTT servers exist independently, which means the servers are located outside of the nodes. In this scenario, the protocol segments are illustrated as follows. Table 5.2.2.2-1: Protocol segment for MQTT server independently located scenario Protocol Segment oneM2M Message Transported MQTT Interaction PS1 Mca (AE of ADN to CSE of IN) Client in ADN to Server PS2 Mca (AE of ADN to CSE of MN) Client in ADN to Server PS3 Mcc (CSE of ASN to CSE of MN) Client in ASN to Server PS4 Mcc (CSE of ASN to CSE of IN) Client in ASN to Server PS5 Mcc (CSE of MN to CSE of MN) Mcc (CSE of MN to CSE of ASN) Mca (CSE of MN to AE of ADN) Client in MN to Server PS6 Mcc (CSE of MN to CSE of MN) Mcc (CSE of MN to CSE of IN) Client in MN to Server PS7 Mcc (CSE of IN to CSE of MN) Mcc (CSE of IN to CSE of ASN) Mca (CSE of IN to AE of ADN) Client in IN to Server The next four clauses show the four configurations in which the MQTT binding can be used in the co-located scenario, followed by similar configurations in the independently-located scenario. NOTE: Other configurations are possible, but they are currently out of scope. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 11 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.3 Configurations | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.3.1 AE to IN | This configuration, illustrated in figure 5.2.3.1-1, allows an AE to connect to an IN via MQTT. Figure 5.2.3.1-1: Using MQTT between AE and IN-CSE The MQTT server is co-located with the IN-CSE and allows connection of the ADN-AEs (typically devices) and/or IN-AEs. It can store and forward messages if there is a gap in the connectivity with the devices. Note that the AEs each establish their own separate TCP/IP connection with the MQTT server. Thus the server shall have an accessible IP address, but AEs need not have. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.3.2 AE to MN | This configuration, illustrated in figure 5.2.3.2-1, allows an ADN-AE to connect to an IN via MQTT. Figure 5.2.3.2-1: Using MQTT between AE and MN-CSE This configuration is very similar to the AE-IN configuration shown in clause 5.2.3.1, except that the MQTT server is hosted on the MN rather than the IN. Onwards connection to the IN-CSE is via a different transport protocol. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 12 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.3.3 MN to IN | This configuration, illustrated in figure 5.2.3.3-1, allows an MN to connect to an IN via MQTT. Figure 5.2.3.3-1: Mcc using MQTT between MN and IN The MQTT server is co-located with the IN-CSE and allows connection of the MNs (typically in-field gateway boxes). It can store and forward messages if there is a gap in the connectivity with the gateways. Note that the MNs each establish their own separate TCP/IP connections with the MQTT server. Thus the server shall have an accessible IP address, but MNs need not have. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.3.4 AE to MN to IN | This configuration, illustrated in figure 5.2.3.4-1, is a combination of the previous two. Figure 5.2.3.4-1: Mca and Mcc both using MQTT In this configuration the two MQTT servers are independent from each other (that is to say they do not have a shared topic space). Any interactions between the ADN-AE and the IN-CSE are mediated by the MN-CSE. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 13 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.3.5 AE to IN (Independent scenario) | This configuration, illustrated in figure 5.2.3.5-1, allows an AE to connect to an IN via MQTT. Figure 5.2.3.5-1: Using MQTT between AE and IN-CSE The MQTT server is an independent entity, located outside of the nodes. In order to deliver Mca messages, MQTT clients within ADN-AE/IN-AE and IN-CSE connect to the MQTT server. After the clients establish TCP/IP connection with the MQTT server, Mca messages between ADN-AE/IN-AE and IN-CSE can be transported via the MQTT server. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.3.6 AE to MN (Independent scenario) | This configuration, illustrated in figure 5.2.3.6-1, allows an ADN-AE to connect to an IN via MQTT. Figure 5.2.3.6-1: Using MQTT between AE and MN-CSE In this configuration, the MQTT server is an independent entity, located outside of the nodes. MQTT clients within ADN-AE and MN-CSE are connected to the MQTT server, and the MQTT server stores and forwards the Mca messages between ADN-AE and MN-CSE. In addition, this figure shows that the onwards connection to the IN-CSE is via a different transport protocol. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.3.7 MN to IN (Independent scenario) | This configuration, illustrated in figure 5.2.3.7-1, allows an MN to connect to an IN via MQTT. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 14 oneM2M TS-0010 version 4.0.1 Release 4 Figure 5.2.3.7-1: Mcc using MQTT between MN and IN In this configuration, the MQTT server is an independent entity, located outside of nodes. Mcc message delivery between MN-CSE and IN-CSE are performed via the independently located MQTT server. As introduced in the previous clauses, in order to send messages, each MQTT client within MN-CSE and IN-CSE connects to the MQTT server and Mcc messages are transported via MQTT server. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 5.2.3.8 AE to MN to IN (Independent scenario) | This configuration, illustrated in figure 5.2.3.8-1, is a combination of the previous two. Figure 5.2.3.8-1: Mca and Mcc both using MQTT In this configuration, the MQTT clients of ADN-AE and MN-CSE and IN-CSE connect to the independently located MQTT server. Any interactions such as Mca or Mcc message delivery among the ADN-AE and the MN-CSE and the IN-CSE are mediated by the MQTT server. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 15 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6 Protocol Binding | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.1 Introduction | In this clause the use of MQTT is profiled and the key elements of the binding are defined: 1) How a CSE or AE connects to MQTT. 2) How an Originator (CSE or AE) formulates a Request as an MQTT message, and transmits it to its intended Receiver. 3) How a Receiver listens for incoming Requests, and how it formulates and transmits a Response. 4) How the Mca and Mcc CRUD operations map to MQTT messages. For more information on MQTT itself see Annex A or refer to the MQTT specification [1]. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.2 Use of MQTT | MQTT includes reliability features which allow recovery from loss of network connectivity without requiring explicit involvement of the applications that are using it, however to do this it requires an underlying network protocol that provides ordered, lossless, bi-directional connections. The MQTT standard [1] allows a choice of underlying protocol. The present document restricts this choice: it shall be one of the following: • TCP/IP. • TCP/IP with Transport Level Security (TLS) 1.2. • WebSocket - either with or without the use of TLS 1.2. See the MQTT standard [1] for considerations on how to use these protocols with MQTT. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.3 Connecting to MQTT | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.3.0 Introduction | In order to communicate, the two client parties (AE and CSE or CSE and CSE) shall connect to a common MQTT server. The MQTT server shall be hosted in one of the two nodes or shall exist as an independent external entity, following one of the two scenarios shown in clause 5.2. Once each party has located the address of the MQTT server, it then connects to it using the standard MQTT CONNECT Control Packet. An MQTT Control Packet consists of up to three parts: a fixed header, a variable header, and a payload as shown in Figure 6.3.0-1. Fixed header Variable header Payload 2 bytes variable variable Figure 6.3.0-1: Format of MQTT Control Packet |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.3.1 Variable header of MQTT CONNECT Packet | A variable header for the MQTT CONNECT Packet consists of four fields in the following order: Protocol Name, Protocol Level, Connect Flags and Keep Alive as shown in Figure 6.3.1-1. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 16 oneM2M TS-0010 version 4.0.1 Release 4 8 15 0 7 Protocol Name (MQTT) Connect Flags Protocl Level Keep Alive MSB LSB Length Figure 6.3.1-1: Variable header of MQTT CONNECT Packet The value of Protocol Name field is "MQTT". The value of the Protocol Level field for the MQTT version 3.1.1 of the protocol is 4. The Connect Flags is shown in Figure 6.3.1-2. The Keep Alive is a time interval measured in seconds. User Name Flag Password Flag Will Retain Will QoS Will Flag Clean Session Reserved bit 7 bit 6 bit 5 bit 3 ~ 4 bit 2 bit 1 bit 0 Figure 6.3.1-2: Connect Flags of variable header for MQTT CONNECT Packet |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.3.2 Payload of MQTT CONNECT Packet | A payload for the MQTT CONNECT Packet is determined by the Connect Flags in the variable header. These fields may consist of Client Identifier, Will Topic, Will Message, User Name, Password. Mandatory fields to establish an MQTT session for oneM2M are: • Client Identifier Optional fields to establish an MQTT session for oneM2M are: • User Name • Password An example of payload of an MQTT CONNECT Packet is shown in Figure 6.3.2-1. 8 15 0 7 Client Identifier User Name Password (0 ~ 65535 bytes) Figure 6.3.2-1: Example of an MQTT CONNECT Packet ETSI ETSI TS 118 110 V4.0.1 (2023-08) 17 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.3.3 Application of MQTT CONNECT Packet | The following additional considerations apply: • Client Identifier: The CONNECT Packet contains a Client Identifier as described in clause 6.3.2. The Client Identifiers have to be unique at least among all clients that connect to a given MQTT server instance (this is a requirement imposed by the MQTT protocol). This condition will be satisfied if an AE uses its AE-ID and a CSE uses its CSE-ID. See clause 7 of ETSI TS 118 101 [2] for a discussion of these Identifiers. The prefix A:: or C:: shall be added to the ID to show whether it is an AE-ID or a CSE-ID as these ID spaces are not distinct. The AE-ID or CSE-ID may not be known during the initial registration process, in which case the client shall use some other appropriate unique ID. • Connect Flags: - A client shall set the "Clean Session" flag in the MQTT CONNECT Packet to false. This means that MQTT Session state related to that client will be retained by the MQTT Server in the event of a disconnection (deliberate or otherwise) of that client. - A client shall not set the "Will Flag", "Will QoS", or "Will Retain" so Will Message and Will Topic shall not be present in the payload. • Keep Alive: A client may choose to provide a non-zero MQTT Keep Alive value or to provide a Keep Alive of 0 (this disables the MQTT Keep Alive). • User Name and Password: The MQTT server may require that a client provides a User Name and a password (or other credential). If the MQTT server authenticates by user name and password, the corresponding user name flag and password flag in the CONNECT shall be set to 1. For more information see clause 7. A client might choose to keep the MQTT connection open permanently (restarting it as soon as possible after any unforeseen connection loss), it might choose to connect only when it wants to act as an Originator, or it might choose to connect based on the <schedule> associated with a relevant oneM2M resource. Once a client has connected to the MQTT server it can then communicate (subject to authorization policies) with any other client connected to its server. There is no need for it to create another connection if it wants to communicate with a different counter-party. When a client determines that it no longer wishes to participate in an MQTT Session with its MQTT Server it shall perform the following steps: • Disconnect from that server, if it is currently connected. • Reconnect with the cleanSession flag set to true. • Disconnect again. These steps delete any state that the MQTT server might be holding on behalf of the client. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4 Sending and Receiving Messages | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4.1 Request and Response Messages | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4.1.0 Introduction | MQTT does not have a data model to describe or constrain the content of its Application Message payloads (to that extent it is similar to a TCP socket). Mca, Mcc and Mcc' request messages shall be serialized into XML or JSON or CBOR following the serialization process defined in clause 6.5. The packet type field in Figure 6.4.1.1-1 is used to define the MQTT Control Packet type. It is a 4-bit field which possible values are listed in Table 6.4.1.0-1. When a oneM2M Request/Response message is bound to MQTT, its packet type shall have value 3, i.e. the Request/Response message is delivered in an MQTT PUBLISH Packet. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 18 oneM2M TS-0010 version 4.0.1 Release 4 Table 6.4.1.0-1: MQTT Control Packet Types Reserved 0 Reserved for future use CONNECT 1 Client request to connect to server CONNACK 2 Connect acknowledgement PUBLISH 3 Publish message PUBACK 4 Publish message acknowledgement PUBREC 5 Publish received (QoS=2) PUBREL 6 Publish release (QoS=2) PUBCOMP 7 Publish complete (QoS=2) SUBSCRIBE 8 Client subscribe request SUBACK 9 Subscribe acknowledgement UNSUBSCRIBE 10 Client unsubscribe request UNSUBACK 11 Unsubscribe acknowledgement PINGREQ 12 Ping request PINGRESP 13 Ping response DISCONNECT 14 Client disconnection request Reserved 15 Reserved for future use |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4.1.1 Fixed header of MQTT PUBLISH Packet | The fixed header of the MQTT PUBLISH Packet consists of RETAIN, QoS Level, DUP flag, Packet Type, Remaining Length fields as shown in Figure 6.4.1.1-1. The QoS Level represents the QoS level of the MQTT PUBLISH Packet with possible values of 0, 1 or 2. However, since oneM2M messages are idempotent, the QoS Level should not be set to QoS 2. RETAIN QoS Level DUP flag Packet Type bit 7 bit 6 bit 5 bit 4 bit 2 bit 1 bit 0 bit 3 Remaining Length MSB LSB Figure 6.4.1.1-1: Fixed header of MQTT PUBLISH Packet NOTE: MQTT packets are subjected to a theoretical maximum message size of 256 MB, but it is good practice not to send packets that are bigger than a 100 kB. If a larger amount of data needs to be sent, it should be segmented into multiple PUBLISH packets. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4.1.2 Variable header of MQTT PUBLISH Packet | The variable header for the MQTT PUBLISH Packet consists of two fields in the following order: Topic Name, Packet Identifier. (MQTT) Packet Identifier 8 15 0 7 Topic Name (/oneM2M/req/Originator-ID/Receiver-ID) or (/oneM2M/resp/Originator-ID/Receiver-ID) Figure 6.4.1.2-1: Variable header for PUBLISH Packet The Topic Name identifies the information channel to which payload data is published. The Topic Name for a oneM2M Request Message is specified at clause 6.4.2. The Topic Filter used to listen for and respond to a Request is specified at clause 6.4.3. The Packet Identifier field is only present in PUBLISH Packets where the QoS level is 1 or 2. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 19 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4.1.3 Payload of MQTT Control PUBLISH Packet | The payload for the MQTT PUBLISH Packet is a oneM2M Request Message or Response Message as specified in clause 6.5. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4.2 Topic Name for Requests | A request is transmitted by sending it as an MQTT PUBLISH Packet to the MQTT Server. The MQTT Publish Packet uses a Topic Name that identifies both the Originator and the Receiver of the request as follows: • /oneM2M/req/<originator>/<receiver>/<type>: - "oneM2M" is a literal string identifying the topic as being used by oneM2M. - <originator> is the SP-relative-AE-ID or SP-relative-CSE-ID of the entity that sends the request on the Mca or Mcc reference point, omitting any leading "/"s and replacing any other "/" characters with ":" characters. - <originator> is the Absolute-CSE-ID of an IN-CSE on the Mcc' reference point, replacing the leading "//" with ":" and replacing any other "/" characters with ":" characters. - <receiver> is the SP-relative-AE-ID or SP-relative-CSE-ID of the Receiver (AE, Transit CSE or Hosting CSE) on the Mca or Mcc reference point, omitting any leading "/"s and replacing any other "/" characters with ":" characters. - <receiver> is the Absolute-CSE-ID of an IN-CSE on the Mcc' reference point, replacing the leading "//" with ":" and replacing any other "/" characters with ":" characters. - "req" is a literal string identifying this as a request. - <type> is "xml", "json" or "cbor" indicating the MQTT payload data type as described in clause 6.5.4. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4.3 Listening for and responding to a Request | A Receiver listens for requests arriving via MQTT by subscribing using a wildcarded Topic Filter of the following form: • /oneM2M/req/+/<receiver>/<type>: - "oneM2M" is a literal string identifying the topic as being used by oneM2M. - + is a wildcard which matches any entity. - <receiver> is the SP-relative-AE-ID or SP-relative-CSE-ID of the Receiver (AE, Transit CSE or Hosting CSE) on the Mca or Mcc reference point, omitting any leading "/"s and replacing any other "/" characters with ":" characters. - <receiver> is the Absolute-CSE-ID of an IN-CSE on the Mcc' reference point, replacing the leading "//" with ":" and replacing any other "/" characters with ":" characters. - "req" is a literal string identifying this as a request. - <type> is "xml", "json" or "cbor" indicating the MQTT payload data type as described in clause 6.5.4. A wildcard may be used to listen for any type. When it receives a request, the Receiver shall perform the Core Transport operations associated with the request, including any access control policy checks. In particular it shall check the request expiration timestamp (if any) contained in the request, since it is possible that that time might have passed while the message was being stored by MQTT. It transmits a response by sending an MQTT PUBLISH Packet to a response topic. This takes the form: • /oneM2M/resp/<originator>/<receiver>/<type>: - "oneM2M" is a literal string identifying the topic as being used by oneM2M. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 20 oneM2M TS-0010 version 4.0.1 Release 4 - <receiver> is the SP-relative-AE-ID or SP-relative-CSE-ID of the Receiver (AE, Transit CSE or Hosting CSE) on the Mca or Mcc reference point, omitting any leading "/"s and replacing any other "/" characters with ":" characters. - <receiver> is the Absolute-CSE-ID of an IN-CSE on the Mcc' reference point, replacing the leading "//" with ":" and replacing any other "/" characters with ":" characters. - <originator> is the SP-relative-AE-ID or SP-relative-CSE-ID of the entity that sent the corresponding request on the Mca or Mcc reference point, omitting any leading "/"s and replacing any other "/" characters with ":" characters. - <originator> is the Absolute-CSE-ID of an IN-CSE on the Mcc' reference point, replacing the leading "//" with ":" and replacing any other "/" characters with ":" characters. - "resp" is a literal string identifying this as a response. - <type> is "xml", "json" or "cbor" indicating the MQTT payload data type as described in clause 6.5.4. The Originator shall subscribe to this Topic (either explicitly or using a wildcarded filter) in order to see the response. The payload of the MQTT PUBLISH packet is used to carry the response primitive, as described in clause 6.5. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4.4 Initial Registration | In some security scenarios, an Originator might not initially know its AE-ID or CSE-ID. Initial registration exchanges can use the communication pattern described in clauses 6.4.1 and 6.4.2 except that they use Topics containing a credential ID rather than an AE-ID or CSE-ID, as follows: • /oneM2M/reg_req/<originator>/<receiver>/<type>: - "oneM2M" is a literal string identifying the topic as being used by oneM2M. - <originator> is the Credential-ID. Any "/" characters embedded in the ID shall be replaced with ":" characters. - <receiver> is the SP-relative-CSE-ID of the Receiver (Transit or Hosting CSE) specified in the corresponding request, omitting any leading "/". - "reg_req" is a literal string identifying it as a registration request. - <type> is "xml", "json" or "cbor" indicating the MQTT payload data type as described in clause 6.5.4. and • /oneM2M/reg_resp/<originator>/<receiver>/<type>: - "oneM2M" is a literal string identifying the topic as being used by oneM2M. - <originator> is the Credential-ID of the Originator in the corresponding request. Any "/" characters embedded in the ID shall be replaced with ":" characters. - <receiver> is the SP-relative-CSE-ID of the Receiver (Transit or Hosting CSE) in the corresponding request, omitting any leading "/". - "reg_resp" is a literal string identifying it as a registration response. - <type> is "xml", "json" or "cbor" indicating the MQTT payload data type as described in clause 6.5.4. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 21 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.4.5 Request/Response Message Flow (Mca or Mcc) | MQTT Domain Non-MQTT Domain AE MQTT Client MQTT Server MQTT Client CSE Initiate Initiate Non-MQTT Domain SUBACK SUBSCRIBE SUBSCRIBE SUBACK CONNACK CONNECT CONNECT CONNACK (/oneM2M/req/+/SP-relative-AE-ID, /oneM2M/resp/SP-relative-AE-ID/+) (/oneM2M/req/+/SP-relative-CSE-ID, /oneM2M/resp/SP-relative-CSE-ID/+) Figure 6.4.5-1: Initiating Process in MQTT binding In the MQTT protocol, each client shall subscribe to the MQTT server to receive messages. As shown in figure 6.4.5-1, the AE or CSE initiates the MQTT binding process by trying to connect to the MQTT server, as described in clause 6.3. After each MQTT client successfully connects to the server, it shall subscribe to the MQTT server. The Topic Filters with which each MQTT client subscribes are "/oneM2M/req/+/<receiver>/<type>" (to receive requests) and "/oneM2M/resp/<originator>/+/<type>" (to receive replies) where <receiver> and <originator> are both set equal to the ID (SP-relative-AE-ID or SP-relative-CSE-ID as appropriate). Accordingly the plus sign ('+' U+002B) wildcard and the SP-relative-AE-ID or SP-relative-CSE-ID are used in the Topic Filter within the MQTT SUBSCRIBE Packet. This enables the MQTT client to receive the PUBLISH Packets whose target it is. Therefore, through this process, the AE or CSE receives messages if the request/response messages are published to "/oneM2M/req/<originator>/<receiver>/<type>" or "/oneM2M/resp/<originator>/<receiver>/<type>". MQTT Domain Non-MQTT Domain Originator MQTT Client MQTT Server MQTT Client Receiver Request Non-MQTT Domain PUBLISH PUBLISH PUBACK PUBACK PUBLISH PUBACK PUBLISH Request Response Response PUBACK (/oneM2M/req/Originator-ID/Receiver-ID) (/oneM2M/req/Originator-ID/Receiver-ID) (/oneM2M/resp/Originator-ID/Receiver-ID) (/oneM2M/resp/Originator-ID/Receiver-ID) Figure 6.4.5-2: Request/Response message delivery over MQTT As an example, Figure 6.4.5-2 illustrates the Request/Response message delivery over MQTT protocol between Originator and Receiver via the Mca/Mcc reference point in oneM2M. The message flow is as follows. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 22 oneM2M TS-0010 version 4.0.1 Release 4 In this flow, the Originator wants to send a Request message to the Receiver. The Originator's MQTT client library sends an MQTT PUBLISH Packet to the MQTT server with "/oneM2M/req/ SP-relative-AE-ID/SP-relative-CSE- ID/<type>" as the Topic Name. The MQTT PUBLISH packet shall include {"op", "fr", "to", "rqi"} and any optional parameters in accordance with the operation (CREATE, RETRIEVE, UPDATE, DELETE, NOTIFY) as specified in clause 7.2.1.1 of ETSI TS 118 104 [3] in its payload. When the MQTT server receives the MQTT PUBLISH Packet from the MQTT client, the server refers to the Topic Name and delivers the message to the intended MQTT client. Finally, the MQTT client library delivers the message to the Receiver. After that, the Receiver builds a Topic Name for the Response message of the form "/oneM2M/resp/Originator- ID/Receiver-ID/<type>". The payload of the MQTT PUBLISH Packet shall include {"rsc", "rqi"} and any optional message parameters in accordance with operation (CREATE, RETRIEVE, UPDATE, DELETE, NOTIFY) as specified in clause 7.2.1.2 of ETSI TS 118 104 [3] in its payload. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.5 Primitive Mapping | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.5.1 Request primitives | A oneM2M request primitive is made up of a number of control parameters and (optionally) a content part. All the parameters in these parts are serialized into the payload of an MQTT Publish Packet, using the rules given in clause 8 of ETSI TS 118 104 [3] applied to m2m:requestPrimitive defined in clause 6.4.1 of ETSI TS 118 104 [3]. All the parameters that are present in the primitive shall be serialized, in particular the request shall contain the mandatory parameters such as Operation, To, From, Request Identifier as specified in clause 8.1.2 of ETSI TS 118 101 [2] and clause 7.1.1.1 of ETSI TS 118 104 [3]. Fixed Variable Request Identifier From To Operation Resource Type Payload mandatory parameters operation dependent parameters Content optional parameters ... Originating Timestamp Figure 6.5.1-1: MQTT Request example An example of an MQTT Request message serialized using JSON is: {"op": 1, "to": "//xxxxx/2345", "fr": "//xxxxx/99", "rqi": "A1234", "ty": 18, "pc": {"m2m:sch":{"rn":"schedule1", "se":{"sce":["* 0-5 2,6,10 * * * *"]}}}, "ot": 20150910T062032} • op: short name of Operation parameter specified as m2m:operation in ETSI TS 118 104 [3]. • to: short name of To parameter specified either xs:anyURI [3] or m2m:nhURI [3]. It is an URI of the target resource. • fr: short name of From parameter which is an ID of the Originator e.g. either the AE or CSE. • rqi: short name of Request Identifier specified as m2m:requestID [3]. • ty: short name of Resource Type parameter specified as m2m:resourceType [3]. • pc: short name of Content parameter specified in ETSI TS 118 104 [3]. • ot: short name of Originating Timestamp parameter specified as m2m:timestamp [3]. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 23 oneM2M TS-0010 version 4.0.1 Release 4 |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.5.2 Response primitives | A oneM2M response primitive is serialized using the rules given in clause 8 of ETSI TS 118 104 [3] applied to m2m:responsePrimitive defined in clause 6.4.2 of ETSI TS 118 104 [3]. In particular, each response primitive shall include the Response Status Code parameter to indicate success or failure of the operation and the Request Identifier parameter. Fixed Variable Content Request Identifier Response Status Code To From Payload mandatory parameters operation dependent parameters optional parameters ... Figure 6.5.2-1: MQTT Response example An example of an MQTT Response message serialized using JSON is: {"rsc": 2000, "rqi": "A1234", "pc": {"m2m:sch":{"se":{"sce":["* 0-5 2,6,10 * * * *"]}}}, "to": "//xxxxx/2345", "fr": "//xxxxx/99"} • rsc: short name of Response Status Code parameter specified as m2m:responseStatusCode in ETSI TS 118 104 [3]. • rqi: short name of Request Identifier specified as m2m:requestID in ETSI TS 118 104 [3]. • pc: short name of Content parameter specified in ETSI TS 118 104 [3]. • to: short name of To parameter specified either xs:anyURI [3] or m2m:nhURI [3]. It is an URI of the target resource. • fr: short name of From parameter which is an ID of the Originator e.g. either the AE or CSE. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.5.3 Serialization Format Negotiation | When sending a response primitive over MQTT, the Receiver should use the same serialization that was used in the corresponding request primitive. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.5.4 Content-type | An MQTT message payload contains a oneM2M request or response primitive which is serialized using the XML, the JSON or the CBOR encoding given in clause 8 of ETSI TS 118 104 [3]. When an MQTT client publishes a message, it shall use a Topic name to indicate the format of the payload included in a PUBLISH message. As defined in clause 8 of ETSI TS 118 104 [3], the payload of request or response message shall include oneM2M primitives serialized using XML, JSON or CBOR. The Topic name takes this form: • /oneM2M/req/<originator>/<receiver>/xml or /oneM2M/req/<originator>/<receiver>/json or /oneM2M/req/<originator>/<receiver>/cbor • /oneM2M/resp/<originator>/<receiver>/xml or /oneM2M/resp/<originator>/<receiver>/json or /oneM2M/resp/<originator>/<receiver>/cbor ETSI ETSI TS 118 110 V4.0.1 (2023-08) 24 oneM2M TS-0010 version 4.0.1 Release 4 In order to receive a PUBLISH message with the Topic name, each MQTT client shall subscribe to the Topic name as follows: • /oneM2M/req/+/<receiver>/# • /oneM2M/resp/<originator>/# In some figures in the present document, topic strings are shown that do not end with /json, /xml or /cbor. However the suffix /json, /xml, or /cbor shall always be used. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 6.6 URI format | oneM2M defines an MQTT URI format to be used in the pointOfAccess attributes in several entity resource types (e.g. <CSEBase>, <remoteCSE>, <AE>) and also in the Response Type parameter and in the notificationURI attributes of the <subscription> resource type. A pointOfAccess attribute contains a list of one or more strings, each of which indicates a way in which that entity can be addressed. An entity can indicate support for MQTT by including strings in either or both of the following forms: • mqtt://<authority> • mqtts://<authority> • mqtt://<authority>/<path> • mqtts://<authority>/<path> The <authority> component is defined in clause 3.2 of IETF RFC 3986 [8] and includes the host and optionally the port of the MQTT Server that is to be used to access the entity in question. The form with scheme mqtts: shall be used to show that the server requires the use of TLS when this particular point of access is being used. If the <authority> does not contain a port component, then the IANA-registered MQTT ports shall be assumed. These are 1883 in the case of mqtt: and 8883 in the case of mqtts:. The <path>, if present, contains one or more MQTT topic levels (separated by a / if there are multiple levels). If there is a path component in a pointOfAccess string, the path is prepended to the topic strings defined in the present document, so for example an AE with AE-ID of "CAE01" and a pointOfAccess containing a path abc/def would subscribe to the MQTT topic: • abc/def/oneM2M/oneM2M/req/+/CAE01/# rather than to: • /oneM2M/req/+/CAE01/# There shall always be a path if an MQTT URI is used in a notificationURI attribute. That path gives the entire MQTT topic string that the notification is to be published to (with no leading /). The structure of that topic string does not have to conform to any of the topic string patterns defined in the present document. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 7 Security | |
d0275cfa012b563611bd35833e616d99 | 118 110 | 7.1 Introduction | The MQTT servers authenticate the clients (both CSEs and AEs) that connect to them and authorize access to Topics used to communicate. The clients do not authenticate each other, instead they use the MQTT server to do this. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 25 oneM2M TS-0010 version 4.0.1 Release 4 Background. The MQTT binding makes use of one or more MQTT Servers to transport messages between AEs and CSEs (or between CSEs) as described in clause 5. The AE/CSEs both act as MQTT Clients of an MQTT Server that mediates delivery of messages between the two. As described in clause 6, the topic in the MQTT PUBLISH packet either indicates the Originator's identity and Receiver's identity, or includes the Originator's Credential and the Receiver's Identity (in the case that the Originator has not yet been assigned an identifier). Trust and the MQTT Server. When the oneM2M binding to MQTT is used, some security functions are performed by the MQTT Server, as described further in this clause. In particular: 1) The MQTT Server authenticates the AEs and CSEs as they connect as MQTT Clients. These MQTT Clients themselves never directly authenticate the CSE or AE that is using another MQTT Client - instead they trust the MQTT Server to authenticate the MQTT Clients, and trust the MQTT Server to route the messages between the Originator and Receiver indicated in the topic. 2) The MQTT Server enforces access control policies to ensure that unidentified or unauthorized clients are not able to publish messages to oneM2M topics or subscribe to receive messages from them. The remainder of clause 7 concerns Authentication and Authorization when the MQTT protocol binding is being used for the Mca or Mcc reference points. Details of Authentication and Authorization over the Mcc' reference point need to be agreed between the relevant service providers. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 7.2 Authorization | There are two levels of authorization in the oneM2M binding to MQTT: • The MQTT Server is responsible for verifying identifiers, for routing messages to the expected CSE or AE, and providing the correct Credential-ID during initial registration The MQTT Server is responsible for verifying that the Client Identifier field in a MQTT CONNECT packet matches the expected AE-ID, CSE-ID or Credential-ID. The MQTT Server is responsible for controlling those topics to which an MQTT Client may subscribe and receive published MQTT packets, and those topics to which an MQTT Client may publish MQTT packets. Since the topic includes the Receiver's CSE-ID, the Originator can trust that the MQTT packets are routed to and from the expected Receiver. If the topic includes the Originator's CSE-ID or AE-ID, then the Receiver can trust that the MQTT packets are routed to and from the expected Originator. If the topic includes the Originator's Credential-ID (which should only occur at initial registration), then the Receiver can use this Credential-ID to determine the CSE-ID or AE-ID or list of allowed AE-ID(s) which are to be used in assigning a CSE-ID or AE-ID to the Originator (as described in ETSI TS 118 103 [7]). This Credential-ID can be trusted to have been verified by the MQTT Server. • The Receiver is responsible for authorizing requests to specific resources, and assigning CSE-ID or AE-ID during initial registration. When the MQTT topic includes the Originator's CSE-ID or AE-ID, then the Receiver is responsible for making access control decisions on requests to perform operations on specific resources hosted on the Receiver. The access control decisions are dictated by the applicable accessControlPolicy resources and the Originator's CSE-ID or AE-ID (and other factors not relevant to the present discussion). This authorization process is as defined in the Architecture Specification [2], the Core Protocol Specification [3] and Security Solutions specification [7]. When the MQTT topic includes the Originator's Credential-ID (which should only occur at initial registration), then the Receiver is responsible for assigning a CSE-ID or AE-ID to the Originator (which may be dependent on the Originator's Credential-ID). |
d0275cfa012b563611bd35833e616d99 | 118 110 | 7.3 Authentication | An MQTT Client and MQTT Server shall apply Transport Layer Security (TLS) using any of the Security Association Establishment Frameworks in ETSI TS 118 103 [7]. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 26 oneM2M TS-0010 version 4.0.1 Release 4 The Security Association Establishment Frameworks provide mutual authentication of the MQTT Client and MQTT Server. The Security Association Establishment Frameworks are described using two main entities Entity A and Entity B: in the case of the oneM2M binding to MQTT, Entity A is a CSE or AE using an MQTT Client, and Entity B is an MQTT Server. NOTE: In ETSI TS 118 103 [7], Entity A is described as establishing the CSE-ID of Entity B as a result of Security Association Establishment. The application to MQTT differs because Entity A establishes the identity of the MQTT Server instead. However, the procedures are still applicable. The Remote Security Provision Frameworks in ETSI TS 118 103 [7] may be applied to provision a symmetric key shared by a CSE/AE using an MQTT Client and an MQTT Server, with the MQTT Server assuming the role of the Enrolment Target. Identification of Originator and Receiver. ETSI TS 118 103 [7] describes a variety of approaches by which successful Security Association Establishment results in Entity B determining the CSE-ID or AE-ID or list of allowed AE-ID(s) for the CSE/AE using the Entity A. These approaches can also be used in the oneM2M binding to MQTT. It is assumed that the MQTT Server is configured with the information necessary to determine the CSE-ID of the Receiver following successful Security Association Establishment with the Receiver's MQTT Client. In some scenarios, the MQTT Server can be configured with appropriate information to verify the CSE-ID or AE-ID of the Originator. However, in cases where the Originator has not yet been assigned its CSE-ID or AE-ID, and the MQTT Server has also not been provided with the CSE-ID or AE-ID of the Originator, then the Receiver is responsible for determining the applicable CSE-ID or AE-ID. In these cases, the MQTT Server forms a Credential-ID, identifying the Credential used to authenticate the Originator, and includes this in the topic when forwarding to the initial registration request to the Receiver's MQTT Client. The Receiver extracts the Credential-ID, and the procedures in ETSI TS 118 104 [3] and ETSI TS 118 103 [7] determine the CSE-ID or AE-ID of the Originator. Password Field Authentication. The present document does not specify use of the password field of the MQTT CONNECT control packet. Authentication is performed using the TLS mechanisms described in ETSI TS 118 103 [7]. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 7.4 Authorization by the MQTT Server | This procedure describes how an MQTT Server authorizes topics to which an MQTT Client may subscribe. The M2M Service Provider is responsible for configuring the MQTT Server with the relevant information used in these authorization decisions: 1) In the case that the MQTT Server determines that the MQTT Client represents a CSE, and if the CSE has been assigned a CSE's SP-Relative-CSE-ID (which is denoted by <my-SP-Relative-CSE-ID>), then: a) the MQTT Server authorizes the MQTT Client to subscribe to the topic /oneM2M/req/+/<my-SP- Relative-CSE-ID>/<type>; and b) for the set of <Registree ID Stem> values corresponding to SP-Relative CSE-ID or AE-ID Stem values of zero or more CSE(s) and/or AE(s) currently registered to this CSE (and known to the MQTT Server), the MQTT Server authorizes the MQTT Client to subscribe to the topics /oneM2M/resp/<Registree ID Stem>/<my-SP-Relative-CSE-ID>/<type>; and c) if this CSE is registered to a CSE and the SP-Relative-CSE-ID of this CSE is <Registrar-SP-Relative- CSE-ID > then the MQTT Server authorizes the MQTT Client to perform the following: i) to subscribe to: /oneM2M/resp/<my-SP-Relative-CSE-ID>/<Registrar-SP-Relative-CSE-ID>/<type>; and ii) to publish to: /oneM2M/resp/<my-SP-Relative-CSE-ID>/<Registrar-SP-Relative-CSE-ID>/<type>. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 27 oneM2M TS-0010 version 4.0.1 Release 4 2) In the case that the MQTT Server determines that the MQTT Client represents an AE which has been assigned an S-Type AE-ID Stem equal to < AE-ID-Stem>, then: a) If the MQTT Server determines that the AE is currently registered, and the AE's Registrar CSE has SP- Relative-CSE-ID equal to <Registrar-SP-Relative-CSE-ID> then the MQTT Server authorizes the MQTT Client to perform the following: i) to subscribe to /oneM2M/resp/<AE-ID-Stem>/<Registrar-SP-Relative-CSE-ID>/<type>; ii) to publish to /oneM2M/req/<AE-ID-Stem>/<Registrar-SP-Relative-CSE-ID>/<type>; iii) to subscribe to /oneM2M/req/<Registrar-SP-Relative-CSE-ID>/<AE-ID-Stem>/<type>; and iv) to publish to /oneM2M/resp/<Registrar-SP-Relative-CSE-ID>/<AE-ID-Stem>/<type>. b) Otherwise, the MQTT Server authorizes the MQTT Client to perform the following: i) to subscribe to /oneM2M/reg_resp/<AE-ID-Stem-Credential-ID>/+/<type>; and ii) to publish to /oneM2M/reg_req/<AE-ID-Stem-Credential-ID>/+/<type>. where <AE-ID-Stem-Credential-ID> is generated from <AE-ID-Stem> as per ETSI TS 118 103 [7]. 3) In the case that the MQTT Server determines that the MQTT Client represents a AE with C-Type AE-ID-Stem equal to <AE-ID-Stem> (which implies that the AE is registered), and the AE's Registrar CSE has SP- Relative-CSE-ID equal to <Registrar-SP-Relative-CSE-ID> then the MQTT Server authorizes the MQTT Client to perform the following: a) to subscribe to /oneM2M/resp/<AE-ID-Stem>/<Registrar-SP-Relative-CSE-ID>/<type>; b) to publish to /oneM2M/req/<AE-ID-Stem>/<Registrar-SP-Relative-CSE-ID>/<type>; c) to subscribe to /oneM2M/req/<Registrar-SP-Relative-CSE-ID>/<AE-ID-Stem>/<type>; and d) to publish to /oneM2M/resp/<Registrar-SP-Relative-CSE-ID>/<AE-ID-Stem>/<type>. 4) In all other cases, the MQTT Server authorizes the MQTT Client to perform the following: a) to subscribe to /oneM2M/reg_resp/<Credential-ID>/+/<type>; and b) to publish to /oneM2M/reg_req/<Credential-ID>/+/<type>. where <Credential-ID> is obtained from the Security Association Establishment procedure as described in ETSI TS 118 103 [7]. |
d0275cfa012b563611bd35833e616d99 | 118 110 | 7.5 General Considerations | Implementors should take note of the Security considerations listed in chapter 5 of the MQTT Specification [1]. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 28 oneM2M TS-0010 version 4.0.1 Release 4 Annex A (informative): Overview of MQTT A.0 Introduction This annex provides some background information on MQTT that might be useful to a reader of the normative clauses of the present document. See reference [1] for the definitive source of information about the protocol itself. A.1 MQTT features MQTT is a light weight publish/subscribe messaging transport protocol, particularly well-suited to event-oriented interactions. It was specifically designed for constrained environments such as those found in Machine to Machine (M2M) and Internet of Things (IoT) contexts where a small code footprint is required and/or network bandwidth is at a premium. MQTT includes reliability features which allow recovery from loss of network connectivity without requiring explicit involvement of the applications that are using it, however it does require an underlying network protocol that provides ordered, lossless, bi-directional connections. The features of MQTT include: • The use of the publish/subscribe message pattern which provides one-to-many message distribution and decoupling of applications. This is described further in clause A.3.1. • Bidirectional communications. An entity can subscribe to receive messages without having a reliable IP address. This could be used to allow unsolicited requests to be sent to a Receiver, or an asynchronous response to be sent to an Originator, where the Originator or Receiver does not have an externally accessible IP address. It thus eliminates the need for long polling and can reduce the need for triggering. • A messaging transport that is agnostic to the content of the payload. The message payload can be text or binary. • A Session concept that can survive loss of network connectivity and can persist across multiple consecutive network connections. Messages can be stored and subsequently forwarded when connectivity is restored. • Three levels of reliability (referred to as "qualities of service") for message delivery within a Session: - "At most once", where messages are delivered according to the best efforts of the operating environment. Message loss can occur. This level could be used, for example, with ambient sensor data where it does not matter if an individual reading is lost as the next one will be published soon after. - "At least once", where messages are assured to arrive but duplicates might occur. This is best suited to messages which have idempotent semantics. - "Exactly once", where message are assured to arrive exactly once. This level could be used, for example, with billing systems where duplicate or lost messages could lead to incorrect charges being applied. • A small transport overhead and protocol exchanges designed to minimize network traffic, with consequent additional savings on battery power when compared to HTTP. • A Retained Message option, allowing new subscribers to get the last message to have been published on a topic prior to their subscription. • A mechanism to notify interested parties when an abnormal disconnection occurs. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 29 oneM2M TS-0010 version 4.0.1 Release 4 A.2 MQTT implementations Like HTTP, the MQTT protocol is asymmetric in that it distinguishes between two different roles: client and server. In MQTT terms, a Client is a program or device that uses MQTT. It always establishes the Network Connection to the Server. A Client can: • Publish application messages that other Clients might be interested in. • Subscribe to request application messages that it is interested in receiving. • Unsubscribe to remove a request for application messages. • Disconnect from the Server. An MQTT Server is an entity that accepts connections from Clients. Unlike HTTP it generally does not run any application logic, instead an MQTT Server acts as an intermediary between Clients publishing application messages and the Clients which have subscribed to receive them. The MQTT specification [1] recommends the use of IANA registered ports 1883 (MQTT over raw TCP/IP) and 8883 (MQTT running over TLS). Although the MQTT protocol is relatively simple to implement, applications normally make use of pre-built implementations: • The applications themselves link to libraries that provide the MQTT client functionality. Libraries are available for a variety of programming languages and operating environments. • The MQTT server functionality can be provided by a standalone software process (possibly running on a server that is remote from the clients), a hardware appliance or a cloud-hosted MQTT service. The Eclipse foundation through their M2M working group, provides open source MQTT client code via its Paho Project, and an open source server implementation via its Mosquitto project. Other open source and commercial implementations are also available. A.3 MQTT Details A.3.1 Addressing a message - Topics and Subscriptions The MQTT protocol is based on the principle of publishing messages and subscribing to topics, or "pub/sub". Multiple clients connect to an MQTT server and subscribe to topics that they are interested in by sending an MQTT request protocol packet to the server. Clients also connect to the server and publish messages to the server, each message being associated with a topic. Many clients can subscribe to the same topics. The combination of the MQTT protocol and its server provides a simple, common interface for clients to connect to. A publisher can publish a message once and it be received by multiple subscribers. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 30 oneM2M TS-0010 version 4.0.1 Release 4 Figure A.3.1-1: MQTT publish-subscribe messaging A Message in MQTT is associated with a topic when it is published. Topics are structured into topic trees, which are treated as hierarchies, using a forward slash (/) as a separator. This allows arrangement of common themes to be created. Topics and topic trees can be created administratively, although its more common for a server to create a topic on-demand (subject to security policies) when a client first attempts to publish or subscribe to it. A client registers its interest in topics by providing one or more topics filters. A topic filter can be a simple topic name, or it can contain special "wildcard" characters, which allow clients to subscribe to multiple topics at once, within a single level or within multiple levels in a topic tree. A.3.2 Reliability MQTT defines three levels of Quality of Service (QoS). The QoS defines how hard the server & client will try to ensure that a message is received. Messages can be sent at any QoS level, and this affects the way the message is transmitted from the client to the server. When a client requests a subscription, it requests the maximum QoS at which it wants to receive messages on that subscription. This controls the way that messages matching that subscription are transmitted from the server to that client. The QoS used to transmit a message from the server is always less than or equal to the QoS used to transmit it to the server. For example, if a message is published at QoS 2 and a client is subscribed with QoS 0, the message will be delivered to that client with QoS 0. If a second client is also subscribed to the same topic, but with QoS 2, then it will receive the same message but with QoS 2. For a second example, if a client is subscribed with QoS 2 and a message is published on QoS 0, the client will receive it on QoS 0. QoS 0 messages are the least reliable. They are sent from client to server (or server to client) with no acknowledgement flowing in the opposite direction. A server is free to discard such messages. QoS 1 is intended for idempotent messages. These messages are transmitted with a short packet ID. When a client (or server) receives such a message it sends an acknowledgement packet back to the message sender. The sender is required to save a copy of that message until it receives the acknowledgement, and if there is a loss of network connectivity before it receives that acknowledgement it is required to resend the message when connectivity is restored. QoS 2 provides exactly once delivery. It uses a two-step acknowledgement protocol, in which both steps can be repeated an arbitrary number of times (if there is a loss of connectivity) without causing duplication of the original application message. Both client and server are required to save a copy of the message during this process. In summary, the higher levels of QoS are more reliable, but involve higher latency and have higher bandwidth requirements. In order to be able to continue with the QoS1 or QoS2 delivery protocols after a network reconnection, the server needs to have a way of distinguishing the individual clients that connect to it. It does this by means of an identifier called a Client Id. A client provides this Id when it first connects and the server records it and uses it as a key to any server-side state (such as the status of incomplete message delivery) associated with that client. When the client reconnects it presents the same Id, and that allows message delivery to complete. The client Id in effect represents the Id of the MQTT Session that is maintained between the client and the server. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 31 oneM2M TS-0010 version 4.0.1 Release 4 A.3.3 Retained Messages When a client publishes a message it can request that the message be retained. This means that the server will keep the message even after sending it to all current subscribers. If a new subscription is made that matches the topic of the retained message, then the message will be sent to the client. At most one such message is retained for any single topic. This is useful as a "last known good" mechanism. If a topic is only updated infrequently (such as for "report by exception"), then without a retained message, a newly subscribed client might have to wait a long time to receive an update. With a retained message, the client will receive an instant update. ETSI ETSI TS 118 110 V4.0.1 (2023-08) 32 oneM2M TS-0010 version 4.0.1 Release 4 History Document history V4.0.1 August 2023 Publication |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 1 Scope | The present document specifies the protocol translation and mappings between the oneM2M service layer and the management technologies specified by OMA such as OMA DM 1.3, OMA DM 2.0 and OMA LightweightM2M. Note that OMA DM 1.3 and OMA DM 2.0 are collectively referenced as OMA DM in the present document. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 2 References | |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 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. Referenced documents which are not found to be publicly available in the expected location might be found in the ETSI docbox. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long-term validity. The following referenced documents are necessary for the application of the present document. [1] ETSI TS 118 101: "oneM2M; Functional Architecture (oneM2M TS-0001)". [2] ETSI TS 118 104: "oneM2M; Service Layer Core Protocol (oneM2M TS-0004)". [3] Open Mobile Alliance™: "OMA Device Management Protocol", Version 1.3. [4] Open Mobile Alliance™: "OMA Device Management Protocol", Version 2.0. [5] Open Mobile Alliance™: "LightweightM2M Architecture", Version 1.0. [6] Open Mobile Alliance™: "Diagnostics and Monitoring Management Object Framework". [7] Open Mobile Alliance™: "Firmware Update Management Object". [8] Open Mobile Alliance™: "Software Component Management Object (SCOMO)". [9] ETSI TS 103 092: "Machine-to-Machine communications (M2M); OMA DM compatible Management Objects for ETSI M2M". [10] Open Mobile Alliance™: "Device Capability Management Object". [11] Open Mobile Alliance™: "Management Interface for M2M Requirements". [12] ISO 8601-1: "Date and time - Representations for information interchange — Part 1: Basic Rules". [13] W3C® Recommendation 28 October 2004: "XML Schema Part 2: Datatypes Second Edition". [14] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace", P. Leach, et al. July 2005. [15] ETSI TS 123 003: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); LTE; 5G; Numbering, addressing and identification (3GPP TS 23.003)". [16] BBF TR-069: "CPE WAN Management Protocol" Issue 1 Amendment 5, November 2013. [17] IETF RFC 7252: "The Constrained Application Protocol (CoAP)". [18] Open Mobile Alliance™: "Lightweight M2M - Software Management Object", Version 1.0. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 8 oneM2M TS-0005 version 4.0.1 Release 4 [19] Open Mobile Alliance™: "LightweightM2M - Device Capability Management Object". [20] ETSI TS 118 122: "oneM2M; Field Device Configuration (oneM2M TS-0022)". [21] ETSI TS 118 132: "oneM2M; MAF and MEF Interface (oneM2M TS-0032)". |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 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. NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee their long-term validity. The following referenced documents may be useful in implementing an ETSI deliverable or add to the reader's understanding, but are not required for conformance to the present document. [i.1] oneM2M Drafting Rules. [i.2] ETSI TS 118 111: "oneM2M; Common Terminology (oneM2M TS-0011)". |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 3 Definition of terms, symbols and abbreviations | |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 3.1 Terms | For the purposes of the present document, the terms given in ETSI TS 118 111 [i.2] apply. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 3.2 Symbols | Void. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 3.3 Abbreviations | Void. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 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]. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5 OMA DM 1.3 and OMA DM 2.0 | |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.1 Mapping of basic data types | oneM2M has defined the data types that describe the format of the value stored with the attribute. Those oneM2M data types are listed in table 5.1-1, and mapped to the data types specified by OMA DM Protocol [3] and [4]. Note that OMA DM 1.3 [3] and OMA DM 2.0 [4] use the same data types. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 9 oneM2M TS-0005 version 4.0.1 Release 4 Table 5.1-1: Basic data types oneM2M Data Types Mapping to data types in OMA DM Description TBD null OMA DM Nodes with null data type shall not store any value. xs:base64Binary b64 Data type for Base64-encoded binary data. xs:base64Binary bin Data type for binary data. xs:boolean bool Data type for Boolean. xs:string chr Data type for text. The length limitation should be considered for the mapping. xs:integer int Data type for 32-bit signed integer. xs:date date Data type for date in ISO 8601-1 [12] format with the century being included in the year. xs:time time Data type specifying that the Node value is a time in ISO 8601-1 [12] format. xs:float float Data type for a single precision 32-bit floating point type as defined in XML Schema 1.0 [13] as the float primitive type. xs:nonNegativeInteger int Data type for numbers equal or larger than 0, mapped from 64-bit to 32- bit representation. xs:positiveInteger int Data type for numbers equal or larger than 1, mapped from 64-bit to 32- bit representation. xs:long int Data type for signed integer numbers, mapped from 64-bit to 32-bit representation. The mgmtLink attribute in the <mgmtObj> Resource node The OMA DM 'node' data type describes the format of the Interior Node that can have child Nodes. The mgmtLink attribute in the <mgmtObj> Resource supports the hierarchy of <mgmtObj> Resource. Note that this is not data type mapping. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.2 Mapping of Identifiers | OMA DM 1.3 and OMA DM 2.0 specify many identifiers including device identifier, server identifier, client version identifier, manufacturer identifier, etc. To enable the device management using OMA DM Protocol, oneM2M identifiers needs to be mapped to identifiers specified by OMA DM Protocol. Table 5.2-1 shows the oneM2M identifiers that need to be mapped to OMA DM Protocol. Table 5.2-1: Map of Identifiers oneM2M Mapping to OMA DM Identifiers Description M2M-Node-ID. Device Identifier (i.e. DevId node in DevInfo MO) In OMA DM, the device identifier is a unique identifier for the device. This value is globally unique and has to be formatted as a URN. OMA DM Gateways and OMA DM enabled devices are assigned with the device identifiers, and each can be mapped to the M2M-Node-ID. See note. The objectID attribute in <mgmtObj> resource. Management Object Identifier (MOID) A unique identifier of the management object. Each MO is characterized by a unique MOID, which is generally a URN. The objectPath attribute in <mgmtObj> resource URI for the local path in the device where the relevant Management Object is located Management Objects in the device are uniquely addressed by a URI that is stored in the objectPath attribute. Note that DM 1.3 and DM 2.0 uses different Addressing scheme, but they are transparent to the oneM2M service layer. NOTE: In case the notion of the device identifier is not supported by the device, the DM Gateway can assign the local identifier for the device, and the M2M-Node-ID should be mapped to this local identifier. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 10 oneM2M TS-0005 version 4.0.1 Release 4 |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3 Mapping of resources | |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.0 Introduction | Clause 5.3 describes how to map <mgmtObj> resources specified in annex D of ETSI TS 118 101 [1] to the relevant management objects as defined by OMA DM ([3] and [4]). Since OMA DM 1.3 and OMA DM 2.0 use the same management objects except standard management objects, the resource mappings can be considered regardless of the specific version of the OMA DM Protocol. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.1 General Mapping Assumptions | OMA DM Protocol implements the management functionalities by using the Management Objects. Management Object is a collection of Nodes which are related for providing certain management functionalities. EXAMPLE: SCOMO is for the software management, and FUMO is for the firmware update, and so on. The individual management operations such as firmware update, software management can be achieved by manipulating the corresponding Management Object. Since oneM2M <mgmtObj> Resources are for providing specific management functionalities, oneM2M <mgmtObj> Resources shall be mapped to Management Objects specified by OMA DM [3] and [4]. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.2 Resource [firmware] | The resource [firmware] is for firmware management in the service layer. Regardless of OMA DM 1.3 and OMA DM 2.0, the resource shall be mapped to FUMO (urn:oma:mo:omafumo:1.0). The attributes of the resource shall be mapped to nodes of the MO as follows. Table 5.3.2-1: Resource [firmware] Attribute Name of [firmware] Mapping to Nodes in Management Object version <x>/PkgVersion name <x>/PkgName URL <x>/DownloadAndUpdate/PkgURL update <x>/DownloadAndUpdate updateStatus <x>/State NOTE: Here <x> is an interior node that acts as a placeholder for the FUMO. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.3 Resource [software] | The resource [software] is for software management in the service layer. Regardless of OMA DM 1.3 and OMA DM 2.0, the resource shall be mapped to SCOMO (urn:oma:mo:oma-scomo:1.0). The attributes of the resource shall be mapped to nodes of the MO as the follows. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 11 oneM2M TS-0005 version 4.0.1 Release 4 Table 5.3.3-1: Resource [software] Attribute Name of [software] Mapping to Nodes in Management Object version <x>/Inventory/Deployed/<x>/Version name <x>/Download/<x>/Name (when the software package is not ready for install) <x>/Inventory/Delivered/<x>/Name (when the software package is ready for install) <x>/Deployed/<x>/Name (when the software package is already installed) URL <x>/Download/<x>/PkgURL install <x>/Download/<x>/Operations/DownloadInstall (when the software package is not yet available) <x>/Inventory/Delivered/<x>/Operations/Install (when the software package has already been downloaded) uninstall /<x>/Inventory/Delivered/<x>/Operations/Remove installStatus <x>/Download/<x>/Status (started install when the software package is not yet available) <x>/Inventory/Delivered/<x>/Status (started install when the software package has already been downloaded) activate <x>/Inventory/Deployed/<x>/Operations/Activate deactivate <x>/Inventory/Deployed/<x>/Operations/Deactivate activeStatus <x>/Inventory/Deployed/<x>/Status NOTE: Here <x> is the interior node that groups together the parameters of a Software Component Management Object. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.4 Resource [memory] | The resource [memory] is for acquire information about the total memory or available memory of the device. Regardless of OMA DM 1.3 and OMA DM 2.0, the resource shall be mapped to memory information of DiagMO (urn:oma:mo:oma-diag:memory:1.0). The attributes of the resource shall be mapped to nodes of the MO as follows. Table 5.3.4-1: Resource [memory] Attribute Name of [memory] Mapping to Nodes in Management Object memAvailable <x>/DiagMonData/RAMAvail memTotal <x>/DiagMonData/RAMTotal NOTE: Here <x> is the interior node that acts as a placeholder for the Memory MO. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.5 Resource [areaNwkInfo] | The resource [areaNwkInfo] is for managing the area network. Regardless of OMA DM 1.3 and OMA DM 2.0, the resource shall be mapped to MANMO (urn:oma:mo:ext-etsi-manmo:1.0). The attributes of the resource shall be mapped to nodes of the MO as follows. Table 5.3.5-1: Resource [areaNwkInfo] Attribute Name of [areaNwkInfo] Mapping to Nodes in Management Object areaNwkType M2MAreaNwkInfo/AreaNwks/<x>/AreaNwkType listOfDevices M2MAreaNwkInfo/AreaNwks/<x>/ListOfDevices NOTE: Here <x> is the interior parent node for information about a specific M2M Area Networks connecting to the same M2M Gateway. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.6 Resource [areaNwkDeviceInfo] | The resource [areaNwkDeviceInfo] is for managing the device of the area network as well as acquiring information about devices in the area network. Regardless of OMA DM 1.3 and OMA DM 2.0, the resource shall be mapped to MANDMO (urn:oma:mo:ext-etsi-mandmo:1.0). The attributes of the resource shall be mapped to nodes of the MO as follows. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 12 oneM2M TS-0005 version 4.0.1 Release 4 Table 5.3.6-1: Resource [areaNwkDeviceInfo] Attribute Name of [areaNwkDeviceInfo] Mapping to Nodes in Management Object devId DevInfo/DevId devType DevDetail/DevType areaNwkId <x>/AreaNwks/<x>/AreaNwkID sleepInterval <x>/AreaNwks/<x>/SleepInterval sleepDuration <x>/AreaNwks/<x>/SleepDuration status <x>/AreaNwks/<x>/Status listOfNeighbors <x>/AreaNwks/<x>/Groups/ListOfDeviceNeighbors NOTE: Here first instance of <x> is the interior node that is the root node for the MANDMO. Second instance of <x> is the interior node that contains information related to a specific M2M Area Network that the device is associated with. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.7 Resource [battery] | The Resource [battery] is to provide battery related information. Regardless of OMA DM 1.3 and OMA DM 2.0, this Resource shall be mapped to Battery Info Management Object (MOID: "urn:oma:mo:oma-diag:batteryinfo:1.0"). The attributes of this Resource shall be mapped to Nodes in the Management Object as follows. Table 5.3.7-1: Resource [battery] Attribute Name of [battery] Mapping to Nodes in Management Object batteryLevel <x>/DiagMonData/<x>/BatteryLevel batteryStatus <x>/DiagMonData/<x>/BatteryStatus NOTE: Here first instance of <x> is the interior node that acts as a placeholder for the Battery MO. Second instance of <x> is the placeholder for zero or more instances of battery data. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.8 Resource [deviceInfo] | The Resource [deviceInfo] is to provide device related information. For OMA DM 1.3, this Resource shall be mapped to DevInfo MO (MOID: "urn:oma:mo:oma-dm-devinfo:1.1") and DevDetail MO (MOID: "urn:oma:mo:oma-dm- devdetail:1.1"). The attributes of this Resource shall be mapped to Nodes in two Management Objects as follows. Table 5.3.8-1: Resource [deviceInfo] mapping in OMA DM 1.3 Attribute Name of [deviceInfo] Mapping to Nodes in Management Object deviceLabel DevInfo/DevId manufacturer DevInfo/Man model DevInfo/Mod deviceType DevDetail/DevType fwVersion DevDetail/FwV swVersion DevDetail/SwV hwVersion DevDetail/HwV For OMA DM 2.0, this Resource shall be mapped to DevInfo MO (MOID: "urn:oma:mo:oma-dm-devinfo:1.2"). The attributes of this Resource shall be mapped to Nodes in the Management Object as follows. Table 5.3.8-2: Resource [deviceInfo] mapping in OMA DM 2.0 Attribute Name of [deviceInfo] Mapping to Nodes in Management Object deviceLabel <x>/DevID manufacturer <x>/Man model <x>/Mod deviceType <x>/DevType fwVersion <x>/FwV swVersion <x>/SwV hwVersion <x>/HwV NOTE: Here <x> is the interior node that is the root node for the DevInfo MO. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 13 oneM2M TS-0005 version 4.0.1 Release 4 |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.9 Resource [deviceCapability] | The Resource [deviceCapability] is to manage the device capabilities such USB, camera, etc. Regardless of OMA DM 1.3 and OMA DM 2.0, this Resource shall be mapped to Device Capability Management Object (MOID: "urn:oma:mo:oma-dcmo:1.0"). The attributes of this Resource shall be mapped to Nodes in the Management Object as follows. Table 5.3.9-1: Resource [deviceCapability] Attribute Name of [deviceCapability] Mapping to Nodes in Management Object capabilityName <x>/Property attached <x>/Attached capabilityActionStatus This attribute is managed by the <mgmtObj> resource hosting CSE, and does not need to be mapped to OMA DM management objects enable <x>/Operations/Enable disable <x>/Operations/Disable NOTE: Here <x> is the interior node groups together the parameters of a DCMO for a particular Device Capability. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.10 Resource [reboot] | The Resource [reboot] is to reboot the device. Regardless of OMA DM 1.3 and OMA DM 2.0, this Resource shall be mapped to Restart Management Object (MOID: "urn:oma:mo:oma-diag:restart:1.0") that is specified in DiagMon [6] and Lock and Wipe Management Object (MOID: "urn:oma:mo:oma-lawmo:1.0"). The attributes of this Resource shall be mapped to Nodes in the Management Objects as follows. Table 5.3.10-1: Resource [reboot] Attribute Name of [reboot] Mapping to Nodes in Management Object reboot "<x>/Operations/Start" Node in Restart MO. The restarting level described at the "<x>/DiagMonConfig/ConfigParms/RestartLevel" Node is up to the implementation factoryReset "<x>/Operations/FactoryReset" Node in LAWMO NOTE: Here <x> is the interior node that acts as a placeholder for the Restart MO and the LAWMO. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.11 Resource [eventLog] | The Resource [eventLog] is to record the event log for the device. Regardless of OMA DM 1.3 and OMA DM 2.0, this Resource shall be mapped to several Management Objects according to the logTypeId attribute of this Resource as follows: • Trap Event Logging Function Management Object (MOID: "urn:oma:mo:oma-diag:trapeventlogging:1.1") if the logTypeId attribute is set to "trap". • Trace Logs Management Object (MOID: "urn:oma:mo:oma-diag:tracelog:1.0") if the logTypeId attribute is set to "trace". • Panic Logs Management Object (MOID: "urn:oma:mo:oma-diag:paniclog:1.1") if the logTypeId attribute is set to "panic". The attributes of this Resource shall be mapped to Nodes in above Management Objects as follows. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 14 oneM2M TS-0005 version 4.0.1 Release 4 Table 5.3.11-1: Resource [eventLog] Attribute Name of [eventLog] Mapping to Nodes in Management Object logTypeId This attribute is not mapped to Nodes in Management Object. Instead, this attribute specifies the log type, and based on the log type, the actual Management Object mapped to this Resource is decided logData "<x>/DiagMonData/log" Node for Trap Event Logging Function MO and Trace Logs MO "<x>/DiagMonData/PanicLog" Node for Panic Logs MO logStatus "<x>/Status" Node for Trap Event Logging Function MO, Trace Logs MO and Panic Logs MO logStart "<x>/Operations/Start" Node for Trap Event Logging Function MO, Trace Logs MO and Panic Logs MO logStop "<x>/Operations/Stop" Node for Trap Event Logging Function MO, Trace Logs MO and Panic Logs MO NOTE: Here <x> is the interior node that acts as a placeholder for the respective Management Objects. |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12 Resource [cmdhPolicy] | |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12.0 Introduction | The Resource Type [cmdhPolicy] represents a set of rules associated with a specific CSE that govern the behaviour of that CSE regarding rejecting, buffering and sending request or response messages via the Mcc reference point. See clause D.12 of ETSI TS 118 101 [1] for a detailed high-level description of the overall structure of the [cmdhPolicy] resource, and clause D.12 of ETSI TS 118 104 [2] for details on the data types of the Resource attributes. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M cmdhPolicies MO (MCMDHMO) (urn:oma:mo:ext-onem2m-mcmdhmo:2.0). The root node of the MCMDHMO is denoted in the following by the leftmost placeholder node <x>. The Resource Type [cmdhPolicy] is a multi-instance Resource where each instance of the Resource shall map to an instance of a <x>/cmdhPolicy/<x> node. The attributes of an instance of [cmdhPolicy] shall be mapped to nodes of the MCMDHMO as follows. Table 5.3.12.0-1: Resource [cmdhPolicy] Attribute Name of [cmdhPolicy] Mapping to Nodes in Management Object name <x>/cmdhPolicy/<x>/name cmdhDefaults <x>/cmdhPolicy/<x>/defaultRule cmdhLimits <x>/cmdhPolicy/<x>/limitRules cmdhNetworkAccessRules <x>/cmdhPolicy/<x>/networkAccessECRules cmdhBuffer <x>/cmdhPolicy/<x>/bufferRules |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12.1 Resource [activeCmdhPolicy] | The Resource [activeCmdhPolicy] provides a link to the currently active set of CMDH policies, see clause D.12.1 of ETSI TS 118 101 [1] and ETSI TS 118 104 [2]. The Resource [activeCmdhPolicy] includes an attribute activeCmdhPolicyLink which is mapped to a leaf node enable. The value of enable shall point to the currently active instance of a <x>/cmdhPolicy node. Table 5.3.12.1-1: Resource [activeCmdhPolicy] Attribute Name of [activeCmdhPolicy] Mapping to Nodes in Management Object activeCmdhPolicyLink <x>/activeCmdhPolicy/<x>/enable At most one <cmdhPolicy> instance shall be enabled at a time. Hence, there can only be a single instance of the activeCmdhPolicy whose enable parameter points to the active CMDH policy ETSI ETSI TS 118 105 V4.0.1 (2025-09) 15 oneM2M TS-0005 version 4.0.1 Release 4 |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12.2 Resource [cmdhDefaults] | The Resource [cmdhDefaults] defines which CMDH related parameters will be used by default when a request or response message contains the Event Category parameter but not any other CMDH related parameters and which default Event Category parameter shall be used when none is given in the request or response, see clauses D.12.2 of ETSI TS 118 101 [1] and ETSI TS 118 104 [2]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M cmdhPolicies MO (MCMDHMO) (urn:oma:mo:ext-onem2m-mcmdhmo:2.0). The Resource [cmdhDefaults] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/cmdhDefaults/<x> node. The attributes of an instance of [cmdhDefaults] shall be mapped to nodes of the MCMDHMO as follows. Table 5.3.12.2-1: Resource [cmdhDefaults] Attribute Name of [cmdhDefaults] Mapping to Nodes in Management Object cmdhDefEcValue <x>/cmdhDefaults/<x>/defaultECRules cmdhEcDefParamValues <x>/cmdhDefaults/<x>/defaultECParamRules |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12.3 Resource [cmdhDefEcValue] | The Resource [cmdhDefEcValue] represents a default value for the ec (event category) parameter of an incoming request or response when this parameter is not indicated in the message itself, see clauses D.12.3 of ETSI TS 118 101 [1] and ETSI TS 118 104 [2]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M cmdhPolicies MO (MCMDHMO) (urn:oma:mo:ext-onem2m-mcmdhmo:2.0). The Resource [cmdhDefEcValue] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/cmdhDefEcValue/<x> node. The attributes of an instance of [cmdhDefEcValue] shall be mapped to nodes of the MCMDHMO as follows. Table 5.3.12.3-1: Resource [cmdhDefEcValue] Attribute Name of [cmdhDefEcValues] Mapping to Nodes in Management Object order <x>/cmdhDefEcValue/<x>/order defEcValue <x>/cmdhDefEcValue/<x>/defEcValue requestOrigin <x>/cmdhDefEcValue/<x>/requestOrigin requestContext <x>/cmdhDefEcValue]/<x>/requestContext requestContextNotification <x>/cmdhDefEcValue]/<x>/requestContextNotification requestCharacteristics <x>/cmdhDefEcValue/<x>/requestCharacteristics |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12.4 Resource [cmdhEcDefParamValues] | The Resource [cmdhEcDefParamValues] represents a specific set of default values for the CMDH related parameters rqet (request expiration timestamp), rset (result expiration timestamp), oet (operational execution time), rp (response persistence) and da (delivery aggregation) that are applicable for a given ec (event category) if these parameters are not specified in the request, see clauses D.12.4 of ETSI TS 118 101 [1] and ETSI TS 118 104 [2]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M cmdhPolicies MO (MCMDHMO) (urn:oma:mo:ext-onem2m-mcmdhmo:2.0). The Resource [cmdhEcDefParamValues] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/cmdhEcDefParamValues/<x> node. The attributes of an instance of [cmdhEcDefParamValues] shall be mapped to nodes of the MCMDHMO as follows. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 16 oneM2M TS-0005 version 4.0.1 Release 4 Table 5.3.12.4-1: Resource [cmdhEcDefParamValues] Attribute Name of [cmdhEcDefParamValues] Mapping to Nodes in Management Object applicableEventCategory <x>/cmdhEcDefParamValues/<x>/applicableEventCategory defaultRequestExpTime <x>/cmdhEcDefParamValues/<x>/defaultRequestExpTime defaultResultExpTime <x>/cmdhEcDefParamValues/<x>/defaultResultExpTime defaultOpExecTime <x>/cmdhEcDefParamValues/<x>/defaultOpExecTime defaultRespPersistence <x>/cmdhEcDefParamValues/<x>/defaultRespPersistence defaultDelAggregation <x>/cmdhEcDefParamValues/<x>/defaultDelAggregation |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12.5 Resource [cmdhLimits] | The Resource [cmdhLimits] represents limits for CMDH related parameter values in request and response messages for a given setting of the ec parameter, see clause D.12.5 of ETSI TS 118 101 [1] and ETSI TS 118 104 [2]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M cmdhPolicies MO (MCMDHMO) (urn:oma:mo:ext-onem2m-mcmdhmo:2.0). The Resource [cmdhLimits] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/cmdhLimits/<x> node. The attributes of an instance of [cmdhLimits] shall be mapped to nodes of the MCMDHMO as follows. Table 5.3.12.5-1: Resource [cmdhLimits] Attribute Name of [cmdhLimits] Mapping to Nodes in Management Object order <x>/cmdhLimits/<x>/order requestOrigin <x>/cmdhLimits/<x>/requestOrigin requestContext <x>/cmdhLimits/<x>/requestContext requestContextNotification <x>/cmdhLimits/<x>/requestContextNotification requestCharacteristics <x>/cmdhLimits/<x>/requestCharacteristics limitsEventCategory <x>/cmdhLimits/<x>/limitsEventCategory limitsRequestExpTime <x>/cmdhLimits/<x>/limitsRequestExpTime limitsResultExpTime <x>/cmdhLimits/<x>/limitsResultExpTime limitsOpExecTime <x>/cmdhLimits/<x>/limitsOpExecTime limitsRespPersistence <x>/cmdhLimits/<x>/limitsRespPersistence limitsDelAggregation <x>/cmdhLimits/<x>/limitsDelAggregation |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12.6 Resource [cmdhNetworkAccessRules] | The Resource [cmdhNetworkAccessRules] defines the usage of underlying networks for forwarding information to other CSEs during processing of CMDH-related requests in a CSE, see clauses D.12.6 of ETSI TS 118 101 [1] and ETSI TS 118 104 [2]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M cmdhPolicies MO (MCMDHMO) (urn:oma:mo:ext-onem2m-mcmdhmo:2.0). The Resource [cmdhNetworkAccessRules] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/cmdhNetworkAccessRules/<x> node. The attributes of an instance of [cmdhNetworkAccessRules] shall be mapped to nodes of the MCMDHMO as follows. Table 5.3.12.6-1: Resource [cmdhNetworkAccessRules] Attribute Name of [cmdhNetworkAccessRules] Mapping to Nodes in Management Object applicableEventCategories <x>/cmdhLimits/<x>/applicableEventCategories cmdhNwAccessRule <x>/cmdhLimits/<x>/NetworkAccessRule ETSI ETSI TS 118 105 V4.0.1 (2025-09) 17 oneM2M TS-0005 version 4.0.1 Release 4 |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12.7 Resource [cmdhNwAccessRule] | The Resource [cmdhNwAccessRule] define limits in usage of specific underlying networks for forwarding information to other CSEs during processing of CMDH-related requests, see clauses D.12.7 of ETSI TS 118 101 [1] and ETSI TS 118 104 [2]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M cmdhPolicies MO (MCMDHMO) (urn:oma:mo:ext-onem2m-mcmdhmo:2.0). The Resource [cmdhNwAccessRule] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/cmdhNwAccessRule/<x> node. The attributes of an instance of [cmdhNwAccessRule] shall be mapped to nodes of the MCMDHMO as follows. Table 5.3.12.7-1: Resource [cmdhNwAccessRule] Attribute Name of [cmdhNwAccessRule] Mapping to Nodes in Management Object targetNetwork <x>/cmdhNwAccessRule]/<x>/targetNetwork minReqVolume <x>/cmdhNwAccessRule/<x>/minReqVolume backOffParameters <x>/cmdhNwAccessRule/<x>/backOffParameters otherConditions <x>/cmdhNwAccessRule/<x>/otherConditions allowedSchedule <x>/cmdhNwAccessRule/<x>/allowedSchedule |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.12.8 Resource [cmdhBuffer] | The Resource [cmdhBuffer] represents limits in usage of buffers for temporarily storing information that needs to be forwarded to other CSEs during processing of CMDH-related requests in a CSE, see clauses D.12.8 of ETSI TS 118 101 [1] and ETSI TS 118 104 [2]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M cmdhPolicies MO (MCMDHMO) (urn:oma:mo:ext-onem2m-mcmdhmo:2.0). The Resource [cmdhBuffer] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/cmdhBuffer/<x>/ node. The attributes of an instance of [cmdhBuffer] shall be mapped to nodes of the MCMDHMO as follows. Table 5.3.12.8-1: Resource [cmdhBuffer] Attribute Name of [cmdhBuffer] Mapping to Nodes in Management Object applicableEventCategory <x>/cmdhNwAccessRule/<x>/applicableEventCategory maxBufferSize <x>/cmdhNwAccessRule/<x>/maxBufferSize storagePriority <x>/cmdhNwAccessRule/<x>/storagePriority |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.13 Resource related to Field Device Configuration | |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.13.1 Introduction | The Resource Types addressed in clause 5.3.13 represent <mgmtObj> specializations required to configure ADN, ASN and MN in the field domain. These resource types and the related specific procedures are specified in ETSI TS 118 122 [20]. Clause 5.3.13.2 to clause 5.3.13.8 define the mapping to and from a M2M FieldDeviceConfig MO (MFDCMO) (urn:oma:mo:ext-onem2m-mfdcmo:1.0) which is applicable to both, OMA DM 1.3 and OMA DM 2.0. The root node of the MFDCMO is denoted in the following by the leftmost placeholder node <x>. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 18 oneM2M TS-0005 version 4.0.1 Release 4 |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.13.2 Resource [registration] | The Resource [registration] is used to convey the service layer configuration information needed to register an AE or CSE with a Registrar CSE, see clause 7.1.2 of ETSI TS 118 122 [20]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M FieldDeviceConfig MO (MFDCMO) (urn:oma:mo:ext-onem2m-mfdcmo:1.0). The Resource [registration] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/registration/<x> node of MFDCMO. The attributes of an instance of [registration] shall be mapped to nodes of the MFDCMO as shown in table 5.3.13.2-1. The mgmtLink attribute of the [registration] resource points to an [authenticationProfile] resource instance which itself is mapped to a <x>/authenticationProfile/<x> node in MFDCMO. The original value of this mgmtLink attribute needs to be translated such that it points to the <x>/authenticationProfile/<x> node in MFDCMO which corresponds to the linked [authenticationProfile] resource instance. The respective node identifier <x>/authenticationProfile/<x> of this [authenticationProfile] resource instance shall be set as the value of the <x>/dataCollection/<x>/authenticationProfile leaf node. Table 5.3.13.2-1: Resource [registration] Attribute Name of [registration] Mapping to Nodes in Management Object originatorID <x>/registration/<x>/originatorID poA <x>/registration/<x>/poA CSEBase <x>/registration/<x>/CSEBase CSE-ID <x>/registration/<x>/CSEID appID <x>/registration/<x>/appID externalID <x>/registration/<x>/externalID triggerRecipientID <x>/registration/<x>/triggerRecipientID mgmtLink [authenticationProfile] <x>/registration/<x>/authenticationProfile |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.13.3 Resource [dataCollection] | The Resource [dataCollection] is used to convey the application configuration information needed by an AE to collect data and then transmit the data to a Hosting CSE, see clause 7.1.3 of ETSI TS 118 122 [20]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M FieldDeviceConfig MO (MFDCMO) (urn:oma:mo:ext-onem2m-mfdcmo:1.0). The Resource [dataCollection] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/dataCollection/<x> node of MFDCMO. The attributes of an instance of [dataCollection] shall be mapped to nodes of the MFDCMO as shown in table 5.3.13.3-1. The mgmtLink attribute of the [dataCollection] resource points to an [authenticationProfile] resource instance which itself is mapped to a <x>/authenticationProfile/<x> node in MFDCMO. The original value of this mgmtLink attribute needs to be translated such that it points to the <x>/authenticationProfile/<x> node in MFDCMO which corresponds to the linked [authenticationProfile] resource instance. The respective node identifier <x>/authenticationProfile/<x> of this [authenticationProfile] resource instance shall be set as the value of the <x>/dataCollection/<x>/authenticationProfile leaf node. Table 5.3.13.3-1: Resource [dataCollection] Attribute Name of [dataCollection] Mapping to Nodes in Management Object containerPath <x>/dataCollection/<x>/containerPath reportingSchedule <x>/dataCollection/<x>/reportingSchedule measurementSchedule <x>/dataCollection/<x>/measurementSchedule mgmtLink [authenticationProfile] <x>/dataCollection/<x>/authenticationProfile ETSI ETSI TS 118 105 V4.0.1 (2025-09) 19 oneM2M TS-0005 version 4.0.1 Release 4 |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.13.4 Resource [authenticationProfile] | The Resource [authenticationProfile] is used to convey the configuration information regarding establishing mutually- authenticated secure communications, see clause 7.1.4 of ETSI TS 118 122 [20]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M FieldDeviceConfig MO (MFDCMO) (urn:oma:mo:ext-onem2m-mfdcmo:1.0). The Resource [authenticationProfile] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/authenticationProfile /<x> node of MFDCMO. The attributes of an instance of [authenticationProfile] shall be mapped to nodes of the MFDCMO as shown in table 5.3.13.4-1. A mgmtLink attribute of the [authenticationProfile] has one or more instantiations. The value of mgmtLink attribute either points to a [trustAnchorCred] resource, or to a [MAFClientRegCfg] resource. An [authenticationProfile] resource does not include mgmtLink attributes to both [trustAnchorCred] and [MAFClientRegCfg] resources. If there are more than one mgmtLink attribute in the [authenticationProfile] resource, these point all to [trustAnchorCred] resource instances. For a mgmtLink attribute pointing to a [trustAnchorCred] resource, the linked [trustAnchorCred] resource instance itself is mapped to a <x>/trustAnchorCred/<x> node in MFDCMO. The respective node identifier <x>/trustAnchorCred/<x> of this [trustAnchorCred] resource instance shall be set as the value of the <x>/authenticationProfile/<x>/trustAnchorCred leaf node. For a mgmtLink attribute pointing to a [MAFClientRegCfg] resource, the linked [MAFClientRegCfg] resource instance itself is mapped to a <x>/MAFClientRegCfg/<x> node in MFDCMO. The respective node identifier <x>/MAFClientRegCfg/<x> of this [MAFClientRegCfg] resource instance shall be set as the value of the <x>/authenticationProfile/<x>/trustAnchorCred leaf node. Table 5.3.13.4-1: Resource [authenticationProfile] Attribute Name of [authenticationProfile] Mapping to Nodes in Management Object SUID <x>/authenticationProfile/<x>/SUID TLSCiphersuites <x>/authenticationProfile/<x>/TLSCiphersuites symmKeyID <x>/authenticationProfile/<x>/symmKeyID symmKeyValue <x>/authenticationProfile/<x>/symmKeyValue MAFKeyRegLabels <x>/authenticationProfile/<x>/MAFKeyRegLabels MAFKeyRegDuration <x>/authenticationProfile/<x>/MAFKeyRegDuration mycertFingerprint <x>/authenticationProfile/<x>/mycertFingerprint rawPubKeyID <x>/authenticationProfile/<x>/rawPubKeyID mgmtLink [trustAnchorCred] <x>/authenticationProfile/<x>/trustAnchorCred mgmtLink [MAFClientRegCfg] <x>/authenticationProfile/<x>/MAFClientRegCfg |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.13.5 Resource [trustAnchorCred] | The Resource [trustAnchorCred] represents configuration information regarding certificates provided by certificate authorities used be managed entities to authenticate peer endpoints, see clause 7.1.6 of ETSI TS 118 122 [20]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M FieldDeviceConfig MO (MFDCMO) (urn:oma:mo:ext-onem2m-mfdcmo:1.0). The Resource [trustAnchorCred] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/trustAnchorCred/<x> node of MFDCMO. The attributes of an instance of [trustAnchorCred] shall be mapped to nodes of the MFDCMO as shown in table 5.3.13.5-1. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 20 oneM2M TS-0005 version 4.0.1 Release 4 Table 5.3.13.5-1: Resource [trustAnchorCred] Attribute Name of [trustAnchorCred] Mapping to Nodes in Management Object certFingerprint <x>/trustAnchorCred/<x>/certFingerprint URI <x>/trustAnchorCred/<x>/URI |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.13.6 Resource [myCertFileCred] | The Resource [myCertFileCred] represents configuration information regarding certificates presented by the managed entity to remote entities for the establishment of secure communications, see clause 7.1.5 of ETSI TS 118 122 [20]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M FieldDeviceConfig MO (MFDCMO) (urn:oma:mo:ext-onem2m-mfdcmo:1.0). The Resource [myCertFileCred] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/myCertFileCred/<x> node of MFDCMO. The attributes of an instance of [myCertFileCred] shall be mapped to nodes of the MFDCMO as shown in table 5.3.13.6-1. Table 5.3.13.6-1: Resource [myCertFileCred] Attribute Name of [myCertFileCred] Mapping to Nodes in Management Object SUIDs <x>/myCertFileCred/<x>/SUIDs myCertFileFormat <x>/myCertFileCred/<x>/myCertFileFormat myCertFileContent <x>/myCertFileCred/<x>/myCertFileContent |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.13.7 Resource [MAFClientRegCfg] | The Resource [MAFClientRegCfg] represents configuration information that permits a MAF client to register with a MAF, see clause 7.1.7 of ETSI TS 118 122 [20]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M FieldDeviceConfig MO (MFDCMO) (urn:oma:mo:ext-onem2m-mfdcmo:1.0). The Resource [MAFClientRegCfg] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/MAFClientRegCfg/<x> node of MFDCMO. The attributes of an instance of [MAFClientRegCfg] shall be mapped to nodes of the MFDCMO as shown in table 5.3.13.7-1. The mgmtLink attribute of the [MAFClientRegCfg] resource points to an [authenticationProfile] resource instance which itself is mapped to a <x>/authenticationProfile/<x> node in MFDCMO. The original value of this mgmtLink attribute needs to be translated such that it points to the <x>/authenticationProfile/<x> node in MFDCMO which corresponds to the linked [authenticationProfile] resource instance. The respective node identifier <x>/authenticationProfile/<x> of this [authenticationProfile] resource instance shall be set as the value of the <x>/dataCollection/<x>/authenticationProfile leaf node. Table 5.3.13.7-1: Resource [MAFClientRegCfg] Attribute Name of [MAFClientRegCfg] Mapping to Nodes in Management Object fqdn <x>/MAFClientRegCfg/<x>/fqdn adminFQDN <x>/MAFClientRegCfg/<x>/adminFQDN httpPort <x>/MAFClientRegCfg/<x>/httpPort coapPort <x>/MAFClientRegCfg/<x>/coapPort websocketPort <x>/MAFClientRegCfg/<x>/websocketPort mgmtLink [authenticationProfile] <x>/MAFClientRegCfg/<x>/authenticationProfile ETSI ETSI TS 118 105 V4.0.1 (2025-09) 21 oneM2M TS-0005 version 4.0.1 Release 4 |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.3.13.8 Resource [MEFClientRegCfg] | The Resource [MEFClientRegCfg] represents configuration information that permits a MEF client to register with a MEF, see clause 7.1.8 of ETSI TS 118 122 [20]. Regardless of OMA DM 1.3 and OMA DM 2.0, this resource shall be mapped to M2M FieldDeviceConfig MO (MFDCMO) (urn:oma:mo:ext-onem2m-mfdcmo:1.0). The Resource [MEFClientRegCfg] is a multi-instance Resource where each instance of the Resource shall map to an instance of the <x>/MEFClientRegCfg/<x> node of MFDCMO. The attributes of an instance of [MEFClientRegCfg] shall be mapped to nodes of the MFDCMO as shown in table 5.3.13.8-1. The mgmtLink attribute of the [MEFClientRegCfg] resource points to an [authenticationProfile] resource instance which itself is mapped to a <x>/authenticationProfile/<x> node in MFDCMO. The original value of this mgmtLink attribute needs to be translated such that it points to the <x>/authenticationProfile/<x> node in MFDCMO which corresponds to the linked [authenticationProfile] resource instance. The respective node identifier <x>/authenticationProfile/<x> of this [authenticationProfile] resource instance shall be set as the value of the <x>/dataCollection/<x>/authenticationProfile leaf node. Table 5.3.13.8-1: Resource [MEFClientRegCfg] Attribute Name of [MEFClientRegCfg] Mapping to Nodes in Management Object fqdn <x>/MEFClientRegCfg/<x>/fqdn adminFQDN <x>/MEFClientRegCfg/<x>/adminFQDN httpPort <x>/MEFClientRegCfg/<x>/httpPort coapPort <x>/MEFClientRegCfg/<x>/coapPort websocketPort <x>/MEFClientRegCfg/<x>/websocketPort mgmtLink [authenticationProfile] <x>/MEFClientRegCfg/<x>/authenticationProfile |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.4 Mapping of procedures for management | |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.4.1 Mapping for <mgmtObj> Resource Primitives | |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.4.1.1 Create Primitive for <mgmtObj> Resource | |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.4.1.1.0 Introduction | The Create Request primitive for the <mgmtObj> Resource, as described in ETSI TS 118 104 [2], shall be mapped to technology specific requests that create the corresponding OMA DM Management Objects. Depending on the type of the <mgmtObj> Resource (i.e. [memory], [battery], [deviceInfo], etc.), the associated OMA DM Management Object as specified in clause 6.3 should be created. Creating OMA DM Management Object can be performed by the Protocol Command Add in OMA DM 1.3 and HGET in OMA DM 2.0. Receiving Create Request primitive does not imply that the mapped technology specific requests shall always be performed since, on receiving the Create Request primitive, the corresponding technology specific data model objects may already exist in the device. For instance, after discovering the external management objects, the DMG in MN or ASN creates <mgmtObj> Resource in the IN-CSE; and in this case, the IN-CSE does not need to create the external management objects. In the case where the technology specific data model objects are successfully created after receiving the Create Request primitive, then the objectID and objectPath attribute should be properly set based on the created technology specific data model objects. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 22 oneM2M TS-0005 version 4.0.1 Release 4 |
b59ff5f2c3ee9c7d158588bafab8a1bc | 118 105 | 5.4.1.1.1 Create Response Status Code Mapping | The result of creating the technology specific data model object should be mapped to the Create Response primitive for the <mgmtObj> Resource as indicated by the status code mapping in the present clause. Table 5.4.1.1.1-1: OMA DM 1.3 Status Code Mapping oneM2M Primitive Status Code OMA DM 1.3 Status Code Description success (200) OK Command accessed leaf node and completed successfully. n/a (213) Chunked item accepted Chunked item accepted and buffered. This status code indicates that the request is still on processing. The final status code shall be mapped to the proper oneM2M Primitive status code. error -not executed (215) Not executed Command was not executed, as a result of: User interaction as user chose to abort or cancel. The parent Atomic command failed causing this command to fail. error - not executed (216) Atomic roll back OK Command was inside Atomic element and Atomic failed. This command was rolled back successfully. error - no privilege (401) Unauthorized The originator's authentication credentials specify a principal with insufficient rights to complete the command. error - not found (404) Not Found The specified data item does not exist on the recipient. This may also imply that the stated URI for the location of the new management object cannot be resolved. error - not allowed (405) Command not allowed Command not allowed. The requested command is not allowed on the target. error - authentication failed (407) Authentication required No authentication credentials were specified. A suitable challenge can also be returned. error - mgmt adapter error (413) Request entity too large The data item to be transferred is too large (e.g. there are restrictions on the size of data items transferred to the recipient). error - mgmt adapter error (414) URI too long URI in command is too long. Either string presenting URI or segment in URI is too long or URI has too many segments. error - Unsupported data type (415) Unsupported media type or format The media type or format for the data item is not supported by the recipient. error - already exists (418) Already exists The requested Add command failed because the target already exists. error - no storage at device (420) Device full The recipient device storage is full. error - mgmt adapter error (424) Size mismatch The chunked object was received, but the size of the received object did not match the size declared within the first chunk. error - no privilege (425) Permission denied The server does not have the proper ACL permissions. error - mgmt adapter error (500) Command failed Non-specific errors created by the recipient while attempting to complete the command. error - not executed (516) Atomic roll back failed Command was inside Atomic element and Atomic failed. This command was not rolled back successfully. Server should take action to try to recover client back into original state. ETSI ETSI TS 118 105 V4.0.1 (2025-09) 23 oneM2M TS-0005 version 4.0.1 Release 4 Table 5.4.1.1.1-2: OMA DM 2.0 Status Code Mapping oneM2M Primitive Status Code OMA DM 2.0 Status Code Description ok (200) OK The DM command completed successfully. error - bad request (400) Bad Request The requested command could not be performed because of malformed syntax in the command. error - no privilege (403) Forbidden The requested command failed because the sender does not have adequate access rights on the recipient. error - not found (404) Not Found The requested target was not found. error - Unsupported data type (415) Unsupported Media Type The request is refused because the request uses a format not supported by the requested resource for the requested method. error - mgmt adapter error (419) ServerURI Error The ServerURI provided causes errors. error - internal error (500) Internal Error The recipient encountered an unexpected condition which prevented it from fulfilling the request. error - unsupported resource (501) Not Implemented The recipient does not support the features to fulfil the request. This is the appropriate response when the recipient does not recognize the requested command and is not capable of supporting it for any resource. error - service unavailable (503) Service Unavailable The recipient is currently unable to handle the request due to a temporary overloading or maintenance of the recipient. The implication is that this is a temporary condition which will be alleviated after some delay. error - no storage (506) Device Full The response indicates that the recipient has not enough storage space for the data. error - user rejected (507) User Rejected The request is not executed since the user rejected the request. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.