hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2.7 Sec-WebSocket-Protocol header | The Sec-WebSocket-Protocol header shall be present in a client handshake message. It enables the client to indicate its supported application subprotocols on the server and be sure that the server agreed to support that subprotocol. It is used by the client to indicate the oneM2M Service Layer Protocol version and supported serialization formats to the server. The value of the Sec-WebSocket-Protocol header shall be one or more of the registered names defined in clause 6.2.2.9. It shall also be allowed to include multiple Sec-WebSocket-Protocol headers with a value that includes one registered name each as defined in IETF RFC 6455 [1], for example: Sec-WebSocket-Protocol: oneM2M.json, oneM2M.xml and Sec-WebSocket-Protocol: oneM2M.xml Sec-WebSocket-Protocol: oneM2M.json are equivalent headers, expressing that the WebSocket client supports both application subprotocols, oneM2M.json and oneM2M.xml. The order of names indicated in the Sec-WebSocket-Protocol header specifies the client's preference. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2.8 Sec-WebSocket-Extensions header | The Sec-WebSocket-Extensions header may be used to negotiate the use of per-message compression as specified in IETF RFC 7692 [6]. If the client handshake includes the header, e.g.: Sec-WebSocket-Extensions: permessage-deflate it indicates to the server the client’s preference to apply the compression mechanism defined in IETF RFC 7692 [6]. The header may include additional parameters as specified in IETF RFC 7692 [6]. When the server accepts use of message compression it responds with a Sec-WebSocket-Extensions header in the server handshake message as specified in clause 6.2.3.6, and in this case compression is applied in both transmission directions. If the server handshake message does not include a Sec-WebSocket-Extensions header, compression shall not be applied. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.2.9 Subprotocol names and serialization formats | The Sec-WebSocket-Protocol header in the opening handshake is used to negotiate the application protocol layered on top of WebSocket. The application protocol addressed in the present document is the Release-2 version of the oneM2M Service Layer. The oneM2M Service Layer Protocol consists of the exchange of serialized representations of request and response primitives as defined in ETSI TS 118 101 [2] and ETSI TS 118 104 [5]. This version of the specification allows use of the serialization formats listed in table 6.2.2.9-1. Both, protocol version and serialization format are associated with a specific subprotocol name. Table 6.2.2.9-1 lists the serialization formats, associated subprotocols names and opcode setting of the WebSocket Frame protocol applicable for the present version of the present document. ETSI ETSI TS 118 120 V3.0.1 (2021-01) 13 oneM2M TS-0020 version 3.0.1 Release 3 Table 6.2.2.9-1: Applicable Subprotocol names Serialization Format Subprotocol Name WS opcode Notes JSON oneM2M.json x1 ("text frame") See clause 8.4 in ETSI TS 118 104 [5] XML oneM2M.xml x1 ("text frame") See clause 8.3 in ETSI TS 118 104 [5] CBOR oneM2M.cbor x2 ("binary frame") See clause 8.5 in ETSI TS 118 104 [5] |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.3 Server handshake format | |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.3.1 Format of status-line | The status-line of a server handshake shall begin with the HTTP version set to "HTTP/1.1", followed by the status code and reason phrase as defined in IETF RFC 6455 [1]. When the WebSocket connection is established successfully, the status-line may look as follows: HTTP/1.1 101 Switching Protocols For the unsuccessful connection establishment, any appropriate HTTP error status code shall be returned with optional addition of a corresponding reason phrase. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.3.2 Upgrade header | The Upgrade header shall be present in each server handshake message with value WebSocket as follows: Upgrade: WebSocket |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.3.3 Connection header | The Connection header shall be present in each server handshake message with value Upgrade as follows: Connection: Upgrade |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.3.4 Sec-WebSocket-Accept header | The Sec-WebSocket-Accept header shall be present in each server handshake message. The header field shall be constructed from the Sec-WebSocket-Key value and the GUID as specified in section 4.2.2 of IETF RFC 6455 [1]. It may look e.g. as follows: Sec-WebSocket-Accept: FuSSKANnI7C/6/FrPMt70mfBY8E= |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.3.5 Sec-WebSocket-Protocol header | The Sec-WebSocket-Protocol header shall be present in a server handshake message. It indicates to the client that the server accepts (one of) the subprotocol(s) indicated by the client. The server compliant with this specification shall select one of the subprotocol names indicated in the Sec-WebSocket- Protocol header of the client handshake message and set the value of the Sec-WebSocket-Protocol header of the server handshake message accordingly. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.2.3.6 Sec-WebSocket-Extensions header | If the optional Sec-WebSocket-Extensions header with value "permessage-deflate" was included in the client handshake message, the Sec-WebSocket-Extensions header with same value shall also be included into the server handshake message, if the server accepts usage of message compression, and apply message compression in the transmit direction and message decompression in the receive direction as defined in IETF RFC 7692 [6]. If the server does not accept message compression, it shall not include the Sec-WebSocket-Extensions header. ETSI ETSI TS 118 120 V3.0.1 (2021-01) 14 oneM2M TS-0020 version 3.0.1 Release 3 |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.3 Closing WebSocket connection | Compliant with section 7 of IETF RFC 6455 [1] a WebSocket connection shall be closed by sending a Connection Close Frame (opcode x8). Both, client and server may initiate a closing handshake of an existing WebSocket connection at any time. WebSocket connections should be kept open for as long as possible considering any given constraints due to communication policies and power saving requirements. Unless communication policies enforce the closing of network access, it is left to implementation to decide when exactly the closing of a WebSocket shall be triggered. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.4 Registration procedure | A oneM2M entity (AE or CSE) not yet registered to its registrar CSE needs to be preconfigured with various parameters as specified in ETSI TS 118 101 [2] and ETSI TS 118 103 [4] in order to be able to send the registration request primitive (i.e. create <AE> or create <remoteCSE> request primitive). To establish a WebSocket connection, the WebSocket client shall be configured with an applicable point of access of its registrar CSE which includes FQDN or IP address and the port number. After the Registration procedure has been successfully completed, the WebSocket Server (e.g. Registrar CSE for WebSocket Client) shall enable routing of any incoming oneM2M primitives to this registree. Before the Registration procedure is successfully completed, any incoming oneM2M primitives to the WebClient shall be rejected by the Receiver (e.g. registrar CSE). Closing of the WebSocket connection after registration does not impact the registration status of an AE or CSE to its registrar, unless an explicit de-registration procedure is performed by deletion of the respective <AE> or <remoteCSE> resource instance. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.5 Handling of Non-Registration Request | Registered entities (AE and CSE) are allowed to send and receive non-registration request primitives. A WebSocket connection should support any of the transfer modes defined in clause 8.2 of ETSI TS 118 101 [2], i.e. blocking requests, and non-blocking requests for both synchronous and asynchronous cases. When sending blocking requests, the WebSocket connection shall not be closed before the response is received, or before any configured timeout period has expired. When sending non-blocking requests, the WebSocket connection shall not be closed before the acknowledgment response is received, or before any configured timeout period has expired. If the entities' communication policies and power saving requirements allow, the connection should be kept open at least until an ongoing procedure has fully completed, i.e. requesting of the result in synchronous mode or completion of Notify procedure in asynchronous mode. If no WebSocket connection with a client exists when a Notify request primitive for this client becomes available at the server side, it should be stored and sent when the WebSocket connection is opened again by the client. |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 6.6 Use of proxy servers | The connection to a proxy shall be requested by sending a request-line with the method token "CONNECT", followed by the request target host and port of the WebSocket server and the HTTP version set to "HTTP/1.1" for example as follows: CONNECT WSserver.example.com:80 HTTP/1.1 ETSI ETSI TS 118 120 V3.0.1 (2021-01) 15 oneM2M TS-0020 version 3.0.1 Release 3 |
d9efe626d8f4af7547b3e7768b04c067 | 118 120 | 7 Security Aspects | Authentication and Transport Layer Security can be established when the oneM2M entity which hosts the WebSocket Server can be addressed with the wss URI scheme. When using the wss URI scheme, one of the Security Association Establishment Frameworks (SAEF) as defined in ETSI TS 118 103 [4] shall be applied to provide mutually authenticated Transport Layer Security between the communicating entities prior to sending the WebSocket client handshake. The SAEF is accomplished by successful completion of a TLS handshake procedure before the client sends its opening handshake message. The details of SAEF and possibly required Remote Security Provisioning Frameworks are specified in ETSI TS 118 103 [4]. In special deployment scenarios, e.g. when the communicating oneM2M entities using WebSocket binding are located in a secure environment and/or implemented on the same device, Transport Layer Security may not be required. In such scenarios unsecured WebSocket communication addressed with the ws URI scheme may be adequate. ETSI ETSI TS 118 120 V3.0.1 (2021-01) 16 oneM2M TS-0020 version 3.0.1 Release 3 Annex A (informative): Example Procedures A.1 AE Registration and creation of a container child resource Figure A.1-1 illustrates a message flow for registration of an ADN-AE to an IN-CSE as described in clause 7.3.5.2.1 of ETSI TS 118 104 [5] with WebSocket mapping and subsequent creation of a <container> child resource. Figure A.1-1: Message flow for registration of an ADN-AE to an IN-CSE ETSI ETSI TS 118 120 V3.0.1 (2021-01) 17 oneM2M TS-0020 version 3.0.1 Release 3 In the considered example, the WebSocket protocol is used to send JSON serialized request and response primitives in text format. The message flow may look as follows: 1) TCP connection establishment and Security Association Establishment as defined in ETSI TS 118 103 [4] based on TLS handshake procedure is accomplished. 2) The WSS client sends e.g. the following opening handshake message, offering to use either JSON or XML serialization of primitives: GET / HTTP/1.1 Host: mncse1234.net:9000 Upgrade: WebSocket Connection: Upgrade Sec-WebSocket-Key: ud63env87LQLd4uIV20/oQ== Sec-WebSocket-Protocol: oneM2M.json, oneM2M.xml Sec-WebSocket-Version: 13 3) The WSS server selects use of JSON serialization and responds the following handshake message: Request-Version: HTTP/1.1 Status-Code: 101 Response-Phrase: Switching Protocols Upgrade: WebSocket Connection: Upgrade Sec-WebSocket-Protocol: oneM2M.json Sec-WebSocket-Accept: FuSSKANnI7C/6/FrPMt70mfBY8E= 4) The AE sends the following request primitive in textual JSON serialized format: {"op":1,"to":"//example.net/mncse1234","rqi":"A1000", "rcn":7,"pc":{"m2m:ae":{"rn":"SmartHomeApplication", "api":"Na56", "apn":"app1234"}},"ty":2} The above JSON object is mapped by the WS client into a data frame of the WebSocket Framing protocol in utf-8 text format, the 4-bit opcode in the WebSocket Base Framing Protocol of the first message fragment is set to x1 ("text frame"). 5) The IN-CSE validates the privilege of the originator to create an <AE> resource, and accepts the request to create the resource. 6) The IN-CSE acknowledges the success of the request by responding the following JSON serialized response primitive. The response primitive includes all attributes of <AE> instance created in step 5). {"rsc":2001,"rqi":"A1000","pc":{"m2m:ae":{"rn":"SmartHomeApplication","ty":2,"ri":"ae1","api" :"Na56","apn":"app1234","pi":"cb1","ct":"20160506T153208", "lt":"20160506T153208","acpi":["acp1","acp2"],"et":"20180506T153208", "aei":"S_SAH25"}}} NOTE: JSON serialized primitives are not encapsulated under member names "m2m:rqp" and "m2m:rsp" as in XML serialized representations, which allows differentiation between request and response primitives (see clause 8.4 of TS-0004 [5]). JSON serialized primitives can be differentiated by the presence of mandatory members such as "op" in request primitives (see step 4) above), and "rsc" in response primitives. The above JSON object is mapped by the WS server into a data frame of the WebSocket Framing protocol in utf-8 text format, the 4-bit opcode in the WebSocket Base Framing Protocol of the first message fragment is set to x1 ("text frame"). ETSI ETSI TS 118 120 V3.0.1 (2021-01) 18 oneM2M TS-0020 version 3.0.1 Release 3 7) The AE sends in textual JSON serialized format the following request primitive to create a <container> resource as child resource of the <AE> created in step 5): {"op":1,"to":"//example.net/mncse1234/SmartHomeApplication","fr":"S_SAH25","rqi":"A1001","rcn ":7,"pc":{"m2m:cnt":{"rn":"SmartHomeContainer","mbs":100000, "mni":500}},"ty":3} The above JSON object is mapped by the WS client into a data frame of the WebSocket Framing protocol in utf-8 text format, the 4-bit opcode in the WebSocket Base Framing Protocol of the first message fragment is set to x1 ("text frame"). 8) The IN-CSE validates the privilege of the originator to create an <container> resource under the <AE> resource created in step 5), and accepts the request to create the resource. 9) The IN-CSE acknowledges the success of the request by responding the following JSON serialized response primitive: {"rsc":2001,"rqi":"A1001","pc":{"m2m:cnt":{"rn":"SmartHomeContainer", "ty":3,"ri":"cnt1","pi":"ae1","ct":"20160506T154048", "lt":"20160506T154048","acpi":["acp1"],"et":"20180506T154048","cr":" S_SAH25","st":0,"mni":500,"mbs":100000,"cni":0,"cbs":0,"mia":3600}}} The above JSON object is mapped by the WS server into a data frame of the WebSocket Framing protocol in utf-8 text format, the 4-bit opcode in the WebSocket Base Framing Protocol of the first message fragment is set to x1 ("text frame"). 10) Primitives of further subsequent CRUDN procedures may be transferred on the existing WebSocket connection. ETSI ETSI TS 118 120 V3.0.1 (2021-01) 19 oneM2M TS-0020 version 3.0.1 Release 3 History Document history V3.0.1 January 2021 Publication |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 1 Scope | The present document contains a collection of specialist technical terms, definitions and abbreviations referenced within the oneM2M specifications. Having a common collection of definitions and abbreviations related to oneM2M documents will: • ensure that the terminology is used in a consistent manner across oneM2M documents; • provide a reader with convenient reference for technical terms that are used across multiple documents. The present document provides a tool for further work on oneM2M technical documentation and facilitates their understanding. The definitions and abbreviations as given in the present document are either externally created and included here, or created internally within oneM2M by the oneM2M TP or its working groups, whenever the need for precise vocabulary is identified or imported from existing documentation. In addition in oneM2M Technical Specifications and Technical Reports there are also clauses dedicated for locally unique definitions and abbreviations. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 2 References | |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 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 at https://docbox.etsi.org/Reference/. 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. Not applicable. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 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 are not necessary for the application of the present document but they assist the user with regard to a particular subject area. [i.1] Recommendation ITU-T X.800 (1991): "Security architecture for open system interconnection for CCIT applications". [i.2] Recommendation ITU-T X.800/Amd.1 (1996): "Security architecture for open systems interconnection for CCITT applications. Amendment 1: Layer Two Security Service and Mechanisms for LANs". [i.3] ISO/IEC 27001 (2005): "Information technology - Security techniques - Information security management systems - Requirements". ETSI ETSI TS 118 111 V4.1.1 (2023-09) 7 oneM2M TS-0011 version 4.1.1 Release 4 [i.4] ISO/IEC 27002 (2005): "Information technology - Security techniques - Code of practice for information security management". [i.5] IETF RFC 4949 (2007): "Internet Security Glossary, Version 2". [i.6] NIST SP800-57 Part 1 (07/2012): "Recommendation for Key Management - General, Rev3". [i.7] NIST SP800-57 Part 1 (05/2011): "Recommendation for Key Management - General, Rev3". [i.8] ISO/IEC 13888-1 (07/2009 - 3rd edition) Information technology - Security techniques - Non-repudiation - Part 1: General". [i.9] ISO/IEC 24760-1 (12/2011 - 1st edition): "Information technology - Security techniques - A framework for identity management - Part 1: terminology and concepts". [i.10] ISO/IEC 27004 (12/2009 - 1st edition): "Information technology - Security techniques - Information security management - Measurement". [i.11] ISO/IEC 9798-1 (07/2010 - 3rd edition): "Information technology - Security techniques - Entity authentication -. Part 1: General". [i.12] ISO/IEC TR 15443-1:2012: "Information technology - Security techniques - Security assurance framework - Part 1: Introduction and concepts". [i.13] IEEE 802.15.4TM-2003: "IEEE Standard for Local and metropolitan area networks - Part 15.4: Low-Rate Wireless Personal Area Networks (LR-WPANs)". [i.14] OMA OMA-TS-LightweightM2M-V1-0-20141111-D: "Lightweight Machine to Machine Technical Specification". |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3 Definitions | |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.0 General Information | NOTE 1: Whenever in the present document a term "M2M Xyz" (e.g. M2M Application, M2M Solution, etc.) is used, then the prefix "M2M" should indicate that - unless otherwise indicated - the term identifies an entity Xyz that complies with oneM2M specifications. NOTE 2: For better readability of the present document the prefix "M2M" is ignored when definitions are alphabetically ordered. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.1 0-9 | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.2 A | Abstract Information Model: Information Model of common functionalities abstracted from a set of Device Information Models Abstraction: process of mapping between a set of Device Information Models and an Abstract Information Model according to a specified set of rules Access Control Attributes: set of parameters of the originator, target resource, and environment against which there could be rules evaluated to control access NOTE: An example of Access Control Attributes of originator is a role. Examples of Access Control Attributes of Environment are time, day and IP address. An example of Access Control Attributes of targeted resource is creation time. ETSI ETSI TS 118 111 V4.1.1 (2023-09) 8 oneM2M TS-0011 version 4.1.1 Release 4 Access Control Policy: set of privileges which represents access control rules defining allowed entities for certain operations within specified contexts that each entity has to comply with to grant access to an object Access Control Role: security attribute associated to an entity defining the entity's access rights or limitations to allowed operations NOTE: One or more operations can be associated to an Access Control Role. An Access Control Role can be associated to one or more entities and an entity can assume one or more Access Control Roles. Access Decision: authorization reached when an entity's Privileges are evaluated Analytics: processing which makes use of data to provide actions, insights and/or inference M2M Application: applications that run the service logic and use M2M Common Services accessible via a set of oneM2M specified open interfaces NOTE: Specification of M2M Applications is not subject of the current oneM2M specifications. Application Dedicated Node: contains at least one Application Entity and does not contain a Common Services Entity NOTE: There may be zero or more ADNs in the Field Domain of the oneM2M System. EXAMPLE: Physical mapping: an Application Dedicated Node could reside in a constrained M2M Device. Application Entity: represents an instantiation of Application logic for end-to-end M2M solutions M2M Application Infrastructure: equipment (e.g. a set of physical servers of the M2M Application Service Provider) that manages data and executes coordination functions of M2M Application Services NOTE: The Application Infrastructure hosts one or more M2M Applications. Specification of Application Infrastructure is not subject of the current oneM2M specifications. Application (App) Registrants: entities seeking to obtain a registered App-ID M2M App-ID Registration Authority (ARA): legal entity that manages/administers the App-ID database used to issue unique global identifiers consistent with oneM2M specifications M2M Application Service: realized through the service logic of an M2M Application and is operated by the User or an M2M Application Service Provider Application Service Node (ASN): contains one Common Services Entity and contains at least one Application Entity NOTE: There may be zero or more ASNs in the Field Domain of the oneM2M System. EXAMPLE: Physical mapping: an Application Service Node could reside in an M2M Device. M2M Application Service Provider: entity (e.g. a company) that provides M2M Application Services to the User M2M Area Network: form of an Underlying Network that minimally provides data transport services among M2M Gateway(s), M2M Device(s), and Sensing&Actuation Equipment NOTE 1: M2M Local Area Networks can use heterogeneous network technologies that may or may not support IP access. NOTE 2: An M2M Area Network technology is characterized by its physical properties (e.g. IEEE 802.15.4-2003 [i.13] 2_4GHz), its communication protocol and potentially a profile. Authentication [i.7]: process that establishes the source of information, or determines an entity's identity Authorization [i.1]: granting of rights, which includes the granting of access based on access rights |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.3 B | Void. ETSI ETSI TS 118 111 V4.1.1 (2023-09) 9 oneM2M TS-0011 version 4.1.1 Release 4 |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.4 C | M2M Common Services: set of oneM2M specified functionalities that are widely applicable to different application domains made available through the set of oneM2M specified interfaces Common Services Entity (CSE): represents an instantiation of a set of Common Service Functions of the M2M environments. Such service functions are exposed to other entities through reference points Common Services Function (CSF): informative architectural construct which conceptually groups together a number of sub-functions NOTE: Those sub-functions are implemented as normative resources and procedures. A set of CSFs is contained in the CSE. Confidentiality [i.1]: property that information is not made available or disclosed to unauthorized individuals, entities, or processes Content Sharing Resource: resource of specific type that contains application data to be shared across applications Credentials: secure data which are used to uniquely identify an entity and which are used in security procedures NOTE: Credentials are a typical kind of sensitive data. Credential-ID: globally unique identifier for a credential that was used to establish a Security Association between entities (CSEs and/or AEs) NOTE: The Credential-ID can be used to determine the identifying information about the authenticated entity, such as the CSE-ID or AE-ID(s) or App-ID(s). |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.5 D | Data: in the context of oneM2M the term "Data" signifies digital representations of anything NOTE: Data can or cannot be interpreted by the oneM2M System and/or by M2M Applications. See also Information. M2M Device: physical equipment with communication capabilities, providing computing and/or sensing and/or actuation services NOTE: An M2M Device hosts one or more M2M Applications or other applications and can contain implementations of CSE functionalities. EXAMPLE: Physical mapping: A M2M Device contains an Application Service Node or an Application Dedicated Node. Device Information Model: Information Model of the native protocol for the physical device Direct Dynamic Authorization: procedure in which a Hosting CSE interacts directly with a Dynamic Authorization System Server to obtain Dynamic Authorization Dynamic Authorization: procedures for dynamically authorizing additional access to resources on a Hosting CSE without changing the <accessControlPolicy> resources configured to the Hosting CSE Dynamic Authorization System (DAS): technology, external to oneM2M, which enables Dynamic Authorization Dynamic Authorization System Server: server configured with policies for Dynamic Authorization, and provided with credentials for issuing Tokens Dynamic Device/Gateway Context: dynamic metrics, which may impact the M2M operations of M2M Devices/Gateways ETSI ETSI TS 118 111 V4.1.1 (2023-09) 10 oneM2M TS-0011 version 4.1.1 Release 4 |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.6 E | Edge/Fog Deployment: oneM2M System that can be deployed as a hierarchical collection of oneM2M nodes capable of supporting the following types of functionality: • Dynamic instantiation/installation (i.e. orchestration) of oneM2M Services (i.e. CSEs, CSFs, CSs and AEs) onto the nodes in the oneM2M System in an automated and coordinated fashion such that operational requirements of the oneM2M system are satisfied. • Remote provisioning and configuration of oneM2M Services installed on oneM2M nodes (e.g. configure IDs, credentials, settings, etc.). • Management and control of oneM2M services installed on oneM2M nodes (e.g. activate, deactivate, reset, etc.). • Collection of operational status and statistics (e.g. KPIs) of oneM2M Services running on oneM2M nodes. • Discovery of oneM2M Service capability information for the individual nodes in the oneM2M System. • Management of oneM2M Service continuity and migration across the nodes in the oneM2M System. • Dynamic de-installation/removal (de-orchestration) of oneM2M Services from the individual nodes in the oneM2M System such that node and network resources (e.g. compute, storage, memory, bandwidth, etc.) can be freed up and made available for use by other services. Edge/Fog Node: oneM2M field node (i.e. MN, ASN or ADN) that can be deployed in a manner consistent with the definition of an Edge/Fog Deployment. Edge/Fog Management Functionality: functionality that enables the deployment and management of oneM2M Services (i.e. CSEs, CSFs, CSs and AEs) on Edge/Fog Nodes in a manner consistent with the definition of Edge/Fog Deployment Edge/Fog Service: CSE, CSF(s), CS(s) and/or AE(s) hosted on a Edge/Fog Node managed in a manner consistent with the definition of Edge/Fog Deployment Encryption [i.6]: process of changing plaintext into ciphertext using a cryptographic algorithm and Key End-to-End Certificate-based Key Establishment (E2EKey): interoperable framework for two end-points to use certificates for establishing symmetric keys for use in End-to-End Security of Data or End-to-End Security of Primitives End-to-End Certificate-based Key Establishment Initiating End-Point: AE or CSE initiating the End-to-End Certificate-based Key Establishment procedure End-to-End Certificate-based Key Establishment Terminating End-Point: AE or CSE with which an End-to-End Certificate-based Key Establishment Initiating End-Point intends to establish a symmetric key using End-to-End Certificate-based Key Establishment procedure End-to-End Security of Data (ESData): interoperable framework for protecting data that ends up transported using oneM2M reference points, in order that so transited CSEs do not need to be trusted with that data End-to-End Security of Primitives (ESPrim): interoperable framework for securing oneM2M primitives so CSEs (forwarding the primitive) do not need to be trusted with the confidentiality and integrity of the primitives Event: interaction or occurrence related to and detected by the oneM2M System Event Categories: set of indicators that specify the treatment of Events for differentiated handling, based on policies |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.7 F | Field Domain: consists of M2M Devices, M2M Gateways, Sensing and Actuation (S&A) Equipment and M2M Area Networks ETSI ETSI TS 118 111 V4.1.1 (2023-09) 11 oneM2M TS-0011 version 4.1.1 Release 4 |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.8 G | M2M Gateway: physical equipment that includes, at minimum, the entities and APIs of a Middle Node Geo-fence: virtual perimeter for real-time geographical area to detect whether an object is entering into or leaving from |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.9 H | Heterogeneous Identification Service: service that supports various identification systems, and allows the mapping between identifiers, and the retrieval of the identification schema information |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.10 I | Identification [i.9]: process of recognizing an entity in a particular domain as distinct from other entities NOTE 1: The process of identification applies verification to claimed or observed attributes. NOTE 2: Identification typically is part of the interactions between an entity and the services in a domain and to access resources. Identification may occur multiple times while the entity is known in the domain. Identification System: set of self-consistent rules sufficient for generating and using identifiers: • a relevant authority is responsible for the generation, assignment and management of the identifiers • an identifier is unique in one identification system Implementation: the instantiation of devices, gateways, platforms, cloud servers, modules, software packages, development kits or all other kinds of entities developed to comply to oneM2M specification Indirect Dynamic Authorization: procedure in which an Originator obtains Dynamic Authorization from a Dynamic Authorization System Server, and provides the Hosting CSE with a Token or Token-ID representing that Dynamic Authorization Information: in the context of oneM2M "Information"signifies data that can be interpreted by the oneM2M System NOTE: Information has a defined syntax and semantic within the oneM2M System. See also Data. Information Model: abstract, formal representation of entities that may include their properties, relationships and the operations that can be performed on them Infrastructure Domain: consists of Application Infrastructure and M2M Service Infrastructure Infrastructure Node (IN): contains one Common Services Entity and contains zero or more Application Entities NOTE: There is exactly one Infrastructure Node in the Infrastructure Domain per oneM2M Service Provider. EXAMPLE: Physical mapping: an Infrastructure Node could reside in an M2M Service Infrastructure. Inner Primitive: oneM2M Primitive being secured by End-to-End Security for Primitives Integrity [i.3], [i.4]: safeguarding the accuracy and completeness of information and processing methods Interworking Proxy Application Entity (IPE): specialized AE that facititates interworking between Non-oneM2M Nodes (NoDN) and the oneM2M System. An IPE maps data of the NoDN into oneM2M resources NOTE: It invokes operations in the NoDN when the related oneM2M resources are modified and modifies oneM2M resources based on the output of NoDN operations. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.11 J | Void. ETSI ETSI TS 118 111 V4.1.1 (2023-09) 12 oneM2M TS-0011 version 4.1.1 Release 4 |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.12 K | Key [i.6]: parameter used in conjunction with a cryptographic algorithm that determines its operation in such a way that an entity with knowledge of the Key can reproduce or reverse the operation, while an entity without knowledge of the Key cannot |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.13 L | LWM2M Client [i.14]: application that manages and controls things that are represented as LWM2M objects LWM2M Client Endpoint Name [i.14]: identifier for a LWM2M Client LWM2M Object [i.14]: LWM2M representation of a thing. LWM2M Objects are identified through a URI LWM2M Server [i.14]: application that manages and controls LWM2M Clients |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.14 M | Management Authority (MA): legal entity that will supervise the issuance of unique global App-IDs under given Authority IDs, and potentially contract with an organization that will issue such unique global identifiers Middle Node (MN): contains one Common Services Entity and contains zero or more Application Entities NOTE 1: There may be zero or more Middle Nodes in the Field Domain of the oneM2M System. NOTE 2: The CSE in a Middle Node communicates with one CSE residing in a Middle Node or in an Infrastructure Node and with one or more other CSEs residing in Middle Nodes or in Application Service Nodes. In addition, the CSE in the Middle Node can communicate with AEs residing in the same MN or residing in an ADN. EXAMPLE: Physical mapping: a Middle Node could reside in an M2M Gateway. Mutual Authentication [i.11]: entity authentication that provides both entities with assurance of each other's identity |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.15 N | Network Operator: entity (e.g. a company) that operates an Underlying Network Node: logical entity that is identifiable in the oneM2M System |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.16 O | oneM2M Feature: oneM2M-defined procedure used for the instantiation of a M2M Common Service, which may not be further decomposed/divided, used for the purpose of testing and certification oneM2M Feature Set: collection of oneM2M Features that jointly need to be supported by M2M Common Service, used for the purpose of testing and certification oneM2M System: system developed by the oneM2M global initiative that enables deployable M2M Solutions Outer Primitive: primitive used to transport an Inner Primitive secured using End-to-End Security of Primitives |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.17 P | Privacy [i.2]: right of individuals to control or influence what information related to them may be collected and stored and by whom and to whom that information may be disclosed Privilege: qualification given to an entity that allows a specific operation (e.g. Create/Retreive/Update/Delete, etc.) on a specific resource within a specified context ETSI ETSI TS 118 111 V4.1.1 (2023-09) 13 oneM2M TS-0011 version 4.1.1 Release 4 Product Profile: defined by a collection of Features or Feature Sets that need to be supported by a oneM2M Implementation for the purpose of testing and certification |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.18 Q | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.19 R | Registrar: legal entities that will directly interface with App Developers seeking App-IDs and can assign unique IDs Remote Security Provisioning: process of providing a credential into a secure environment of a Node deployed in the field Repudiation: denial by an entity of a claimed event or action NOTE: This definition applies to the security context only. Role-Based Access Control [i.3] (RBAC): permissions attributed to an Access Control Role granting access to an object |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.20 S | Secure [i.12]: not vulnerable to most attacks, are able to tolerate many of the attacks that they are vulnerable to, and that can recover quickly with a minimum of damage from the few attacks that successfully exploit their vulnerabilities Security [i.5]: system condition that results from the establishment and maintenance of measures to protect the system Security Association: set of shared security attributes necessary to perform secure communication between two entities (CSEs and/or AEs) which have performed Mutual Authentication NOTE: The security attributes include a description of the algorithms to be applied, and derived keys which are applied for the lifetime of the security association. Security Association Establishment: procedure for establishing a Security Association between two entities (CSEs and/or AEs) Security Pre-Provisioning: process of providing a credential into a secure environment of the Node prior to device deployment, e.g. during manufacturing Security Provisioning: process of configuring a credential into a secure environment of a Node to enable access to a service provided by a target entity, such as communication services or M2M Services NOTE: This involves putting in the device and target entity the security Credentials that will be used for Mutual Authentication. Sensing and Actuation (S&A) Equipment: equipment that provides functionality for sensing and/or influencing the physical environment by interacting with one or more M2M Application Services NOTE: Sensing and Actuation Equipment can interact with the oneM2M System, however does not host an M2M Application. The specification of S&A Equipment is not considered in the current oneM2M specifications. S&A Equipment may, but does not need to, be co-located with an M2M Device. Sensitive Data: classification of stakeholder's data that is likely to cause its owner some adverse impact if either: • It becomes known to others when not intended. • It is modified without consent of the affected stakeholder. M2M Service: consists of one or more M2M Application Services and one or more M2M Common Services M2M Service Administrative State of a M2M Device: indicates whether the M2M Service is enabled by the M2M Service Provider to be run for this device ETSI ETSI TS 118 111 V4.1.1 (2023-09) 14 oneM2M TS-0011 version 4.1.1 Release 4 M2M Service Infrastructure: physical equipment (e.g. a set of physical servers) that provides management of data and coordination capabilities for the M2M Service Provider and communicates with M2M Devices NOTE: An M2M Service Infrastructure may communicate with other M2M Service Infrastructures. An M2M Service Infrastructure contains a CSE. It can also contain M2M applications. M2M Service Operational Status of a M2M Device: indicates whether the M2M Service is currently running for this device M2M Service Provider: entity (e.g. a company) that provides M2M Common Services to a M2M Service Subscriber M2M Service Subscriber: M2M Stakeholder that subscribes to a M2M Service Provider to consume its M2M Service(s) M2M Service Subscription: agreement between a M2M Service Provider and a M2M Service Subscriber for consumption of M2M Services for a period of time NOTE: An M2M Service Subscription is typically a commercial agreement. M2M Service User: entity authorized by a M2M Service Subscriber to use M2M Services M2M Session: service layer communication relationship between endpoints managed via M2M Common Services consisting of session authentication, connection establishment/termination, transmission of information and establishment/termination of Underlying Network services M2M Solution: set of deployed systems satisfying all of the following criteria: 1) it satisfies the end-to-end M2M communication requirements of particular entities; and 2) some part of the M2M Solution is realized by including services compliant to oneM2M specifications. Static Device/Gateway Context: static metrics, which may impact the M2M operations of M2M Devices/Gateways M2M Stakeholder: entities who facilitate and/or participate in the legitimate operation of the oneM2M system NOTE: Examples of stakeholders, in alphabetical order, are: M2M Application Service Provider; Manufacturer of M2M Devices and/or M2M Gateways; Manufacturer of oneM2M system and its components; M2M Device/Gateway Management entities; M2M Service Provider; Network Operator; M2M Service Subscribers; M2M Service Users; etc. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.21 T | Time Series Data: sequence of data points which typically consist of successive measurements made over a time interval Thing: element which is individually identifiable in the oneM2M system Trust [i.8]: relationship between two elements, a set of activities and a security policy in which element x trusts element y if and only if x has confidence that y will behave in a well defined way (with respect to the activities) that does not violate the given security policy ETSI ETSI TS 118 111 V4.1.1 (2023-09) 15 oneM2M TS-0011 version 4.1.1 Release 4 |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.22 U | Underlying Network: functions, networks, busses and other technology assisting in data transportconnectivity services |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.23 V | Verification [i.10]: confirmation, through the provision of objective evidence, that specified requirements have been fulfilled Virtual Device: logical device (implemented as software) that acts similar to physical M2M Device and provides derived data EXAMPLE: Average temperature of a room, number of vehicles that passed during the last minute. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.24 W | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.25 X | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.26 Y | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 3.27 Z | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4 Abbreviations | |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.1 0-9 | 3GPP 3rd Generation Partnership Project |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.2 A | ACL Access Control List ADN Application Dedicated Node AE Application Entity API Application Programming Interface AR Application Registrants ARA M2M App-ID Registration Authority ASN Application Service Node |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.3 B | BBF Broadband Forum ETSI ETSI TS 118 111 V4.1.1 (2023-09) 16 oneM2M TS-0011 version 4.1.1 Release 4 |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.4 C | CHA Continua Health Alliance CPU Centralized Processing Unit CSE Common Services Entity CSF Common Services Function |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.5 D | DAS Dynamic Authorization System DM Device Management |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.6 E | E2EKey End-to-End Certificate-based Key Establishment ESData End-to-End Security of Data ESPrim End-to-End Security of Primitives |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.7 F | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.8 G | GBA Generic Bootstrapping Architecture GSM Global System for Mobile communications GSMA GSM Association |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.9 H | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.10 I | IN Infrastructure Node IP Internet Protocol IPE Interworking Proxy application Entity |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.11 J | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.12 K | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.13 L | LWM2M Lightweight M2M. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.14 M | M2M Machine to Machine ETSI ETSI TS 118 111 V4.1.1 (2023-09) 17 oneM2M TS-0011 version 4.1.1 Release 4 MA Management Authority MN Middle Node MSISDN Mobile Subscriber Integrated Services Digital Network-Number MTC Machine Type Communications |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.15 N | NSE Network Service Entity |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.16 O | OMA Open Mobile Alliance |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.17 P | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.18 Q | QoS Quality of Service |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.19 R | RBAC Role-Based Access Control |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.20 S | S&A Sensing and Actuation SDO Standards Developing Organization SMS Short Message Service |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.21 T | TR Technical Report TS Technical Specification |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.22 U | UICC Universal Integrated Circuit Card USIM Universal Subscriber Identity Module USSD Unstructured Supplementary Service Data URI Universal Resource Identifier |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.23 V | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.24 W | WAN Wide Area Network ETSI ETSI TS 118 111 V4.1.1 (2023-09) 18 oneM2M TS-0011 version 4.1.1 Release 4 |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.25 X | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.26 Y | Void. |
ce0ee797d91e3a8edf7731f55acfd586 | 118 111 | 4.27 Z | Void. ETSI ETSI TS 118 111 V4.1.1 (2023-09) 19 oneM2M TS-0011 version 4.1.1 Release 4 Annex A (informative): Bibliography • oneM2M TR-0005: "Roles and Focus Areas". ETSI ETSI TS 118 111 V4.1.1 (2023-09) 20 oneM2M TS-0011 version 4.1.1 Release 4 History Document history V4.1.1 September 2023 Publication |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 1 Scope | The present document contains the Abstract Test Suite (ATS) for oneM2M as defined in ETSI TS 118 101 [1] and ETSI TS 118 104 [2] in compliance with the relevant requirements and in accordance with the relevant guidance given in ISO/IEC 9646-7 [5]. The objective of the present document is to provide a basis for conformance tests for oneM2M products giving a high probability of inter-operability between different manufacturers' equipment. The ISO standard for the methodology of conformance testing (ISO/IEC 9646-1 [3] and ISO/IEC 9646-2 [4]) as well as ETSI TS 118 115 [i.2] are used as a basis for the test methodology. |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 2 References | |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 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 at https://docbox.etsi.org/Reference/. 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] ISO/IEC 9646-1 (1994): "Information technology -- Open Systems Interconnection -- Conformance testing methodology and framework -- Part 1: General concepts". [4] ISO/IEC 9646-2 (1994): "Information technology -- Open Systems Interconnection -- Conformance testing methodology and framework -- Part 2: Abstract Test Suite specification". [5] ISO/IEC 9646-7 (1995): "Information technology -- Open Systems Interconnection -- Conformance testing methodology and framework -- Part 7: Implementation Conformance Statements". [6] ETSI ES 201 873-1 (V4.5.1): "Methods for Testing and Specification (MTS); The Testing and Test Control Notation version 3; Part 1: TTCN-3 Core Language". [7] oneM2M TS-0018: "Test Suite Structure and Test Purposes". ETSI ETSI TS 118 119 V2.3.0 (2020-11) 7 oneM2M TS-0019 version 2.3.0 Release 2 |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 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 are not necessary for the application of the present document but they assist the user with regard to a particular subject area. [i.1] oneM2M Drafting Rules. NOTE: Available at http://www.onem2m.org/images/files/oneM2M-Drafting-Rules.pdf. [i.2] ETSI TS 118 115: "oneM2M; Testing Framework (oneM2M TS-0015)". [i.3] ETSI TS 118 125: "Definition of product profiles (oneM2M TS-0025)". [i.4] ETSI TS 118 111: "oneM2M; Common Terminology (oneM2M TS-0011)". |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 3 Definition of terms, symbols and abbreviations | |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 3.1 Terms | For the purposes of the present document, the terms given in ISO/IEC 9646-1 [3], ISO/IEC 9646-7 [5] and ETSI TS 118 115 [i.2] apply. |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 3.2 Symbols | Void. |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 3.3 Abbreviations | For the purposes of the present document, the abbreviations given in ETSI TS 118 111 [i.4] and the following apply: AE Application Entity APT Abstract Protocol Tester ATM Abstract Test Method ATS Abstract Test Suite CoAP Constrained Application Protocol CSE Common Service Entity HTTP HyperText Transfer Protocol IP Internet Protocol IUT Implementation Under Test IXIT Implementation eXtra Information for Test JSON JavaScript Object Notation MQTT Message Queuing Telemetry Transport MTC Main Test Component PA Platform Adaptor PICS Protocol Implementation Conformance Statement PTC Paralell Test Component PX PiXit SA System Adaptor SUT System Under Test TC Test Case TCP Transmission Control Protocol ETSI ETSI TS 118 119 V2.3.0 (2020-11) 8 oneM2M TS-0019 version 2.3.0 Release 2 TP Test Purposes TSS Test Suite Structure TTCN Tree and Tabular Combined Notation UDP User Datagram Protocol UT Upper Tester XML eXtensible Markup Language |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 4 Conventions | The key words "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]. |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5 Abstract Test Method (ATM) | |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.1 Abstract protocol tester | An abstract Protocol Tester (APT) is a process that provides behaviours for testing an IUT by emulating a peer IUT at the same layer, and enabling to address a single test objective. APTs used by the oneM2M test suite are described in figure 5.1-1. The test system will simulate valid and invalid protocol behaviour, and will analyse the reaction of the IUT. Figure 5.1-1: Abstract protocol testers - oneM2M As figure 5.1-1 illustrates, the corresponding ATS needs to use lower layers to establish a proper connection to the System Under Test (SUT) over a physical link (Lower layers link). Three different lower layers have been specified corresponding to the binding protocols considered in oneM2M: HTTP, CoAP and MQTT. |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.2 Test Configuration | |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.2.1 AE Test Configuration | Test configurations are defined to test different entities such as CSE and AE, etc. ETSI ETSI TS 118 119 V2.3.0 (2020-11) 9 oneM2M TS-0019 version 2.3.0 Release 2 Figure 5.2.1-1 shows a AE test configuration which is mapped to CF03 in clause 6.3.3.3 in ETSI TS 118 115 [i.2] and aligns with conformance test system architecture in clause 6.3.3.2 in ETSI TS 118 115 [i.2]. The TTCN-3 Test Component in Test System sends triggering actions or behaviour to the Upper Tester Application of SUT through upper tester transport link Ut while the IUT sends/receives oneM2M service primitives through Mca to/from CSE in Test System. Figure 5.2.1-1: AE test configuration |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.3 Test architecture | The approach for the implementation of an Abstract Protocol Tester selected in oneM2M follows the recommendation of the oneM2M Testing Framework (ETSI TS 118 115 [i.2]) where the TTCN-3 language and its architecture are recommended. Following this recommendation the oneM2M tester architecture comprises a non-platform dependent Test Suite, and a platform dependent part. NOTE: However, it can be implemented in a semi-independent manner, which will minimize the dependency to those elements. Figure 5.3-1: High level oneM2M Test Architecture • oneM2M TTCN-3 Abstract Test Suite: the test suite is platform independent, and it is the cornerstone of the architecture. It allows a complete decoupling between the test suite and the rest of the test system. The test suite is composed of a complete set of test cases covering oneM2M requirements specified by ETSI TS 118 101 [1] and ETSI TS 118 104 [2]. • oneM2M System Adaptor: this is the platform dependent part that includes adaptors and codecs (out of the scope of the present document). This part of the architecture definition depends on the specific platform (e.g. Windows® or Linux®) and test tool on which the tester is going to run. Mca SUT TEST SYSTEM TTCN-3 Test Component IUT (AE) CSE Ut Upper Tester Application ETSI ETSI TS 118 119 V2.3.0 (2020-11) 10 oneM2M TS-0019 version 2.3.0 Release 2 Figure 5.3-2 shows the oneM2M TTCN-3 test architecture design used for the oneM2M ATS. The Test Suite needs to interact with the System Adaptor to implement the collection of TTCN-3 test cases that are intended to be used to test the oneM2M IUTs. The oneM2M TTCN-3 test cases implement the test algorithms specified in the TSS&TP document (oneM2M TS-0018 [7]), including verdict logic that allows pass/fail diagnosis. The test algorithms use the interfaces defined in ETSI TS 118 101 [1] and ETSI TS 118 104 [2] (mca, mcc) in order to: 1) control the test event to be sent towards the IUT; and 2) observe the test events received from the IUT. In TTCN-3 these two interfaces have been implemented through a set of logical TTCN-3 ports (mcaPort and mcaPortIn for mca interface, and mccPort and mccPortIn for mcc interface) which allows oneM2M message primitives exchange with the IUT. Figure 5.3-2: oneM2M Test Architecture The oneM2M primitive messages have been mapped into TTCN-3 structure. Through this mapping, the TTCN-3 is able to build and send these messages, as well as receive them via the ports defined above. Additionally, the test cases are able to control and configure the test platform through a dedicated port called acPort while port utPort enables oneM2M TTCN-3 Test Component module to trigger specific action or behaviour on IUT. TTCN-3 Test Components can also exchange information through a dedicated port called infoPort. ETSI ETSI TS 118 119 V2.3.0 (2020-11) 11 oneM2M TS-0019 version 2.3.0 Release 2 To build up a tester, the test platform needs to be also developed (out of scope). This test platform is composed of three adaptation layers: • PA (Platform Adaptor) layer functionality implements the communication between the TTCN-3 modules and external elements that constitute the test tool such as timers and external functions. The External functions are a powerful resources supported by TTCN-3 language. An External function is a function declared at the TTCN-3 level but implemented at the native level. • SA (System Adaptor) layer functionality is divided into two modules: - oneM2M lower layers stack module implements the communication with the IUT and carries out the oneM2M primitives messages sent to or received from the IUT. This module is based on TCP or UDP depending on the binding supported by the IUT. The binding is a system adaptor parameter. - Upper Tester Transport module implements functions that enable triggering specific actions or behaviour on the IUT. • CODECS layer is the part of the tester to encode and decode messages between the TTCN-3 abstract internal data representation and the format required by the related base standard which the IUT understands. Several CODECS are required in oneM2M tester to cope with the bindings considered in oneM2M (HTTP, CoAP, MQTT) and the serialization methods (xml, json). |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4 Ports and ASPs (Abstract Services Primitives) | |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4.0 Introduction | The oneM2M ATS implements the following ports: • The mcaPort and mcaPortIn. • The mccPort and mccPortIn. • The acPort. • The utPort. • The InfoPort. |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4.1 mcaPort, mcaPortIn, mccPort, mccPortIn | These ports are used to send and receive the following message sets: • Request Primitives messages in accordance with ETSI TS 118 104 [2]. • Response Primitives messages in accordance with ETSI TS 118 104 [2]. Two primitives are currently defined for these ports indicated in table 5.4.1-1: 1) The M2MRequestPrimitive - to send or receive oneM2M messages to/from the IUT. Depending on the IUT to be tested: a) If the IUT is an AE, these messages are either received or sent by the tester which is associated with the CSE role through the mcaPortIn or the mcaPort respectively. b) If the IUT is a CSE, these messages are either sent or received by the tester when it plays the AE role through the mcaPort or the mcaPortIn respectively, or sent or received by the tester when it plays the CSE role through the mccPort or the mccPortIn respectively. 2) The M2MResponsePrimitive - to send or receive oneM2M messages to/from the IUT. Depending on the IUT to be tested: a) If the IUT is an AE, these messages are either sent or received by the tester which is associated with the CSE role through the mcaPortIn or the mcaPort respectively. ETSI ETSI TS 118 119 V2.3.0 (2020-11) 12 oneM2M TS-0019 version 2.3.0 Release 2 b) If the IUT is a CSE, these messages are either sent or received by the tester when it plays the CSE role through the mccPortIn or the mccPort respectively, sent or received by the tester when it plays the AE role through the mcaPortIn or mcaPort respectively. Both primitives contain another parameters that permits to dynamically configure the test adaptor for every single sending. These parameters are: • Host: IP address of the IUT. • XML Namespace. • Protocol binding. • Serialization. • ForceFields: used to force invalid or empty values to certain attributes. This behaviour shall be implemented by the System Adaptor. Table 5.4.1-1: Mapping of TTCN-3 Primitives to oneM2M Service Primitives TTCN-3 Primitive oneM2M Message Direction IUT M2MRequestPrimitive Request Primitive AE Request Primitive CSE M2MResponsePrimitive Response Primitive AE Response Primitive CSE |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4.2 utPort | |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4.2.0 Introduction | The utPort is included in the oneM2M ATS in order to be able to stimulate the IUT and receive extra information from IUT upper layers. For instance, the utPort can be applied to automate AE testing shown in clause 5.4.2.1. |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4.2.1 Usage for Automated AE Testing | The utPort is in charge of the communication between TTCN-3 Test Component module in Test System and the Upper Tester Application in SUT. Functionalities that TTCN-3 Test Component module and the Upper Tester Application are required to implement are listed as follows: • TTCN-3 Test Component is able to configure the Test System and send standardized triggering commands to the SUT (Upper Tester Application). • Upper Tester Application can process the triggering command messages received from Test System (TTCN-3 Test Component) and stimulates IUT to act following the corresponding triggering command (i.e. sending oneM2M service primitives to Test System through Mca port). oneM2M service Primitive defined for utPort is listed as follows: • The UtTrigger primitive is used to trigger upper layer events in IUT (i.e. sending oneM2M service primitives to Test System through Mca port). • The UtTriggerAck primitive is used by IUT to send acknowledgement back to the Test System. The Upper Tester Application in SUT can be implemented as an embedded source code. An example for implementation of automated AE test for Registration is shown as figure 5.4.2.1-1. ETSI ETSI TS 118 119 V2.3.0 (2020-11) 13 oneM2M TS-0019 version 2.3.0 Release 2 Figure 5.4.2.1-1: Example of automated AE test using Ut interface |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4.2.2 Upper Tester Control Primitives | |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4.2.2.1 Introduction | The upper tester triggering message is used to transport control commands between Test System and the Upper Tester Application. The control command will contain essential parameters that are required for certain test case. The upper tester triggering message type maps to particular message formats for exchanging data and those message formats are defined by TTCN-3 primitive as shown in table 5.4.2.2.1-1, UtTrigger and UtTriggerAck primitive. Table 5.4.2.2.1-1: Mapping of TTCN-3 Primitives to oneM2M Service Primitives Upper TesterControl Message Type TTCN-3 Primitives Direction TS UT Trigger UtTrigger Primitive Trigger Acknowledgement UtTriggerAck Primitive |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4.2.2.2 UtTrigger and UtTriggerAck Primitives | The UtTrigger primitive is initialized by the Test System to send triggering message to the target IUT as depicted in figure 5.4.2.2.2-1. The IUT will send acknowledgement message back to the Test System using UtTriggerAck primitive if trigger message is successfully transported to the IUT. Then IUT starts interaction with Test System through oneM2M request and response primitives. UT UT TS TS UtTrigger primitive UtTriggerAck primitive UT TS UtTrigger primitive UtTriggerAck primitive Figure 5.4.2.2.2-1: Trigger message flow Table 5.4.2.2.2-1 defines UtTrigger and UtTriggerAck primitives including oneM2M data types to which are mapped as well as examples to show how to implement UtTrigger and UtTriggerAck primitives. SUT TEST SYSTEM TTCN-3 Test Component CSE Upper Tester Application IUT (AE) Stimulate Registration Stimulate Container Create Registration Container Create Trigger Registration Function call utPort utPort mcaPort mcaPort Ut Mca ETSI ETSI TS 118 119 V2.3.0 (2020-11) 14 oneM2M TS-0019 version 2.3.0 Release 2 Table 5.4.2.2.2-1: UtTrigger and UtTriggerAck Primitive Ut Control Primitive Mapping to oneM2M data types Description Reference Triggering Message HTTP message UtTrigger Primitive request Primitive ONLY essential parameters included for certain test case See note 1 ETSI TS 118 104 [2] Example A: If the test objective is to test "Test System triggers IUT to execute a test case for creation of <AE> with labels attribute under a CSEBase resource", then the triggering message would be serialized as following. Request { "m2m:rqp" :{ "op": 1, //indicate CREATE operation "ty": 2, //indicate AE resource type "to": {TEST_SYSTEM_ADDRESS}, "pc": { "m2m:ae": { "lbl":"UNINITIALIZED" //indicate that attribute labels needs to be included }, } "rvi": "2a" } } Request POST /{SUT_UT_APPLICATION_URL} HTTP/1.1 Host: {SUT_IP_ADDRESS:PORT} Content-Length: {PAYLOAD_LENGTH} Content-Type: application/json { "m2m:rqp" :{ "op": 1, //indicate CREATE operation "ty": 2, //indicate AE resource type "to": {TEST_SYSTEM_ADDRESS}, "pc": { "m2m:ae": { "lbl":"UNINITIALIZED" //indicate that attribute labels needs to be included } }, "rvi": "2a" } } ETSI ETSI TS 118 119 V2.3.0 (2020-11) 15 oneM2M TS-0019 version 2.3.0 Release 2 Ut Control Primitive Mapping to oneM2M data types Description Reference Triggering Message HTTP message Example B: If the test objective is to test "Test System triggers IUT to execute a test case for delete of a <AE> resource.", then the triggering message would be serialized as following. Request { "m2m:rqp" :{ "op": 4, //indicate DELETE operation "to": {TARGET_AE_RESOURCE_ADDRESS}, //indicate Target AE resource address "rvi": "2a" } } Request POST /{SUT_UT_APPLICATION_URL} HTTP/1.1 Host: {SUT_IP_ADDRESS:PORT} Content-Length: {PAYLOAD_LENGTH} Content-Type: application/json { "m2m:rqp" :{ "op": 4, //indicate DELETE operation "to": {TARGET_AE_RESOURCE_ADDRESS}, //indicate Target AE resource address "rvi": "2a" } } UtTriggerAck Primitive responsePrimitive ONLY responseStatusCode attribute included See note 2 ETSI TS 118 104 [2] Response { "m2m:rsp": { "rsc": 2000 } } For any triggering response, it only contains a response status code, and the response status code for the triggering operation can only be set to either 2000 (OK) or 4000 (BAD_REQUEST) according to the rules for triggering operations. Response HTTP/1.1 200 OK X-M2M-RSC: 2000 NOTE 1: Additional rules defined in table 5.4.2.2.2-3 are also applied. NOTE 2: Attribute response status code is defined in table 5.4.2.2.2-3. ETSI ETSI TS 118 119 V2.3.0 (2020-11) 16 oneM2M TS-0019 version 2.3.0 Release 2 Table 5.4.2.2.2-2: Rules for defining UtTrigger and UtTriggerAck primitives ① UtTrigger primitive is represented in requestPrimitive serialized in JSON format. ② UtTrigger primitive shall be interpreted as follows: − Any attribute/parameter containing a value shall be present and equal in the triggered request primitive. − Any attribute/parameter containing "UNINITIALIZED" value shall be present in the triggered request primitive. − Any other attribute/parameter shall comply with ETSI TS 118 104 [2]. ③ Parameters within UtTrigger are listed as following: − operation: (mandatory)operation type that IUT is triggered to perform. − resourceType: (optional)resource type of a target resource against which IUT is triggered to perform certain operation. − to: (mandatory)target resource against which IUT is triggered to perform certain operation. − primitiveContent:(optional)represents the resource attributes that shall be included in the requestPrimitive. Table 5.4.2.2.2-3: Definition of ResponseStatusCode for UtTriggerAck primitive Response Status Code Description Response Status Code Value Interpretation OK 2000 The SUT receives successfully the triggering message from Test System BAD_REQUEST 4000 The SUT does not interpret correctly the UtTrigger primitive NOTE: Only above two response status codes are allowed to use in UtTriggerAck primitive. |
f215c66b432ed5d802cfdaafebadf0dc | 118 119 | 5.4.2.2.3 Control Communication Protocol | Protocol used for proceeding communications between TS and Upper Tester Application is designated to the Hypertext Transfer Protocol (HTTP) protocol owning it is an application protocol that is widely supported by most all IoT devices and various intrinsic features such as persistent connection, ease of programming, flexibility, etc. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.