hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.7 Universal and Common Properties for Device models | Universal and common properties are defined either as the specialized [objectAttribute]s of the [deviceInfo] resource in clause D.8 of ETSI TS 118 101 [i.3] when the Device model contains a nodeLink attribute that links to a <node> resource, or as specialized custom attributes of the [dmDeviceInfo] in clause 5.8.3 when the Device model contains a flexNodeLink attribute that links to a [flexNode] resource (see Rule 1-8 in clause 6.2.2). Some properties are mandatory for all device models and called "Universal Properties", since they are universally seen in typical device types and carry necessary information to identify each device instance. Others are optional for all device models and called "Common Properties", since they are commonly used in many device types but not always. Universal and common properties are applicable to all device models. They are not repeated in the property table of each device model in clause 5.5, where only device specific properties shall be specified. NOTE: The instantiated values of the universal properties might be empty in case of exceptional scenarios, e.g. interworking with non-oneM2M device models. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8 Device Management | |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.0 Introduction | The entities that are specified in this clause allow performing classical Device Management (DM) functions: rebooting a device, upgrading it, reading / setting its configuration, monitoring its logs, checking its memory or battery status, managing its firmware or its software modules, etc. They belong to the "management" domain. In the case of a NoDN, it is the IPE in charge of exposing the device to oneM2M that creates / implements these modules. It may rely on external Device Management techniques like e.g. LwM2M (from OMA) or USP (from BBF), or any other technique, proprietary or standardized, that allows performing at least some DM functions, for instance a reboot. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.1 flexNode | This flexContainer specialization is the root for SDT-based Device Management modules. The containerDefinition attribute of this specialization shall be "org.onem2m.management.device.flexNode". It is targeted by the flexNodeLink attribute of <flexContainer> SDT devices (see in clause 6.2.2 the rules 1-6, 1-7 and 1-8). Table 5.8.1-1: Child resources of [flexNode] resource Child Resources of [flexNode] Child Resource Type Multiplicity Description dmAreaNwkInfo_<i> [dmAreaNwkInfo] 0..n See clause 5.8.10 dmAgent [dmAgent] 0..1 See clause 5.8.2 dmDeviceInfo [dmDeviceInfo] 1 See clause 5.8.3 dmDataModelIO_<i> [dmDataModelIO] 0..N See clause 5.8.4 ETSI ETSI TS 118 123 V4.8.1 (2024-02) 95 oneM2M TS-0023 version 4.8.1 Release 4 Child Resources of [flexNode] Child Resource Type Multiplicity Description dmFirmware_<i> [dmFirmware] 1..N See clause 5.8.5 dmSoftware_<i> [dmSoftware] 0..N See clause 5.8.6 dmEventLog_<i> [dmEventLog] 0..N See clause 5.8.7 dmPackage_<i> [dmPackage] 0..N See clause 5.8.8 battery_<i> [battery] 0..N See clause 5.3.9 dmCapability_<i> [dmCapability] 0..N See clause 5.8.11 dmStorage_<i> [dmStorage] 0..N See clause 5.8.12 NOTE 1: The notation '_<i>' for child resources indicates that the resource name is the name of the child ModuleClass or SubDevice flexContainer, appended with an underscore '_' and an incrementing index so that it is unique in the [flexNode] children (e.g. "dmFirmware_0", "dmFirmware_1", etc.). The index shall not have leading 0's NOTE 2: The current list of modules for Device Management is not fixed and can evolve with new optional features. Table 5.8.1-2: Custom Attributes of [flexNode] resource Attributes of [flexNode] Multiplicity RW/ RO/ WO Description [flexNodeAnnc] attributes nodeID 1 RW The M2M-Node-ID of the node which is represented by this <flexNode> resource. hostedAELinks 0..1(L) RO This attribute allows to find the AEs that are represented by this [flexNode] resource, if any. The attribute shall contain a list of resource identifiers of <AE> resources representing the ADN-Aes that are represented by the current [flexNode] resource. OA hostedServiceLinks 0..1(L) RO This attribute allows to find SDT device <flexContainer> resources that have been created to represent services hosted on a device (ADN or NoDN proxied by an IPE), the device being represented by this [flexNode] resource. If the device hosts a set of services represented by SDT device <flexContainer>s, then the attribute shall contain the list of resource identifiers of these <flexContainer> resources. OA If the <flexContainer>(s) that are listed in the hostedServiceLinks attribute have a nodeLink attribute that points to a <node>, then: • if there are more than one such <flexContainer>, they shall all have the same nodeLink attribute value, and • this [flexNode] resource shall have a nodeLink attribute with the same value, and shall have the same nodeID attribute as this <node> resource. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.2 dmAgent | This ModuleClass is the entry point module of [flexNode]; it provides capabilities to control and monitor the Device Management of the device. Table 5.8.2-1: Actions of dmAgent ModuleClass Return Type Name Arguments Optional Description none reboot rebootType: hd:enumRebootType false Execute a reboot or a factory reset. M2MID deployPackage name: xs:string version: xs:string url: xs:url true Create a dmPackage. Return the ID of the created package. The deployPackage action allows creating a new [dmPackage] module class (see clause 5.8.9), child of this dmAgent's parent flexNode. The returned value is the ID of this created <flexContainer>. The created dmPackage is in NotInstalled state. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 96 oneM2M TS-0023 version 4.8.1 Release 4 The DataPoints of dmAgent Module Class are as follows: • 'state' represents the state of the agent for DM purposes (ready, sleeping, etc.). • some optional device properties which can be used for Device Management purpose. The dmAgent can be seen as a 'dashboard' that gathers common information such as battery level, memory or CPU usage, etc. Table 5.8.2-2: DataPoints of dmAgent ModuleClass Name Type R/W Optional Unit Description state hd:enumDmAgentState R false The current state of the agent (ready, error, etc.) storageAvailable xs:integer R true KB The size of available storage memory. storageTotal xs:integer R true KB The size of total storage memory. ramAvailable xs:integer R true KB The size of available RAM memory. ramTotal xs:integer R true KB Total size of the RAM memory. powerStatus hd:enumPowerState R true The status of the electrical power. cpuUsage xs:integer R true % Current CPU usage in percent. systemTime m2m:timestamp RW true Reference time for the device. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.3 dmDeviceInfo | This ModuleClass is used to share static information regarding the device. Table 5.8.3-1: DataPoints of dmDeviceInfo ModuleClass Name Type R/W Optional Unit Description serialNumber xs:string R true Unique device label assigned by the manufacturer. The value of the datapoint typically exposes the device's serial number that is specific to a manufacturer. manufacturer xs:string R true The name/identifier of the device manufacturer. manufacturerDetailsLink xs:anyURI RW true URL to manufacturer's website. manufacturingDate m2m:timestamp R true Manufacturing date of device. model xs:string R true The name/identifier of the device model assigned by the manufacturer. subModel xs:string R true Device sub-model name. hwVersion xs:string R true The hardware version / revision of the device. osVersion xs:string R true Version of the operating system (defined by manufacturer). country m2m:countryCode R true Country code of the device. It could be manufacturing country, deployment country or procurement country. supportURL xs:anyURI RW true URL that points to product support information of the device. presentationURL xs:anyURI RW true To quote UpnP: "the control point can retrieve a page from this URL, load the page into a web browser, and depending on the capabilities of the page, allow a user to control the device and/or view device status. The degree to which each of these can be accomplished depends on the specific capabilities of the presentation page and device". ETSI ETSI TS 118 123 V4.8.1 (2024-02) 97 oneM2M TS-0023 version 4.8.1 Release 4 Name Type R/W Optional Unit Description friendlyName xs:string RW true The device friendly name. description xs:string RW true A human readable description of the device (e.g. Alice's cell phone, kitchen's fridge, etc.). NOTE: Although all datapoints are optional, depending on the underlying DM technology, some datapoints should be filled, for instance serialNumber, manufacturer and model when this information is available. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.4 dmDataModelIO | This ModuleClass provides capabilities to handle the device's Data Model for cases where the underlying Device Management technology supports APIs that are not directly reflected in the flexNode modules. Table 5.8.4-1: Actions of dmDataModelIO ModuleClass Return Type Name Arguments Optional Description xs:string readIO address: xs:string true Read the current values of parameters. Argument: the list of the parameter names. Returns a JSON serialization of the parameters (see Rules 3-2 and 3-6 in clause 6.2.4). xs:string writeIO address: xs:string payload: xs:string true Update the current values of parameters. Arguments: 'address': the list of the parameter names, 'payload': the list of the parameter values. Returns the list of the modified parameter names. Table 5.8.4-2: DataPoints of dmDataModelIO ModuleClass Name Type R/W Optional Unit Description dataModelType hd:enumDataModelType R false The type of the data model (OMA DM, OMA LwM2M, BBF TR-181, etc.). The readIO and writeIO actions are defined for handling parameters of the underlying Device Management protocol using the APIs defined by those technologies. The values used in the address argument are dependent on the value of the dataModelType data point of the dmAgent module. Example of address values could be 'Device.WiFi.SSID.1' if dataModelType=6 (BBF TR-181 USP) or '/9/1/1' if dataModelType=4 (OMA LwM2M). These address and payload argument can contain several values separated by a comma ','. The payload argument's value types are the valid JSON primitive types (string, number, boolean, null). EXAMPLES: readIO(address="Device.WiFi.SSID.SSID") => {"Device.WiFi.SSID.SSID": "SSIDName"} readIO(address="/3/0/1,/3/0/2") => {"/3/0/1":"MyCompany","/3/0/2":"SN376575A86"} writeIO(address="Device.DeviceInfo.FriendlyName,Device.WiFi.SSID.SSID", payload="my device,my ssid"} => {"Device.DeviceInfo.FriendlyName,Device.WiFi.SSID.SSID"} writeIO(address="/3/0/15", payload="Europe/Paris") => {"/3/0/15"} NOTE: Some datapoints of the dmAgent and dmDeviceInfo moduleClasses correspond to fixed parameters in OMA & BBF data models. The corresponding concepts in OMA DM / LwM2M data models (resp. BBF TR-181 [i.12]) are specified in ETSI TS 118 105 [5] (resp. ETSI TS 118 106 [i.13]). For instance the datapoint memAvailable corresponds to 'Device.DeviceInfo.MemoryStatus.Free' in BBF TR-181 [i.12] (see ETSI TS 118 106 [i.13] clause 7.3) and to '/3/0/10' in LwM2M (ETSI TS 118 105 [5], clause 6.3.4). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 98 oneM2M TS-0023 version 4.8.1 Release 4 |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.5 dmFirmware | This ModuleClass provides Device Management capabilities to control and monitor the firmware of a device. The device can contain multiple components (a graphic card for instance) that can have individual firmwares, and they need to be managed separately. The [flexNode] allows one [dmFirmware] module per component plus one 'major' [dmFirmware] for the device itself. Individual firmwares are managed using the [dmFirmware] actions presented in Table 5.8.6-1. Table 5.8.5-1: Actions of dmFirmware ModuleClass Return Type Name Argument Optional Description xs:string updateFirmware url: xs:url version: xs:string true Downloads a new firmware to the device / sub-component. In case of devices that do support toggling between multiple preinstalled firmware versions it also starts the firmware flashing/installation process. The updateFirmware action as it results returns an AE/IPE message indicating if the action was successful or not. xs:string toggle none true Toggles between the firmware versions installed on a device/sub-component. In case of devices that do not support such toggling, it triggers the firmware flashing/installation process. The toggle action as it results returns an AE/IPE message indicating if the action was successful or not. The abstraction model used for [dmFirmware] manages the firmware through two images: a primary firmware image and a secondary one. Despite the naming both images are equivalent and a secondary image can be actively used by a device just like the primary one. Using an abstraction model based on two firmware images it is possible to effectively manage firmware on devices with different firmware capabilities. The state machine for firmware management using two images is shown in Figure 5.8.6-1 for devices that do support toggling between multiple preinstalled firmware versions and in Figure 5.8.6-2 for devices that can have only one firmware version installed. Table 5.8.5-2: DataPoints of dmFirmware ModuleClass Name Type R/W Optional Unit Description multiFirmware xs:boolean R false Indicates if the device/sub-component supports toggling between multiple preinstalled firmware versions. primaryState hd:enumFirmwareState R false The current state of the primary firmware image (active, downloading, etc.) primaryName xs:string R false The name of the primary firmware image. primaryVersion xs:string R false The version of the primary firmware image. primaryUrl xs:url R true The URL from which the primary firmware image was downloaded. secondaryState hd:enumFirmwareState R true The current state of the secondary firmware image (active, downloading, etc.). Mandatory when updateFirmware is available. secondaryName xs:string R true The name of the secondary firmware image. secondaryVersion xs:string R true The version of the secondary firmware image. secondaryUrl xs:url R true The URL from which the secondary firmware image was downloaded. component xs:string R true Allows to identify the sub-component that uses this firmware. This datapoint is mandatory if this is a sub-component firmware. NOTE 1: Both primary and secondary firmware image related dataPoints are mandatory when updateFirmware is available, however depending on the device capabilities one of the two state machines - the one presented in Figure 5.8.6-1 or the one shown in Figure 5.8.6-2 should be used. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 99 oneM2M TS-0023 version 4.8.1 Release 4 Figure 5.8.5-1: Lifecycle of a dmFirmware for devices that support toggling between preinstalled firmware images For devices that support toggling between multiple preinstalled firmware images the following rules apply: • There is always one firmware image that is in "Active" state. • Toggling between firmware images is only possible if one image is in "Ready" state and the other image is in "Active" state. • updateFirmware action is always performed on the image that is in "Ready" or "Failure" state. NOTE 2: It is the AE/IPE responsibility to provide the appropriate action result pointing if the action was triggered on the device or not (e.g. if the current firmware state did not allow it). Ready Installing Downloading Installing Downloading Ready Active PRIMARY SECONDARY T O G G L E Active Failure Failure ETSI ETSI TS 118 123 V4.8.1 (2024-02) 100 oneM2M TS-0023 version 4.8.1 Release 4 Figure 5.8.5-2: Lifecycle of a dmFirmware for devices that can have only one firmware version installed In case of a device that can have only one firmware version installed the additional firmware image is used differently. First of all it is treated as a temporary storage for the updateFirmware action that triggers the download process. When the download process is finished the status of the firmware image is changed to "Ready". It is important to note that in this case the installation/flashing process is started after the toggle action is issued, making it a "long toggle". At the very same moment the toggle is issued, the previously active firmware image is moved to "Archival" state, making it a historical record that cannot be restored. The reason why it cannot be restored is trivial - it was just overwritten by the flashing process. For devices that can have only one firmware version installed the following rules apply: • There is always no more than one firmware image that is in "Active" or "Installing" state. • Toggling between firmware images is only possible if one image is in "Ready" state and the other image is in "Active" state. • The toggle action moves the image that was previously in "Active" state to the "Archival" state. • The toggle action moves the image that was previously in "Ready" state to the "Installing" state. • updateFirmware action is always performed on the image that is in "Archival" or "Failure" state. • If one image is in "Archival" state and the other is in "Failure" state the updateFirmware action is always performed on the image that is in "Archival" state. NOTE 3: It is the AE/IPE responsibility to provide the appropriate action result pointing if the action was triggered on the device or not (e.g. if the current firmware state did not allow it). |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.6 dmSoftware | This ModuleClass provides DM capabilities to control and monitor software modules of the device. An instance of this module class represents a software module hosted by the device. Archival Active Downloading Active Downloading Archival Installing PRIMARY SECONDARY T O G G L E Installing Ready Ready Failure Failure ETSI ETSI TS 118 123 V4.8.1 (2024-02) 101 oneM2M TS-0023 version 4.8.1 Release 4 A [dmSoftware] module is created on a Hosting CSE by the IPE in charge of the device, either at the initialization if it represents a software module that is pre-installed on the device, or after installation of one or more [dmPackage] modules (see clause 5.8.9) that have been dynamically created (for instance a software image with associated configuration files and libraries). The association between one or more dmPackage modules and a dmSoftware module are under the responsibility of the IPE: dmSoftware modules are created, deleted or updated only by the IPE (for instance updating a dmPackage can trigger the modification of the version datapoint of an associated dmSoftware). From external applications, [dmSoftware] modules can only be discovered from the parent [flexNode], not created, and afterwards they can only be activated / deactivated. They can be seen as 'high level' information ("there is such software that is running on the device"), whereas dmPackages are 'low level' information ("there is such executable file that is deployed on the device"). Table 5.8.6-1: Actions of dmSoftware ModuleClass Return Type Name Argument Optional Description none activate none true Activate the software module. none deactivate none true Deactivate the software module. Table 5.8.6-2: DataPoints of dmSoftware ModuleClass Name Type R/W Optional Unit Description state hd:enumSoftwareState R false The current state of the software module (see clause 5.6.47). name xs:string R true The name of the software module. version xs:string R true The version of the software module. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.7 dmEventLog | This ModuleClass provides DM capabilities to control and monitor event logs of the device. Table 5.8.7-1: Actions of dmEventLog ModuleClass Return Type Name Arguments Optional Description none retrieveLog start: xs:datetime end: xs:datetime true Upload from the device the logging data between 'start' and 'end'. 'start' shall be a date before 'end', and is optional. The default is beginning of time. 'end' shall be a date after 'start' and is optional. The default is the timestamp of the last available log entry. This action, if provided, requests the IPE to read logging data on the device. This log is then stored in the 'data' datapoint. It is only valid when the 'enabled' datapoint is true. The start and end arguments are only indications of the timeframe for the log retrieval. If a target device can deliver only partial logs for a given timeframe, for example when the start argument is too far in the past and logs are not available for that time anymore, then the device shall deliver logs from the earliest available point in time on. Table 5.8.7-2: DataPoints of dmEventLog ModuleClass Name Type R/W Optional Unit Description type m2m:logTypeId R false The type of the log (e.g. security log, system log, etc.). data xs:string R false Raw data of last event. No format specified. status m2m:logStatus R false The current status of the logging process (Started, Stopped, Error, etc.) enabled xs:boolean RW false Start / stop logging. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 102 oneM2M TS-0023 version 4.8.1 Release 4 For devices using the dmEventLog ModuleClass, the following rules apply: • The actual logging process on the device (if any), and the retrieval of device logging data by the IPE, are out of scope of the present document. • Instances of this module should only be created by the IPE (one per log type supported by the device for instance). • The IPE can create a [dmEventLog] instance with status datapoint 'NotPresent' for a given log type, to indicate that this log type is not supported by the device. Otherwise status should have value 'Started' (resp. 'Stopped') if the enabled datapoint is set to true (resp. false). The status datapoint can be given 'Error' value if the log processing dysfunctions. • The IPE should use the <flexContainerInstance> history mechanism (see ETSI TS 118 101, clause 9.6.59) by setting on [dmEventLog] at least one attribute maxNrOfInstances, maxByteSize or maxInstanceAge. Then for each log event read by the IPE from the device, and if the enabled datapoint has value true, a <flexContainerInstance> resource shall be created, child of this module <flexContainer>. The [dmEventLog] module itself just contains the last logged event from the device for this log type. • The [dmEventLog] <flexContainer>, and therefore its <flexContainerInstance> children resources, should have a dataGenerationTime custom attribute that indicates the time the event was logged on the device (see Rule 2-5 in clause 6.2.3). When the enabled datapoint is set to false, the IPE shall set the status datapoint to 'Stopped' and shall not modify the data datapoint of the module, and therefore shall not create any <flexContainerInstance> child resource. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.8 dmPackage | This ModuleClass provides DM capabilities to deploy, control and monitor packages of the device: • These packages can be simple resource files such as software libraries, configuration files, etc. In this case the softwares datapoint will be empty. • They also can correspond to software images, in which case their installation will trigger the creation by the IPE of one or more [dmSoftware] SDT modules classes that can be activated / deactivated (see clause 5.8.7). In this case the softwares datapoint will contain the list of IDs of this(these) dmSoftware module(s). • Instances of the dmPackage module class can be dynamically created by the deployPackage action of the dmAgent module class (see clause 5.8.2). Table 5.8.8-1: Actions of dmPackage ModuleClass Return Type Name Argument Optional Description none install none false Download if needed and install the package. none uninstall none false Uninstall the package. none update version: xs:string url: xs:string false Update the package. NOTE: • The package can be pre-downloaded when the [dmPackage] resource is created. • In the update action, the arguments version and url can be empty strings (case for instance of updating a package on a Linux-type system). • When the [dmPackage] resource is deleted, the package shall be removed from the device. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 103 oneM2M TS-0023 version 4.8.1 Release 4 Table 5.8.8-2: DataPoints of dmPackage ModuleClass Name Type R/W Optional Unit Description type hd:enumPackageType R false The type of the package (software, library, config file, web content, etc. See clause 5.6.49) state hd:enumPackageState R false The current state of the package (see clause 5.6.48) name xs:string R true The name of the package version xs:string R true The version of the package url xs:url R true The URL from which the package can be downloaded softwares m2m:listOfM2MID R true The list of dmSoftware modules, if any, that are associated with this dmPackage NOTE: • the dmPackage name and version datapoints are optional because they can be deduced from the downloaded resource. The url datapoint is optional because the package can be pre-installed or downloaded from a default repository (for instance a package on a Linux-type system). • The possible dependencies between dmPackage modules (for instance the dmPackage of an executable software image depends on the deployment of other dmPackage that correspond to libraries needed by this software) is out of scope of the present document. The control of the association between a dmPackage and an associated dmSoftware, for instance updating a dmPackage when the dmSoftware is active, is out of scope of the present document. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.9 dmAreaNwkInfo | A dmAreaNwkInfo is a SDT SubDevice entity, mapped as a <flexContainer> resource that expresses the information about the devices in a M2M Area Network managed by the parent flexNode. Table 5.8.9-1: Properties of dmAreaNwkInfo model Property Name Property Type Multiplicity Description areaNwkType xs :string 1 Indicates the type of M2M Area Network Table 5.8.9-2: Modules of dmAreaNwkInfo model Module Instance Name Module Class Name Multiplicity Description dmAreaNwkDeviceInfo dmAreaNwkDeviceInfo 0..N See clause 5.8.11 |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.10 dmAreaNwkDeviceInfo | This ModuleClass is used to share information regarding the devices in the M2M Area Network. Table 5.8.10-1: DataPoints of dmAreaNwkDeviceInfo ModuleClass Name Type R/W Optional Unit Description devId xs:string R false Indicates the id of the device. It could be the id of the hardware or nodeId. devType xs:string R false Indicates the type of the device. The attribute also indicates the functions or services that are provided by the device. Examples include temperature sensor, actuator, IEEE 802.15.4™ coordinator or router. sleepInterval xs:integer R true seconds The interval between two sleeps. sleepDuration xs:integer R true seconds The time duration of each sleep. status xs:string R true The status of the device (sleeping or waked up). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 104 oneM2M TS-0023 version 4.8.1 Release 4 |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.11 dmCapability | This ModuleClass is used to model the service capabilities of a managed device. Table 5.8.11-1: Actions of dmCapability ModuleClass Return Type Name Argument Optional Documentation m2m:status enable none true The action that allows enabling the device capability. Returns the status of the action. m2m:status disable none true The action that allows disabling the device capability. Returns the status of the action. Table 5.8.11-2: DataPoints of dmCapability ModuleClass Name Type R/W Optional Unit Description name xs:string R false The name of the device capability. attached xs:boolean R false Indicates whether the capability is currently attached to the device or not. currentState xs: boolean R false Indicates the current state of the capability (e.g. enabled or disabled). |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 5.8.12 dmStorage | This ModuleClass is used to model the storage on a managed device. Table 5.8.12-1: Actions of dmStorage ModuleClass Return Type Name Argument Optional Documentation none format none true The action that allows to format the mounted storage. none unmount none true The action that allows to safety eject storage device. Table 5.8.12-2: DataPoints of dmStorage ModuleClass Name Type R/W Optional Unit Description UUID xs:string R true The uuid of the storage device. type xs:integer R true Indicates the type of storage. 0 indicates internal and 1 indicates external. name xs:string RW true Indicates name of the mounted storage. writeSpeed xs:integer R true Indicates the write speed of storage device. readSpeed xs:integer R true Indicates the read speed of storage device. availStorage xs:integer R false MB Indicates the current available amount of memory. totalStorage xs:integer R false MB Indicates the total amount of memory available. presence xs:integer R true Indicates current presence status of memory card. 0 indicates card is ejected, 1 indicates card is inserted. status xs:integer R true Indicates current operation status of storage. 1 indicates storage is ready, 0 indicates storage is busy. mounts xs:integer R true Indicates number of successful mounts of the storage. forcedUnmounts xs:integer R true Indicates number of forced unmounts of the storage. fileSystem xs:string RW true Indicates the filesystem type used on the mounted storage. mountingPoint xs:string RW true Indicates mounting point of the mounted storage. mountOptions xs:string R true Indicates additional file system specific and file system independent mount options that indicate specific behaviours of the mount point as well as the capabilities of the underlying file system. writable xs:boolean R false Indicates whether the storage volume is mounted as read/write ("TRUE") or read-only ("FALSE"). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 105 oneM2M TS-0023 version 4.8.1 Release 4 6 The Principle of Resource Mapping for Home Appliance Information Model |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.1 Introduction | Home appliance information models which are defined in clause 5 need to be represented as resources in the oneM2M system. This clause defines the principle of resource mapping based on <flexContainer>. The individual information mapping is provided in annexes A, B and C. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.2 The Resource Mapping Rules | |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.2.0 Introduction | The present clause specifies the rule to map the "Harmonized Information Model" to oneM2M resources. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.2.1 Resource mapping for Device model | When the AE exposes a controlling interface for a home domain device which is specified as an information model in clause 5.5, a specialization of the <flexContainer> resource shall be created as the mapping of the model following conversion rules: • Rule 1-1: Each Device model defined in clause 5.5 shall be mapped to a specialization of <flexContainer>. The containerDefinition attribute shall be set according to clause 6.4.2. • Rule 1-2: Each entry in the 'Module' table shall be mapped to a child resource(s) which is mapped as a specialized <flexContainer> following the rule in clause 6.2.3. • Rule 1-3: The specialized <flexContainer> resource of the Device model may contain an optional attribute nodeLink (as defined in ETSI TS 118 101 [i.3] and in ETSI TS 118 104 [4]). The value of nodeLink shall be set to the resource identifier of a <node> resource described in Rule 1-5 below. See also Rule 1-8. • Rule 1-4: XSD file for each Device model shall be named according to clause 6.5.2. • Rule 1-5: If the nodeLink attribute is present, a <node> resource shall be created on the same hosting CSE as the <flexContainer> representing this Device model. The <node> resource contains all the management information as specialized <mgmtObj> resources (e.g. [firmware]) about the Device model instance for device management purposes. • Rule 1-6: The specialized <flexContainer> resource of the Device model may contain an optional [customAttribute] named flexNodeLink. The value of flexNodeLink shall be set to the resource identifier of a <flexContainer> resource described in Rule 1-7 below. See also Rule 1-8. • Rule 1-7: If the flexNodeLink [customAttribute] is present, a [flexNode] specialization of a <flexContainer> resource shall be created on the same hosting CSE as the <flexContainer> representing this Device model. This [flexNode] resource contains all the Device Management information as specialized <flexContainer> resources defined in clause 5.8 (e.g. [dmFirmware]) about the device model instance for Device Management purposes. • Rule 1-8: at least one of nodeLink (Rule 1-3) or flexNodeLink (Rule 1-6) shall be present. If both are present, the [flexNode] resource pointed to by the flexNodeLink custom attribute shall contain a nodeLink attribute with the same value as this device model's nodeLink. • Rule 1-9: Each entry in the 'SubDevice' table shall be mapped to a child resource(s) which is mapped as a specialized <flexContainer> following the rule in clause 6.2.7. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 106 oneM2M TS-0023 version 4.8.1 Release 4 |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.2.2 Resource mapping for ModuleClass | The ModuleClass models shall be mapped to the specializations of a <flexContainer> resource. The following rules shall be applied: When the Device or SubDevice models in clauses 5.4, 5.5, 5.8.2 or 5.8.10 are mapped to the <flexContainer> resource, and if the device or sub-device supports the functionality associated with a ModuleClass in the model, a <flexContainer> resource which is mapped from ModuleClass definitions shall be created as a child resource: • Rule 2-1: The containerDefinition attribute shall be set according to clause 6.4.3. • Rule 2-2: Each entry of 'Action', 'Property', and 'DataPoint' in ModuleClass definitions shall be mapped following the resource mapping rules described in clauses 6.2.4 to 6.2.7. • Rule 2-3: XSD file for each ModuleClass shall be named according to clause 6.5.3. • Rule 2-4: The resourceName attribute for each module class that appears as a child of a Device or SubDevice model shall be CREATED with the value set to "Module Instance Name". If the module class is contained in a list (multiplicity 0..N or 1..N), its resourceName attribute shall be set to "Module Instance Name" appended with an underscore '_' and an incrementing index so that it is unique in the parent's children (e.g. "firmware_0", "firmware_1", etc.). The index shall not have leading 0's. • Rule 2-5: The specialized <flexContainer> resource of the Module model may contain an optional [customAttribute] named dataGenerationTime. The value of dataGenerationTime contains the time when the data was generated by the device. The data type of this custom attribute is m2m:timestamp. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.2.3 Resource mapping for Action | Actions defined as part of a ModuleClass model shall be mapped to the specializations of a <flexContainer> resource. The following rules shall be applied: • Rule 3-1: The containerDefinition attribute shall be set according to clause 6.4.4. • Rule 3-2: When the Action supports any 'Arguments', they are mapped to [customizedAttribute] with their variable names (short names are given in clause 6.3.4). When the Action supports a 'Return Type', it is mapped to a [customizedAttribute] named 'result' (short name 'resut'). The keyword 'result' is reserved and cannot be used as an Argument name. • Rule 3-3: XSD file for each Action shall be named according to clause 6.5.4. • Rule 3-4: The Action shall be triggered: - by updating at least one of the Arguments custom attributes with any value, if the action has at least one argument; or - by updating the <flexContainer> resource with empty content if it has no argument. • Rule 3-5: The resourceName attribute for each Action model that appears as a child of a ModuleClass model shall be CREATED with the value set to "Action name". • Rule 3-6: If an action returns a value that is of a complex data type, i.e. not one of the standard scalar types, then this value shall be encoded as a JSON structure and returned serialized in an xs:string. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.2.4 Resource mapping for Property | When the Device model (in clause 5.5) or the ModuleClass model (in clause 5.3) is mapped to the <flexContainer> resource, and if the device supports a Property, the following rules shall be applied: • Rule 4-1: Each entry of 'Property' table in ModuleClass model, shall be mapped to the [customAttribute] of <flexContainer> resource which is mapped from associated ModuleClass model, with its Property name with prefix 'prop'. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 107 oneM2M TS-0023 version 4.8.1 Release 4 • Rule 4-2: Each 'Property' of a Device model is either mapped to a specialized [objectAttribute] of a [deviceInfo] <mgmtObj> resource following Rule 1-3, when the nodeLink attribute is present, or to a [customAttribute] of a [dmDeviceInfo] <flexContainer> resource following Rule 1-6 otherwise. • Rule 4-3: Each entry of 'Property' table in SubDevice model, shall be mapped to the [customAttribute] of <flexContainer> resource which is mapped from associated SubDevice model, with its Property name with prefix 'prop'. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.2.5 Resource mapping for DataPoint | When the ModuleClass model (in clause 5.3) is mapped to the <flexContainer> resource, and if the ModuleClass supports a DataPoint, the following rules shall be applied: • Rule 5-1: Each entry of DataPoint table in ModuleClass model, shall be mapped to [customAttribute] of <flexContainer> resource which is mapped from associated ModuleClass model, with its DataPoint name. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.2.6 Resource mapping for SubDevice model | The SubDevice models (in clause 5.4 or 5.8.10) shall be mapped to the specializations of a <flexContainer> resource. The following rules shall be applied: • When the SubDevice model in clause 5.4 or 5.8.10 is mapped to the <flexContainer> resource, and if the device supports the functionality associated with a SubDevice in the model, a <flexContainer> resource which is mapped from SubDevices definitions shall be created as a child resource: - Rule 7-1: The containerDefinition attribute shall be set according to clause 6.4.5. - Rule 7-1a: Each entry in the 'Module' table shall be mapped to a child resource(s) which is mapped as a specialized <flexContainer> following the rule in clause 6.2.3. - Rule 7-2: The XSD file for each SubDevice model shall be named according to clause 6.5.5. - Rule 7-3: Void. - Rule 7-4: The resourceName attribute for each SubDevice that appears as a child of a Device or FlexNode model shall be created with the value set to "SubDevice Instance Name". If the SubDevice is contained in a list (multiplicity 0..N or 1..N), its resourceName attribute shall be set to "SubDevice Instance Name" appended with an underscore '_' and an incrementing index so that it is unique in the parent's children (e.g. "cuff_0", "cuff_1", etc.). The index shall not have leading 0's. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.3 Short names | |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.3.0 Introduction | XML and JSON representations require the explicit encoding of the names of resource attributes, (in the case of XML) and resource types. Whenever a protocol binding transfers such a name over a oneM2M reference point, it shall use a shortened form of that name. Short names enable payload reduction on involved telecommunication interfaces. The mapping between the full names and their shortened form is given in the clauses that follow. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.3.1 Resource types | In protocol bindings resource type names for device models shall be translated into short names of Table 6.3.2-1. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 108 oneM2M TS-0023 version 4.8.1 Release 4 Table 6.3.2-1: Specialization type short names (Device models) Resource Type Name Short Name Device3DPrinter dTDPr deviceAirConditioner deACr deviceAirPurifier deAPr deviceAirQualityMonitor dAQMr deviceAudioReceiver deARr deviceBloodPressureMonitor dBPMr deviceCamera devCa deviceClothesDryer deCDr deviceClothesWasher deCWr deviceClothesWasherDryer dCWDr deviceCoffeeMachine deCMe deviceCookerHood deCHd deviceCooktop devCp deviceDehumidifier devDr deviceDishWasher deDWr deviceDoor devD0 deviceDoorLock deDLk deviceElectricVehicleCharger dEVCr deviceFan devFn deviceFoodProbe deFPe deviceFreezer devFr deviceGlucosemeter devGr deviceHeartRateMonitor dHRMr deviceHomeCCTV dHCCT deviceHumidifier devHr deviceKettle devKe deviceLight devLt deviceMicrogeneration devMn deviceMultiFunctionPrinter dMFPr deviceOutdoorLamp deOLp deviceOven devOn devicePrinter devPr devicePulseOximeter dePOr deviceRefrigerator devRr deviceRobotCleaner deRCr deviceScanner devSr deviceSecurityPanel deSPl deviceSetTopBox dSTBx deviceSmartElectricMeter dSEMr deviceSmartPlug deSPg deviceSteamCloset deSCt deviceStorageBattery deSBy deviceSwitch devSh deviceTelevision devTn deviceThermometer devTr deviceThermostat devTt deviceWaterHeater deWHr deviceWaterValve deWVe deviceWeightScaleAndBodyCo mpositionAnalyser dWSAB deviceWindowShade deWSe deviceBottleWarmer deBWr deviceGarbageDisposal deGDp deviceWaterPurifier deWPr flexNode fleNe In protocol bindings resource type names for SubDevice model shall be translated into short names of Table 6.3.2-2. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 109 oneM2M TS-0023 version 4.8.1 Release 4 Table 6.3.2-2: Specialization type short names (SubDevice models) Resource Type Name Short Name cuff cuff powerOutlet powOt subDeviceCuff suDCf subDevicePowerOutlet sDPOt dmAreaNwkInfo dANIo NOTE: See clause 6.2.7, rule 7-4. In protocol bindings resource type names for module classes shall be translated into short names of Table 6.3.2-3. Table 6.3.2-3: Specialization type short names (ModuleClasses and Module Instances) Resource Type Name Short Name 3DPrinter thDPr acousticSensor acoSr airCleanOperationMode aCOM0 airConJobMode aCJMe airConOperationMode aCOMe airFlow airFw airPurifierJobMode aPJMe airPurifierOperationMode aPOMe airQualitySensor aiQSr alarmSpeaker alaSr audioVolume audVe autoDocumentFeeder auDFr battery bat binaryObject binOt binarySwitch binSh bioElectricalImpedanceAnalysis bEIAs bodyCompositionAnalyser boCAr boiler boilr boilingSwitch boiSh brewing brewg brewingSwitch breSh brightness brigs channel chanl clock clock clothesDryerJobMode cDJMe clothesDryerOperationMode cDOMe clothesWasherDryerJobMode cWDJM clothesWasherDryerOperationMode cWDOM clothesWasherJobMode cWJMe clothesWasherJobModeOption cWJMO clothesWasherOperationMode cWOMe colour color colourSaturation colSn controlPanelLock coPLk cookerHoodJobMode cHJMe credentials creds customTemperature cusTe dataGenerationTime dgt dehumidifierJobMode deJMe dehumidifierOperationMode deOMe dishWasherJobMode dWJMe dmAgent dmAgt dmAreaNwkDeviceInfo dANDo dmCapability dmCay dmDataModelIO dDMIO dmDeviceInfo dmDIo dmEventLog dmELg ETSI ETSI TS 118 123 V4.8.1 (2024-02) 110 oneM2M TS-0023 version 4.8.1 Release 4 Resource Type Name Short Name dmFirmware dmFie dmPackage dmPae dmSoftware dmSoe dmStorage dmSte doorLock dooLk doorlock doork doorStatus dooSs electricVehicleConnector elVCr energyConsumption eneCn energyGeneration eneGn faultDetection fauDn filterInfo filIo foaming foamg fridgeTemperature friTe frozenTemperature froTe geoLocation geoLn glucometer glucr grinder grinr heatingZone heaZe height heigt hotWaterSupply hoWSy impactSensor impSr keepWarm keeWm keypad keypd liquidLevel liqLl liquidRemaining liqRg lock lock mediaInput medIt mediaOutput medOt mediaSelect medSt milkFoaming milFg milkQuantity milQy milkStatus milSs motionSensor motSr numberValue numVe openLevel opeLl operationMode opeMe overcurrentSensor oveSr oximeter oximr ozoneMeter ozoMr phoneCall phoCl playerControl plaCl powerSave powS0 printerRunState prRSe printQueue priQe pulsemeter pulsr pushButton pusBn recorder recor refrigeration refrn relativeHumidity relHy remoteControlEnable reCEe robotCleanerJobMode rCJMe robotCleanerOperationMode rCOMe runState runSe scannerRunState scRSe securityMode secMe sessionDescription sesDn signalStrength sigSh sleepTimer sleTr smokeSensor smoSr sphygmomanometer sphyr spinLevel spiLl steamClosetJobMode sCJMe ETSI ETSI TS 118 123 V4.8.1 (2024-02) 111 oneM2M TS-0023 version 4.8.1 Release 4 Resource Type Name Short Name steamClosetOperationMode sCOMe televisionChannel telCl temperature tempe temperatureAlarm temAm textMessage texMe timer timer turbo turbo uvSensor uveSr waterFilterInfo waFIo waterFlow watFw waterSensor watSr waterStatus watSs weight weigt In protocol bindings resource type names for actions shall be translated into short names of Table 6.3.2-4. Table 6.3.2-4: Specialization type short names (Actions) Resource Type Name Short Name activate actie activateClockTimer acCTr answer answr call call close close deactivate deace deactivateClockTimer deCTr decrementNumberValue deNVe deployPackage depPe disable disae downChannel dowCl downVolume dowVe enable enabe format formt hangup hangp incrementNumberValue inNVe install instl nextTrack nexTk open open previousTrack preTk reboot rebot readIO reaIO resetNumberValue reNVe resetTextMessage reTMe start3Dprint staDt stop3Dprint stoDt toggle togge uninstall uninl unmount unmot upChannel uphCl updateFirmware updFe upVolume upoVe writeIO wriIO |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.3.2 Resource attributes for properties and data points | In protocol bindings resource attributes names for properties of module classes shall be translated into short names of Table 6.3.3-1. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 112 oneM2M TS-0023 version 4.8.1 Release 4 Table 6.3.3-1: Resource attribute short names (ModuleClass properties) Attribute Name Occurs in Short Name chargingCapacity electricVehicleConnector chaCy dischargingCapacity electricVehicleConnector disCy electricEnergy battery eleEy material battery matel voltage battery volte In protocol bindings resource attributes names for data points of module classes shall be translated into short names of Table 6.3.3-2. Table 6.3.3-2: Resource attribute short names (ModuleClass data points) Attribute Name Occurs in Short Name absoluteEnergyConsumption energyConsumption abECn absoluteStartTime timer abSTe absoluteStopTime timer abST0 acousticStatus acousticSensor acoSs adfStates autoDocumentFeeder adfSs alarm motionSensor, smokeSensor, temperatureAlarm, waterSensor alarm alarmStatus alarmSpeaker alaSs altitude geoLocation altie automode airFlow autoe availableChannels televisionChannel avaCs basalMetabolism bodyCompositionAnalyser basMm bath hotWaterSupply bath batteryThreshold battery batTd blue colour blue bmi bodyCompositionAnalyser bmi bodyLength bodyCompositionAnalyser bodLh bone bioElectricalImpedanceAnalysis bone brightness brightness brigs callerID phoneCall calID callState phoneCall calSe capacity battery capay ch2o airQualitySensor ch2o channelId televisionChannel chaId channelName televisionChannel chaNe charging battery charg chargingCapacity electricVehicleConnector chaCy co airQualitySensor co co2 airQualitySensor co2 coarseness grinder coars code faultDetection, filterInfo code coldWash clothesWasherJobModeOption colWh colourSaturation colourSaturation colSn component dmFirmware compt concentration glucometer concn contextCarbohydratesAmount glucometer coCAt contextCarbohydratesSource glucometer coCSe contextExercise glucometer conEe contextHealth glucometer conHh contextLocation glucometer conLn contextMeal glucometer conMl contextMedication glucometer conMn contextTester glucometer conTr country dmDeviceInfo couny cpuUsage dmAgent cpuUe cupsNumber brewing cupNr current energyConsumption currt currentAdfState autoDocumentFeeder cuASe currentDate clock curDe ETSI ETSI TS 118 123 V4.8.1 (2024-02) 113 oneM2M TS-0023 version 4.8.1 Release 4 Attribute Name Occurs in Short Name currentJobMode airConJobMode, airPurifierJobMode, clothesDryerJobMode, clothesWasherDryerJobMode, clothesWasherJobMode, cookerHoodJobMode, dehumidifierJobMode, dishWasherJobMode, robotCleanerJobMode, steamClosetJobMode cuJMe currentJobModeName airConJobMode, airPurifierJobMode, clothesDryerJobMode, clothesWasherDryerJobMode, clothesWasherJobMode, cookerHoodJobMode, dehumidifierJobMode, dishWasherJobMode, robotCleanerJobMode, steamClosetJobMode cJMNe currentJobState runState cuJSe currentMachineState runState cuMSe currentPlayerMode playerControl cuPMe currentPlayerModeName playerControl cPMNe currentSecurityMode securityMode cuSMe currentTemperature temperature curT0 currentTime clock curTe currentTimeZone clock cuTZe currentValue smokeSensor crv data dmEventLog data dataModelType dmDataModelIO daMTe defaultValue numberValue, textMessage defVe defrost refrigeration defrt description faultDetection, dmDeviceInfo dc desiredHumidity relativeHumidity desHy detectedTime overcurrentSensor, smokeSensor detTe diastolicPressure sphygmomanometer diaPe discharging battery discg dischargingCapacity electricVehicleConnector disCy doorState doorStatus dooSe duration overcurrentSensor, recorder dur electricEnergy battery eleEy enabled dmEventLog enabd energy pulsemeter enery estimatedTimeToEnd timer eTTEd extraRinse clothesWasherJobModeOption extRe fat bioElectricalImpedanceAnalysis fat fatFreeMass bodyCompositionAnalyser faFMs filterLifetime filterInfo filLe foamingStrength foaming foaSh frequency energyConsumption freqy friendlyName dmDeviceInfo friNe fwVersion dmDeviceInfo fweVn generationSource energyGeneration genSe grainsRemaining grinder graRg green colour green hash binaryObject hash hba1c glucometer hba1c heading geoLocation headg headingAccuracy geoLocation heaAy heatingLevel heatingZone heaLl height height heigt horizontalAccuracy geoLocation horAy horizontalDirection airFlow horDn hwVersion dmDeviceInfo hweVn impactDirectionHorizontal impactSensor imDHl impactDirectionVertical impactSensor imDVl impactLevel impactSensor impLl impactStatus impactSensor impSs impedance bodyCompositionAnalyser impee ETSI ETSI TS 118 123 V4.8.1 (2024-02) 114 oneM2M TS-0023 version 4.8.1 Release 4 Attribute Name Occurs in Short Name jobModes airConJobMode, airPurifierJobMode, clothesWasherDryerJobMode, clothesWasherJobMode, cookerHoodJobMode, dehumidifierJobMode, dishWasherJobMode, robotCleanerJobMode steamClosetJobMode, jobMs jobStates runState jobSs kcal bioElectricalImpedanceAnalysis kcal keyNumber keypad keyNr latitude geoLocation latie level battery lvl light alarmSpeaker light liquidLevel liquidLevel liqLl liquidRemaining liquidRemaining liqRg lock lock lock loginName credentials logNe longitude geoLocation longe loudness acousticSensor louds lowBattery battery lowBy lqi signalStrength lqi machineStates runState macSs manufacturer dmDeviceInfo manur manufacturerDetailsLink dmDeviceInfo maDLk manufacturingDate dmDeviceInfo manDe material battery matel maxHeatingLevel heatingZone maHLl maxLength textMessage maxLh maxLevel openLevel maxLl maxSpeed airFlow maxSd maxValue audioVolume, numberValue, ozoneMeter, temperature maxVe meanPressure sphygmomanometer meaPe measuringScope energyConsumption meaSe mediaID mediaSelect medID mediaName mediaSelect medNe mediaType mediaSelect medTe memorySize 3Dprinter memSe messageEncoding textMessage mesEg minLength textMessage minLh minLevel openLevel minLl minSpeed airFlow minSd minValue numberValue, temperature minVe modality pulsemeter moday model dmDeviceInfo model monitoringEnabled airQualitySensor monEd multiFirmware dmFirmware mulFe multiplyingFactors energyConsumption, energyGeneration mulFs muscle bioElectricalImpedanceAnalysis musce muscleMass bodyCompositionAnalyser musMs muteEnabled audioVolume mutEd name dmPackage, dmSoftware name network 3Dprinter netwk numberValue numberValue numVe object binaryObject objet objectType binaryObject objTe openAlarm doorStatus opeAm openDuration doorStatus opeDn openLevel openLevel opeLl osVersion dmDeviceInfo oseVn overcurrentStatus overcurrentSensor oveSs oxygenSaturation oximeter oxySn ozoneStatus ozoneMeter ozoSs ozoneValueMG ozoneMeter ozVMG ozoneValuePPM ozoneMeter oVPPM password credentials pwd ETSI ETSI TS 118 123 V4.8.1 (2024-02) 115 oneM2M TS-0023 version 4.8.1 Release 4 Attribute Name Occurs in Short Name power energyConsumption power powerGenerationData energyGeneration poGDa powerSaveEnabled powerSave poSEd powerState binarySwitch powSe powerStatus dmAgent powSs presentationURL dmDeviceInfo prURL previousChannel televisionChannel preCl preWash clothesWasherJobModeOption preWh primaryName dmFirmware priNe primaryState dmFirmware priSe primaryUrl dmFirmware priUl primaryVersion dmFirmware priVn printingState printQueue priS0 printSizeX 3Dprinter priSX printSizeY 3Dprinter priSY printSizeZ 3Dprinter priSZ printType 3Dprinter priTe progressPercentage runState proPe pulseRate pulsemeter pulRe pushed pushButton pushd ramAvailable dmAgent ramAe ramTotal dmAgent ramTl rapidCool refrigeration rapCl rapidFreeze refrigeration rapFe recipientID phoneCall recID red colour red referenceTimer timer refTr relativeHumidity relativeHumidity relHy remoteControlEnabled remoteControlEnable reCEd resistance bioElectricalImpedanceAnalysis resie roundingEnergyConsumption energyConsumption roECn roundingEnergyGeneration energyGeneration roEGn rr pulsemeter r0 rssi signalStrength rssi runningTime timer runTe sdp sessionDescription sdp secondaryName dmFirmware secNe secondaryState dmFirmware secSe secondaryUrl dmFirmware secUl secondaryVersion dmFirmware secVn securityModes securityMode secMs sensitivity motionSensor sensy sensorHumidity airQualitySensor senHy sensorOdor airQualitySensor senOr sensorPM1 airQualitySensor sePM1 sensorPM10 airQualitySensor sePM0 serialNumber dmDeviceInfo serNr sensorPM2 airQualitySensor sePM2 significantDigits energyConsumption, energyGeneration sigDs silentTime motionSensor silTe size binaryObject size smokeThreshhold smokeSensor smoTd softLeanMass bodyCompositionAnalyser soLMs soilLevel clothesWasherJobModeOption soiLl speed airFlow speed speedFactor playerControl speFr speedWash clothesWasherJobModeOption speWh spinLevelStrength spinLevel spLSh spinSpeed clothesWasherJobModeOption spiSd startPause operationMode staPe state dmAgent, dmPackage, dmSoftware state status boiler, dmEventLog, electricVehicleConnector, faultDetection, filterInf, mediaSelect sus ETSI ETSI TS 118 123 V4.8.1 (2024-02) 116 oneM2M TS-0023 version 4.8.1 Release 4 Attribute Name Occurs in Short Name steamTreat clothesWasherJobModeOption steTt step numberValue step stepValue audioVolume, openLevel, temperature steVe storageAvailable dmAgent stoAe storageTotal dmAgent stoTl strength brewing streh subModel dmDeviceInfo subMl supportedHorizontalDirection airFlow suHDn supportedMediaSources mediaSelect suMSs supportedMessageValues textMessage suMVs supportedPlayerModes playerControl suPMs supportedVerticalDirection airFlow suVDn supportURL dmDeviceInfo suURL swVersion dmDeviceInfo sweVn systemTime dmAgent sysTe systolicPressure sphygmomanometer sysPe targetAltitude geoLocation tarAe targetDuration timer tarDn targetLatitude geoLocation tarLe targetLongitude geoLocation tarL0 targetTemperature temperature tarTe targetTimeToStart timer tTTSt targetTimeToStop timer tTTSp temperature temperatureAlarm tempe temperatureThreshold temperatureAlarm temTd textMessage textMessage texMe time keepWarm time token credentials tk tone alarmSpeaker tone turboEnabled turbo turEd type dmEventLog type unit temperature unit uri printQueue ur0 url sessionDescription, dmPackage, dmSoftware ur1 useGrinder grinder useGr uvStatus uvSensor uvtSs uvValue uvSensor uvaVe version dmPackage, dmSoftware versn verticalAccuracy geoLocation verAy verticalDirection airFlow verDn visceraFat bioElectricalImpedanceAnalysis visFt voc airQualitySensor voc voltage battery volte voltage energyConsumption volte volumePercentage audioVolume volPe washTemp clothesWasherJobModeOption wasTp water bioElectricalImpedanceAnalysis water waterFlowStrength waterFlow waFSh weight weight weigt |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.3.3 Resource attributes for actions arguments | In protocol bindings resource attributes names for arguments of actions shall be translated into short names of Table 6.3.4-1. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 117 oneM2M TS-0023 version 4.8.1 Release 4 Table 6.3.4-1: Resource attribute short names (Action arguments) Argument Name Occurs in Short Name address readIO, writeIO addrs name deployPackage name payload writeIO payld rebootType reboot rebTe url deployPackage, updateFirmware, update url version deployPackage, updateFirmware, update versn |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.4 containerDefinition values | |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.4.1 Introduction | Each specialization has a containerDefinition attribute which can be used as a unique identifier and contains the information of the resource. In this clause, the detailed values of containerDefinition attributes in every specializations for the harmonized information model are given. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.4.2 Device models | Depending on the domain, the containerDefinition attribute of specializations for device models shall have the values that comply with the following rule: • Rule: "org.onem2m.[domain].device.[device name]", where [domain] is one of the following names: "agriculture", "city", "common", "health", "home", "industry", "railway", "vehicular" and "management". The name is chosen according to the domain in which the device is defined. For example, the containerDefinition attribute of the specialization for the "deviceAirConditioner" device of the "home" domain shall be "org.onem2m.home.device.deviceAirConditioner". |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.4.3 ModuleClasses | Depending on the domain, the containerDefinition attribute of specializations for module classes shall have the values that comply with the following rule: • Rule: "org.onem2m.[domain].moduleclass.[moduleclass name]", where [domain] is one of the following names: "agriculture", "city", "common", "health", "home", "industry", "railway", "vehicular" and "management". The name is chosen according to the domain in which the module class is defined. For example, the containerDefinition attribute of the specialization for the "alarmSpeaker" module class of the "common" domain shall be "org.onem2m.common.moduleclass.alarmSpeaker", the containerDefinition attribute of the specialization for the "dmAgent" module class of the "management" domain shall be "org.onem2m.management.moduleclass.dmAgent". |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.4.4 Actions | Depending on the domain, the containerDefinition attribute of specializations for actions shall have the values that comply with the following rule: • Rule: "org.onem2m.[domain].action.[action name]", where [domain] is one of the following names: "agriculture", "city", "common", "health", "home", "industry", "railway", "vehicular" and "management". The name is chosen according to the domain in which the action is defined. For example, the containerDefinition attribute of the specialization for "activateClockTimer" action in the "timer" module class of the "common" domain shall be "org.onem2m.common.action.activateClocktimer", the containerDefinition attribute of the specialization for the "activate" action of the "dmSoftware" module class for the "management" domain shall be "org.onem2m.management.action.activate". ETSI ETSI TS 118 123 V4.8.1 (2024-02) 118 oneM2M TS-0023 version 4.8.1 Release 4 |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.4.5 SubDevices | Depending on the domain, the containerDefinition attribute of specializations for sub-devices shall have the values that comply with the following rule: • Rule: "org.onem2m.[domain].subdevice.[subDevice name]", where [domain] is one of the following names: "agriculture", "city", "common", "health", "home", "industry", "railway", "vehicular" and "management". The name is chosen according to the domain in which the sub-device is defined. For example, the containerDefinition attribute of specialization for "subDevicePowerOutlet" of the "common" domain shall be "org.onem2m.common.subdevice.subDevicePowerOutlet",the containerDefinition attribute of the specialization for the "dmAreaNwkInfo" of the "management" domain shall be "org.onem2m. management.subdevice.dmAreaNwkInfo". |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.5 XSD definitions | |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.5.1 Introduction | The present clause specifies how to name the files which define data types in XSD for Device and SubDevice models, ModuleClasses, Actions and enumerated types. Seven SDT domains correspond to different vertical, economic domains (Agriculture, Smart City, Health, Home, Industry, Railway, Vehicular), they contain devices and modules that are specific to these domains. Management domain contains transversal, Device Management modules, Horizontal is only for enumerated types and Common is the domain that gathers devices and modules that do not pertain to a specific domain but are re-usable anywhere. Table 6.5.1-1 defines the short names for XML name spaces and file name prefix. Table 6.5.1-1: Short names for the XML name spaces Domain XML Name Space Domain Prefix URI Agriculture xmlns:agd AGD http://www.onem2m.org/xml/protocols/agriculturedomain City xmlns:cid CID http://www.onem2m.org/xml/protocols/citydomain Common xmlns:cod COD http://www.onem2m.org/xml/protocols/commondomain Health xmlns:hed HED http://www.onem2m.org/xml/protocols/healthdomain Home xmlns:hod HOD http://www.onem2m.org/xml/protocols/homedomain Industry xmlns:ind IND http://www.onem2m.org/xml/protocols/industrydomain Management xmlns:mad MAD http://www.onem2m.org/xml/protocols/managementdomain PublicSafety xmlns:psd PSD http://www.onem2m.org/xml/protocols/publicsafetydomain Railway xmlns:rad RAD http://www.onem2m.org/xml/protocols/railwaydomain Vehicular xmlns:ved VED http://www.onem2m.org/xml/protocols/vehiculardomain |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.5.2 XSD definitions for Device models | The XSD definitions for Device models are specified upon the following rule: • Rule: [Domain Prefix]-[device name]-v<TS-version>.xsd where the string '<TS-version>' shall be interpreted as the version of the present document. For example, the XSD definition for deviceAirConditioner specified in TS-0023 v4.3.0 shall be "HOD- deviceAirConditioner-v4_3_0.xsd". |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.5.3 XSD definitions for ModuleClass | The XSD definitions for ModuleClass are specified upon the following rule: • Rule: [Domain Prefix]-mod-[ModuleClass name]-v<TS-version>.xsd where the string '<TS-version>' shall be interpreted as the version of the present document. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 119 oneM2M TS-0023 version 4.8.1 Release 4 For example, the XSD definition for alarmSpeaker specified in TS-0023 v4.3.0 shall be "COD-mod-alarmSpeaker- v4_3_0.xsd". |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.5.4 XSD definitions for Action | The XSD definitions for Actions are specified upon the following rule: • Rule: [Domain Prefix]-act-[action name]-v<TS-version>.xsd where the string '<TS-version>' shall be interpreted as the version of the present document. For example, the XSD definition for activateClockTimer specified in TS-0023 v4.3.0 shall be "HOD-act- activateClockTimer -v4_3_0.xsd". |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.5.5 XSD definitions for SubDevices | The XSD definitions for SubDevices are specified upon the following rule: • Rule: [Domain Prefix]-[SubDevice name]-v<TS-version>.xsd where the string '<TS-version>' shall be interpreted as the version of the present document. For example, the XSD definition for subDeviceCuff specified in TS-0023 v4.3.0 shall be "COD-subDeviceCuff- v4_3_0.xsd". |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 6.5.6 XSD definitions for Enumerated Types | The XSD definitions for enumerated types are specified upon the following rule: • Rule: HD-enumerationTypes-v<TS-version>.xsd where the string '<TS-version>' shall be interpreted as the version of the present document. This file contains the definitions of all enumerated types, and nothing else. 7 Mapping with Other Information Models from External Organizations |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.0 Introduction | This clause specifies how the Home Appliance Information Model (HAIM) defined in clause 5 of the present document can be mapped with existing external models from , OCF, ECHONET, OMA GotAPI etc. and introduction of these models is written in annex B. The mapping shall be to enable the interworking between the oneM2M system and external technologies at the information model level. This means a oneM2M native application which understand only oneM2M standardized HAIM shall be able to interact with non-oneM2M home appliances of different technologies in a consistent way without knowing the technology specific details. An IPE shall be responsible for translating the HAIM to/from technology specific information model bidirectionally following the mapping specification in this clause. Using HAIM as a bridge, home appliances and applications of different technologies shall be able to also interact with each other via the oneM2M system (with IPEs). |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1 OMA GotAPI (DWAPI) | |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.1 Introduction | The following clauses are intended to specify the mapping relationship between HAIM and OMA DWAPI with tables. OMA Device Web Application Programming Interface (DWAPI) [7] is based on OMA Generic Open Terminal Application Programming Interface (GotAPI) [19] and supports Personal Healthcare Devices (DWAPI-PCH) and 3D printer (DWAPI-3DP). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 120 oneM2M TS-0023 version 4.8.1 Release 4 OMA DWAPI has no concept that corresponds to ModuleClass in oneM2M. The mappings of DataPoints to data objects of OMA DWAPI are expressed in the following clauses. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.2 Device Models | |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.2.1 device3Dprinter | The device3Dprinter of HAIM shall be mapped to 3D printer of OMA DWAPI-3DP on the basis of Table 7.1.2-1. Table 7.1.2.1-1: Map of device3Dprinter of oneM2M HAIM to OMA DWAPI-3DP ModuleClass Data Points of oneM2M HAIM Data objects of OMA DWAPI-3DP Description binarySwitch powerState - See clause 5.3.1.12. The powerState is not supported in OMA DWAPI-3DP data object. The power state is assumed power-on in OMA DWAPI-3DP. faultDetection code operatingStatus See clause 5.3.1.34. It shall be the integer type at HAIM, but shall be the string type at OMA DWAPI-3DP. See Table 7.1.2.1-2. 3Dprinter printType printType See clause 5.3.1.1. printSizeX printSizeX printSizeY printSizeY printSizeZ printSizeZ network network memorySize memorySize runState currentMachineState operatingStatus See clause 5.3.1.75. This value represents the machineState of the 3D printer itself. This value SHALL be interpreted by using hd:enumMachineState and generated operatingStatus as a string. See Table 7.1.2.1-2. temperature currentTemperature nozzleTemp See clause 5.3.1.87. This value represents the temperature of the nozzle. This value SHALL be a float number in a range from 0,0 to 1 000,0. The unit is C. printQueue uri uri See clause 5.3.1.67. printingState msg See clause 5.3.1.67. This value represents the machineState of the queued printing job. This value shall be interpreted by using hd:enumMachineState and generated msg as a string. See Table 7.1.2.1-3. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 121 oneM2M TS-0023 version 4.8.1 Release 4 Table 7.1.2.1-2: Map of hd:enumMachineState of oneM2M HAIM to operatingStatus of OMA DWAPI-3DP Value Interpretation operatingStatus of OMA DWAPI-3DP Note 1 idle RDY Ready to use 2 preActive Not available 3 active RUN Under printing operation 4 reserved Not available 5 stopped Not available 6 error MAN Maintenance needed 7 diagnostic Not available 8 test Not available 9 maintenance MAN Maintenance needed 10 clear CLR Printing completed but the result is not removed yet 11 charging Not available Table 7.1.2.1-3: Map of hd:enumJobState of oneM2M HAIM to msg of OMA DWAPI-3DP Value Interpretation msg of OMA DWAPI-3DP Note 1 aborted Not available 2 cancelled Not available 3 completed Completed 4 paused Waiting 5 pending Waiting 6 processing Good Start |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.2.2 deviceBloodPressureMonitor | DeviceBloodPressureMonitor of HAIM shall be mapped to Blood Pressure Monitor of OMA DWAPI-PCH on the basis of Table 7.1.2.2-1. Table 7.1.2.2-1: Map of deviceBloodPressureMonitor of oneM2M HAIM to OMA DWAPI-PCH ModuleClass DataPoints of oneM2M HAIM Data objects of OMA DWAPI-PCH Description sphygmomanometer diastolicPressure diastolic See clause 5.3.1.83. systolicPressure systolic meanPressure mean pulsemeter pulseRate pulse See clause 5.3.1.68 battery level batteryLevel See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI-PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] at OMA DWAPI-PCH. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 122 oneM2M TS-0023 version 4.8.1 Release 4 |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.2.3 deviceGlucosemeter | DeviceGlucometer of HAIM shall be mapped to Glucometer of OMA DWAPI-PCH on the basis of Table 7.1.2.3-1. Table 7.1.2.3-1: Map of deviceGlucometer of oneM2M HAIM to OMA DWAPI-PCH ModuleClass DataPoints of oneM2M HAIM Data objects of OMA DWAPI-PCH Description glucometer concentration concentration See clause 5.3.1.42. hba1c hba1c contextExercise contextExercise contextMedication contextMedication contextCarbohydratesAmount contextCarbohydrates contextCarbohydratesSource contextCarbohydrates contextMeal contextMeal contextLocation contextLocation contextTester contextTester contextHealth contextHealth battery level batteryLevel See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI- PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] at OMA DWAPI-PCH. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.2.4 devicePulseOximeter | DevicePulseOximeter of HAIM shall be mapped to Pulse Oximeter of OMA DWAPI-PCH on the basis of Table 7.1.2.4-1. Table 7.1.2.4-1: Map of devicePulseOximeter of oneM2M HAIM to OMA DWAPI-PCH ModuleClass DataPoints of oneM2M HAIM Data objects of OMA DWAPI-PCH Description pulsemeter modality spo2, pulse See clause 5.3.1.68. When oximeter module does not exist, pulsemeter module is mandatory. oximeter modality spo2, pulse See clause 5.3.1.59. When pulsemeter module does not exist, oximeter module is mandatory. battery level batteryLevel See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI-PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] at OMA DWAPI-PCH. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.2.5 deviceThermometer | DeviceTermometer of HAIM shall be mapped to Thermometer of OMA DWAPI-PCH on the basis of Table 7.1.2.5-1. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 123 oneM2M TS-0023 version 4.8.1 Release 4 Table 7.1.2.5-1: Map of deviceThermometer of oneM2M HAIM to OMA DWAPI-PCH ModuleClass Data Points of oneM2M HAIM Data objects of OMA DWAPI-PCH Description temperature unit temperature See clause 5.3.1.87. battery level batteryLevel See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI-PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] at OMA DWAPI-PCH. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.2.6 deviceWeightScaleAndBodyCompositionAnalyser | DeviceWeightScaleAdBodyCompositionAnalyser of HAIM shall be mapped to Weight Scale Body Composition Analyser of OMA DWAPI-PCH on the basis of Table 7.1.2.6-1. Table 7.1.2.6-1: Map of deviceWeightScaleAdBodyCompositionAnalyser of oneM2M HAIM to OMA DWAPI-PCH ModuleClass DataPoints of oneM2M HAIM Data objects of OMA DWAPI-PCH Description bodyCompositionAnalyser bodyLength bodyLength See clause 5.3.1.14. Bmi bmi fatFreeMass fatFreeMass softLeanMass softLeanMass muscleMass muscleMass basalMetabolism basalMetabolism impedance impedance weight weight bodyMass See clause 5.3.1.99. bioElectricalImpedanceAnalysis water bodyWater See clause 5.3.1.13. fat bodyFat muscle musclePercentage battery level batteryLevel See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI- PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] at OMA DWAPI-PCH. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.2.7 deviceHeartRateMonitor | DeviceHeartRateMonitor of HAIM shall be mapped to Heart Rate Monitor of OMA DWAPI-PCH on the basis of Table 7.1.2.7-1. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 124 oneM2M TS-0023 version 4.8.1 Release 4 Table 7.1.2.7-1: Map of deviceHeartRateMonitor of oneM2M HAIM to OMA DWAPI-PCH ModuleClass DataPoints of oneM2M HAIM Data objects of OMA DWAPI-PCH Description pulsemeter pulseRate rate See clause 5.3.1.68. rr rr energy energy battery level batteryLevel See clause 5.3.1.10. It shall be the integer type at HAIM, but shall be the float type at OMA DWAPI- PCH. It shall be the rounded percentage of the current level of battery in the range of [0, 100] at HAIM, but shall be a float number in the range of [0,0, 1,0] at OMA DWAPI-PCH. |
e6ebfc519c3e089619ef5d1ffe3caa64 | 118 123 | 7.1.3 Data Types | Data types of oneM2M HAIM and OMA DWAPI-PCH shall be mapped each other on the basis of Table 7.1.3-1. Table 7.1.3-1: Map of data types between oneM2M and OMA DWAPI-PCH oneM2M data type Mapping to data type in OMA DWAPI Description xs:integer int, number, string Data type for 32-bit signed integer. For indicating 3D printerState, the integer value should be interpreted into string by referring the tables in clause 7.1.2.1. xs:string string, array Data type for text. The length limitation should be considered for the mapping. xs:float float Data type for a single precision 32-bit floating point type as defined in XML Schema 1.0 [14] as the float primitive type. xs:boolean boolean Data type for Boolean. 8 Ontology for the Home Appliance Information Model aligned with oneM2M Base Ontology The following table shows a mapping of the Home Appliance Information Model to the oneM2M Base Ontology in ETSI TS 118 112 [i.5]. Table 8-1 only shows mapping of SDT concepts that are used to classify all concepts in the Home Appliance Information Model. Therefore, since any concept in the Home Appliance Information Model can be classified according to a specific SDT concept it also (transitively) maps to the related class of the oneM2M Base Ontology. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 125 oneM2M TS-0023 version 4.8.1 Release 4 Table 8-1: Mapping between SDT concepts in the Home Appliance Information Model and the oneM2M Base Ontology SDT Concept in the Home Appliance Information Model Mapping relationship Class in Base Ontology Property in Base Ontology Comment SDT: Device sub-class of Device SDT: SubDevice sub-class of Device The base ontology allows a Device to consist of (sub-) Devices SDT: Action sub-class of Operation SDT: Args (of an Action) sub-class of OperationInput SDT: ReturnType (of an Action) sub-class of OperationOutput SDT: Event sub-class of Operation SDT: Data (of an Event) sub-class of OutputDataPoint SDT: Module sub-class of Service The base ontology allows a Service to have subServices. Each SDT:Module implements one SDT:ModuleClass. Therefore SDT:Module can be considered a subclass of SDT:ModuleClass and therefore subclass of oneM2M:Service. See note. SDT: ModuleClass sub-class of Service See note SDT: UnitOfMeasure sub-class of MetaData SDT: DataPoint sub-class of InputDataPoint If SDT:DataPoint is writable SDT: DataPoint sub-class of OutputDataPoint If SDT:DataPoint is readable SDT: Property (of a Device) sub-class of ThingProperty SDT: Property (of a ModuleClass) sub-class of Aspect Aspect (of the Functionality) SDT: SimpleType sub-property of hasDataType The base ontology's SimpleTypeVariable class has data properties: • hasDataType • hasDataRestriction SDT: Constraint sub-property of hasDataRestriction NOTE: In RESTful technologies the Service (i.e. the electronic representation of a Functionality in a network) is implicitly bound to its Functionality by the naming of the used resources (e.g. the Functionality of ModuleClass "AudioVolume" is implemented as a Service through CRUD operations on a [audioVolume] <flexContainer> specialization). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 126 oneM2M TS-0023 version 4.8.1 Release 4 Annex A (informative): Resource Mapping Examples A.1 Introduction The AE may construct oneM2M resource tree on hosting CSE as the mapping of associated device, and each XSD definition for the device information models is generated following 'Resource Mapping Rule' in clause 6.2. The present clause explains how to use the oneM2M resource tree to map Device model for each device (see clause 5.5). A.2 Example for Device model 'deviceAirConditioner' The present clause explains the creation process for the device typed 'deviceAirConditioner' (see clause 5.5.4.1 for device model definition of 'deviceAirConditioner'). Using the definition, 'deviceAirConditioner' model is mapped to [deviceAirConditioner] resource which is a specialization of <flexContainer> resource (see Figure A.2-1). Figure A.2-1: Structure of [deviceAirConditioner] resource ETSI ETSI TS 118 123 V4.8.1 (2024-02) 127 oneM2M TS-0023 version 4.8.1 Release 4 The AE creates the [deviceAirConditioner] specialization of <flexContainer> resource for the Device model [deviceAirConditioner] resource. The [deviceAirConditioner] resource contains the child resource specified in Table A.2-1. Table A.2-1: Child resources of [deviceAirConditioner] resource Child Resources of [deviceAirConditioner] Child Resource Type Multiplicity Description [variable] <flexContainer> as defined in the specialization [binarySwitch] 0..1 This resource is used to map 'binarySwitch' ModuleClass defined in clause 5.3.1.12. [variable] <flexContainer> as defined in the specialization [runState] 0..1 This resource is used to map 'runState' ModuleClass defined in clause 5.3.1.75. [variable] <flexContainer> as defined in the specialization [airConJobMode] 0..1 This resource is used to map 'airConJobMode' ModuleClass defined in clause. [variable] <flexContainer> as defined in the specialization [airConOperationMode] 0..1 This resource is used to map 'airConOperationMode' ModuleClass defined in clause 5.3.1.57. [variable] <flexContainer> as defined in the specialization [airCleanOperationMode] 0..1 This resource is used to map 'airCleanOperationMode' ModuleClass defined in clause 5.3.1.57. [variable] <flexContainer> as defined in the specialization [temperature] 0..1 This resource is used to map 'temperature' ModuleClass defined in clause 5.3.1.87. [variable] <flexContainer> as defined in the specialization [timer] 0..1 This resource is used to map 'timer' ModuleClass defined in clause 5.3.1.90. [variable] <flexContainer> as defined in the specialization [sleepTimer] 0..1 This resource is used to map 'sleepTimer' ModuleClass defined in clause 5.3.1.90. [variable] <flexContainer> as defined in the specialization [turbo] 0..1 This resource is used to map 'turbo' ModuleClass defined in clause 5.3.1.91. [variable] <flexContainer> as defined in the specialization [airFlow] 0..1 This resource is used to map 'airFlow' ModuleClass defined in clause 5.3.1.4. [variable] <flexContainer> as defined in the specialization [powerSave] 0..1 This resource is used to map 'powerSave' ModuleClass defined in clause 5.3.1.66. [variable] <flexContainer> as defined in the specialization [airQualitySensor] 0..1 This resource is used to map 'airQualitySensor' ModuleClass defined in clause 5.3.1.6. [variable] <flexContainer> as defined in the specialization [filterInfo] 0..1 This resource is used to map 'filterInfo' ModuleClass defined in clause 5.3.1.35. [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [i.3]. The [deviceAirConditioner] resource contains the attributes specified in Table A.2-2. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 128 oneM2M TS-0023 version 4.8.1 Release 4 Table A.2-2: Attributes of [deviceAirConditioner] resource Attributes of [deviceAirConditioner] Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. resourceName 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. expirationTime 1 RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. creationTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. lastModifiedTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. labels 0..1 RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. creator 0..1 RW See clause 9.6.35 in ETSI TS 118 101 [i.3]. containerDefinition 1 WO The value is "org.onem2m.home.device.airconditioner". ontologyRef 0..1 RW See clause 9.6.35 in ETSI TS 118 101 [i.3]. contentSize 1 RO See clause 9.6.35 in ETSI TS 118 101 [i.3]. nodeLink 0..1 RO nodeLink attribute links to a <node> resource that is hosted on the same hosting CSE of the <flexContainer>. See clauses 6.2.2 and 6.2.5 for more details. flexNodeLink 0..1 RO flexNodeLink attribute links to a [flexNode] specialization of a <flexContainer> resource that is hosted on the same hosting CSE of the <flexContainer>. See clauses 5.8, 6.2.2 and 6.2.5 for more details. A.3 Example of ModuleClass 'binarySwitch' The [binarySwitch] resource is used to share information regarding the modelled binary switch module as a ModuleClass. The [binarySwitch] resource is a specialization of the <flexContainer> resource. Figure A.3-1: Structure of [binarySwitch] resource ETSI ETSI TS 118 123 V4.8.1 (2024-02) 129 oneM2M TS-0023 version 4.8.1 Release 4 The [binarySwitch] resource contains the child resource specified in Table A.3-1. Table A.3-1: Child resources of [binarySwitch] resource Child Resources of [binarySwitch] Child Resource Type Multiplicity Description [variable] <flexContainer> as defined in the specialization [toggle] 0..1 This resource is used to map 'toggle' Action defined in clause 5.3.1.12. [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [i.3]. The [binarySwitch] resource contains the attributes specified in Table A.3-2. Table A.3-2: Attributes of [binarySwitch] resource Attributes of [binarySwitch] Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. resourceName 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. expirationTime 1 RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. creationTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. lastModifiedTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. labels 0..1 RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. creator 0..1 RW See clause 9.6.35 in ETSI TS 118 101 [i.3]. containerDefinition 1 WO The value is "org.onem2m.home.moduleclass.binaryswitch" ontologyRef 0..1 RW See clause 9.6.35 in ETSI TS 118 101 [i.3]. contentSize 1 RO See clause 9.6.35 in ETSI TS 118 101 [i.3]. nodeLink 0..1 RW Not applicable to a ModuleClass specialization. This attribute is not present in an instantiation of this resource. flexNodeLink 0..1 RW Not applicable to a ModuleClass specialization. This attribute is not present in an instantiation of this resource. dataGenerationTime 0..1 RO See clause 6.2.3. powerState 1 RW See clause 5.3.1.12. A.4 Example of Action 'toggle' The [toggle] resource is used to share information regarding the modelled toggle as an Action. The [toggle] resource is a specialization of the <flexContainer> resource. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 130 oneM2M TS-0023 version 4.8.1 Release 4 Figure A.4-1: Structure of [toggle] resource The [toggle] resource contains the child resource specified in Table A.4-1. Table A.4-1: Child resources of [toggle] resource Child Resources of [toggle] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 in ETSI TS 118 101 [i.3] The [toggle] resource contains the attributes specified in Table A.4-2. Table A.4-2: Attributes of [toggle] resource Attributes of [toggle] Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. resourceID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. resourceName 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. parentID 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. expirationTime 1 RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. creationTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. lastModifiedTime 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. labels 0..1 RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. dynamicAuthorizationCon sultationIDs 0..1 (L) RW See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. stateTag 1 RO See clause 9.6.1.3 in ETSI TS 118 101 [i.3]. creator 0..1 RW See clause 9.6.35 in ETSI TS 118 101 [i.3]. containerDefinition 1 WO The value is "org.onem2m.home.moduleclass.binaryswitch.toggle". ontologyRef 0..1 RW See clause 9.6.35 in ETSI TS 118 101 [i.3]. contentSize 1 RO See clause 9.6.35 in ETSI TS 118 101 [i.3]. nodeLink 0..1 RW Not applicable to an Action specialization. This attribute is not present in an instantiation of this resource. flexNodeLink 0..1 RW Not applicable to an Action specialization. This attribute is not present in an instantiation of this resource. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 131 oneM2M TS-0023 version 4.8.1 Release 4 Annex B (informative): Introduction of External Organizations' Data Models B.1 OMA Got API (DWAPI-PCH) OMA GotAPI(OMA Generic Open Terminal API Framework) provides the framework to enable applications and multitype devices through GotAPI Servers and Extension Plug-Ins [6]. When APIs are implemented in Extension Plug-Ins under the GotAPI framework, these APIs are called as OMA Device WebAPIs Enabler. In case of healthcare devices, these APIs are called as OMA Device WebAPIs for Personal Connected Healthcare (DWAPI-PCH). Healthcare devices can be a one of the smart home devices so OMA DWWAPI-PCH can have relationship with oneM2M SDT. B.2 OCF B.2.1 Introduction OCF specifications provide a common, open connectivity framework for embedded developers that enables a common device discovery and interaction model, common data model and a robust security framework whilst abstracting away the physical connectivity hardware (and related protocols). OCF Device Specification [i.8] defines list of smart home devices. Each smart home device contains a unique identifier and list of mandatory/optional resources. Each resource definition contains a unique identifier, identification of the default interface and other supported interfaces, list of supported methods, list of allowed actions and list of the mandatory/optional property(-ies) the resource exposes. This clause specifies the mapping relationship between oneM2M and OCF Devices. B.2.2 Device Type Mapping Table B.2.2-1 captures the equivalency mapping between OCF defined Device Types and oneM2M defined Devices. The minimum module sets for each oneM2M device is provided in the present document. The minimum resource sets for each OCF Device is provided in the OCF Device Specification [i.8]. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 132 oneM2M TS-0023 version 4.8.1 Release 4 Table B.2.2-1: OCF to oneM2M Device Type Mapping OCF Device Name OCF Device Type oneM2M Device Active Speaker oic.d.speaker N/A Air Conditioner oic.d.airconditioner deviceAirConditioner Air Purifier oic.d.airpurifier deviceAirPurifier Air Quality Monitor oic.d.airqualitymonitor deviceAirQualityMonitor Battery oic.d.battery deviceStorageBattery Blind oic.d.blind deviceWindowShade Camera oic.d.camera deviceCamera Clothes Washer Dryer oic.d.washerdryer deviceClothesWasherDryer Coffee Machine oic.d.coffeemachine deviceCoffeeMachine Cooker Hood oic.d.cookerhood deviceCookerHood Cooktop oic.d.cooktop deviceCooktop Dehumidifier oic.d.dehumidifier deviceDehumidifier Dishwasher oic.d.dishwasher deviceDishWasher Door oic.d.door deviceDoor Dryer (Laundry) oic.d.dryer deviceClothesDryer Electric Vehicle Charger oic.d.electricvehiclecharger deviceElectricVehicleCharger Electric Meter oic.d.electricmeter deviceSmartElectricMeter Energy Generator oic.d.energygenerator deviceMicrogeneration Fan oic.d.fan deviceFan Food Probe oic.d.foodprobe deviceFoodProbe Freezer oic.d.freezer deviceFreezer Garage Door oic.d.garagedoor deviceDoor Generic Sensor oic.d.sensor N/A Grinder oic.d.grinder N/A Humidifier oic.d.humidifier deviceHumidifier Light oic.d.light deviceLight Oven oic.d.oven deviceOven Printer oic.d.printer devicePrinter Printer Multi-Function oic.d.multifunctionprinter deviceMultiFunctionPrinter Receiver oic.d.receiver deviceAudioReceiver Refrigerator oic.d.refrigerator deviceRefrigerator Robot Cleaner oic.d.robotcleaner deviceRobotCleaner Scanner oic.d.scanner deviceScanner Security Panel oic.d.securitypanel deviceSecurityPanel Set Top Box oic.d.stb deviceSetTopBox Smart Lock oic.d.smartlock deviceDoorLock Smart Plug oic.d.smartplug deviceSmartPlug Switch oic.d.switch deviceSwitch Television oic.d.tv deviceTelevision Thermostat oic.d.thermostat deviceThermostat Washer (Laundry) oic.d.washer deviceClothesWasher Water Heater oic.d.waterheater deviceWaterHeater Water Valve oic.d.watervalve deviceWaterValve Window oic.d.window N/A ETSI ETSI TS 118 123 V4.8.1 (2024-02) 133 oneM2M TS-0023 version 4.8.1 Release 4 Annex C (informative): Mapping to Content Attribute C.1 Introduction Current SDT models are used only in form of <flexContainer>s, and how to design content attribute of <contentInstance> and <timeSeriesInstance> is left to developers. There is no rule for design of content attribute, it means interoperability of content attribute is low. Then SDT can become one of the rules for design of content attribute, and the low interoperability problem will be solved. The present clause explains how to use SDT as one of the rules for design of content attribute. There are several benefits of using SDT in content attribute. First, the resource architecture can be simpler than the one using <flexContainer>s. When using <flexContainer>s, universal attributes are mapped either into attributes of [deviceInfo] under a <node> besides <flexContainer>s, or into custom attributes of [dmDeviceInfo] under a [flexNode] (see Rule 1-8 in clause 6.2.2). Moreover, Action Class and DataPoint Class are the same layer in SDT, but Action Class is mapped to <flexContainer> itself and DataPoint Class is mapped to attributes of <flexContainer> expressing Module class. On the other hand, Using SDT in content attribute means using only one <contentInstance> or <timeSeriesInstance> so the resource architecture is simple. Relating this benefit, it becomes easy to understand where to write information. Second, <contentInstance> and <timeSeriesInstance> becomes more interoperable. How to write SDT in content attribute is able to become one of designs of content attribute and the low interoperability of <contentInstance> and <timeSeriesInstance> will be solved. Third, If useful libraries are prepared, content attribute is able to be expressed in XML/JSON/CBOR with small changes on program. In addition, tools can generate validator of the data and converter among the supported formats. C.2 XML representation of SDT instances C.2.1 Mapping Rules of XML representation ModuleClasses, SubDevice models and DeviceClass models written in clause 5 are expressed another way with using each class names as the tag. This clause introduces this way. Normative work for defining the mapping rules from SDT to XML/ JSON instance are defined by SDT4.0. Mapping from SDT instance into XML representation is following. Inclusion relationship of SDT instances are directly expressed as inclusion relationship of XML tags. Tag name is the same as each classes. <DeviceClass Class Name> <SubDevice Class Name> <ModuleClass Class Name> <DataPoint Class Name>value</DataPoint Class Name> <Property Class Name>value</Property Class Name> </ModuleClass Class Name> </SubDevice Class Name> </DeviceClass Class Name> ETSI ETSI TS 118 123 V4.8.1 (2024-02) 134 oneM2M TS-0023 version 4.8.1 Release 4 Action Class can not have any value and it only lengthen the message so it is omitted. When a certain device does not have any SubDevice, the tags about SubDevices don't appear and tags about ModuleClass are placed under the DeviceClass directly. C.2.2 Example of XML representation Below is the example for deviceThreeDPrinter: <deviceThreeDPrinter> <binarySwitch> <powerState>True</powerState> <toggle></toggle> </binarySwitch> <faultDetection> <status>False</status> <code></code> <description></description> </faultDetection> <3Dprinter> <printType>2</printType> <printSizeX>70</printSizeX> <printSizeY>80</printSizeY> <printSizeZ>90</printSizeZ> <network>True</network> <memorySize>100</memorySize> </3Dprinter> <runState> <currentMachineState>1</currentMachineState> <machineStates>1,2,3</machineStates> <currentJobState>1</currentJobState> <jobStates>1,2,3</jobStates> <progressPercentage>60</progressPercentage> </runState> <temperature> <currentTemperature>20</currentTemperature> <targetTemperature>23</targetTemperature> <unit>celsius</unit> ETSI ETSI TS 118 123 V4.8.1 (2024-02) 135 oneM2M TS-0023 version 4.8.1 Release 4 <minValue>15</minValue> <maxValue>28</maxValue> <stepValue>0.1</stepValue> </temperature> <printQueue> <uri> file://www.example.com/file.extension</uri> <printingState>1</printingState> </printQueue> </deviceThreeDPrinter> C.3 JSON representation of SDT instances C.3.1 Mapping Rules of JSON representation This clause explains how to represent SDT instances in JSON format. Inclusion relationship of SDT instances are directly expressed as inclusion relationship of JSON hash({}). Key name is same as each class name of SDT. Value types are written in various types depending on SDT definition. { "Device Class Name": { "SubDevice Class Name": { "Module Class Name": { "DataPointClassName": value ( by specified types in SDT) } } } Action Class can not have any value and it only lengthen the message so it is omitted. When a certain device does not any SubDevice Class, the tags about SubDevices Class do not appear and tags about Module Class are placed under the Device Class directly. C.3.2 Example of JSON representation Below is the example for deviceThreeDPrinter: { "deviceThreeDPrinter": { "binarySwitch": { "powerState": true }, "faultDetection": { "status": false, "code": "", "description": "" }, ETSI ETSI TS 118 123 V4.8.1 (2024-02) 136 oneM2M TS-0023 version 4.8.1 Release 4 "3Dprinter": { "printType": 2, "printSizeX": 70, "printSizeY": 80, "printSizeZ": 90, "network": true, "memorySize": 100 }, "runState": { "currentMachineState": 1, "machineStates": [1, 2, 3], "currentJobState": 1, "jobState": [1, 2, 3], "progressPercentage": 60, }, "temperature": { "currentTemperature": 20, "targetTemperature": 23, "unit": "celsius", "minValue": 15, "maxValue": 28, "stepValue": 0.1 }, "printQueue":{ "uri": "file://www.example.com/file.extension", "printingState": 1 } } C.4 How to write into content attribute Any size of the SDT class cluster may be mapped to content attribute. For example, from only the DataPoint class to DataPoint, Action, Module, SubDevice and Device classes may be mapped to one content attribute at once. ETSI ETSI TS 118 123 V4.8.1 (2024-02) 137 oneM2M TS-0023 version 4.8.1 Release 4 Figure C.4-1: Image of Mapping SDT to content attribute An example that expresses a CREATE request for <contentInstance> serialized into an XML document is shown below. This example is for the Module class and DataPoint class mapping and only content attribute and contentInfo attribute are shown as content parameter (pc). <?xml version="1.0" encoding="UTF-8"?> <m2m:rqp xmlns:m2m="http://www.onem2m.org/xml/protocols"> <op>1</op> <to>//example.net/myCSE/-/Cont1</to> <fr>/myCSE/C2345</fr> <rqi>0002bf63</rqi> <ty>4</ty> <pc> <m2m:cin> <cnf>SDT:org.onem2m.home.device/module/temperature </cnf> <con> <tempe> <curT0>5</curT0> <tarTe>3</tarTe> </tempe> </con> </m2m:cin> </pc> </m2m:rqp> In content attribute, a value of DataPoint may be written between tags named the certain DataPoint name. contentInfo attribute is able to be omitted because content attribute has tags named the certain Module class name (<temp></temp>). ETSI ETSI TS 118 123 V4.8.1 (2024-02) 138 oneM2M TS-0023 version 4.8.1 Release 4 An example for only DataPoint class mapping is shown below: <?xml version="1.0" encoding="UTF-8"?> <m2m:rqp xmlns:m2m="http://www.onem2m.org/xml/protocols"> <op>1</op> <to>//example.net/myCSE/-/Cont1</to> <fr>/myCSE/C2345</fr> <rqi>0002bf63</rqi> <ty>4</ty> <pc> <m2m:cin> <cnf>SDT:org.onem2m.home.device/datapoint/temperature/currentTemperature </cnf> <con>5</con> </m2m:cin> </pc> </m2m:rqp> In this case, the contentInfo attribute can NOT be omitted because it cannot be determined which Datapoint is written in the content attribute without the contentInfo attribute. If a contentInfo attribute is not used, content attribute may change as follows: <con> <curT0>5</curT0> </con> ETSI ETSI TS 118 123 V4.8.1 (2024-02) 139 oneM2M TS-0023 version 4.8.1 Release 4 Annex D (informative): Bibliography • Open Mobile Alliance™ OMA-TS-Blood-Pressure-Monitor-APIs-V1-0-20160419-C: "Blood Pressure Monitor APIs". • Open Mobile Alliance™ OMA-TS-Glucometer-APIs-V1-0-20160419-C: "Glucometer APIs ". • Open Mobile Alliance™ OMA-TS-Heart-Rate-Monitor-APIs-V1-0-20160419-C: "Heart Rate Monitor APIs". • Open Mobile Alliance™ OMA-TS-Pulse-Oximeter-APIs-V1-0-20160419-C: "Pulse Oximeter APIs". • Open Mobile Alliance™ OMA-TS-Thermometer-APIs-V1-0-20160419-C: "Thermometer APIs". • Open Mobile Alliance™ OMA-TS-Weight-Scale-Body-Composition-Analyzer-APIs-V1-0-20160419-C: "Weight Scale / Body Composition Analyzer APIs". ETSI ETSI TS 118 123 V4.8.1 (2024-02) 140 oneM2M TS-0023 version 4.8.1 Release 4 History Document history V4.8.1 February 2024 Publication |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 1 Scope | The present document defines a number of test suites to assess the interoperability between implementations claiming conformance to CAdES baseline signatures [1]. The test suites are defined with four different layers reflecting the four different levels of CAdES baseline signatures: • Tests suite addressing interoperability between applications claiming B-B level conformance. • Tests suite addressing interoperability between applications claiming B-T level conformance. • Tests suite addressing interoperability between applications claiming B-LT level conformance. • Tests suite addressing interoperability between applications claiming B-LTA level conformance. Test suites also cover augmentation of CAdES baseline signatures and negative test cases. These test suites are agnostic of the PKI infrastructure. Any PKI infrastructure can be used including the one based on EU Member States Trusted Lists. |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 2 References | |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 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 EN 319 122-1: "Electronic Signatures and Infrastructures (ESI); CAdES digital signatures; Part 1: Building blocks and CAdES baseline signatures". |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 2.2 Informative references | References are either specific (identified by date of publication and/or edition number or version number) or non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the referenced document (including any amendments) applies. 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] ETSI TR 119 124-1: "Electronic Signatures and Infrastructures (ESI); CAdES digital signatures - Testing Conformance and Interoperability; Part 1: Overview". [i.2] ETSI TR 119 001: "Electronic Signatures and Infrastructures (ESI); The framework for standardization of signatures; Definitions and abbreviations". [i.3] ETSI EN 319 102-1: "Electronic Signatures and Infrastructures (ESI); Procedures for Creation and Validation of AdES Digital Signatures; Part 1: Creation and Validation". ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 6 |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 3 Definitions and abbreviations | |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 3.1 Definitions | For the purposes of the present document, the terms and definitions given in ETSI TR 119 001 [i.2] and the following apply: negative test case: test case for a signature whose validation according to ETSI EN 319 102-1 [i.3] would not result in TOTAL-PASSED |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 3.2 Abbreviations | For the purposes of the present document, the abbreviations given in ETSI TR 119 001 [i.2] apply. |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 4 Overview | This clause describes the overall approach used throughout the present document to specify test suites for CAdES baseline signatures interoperability testing. ETSI EN 319 122-1 [1] defines four different levels of CAdES baseline signatures. The test suites are defined with different layers reflecting the levels of CAdES baseline signatures specified in [1]: • Testing CAdES signatures interoperability between applications claiming B-B level conformance. • Testing CAdES signatures interoperability between applications claiming B-T level conformance. • Testing CAdES signatures interoperability between applications claiming B-LT level conformance. • Testing CAdES signatures interoperability between applications claiming B-LTA level conformance. • Testing augmentation of CAdES signatures from B-T level to B-LTA level. • Negative test cases for CAdES baseline signatures: - CAdES-B-B signatures test cases. - CAdES-B-T signatures test cases. - CAdES-B-LTA signatures test cases. |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 5 Testing interoperability of CAdES-B-B signatures | The test cases in this clause have been defined for different combinations of CAdES-B-B signatures attributes. Mandatory attributes for CAdES-B-B signatures described in [1], clause 6.3, shall be present. Table 1 shows which attributes are required to generate CAdES-B-B signatures for each test case. ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 7 Table 1: Test cases for CAdES-B-B signatures TC ID Description Pass criteria Signature attributes CAdES/BB/1 This is the simplest CAdES- B-B signatures interoperability test case. The signature ONLY CONTAINS the mandatory CAdES attributes. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2 and SigningCertificate (included in SignedData.certificates field) attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ContentType o SigningTime o ESSSigningCertificateV2 CAdES/BB/2 In this CAdES-B-B signatures interoperability test case the signature contains a CertifiedAttributeV2 in addition to the CAdES/BB/1 test case attributes. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2, CertifiedAttributesV2 (included in SignerAttributesV2) and SigningCertificate (included in SignedData.certificates field) attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ContentType o SigningTime o ESSSigningCertificateV2 o SignerAttributesV2 (CertifiedAttributeV2) CAdES/BB/3 In this CAdES-B-B signatures interoperability test case the signature contains a ClaimedAttribute in addition to the CAdES/BB/1 test case attributes. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2, ClaimedAttribute (included in SignerAttributesV2) and SigningCertificate (included in SignedData.certificates field) attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ContentType o SigningTime o ESSSigningCertificateV2 o SignerAttributesV2 (CertifiedAttributeV2) CAdES/BB/4 This test case tests a CAdES-B-B signature with multiple independent signatures. The input to this test is a CAdES signature as specified in CAdES/BB/1 test case. Positive validation. The signature shall contain 2 SigningCertificates attributes (included in SignedData.certificates field) and 2 signerInfos containing ContentType, SigningTime, MessageDigest and ESSSigningCertificateV2 attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime CAdES/BB/5 This test case tests a CAdES-B-B signature with a CounterSignature attribute. The input to this test is a CAdES signature as specified in CAdES/BB/1 test case. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2, CounterSignature and SigningCertificate (included in SignedData.certificates field) attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ContentType o SigningTime o ESSSigningCertificateV2 • UnsignedAttributes o CounterSignature CAdES/BB/6 This test case tests a CAdES-B-B signature that contains SignerLocation and CommitmentTypeIndication attributes in addition to the CAdES/BB/1 test case attributes. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2, SignerLocation (containing at least the countryName and localityName values), CommitmentTypeIndication and SigningCertificate (included in SignedData.certificates field) attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ContentType o SigningTime o ESSSigningCertificateV2 o SignerLocation o CommitmentTypeIndication ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 8 TC ID Description Pass criteria Signature attributes CAdES/BB/7 This test case tests a CAdES-B-B signature that contains a ContentTimeStamp attribute in addition to the CAdES/BB/1 test case attributes. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2, ContentTimeStamp and SigningCertificate (included in SignedData.certificates field) attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ContentType o SigningTime o ESSSigningCertificateV2 o ContentTimeStamp CAdES/BB/8 This test case tests a CAdES-B-B signature that contains an explicit SignaturePolicyIdentifier attribute in addition to the CAdES/BB/1 test case attributes. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2, SignaturePolicyIdentifier and SigningCertificate (included in SignedData.certificates field) attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ContentType o SigningTime o ESSSigningCertificateV2 o SignaturePolicyIdentifier CAdES/BB/9 This test case tests a CAdES-B-B signature in which digest algorithm SHA1 is used to digest data to be signed. The signature ONLY CONTAINS the mandatory CAdES attributes. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, ESSSigningCertificate and SigningCertificate (included in SignedData.certificates field) attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ContentType o SigningTime o ESSSigningCertificate |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 6 Testing interoperability of CAdES-B-T signatures | The test cases in this clause have been defined for different combinations of CAdES-B-T signatures attributes. CAdES baseline signatures claiming conformance to B-T level of document [1] shall be built on baseline signatures conformant to B-B level. A CAdES baseline signature conformant to B-T level shall be a baseline signature conformant to B-B level for which a Trust Service Provider has generated a trusted token (time-stamp token) proving that the signature itself actually existed at a certain date and time. Mandatory attributes for CAdES-B-T signatures described in document [1], clause 6.3, shall be present. Table 2 shows which attributes are required to generate CAdES-B-T signatures for each test case. Table 2: Test cases for CAdES-B-T signatures TC ID Description Pass criteria Signature attributes CAdES/BT/1 This is the simplest CAdES- B-T signatures interoperability test case. The signature ONLY CONTAINS the mandatory CAdES attributes for CAdES-B-B signatures and a SignatureTimeStamp unsigned attribute. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2, SignatureTimeStamp and SigningCertificate (included in SignedData.certificates field) attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp CAdES/BT/2 This test case tests the adding of an indipendent CAdES-B-T signature to an already signed document in CAdES-B-T signature format. The input to this test is a CAdES-B-T signature as specified in CAdES/BT/1 test case. Positive validation. The signature shall contain 2 SigningCertificates attributes (included in SignedData.certificates field) and 2 signerInfos containing ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 9 TC ID Description Pass criteria Signature attributes CAdES/BT/3 This test case tests the adding of an indipendent CAdES-B-T signature to an already signed document in CAdES-B-B signature format. The input to this test is a CAdES-B-B signature as specified in CAdES/BB/1 test case. Positive validation. The signature shall contain 2 SigningCertificates attributes (included in SignedData.certificates field) and 2 signerInfos containing ContentType, SigningTime, MessageDigest and ESSSigningCertificateV2 attributes. The second signerInfo contains a SignatureTimeStamp attribute too. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 7 Testing interoperability of CAdES-B-LT signatures | The test cases in this clause have been defined for different combinations of CAdES-B-LT signatures attributes. CAdES baseline signatures claiming conformance to B-LT level of document [1] shall be built on baseline signatures conformant to B-T level. A CAdES baseline signature conformant to B-LT level shall be a baseline signature conformant to B-T level to which values of certificates and values of certificates status used to validate the signature have been added. Mandatory attributes for CAdES-B-LT signatures described in document [1], clause 6.3, shall be present. Table 3 shows which attributes are required to generate test CAdES-B-LT signatures for each test case. Table 3: Test cases for CAdES-B-LT signatures TC ID Description Pass criteria Signature attributes CAdES/BLT/1 This is the simplest CAdES- B-LT signatures interoperability test case. The signature contains the mandatory CAdES attributes for CAdES-B-T signatures. The full set of certificates that have been used to validate the signature is included. The revocation material that have been used in the validation of the signature is included. The revocation data used are CRLs. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, Certificates, Crls.crl, ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates • Crls.crl • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp CAdES/BLT/2 This CAdES-B-LT signatures interoperability test case is similar to CAdES/BLT/1 one. The signature contains the mandatory CAdES attributes for CAdES-B-T signatures. The full set of certificates that have been used to validate the signature is included. The revocation material that have been used in the validation of the signature is included. The revocation data used are OCSP responses. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, Certificates, Crls.other, ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates • Crls.other • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 10 TC ID Description Pass criteria Signature attributes CAdES/BLT/3 In this CAdES-B-LT signatures interoperability test case the signature contains a CertifiedAttributeV2 attribute in addition to the CAdES/BLT/1 test case attributes. The full set of certificates that have been used to validate the signature is included and contains the Attribute Authority certificate too. The revocation material that have been used in the validation of the signature is included. The revocation data used are CRLs. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, CertifiedAttributesV2 (included in SignerAttributesV2), Certificates, Crls.crl, ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates • Crls.crl • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime o SignerAttributesV2 (CertifiedAttributeV2) • UnsignedAttributes o SignatureTimeStamp CAdES/BLT/4 In this CAdES-B-LT signatures interoperability test case the signature contains a CertifiedAttributeV2 attribute in addition to the CAdES/BLT/2 test case attributes. The full set of certificates that have been used to validate the signature is included and contains the Attribute Authority certificate too. The revocation material that have been used in the validation of the signature is included. The revocation data used are OCSP responses. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, CertifiedAttributesV2 (included in SignerAttributesV2), Certificates, Crls.other, ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates • Crls.other • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime o SignerAttributesV2 (CertifiedAttributeV2) • UnsignedAttributes o SignatureTimeStamp |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 8 Testing interoperability of CAdES-B-LTA signatures | The test cases in this clause have been defined for different combinations of CAdES-B-LTA signatures attributes. CAdES baseline signatures claiming conformance to B-LTA level of document [1] shall be built on baseline signatures conformant to B-LT level. A CAdES baseline signature conformant to B-LTA level shall be a baseline signature conformant to B-LT level to which one or more archive-time-stamp-v3 attributes (each one including one ats-hash-index-v3 unsigned attribute as specified in document [1]) have been added. Mandatory attributes for CAdES-B-LTA signatures described in document [1], clause 6.3, shall be present. Table 4 shows which attributes are required to generate test CAdES-B-LTA signatures for each test case. ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 11 Table 4: Test cases for CAdES-B-LTA signatures TC ID Description Pass criteria Signature attributes CAdES/BLTA/1 This is the simplest CAdES- B-LTA signatures interoperability test case. The signature contains the mandatory CAdES attributes for CAdES-B-LT signatures (the revocation data used are CRLs). One ArchiveTimeStampV3 attribute is included (including one ats-hash- index-v3 unsigned attribute). Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, Certificates, Crls.crl, ESSSigningCertificateV2, SignatureTimeStamp and ArchiveTimeStampV3 (including one ats-hash-index-v3 unsigned attribute) attributes. • Certificates • Crls.crl • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp o ArchiveTimeStampV3 o ats-hash-index-v3 CAdES/BLTA/2 This CAdES-B-LTA signatures interoperability test case is similar to CAdES/BLTA/1 one. The signature contains the mandatory CAdES attributes for CAdES-B-LT signatures (the revocation data used are OCSP responses). One ArchiveTimeStampV3 attribute is included (including one ats-hash- index-v3 unsigned attribute). Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, Certificates, Crls.other, ESSSigningCertificateV2, SignatureTimeStamp and ArchiveTimeStampV3 (including one ats-hash-index-v3 unsigned attribute) attributes. • Certificates • Crls.other • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp o ArchiveTimeStampV3 o ats-hash-index-v3 CAdES/BLTA/3 In this case the CAdES-B- LT signature was time- stamped with an ArchiveTimeStampV2. Afterwards, the resulting long-term-validation signature is time-stamped again with an ArchiveTimeStampV3. The validation material corresponding to the first ArchiveTimeStampV2 is added within time-stamp token itself by one of the following methods: (1) the TSU provides the information in the SignedData of the time- stamp token; (2) adding the certificate-values attribute and the revocation-values attribute of the TSP as an unsigned attribute within the time-stamp token. The revocation data used are CRLs. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, Certificates, Crls.crl, CompleteCertificateRefs, CompleteRevocationRefs, ESSSigningCertificateV2, SignatureTimeStamp, ArchiveTimeStampV2 and ArchiveTimeStampV3 (including one ats-hash-index-v3 unsigned attribute) attributes. • Certificates • Crls.crl • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o CompleteCertificateRefs o CompleteRevocationRefs o SignatureTimeStamp o ArchiveTimeStampV2 o Certificates o Crls.crl o ArchiveTimeStampV3 o ats-hash-index-v3 ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 12 TC ID Description Pass criteria Signature attributes CAdES/BLTA/4 In this case the CAdES-B- LT signature was time- stamped with an ArchiveTimeStampV2. Afterwards, the resulting long-term-validation signature is time-stamped again with an ArchiveTimeStampV3. The validation material corresponding to the first ArchiveTimeStampV2 is added within time-stamp token itself by one of the following methods: (1) the TSU provides the information in the SignedData of the time- stamp token; (2) adding the certificate-values attribute and the revocation-values attribute of the TSP as an unsigned attribute within the time-stamp token. The revocation data used are OCSP responses. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, Certificates, Crls.other, CompleteCertificateRefs, CompleteRevocationRefs, ESSSigningCertificateV2, , ArchiveTimeStampV2 and ArchiveTimeStampV3 (including one ats-hash-index-v3 unsigned attribute) attributes. • Certificates • Crls.other • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o CompleteCertificateRefs o CompleteRevocationRefs o SignatureTimeStamp o ArchiveTimeStampV2 o Certificates o Crls.other o ArchiveTimeStampV3 o ats-hash-index-v3 CAdES/BLTA/5 In this case the CAdES-B- LT signature was time- stamped with an ArchiveTimeStampV3. Afterwards, the resulting CAdES-B-LTA signature is time-stamped again with an ArchiveTimeStampV3. The validation material corresponding to the first ArchiveTimeStampV3 is added in root SignedData. The revocation data used are CRLs. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, Certificates, Crls.crl, ESSSigningCertificateV2, SignatureTimeStamp and 2 different ArchiveTimeStampV3 attributes. • Certificates • Crls.crl • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp o ArchiveTimeStampV3 o ats-hash-index-v3 o ArchiveTimeStampV3 o ats-hash-index-v3 CAdES/BLTA/6 In this case the CAdES-B- LT signature was time- stamped with an ArchiveTimeStampV3. Afterwards, the resulting CAdES-B-LTA signature is time-stamped again with an ArchiveTimeStampV3. The validation material corresponding to the first ArchiveTimeStampV3 is added in root SignedData. The revocation data used are OCSP responses. Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, Certificates, Crls.other, ESSSigningCertificateV2, SignatureTimeStamp and 2 different ArchiveTimeStampV3 attributes. • Certificates • Crls.other • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp o ArchiveTimeStampV3 o ats-hash-index-v3 o ArchiveTimeStampV3 o ats-hash-index-v3 CAdES/BLTA/7 In this test case the CAdES- B-LT signature contains an explicit SignaturePolicyIdentifier attribute in addition to the mandatory CAdES attributes. The revocation data used are OCSP responses. One ArchiveTimeStampV3 attribute is included (including one ats-hash- index-v3 unsigned attribute). Positive validation. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate (included in SignedData.certificates field), SignaturePolicyIdentifier, Crls.crl, ESSSigningCertificateV2 and ArchiveTimeStampV3 attributes. • Certificates • Crls.crl • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SignaturePolicyIdentifier o SigningTime • UnsignedAttributes o SignatureTimeStamp o ArchiveTimeStampV3 o ats-hash-index-v3 ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 13 9 Testing CAdES baseline signatures augmentation interoperability The test cases in this clause have been defined for testing augmentation of CAdES-B-T signatures to CAdES-B-LTA signatures and subsequent validation of the augmented signatures. A CAdES baseline signature conformant to B-LTA level shall be a baseline signature conformant to B-T level to which values of certificates and values of certificates status used to validate the signature and one or more archive-time-stamp- v3 attributes (each one including one ats-hash-index-v3 unsigned attribute as specified in document [1]) have been added. Table 5 shows which attributes are required to augment a CAdES-B-T signature to a CAdES-B-LTA signature for each test case. Table 5: Test cases for augmentation of CAdES-B-T signatures to CAdES-B-LTA signatures TC ID Description Pass criteria Signature attributes CAdES/Aug/1 The CAdES-B-T signature, passed as input, shall be validated, the validation material concerning the signing certificate and the certificate that generated the signature timestamp shall be added (the revocation data used are CRLs) and, after that, one ArchiveTimeStampV3 attribute shall be added too (including one ats-hash- index-v3 unsigned attribute). Positive validation. The signature shall contain a CAdES-B-T signature with ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2 and SignatureTimeStamp to which Certificates, Crls.crl and ArchiveTimeStampV3 (including one ats-hash-index-v3 unsigned attribute) attributes have been added. • CAdES-B-T signature o Certificates o Crls.crl • UnsignedAttributes o ArchiveTimeStampV3 o ats-hash-index-v3 CAdES/Aug/2 The CAdES-B-T signature, passed as input, shall be validated, the validation material concerning the signing certificate and the certificate that generated the signature timestamp shall be added (the revocation data used are OCSP responses) and, after that, one ArchiveTimeStampV3 attribute shall be added too (including one ats-hash- index-v3 unsigned attribute). Positive validation. The signature shall contain a CAdES-B-T signature with ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2 and SignatureTimeStamp to which Certificates, Crls.other and ArchiveTimeStampV3 (including one ats-hash-index-v3 unsigned attribute) attributes have been added. • CAdES-B-T signature o Certificates o Crls.other • UnsignedAttributes o ArchiveTimeStampV3 o ats-hash-index-v3 CAdES/Aug/3 The input to this test case is a CAdES-B-LTA signature. The signature, passed as input, shall be validated, the validation material concerning the certificate that generated the ArchiveTimeStampV3 shall be added (the revocation data used are CRLs) and, after that, one ArchiveTimeStampV3 attribute shall be added too (including one ats-hash- index-v3 unsigned attribute). Positive validation. The signature shall contain a CAdES-B-LTA signature with ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2, SignatureTimeStamp, Certificates, Crls.crl and ArchiveTimeStampV3 to which Certificates, Crls.crl and a second ArchiveTimeStampV3 (including one ats-hash-index-v3 unsigned attribute) attributes have been added. • CAdES-B-T signature o Certificates o Crls.crl • UnsignedAttributes o ArchiveTimeStampV3 o ats-hash-index-v3 o ArchiveTimeStampV3 o ats-hash-index-v3 ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 14 TC ID Description Pass criteria Signature attributes CAdES/Aug/4 The input to this test case is a CAdES-B-LTA signature. The signature, passed as input, shall be validated, the validation material concerning the certificate that generated the ArchiveTimeStampV3 shall be added (the revocation data used are OCSP responses) and, after that, one ArchiveTimeStampV3 attribute shall be added too (including one ats-hash- index-v3 unsigned attribute). Positive validation. The signature shall contain a CAdES-B-LTA signature with ContentType, SigningTime, MessageDigest, ESSSigningCertificateV2, SignatureTimeStamp, Certificates, Crls.other and ArchiveTimeStampV3 to which Certificates, Crls.other and a second ArchiveTimeStampV3 (including one ats-hash-index-v3 unsigned attribute) attributes have been added. • CAdES-B-T signature o Certificates o Crls.other • UnsignedAttributes o ArchiveTimeStampV3 o ats-hash-index-v3 o ArchiveTimeStampV3 o ats-hash-index-v3 |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 10 Negative test cases for CAdES baseline signatures | |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 10.1 CAdES-B-B signatures test cases | The test cases in this clause have been defined for CAdES-B-B signatures. Table 6 summarizes negative test cases for CAdES-B-B signatures. Table 6: Negative test cases for CAdES-B-B signatures TC ID Description Pass criteria Signature attributes CAdES/BBN/1 Verify a CAdES-B-B signature that DOES NOT CONTAIN the mandatory SigningTime attribute Negative validation because the signature does not contain the mandatory SigningTime attribute. The signature shall contain ContentType, MessageDigest, SigningCertificate and ESSSigningCertificateV2 attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType CAdES/BBN/2 Verify a CAdES-B-B signature that DOES NOT CONTAIN the mandatory SigningCertificate reference attribute Negative validation because the signature does not contain the mandatory SigningCertificate reference attribute. The signature shall contain ContentType, MessageDigest, SigningCertificate and SigningTime attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ContentType o SigningTime CAdES/BBN/3 Verify a CAdES-B-B signature that DOES NOT CONTAIN the mandatory ContentType attribute qualifying the signed data object Negative validation because the signature does not contain the mandatory ContentType attribute. The signature shall contain ESSSigningCertificateV2, MessageDigest, SigningCertificate and SigningTime attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o SigningTime o ESSSigningCertificateV2 CAdES/BBN/4 Verify a CAdES-B-B signature that DOES NOT CONTAIN the mandatory certificates component into CMS signedData object Negative validation because the signature does not contain the mandatory certificates component. The signature shall contain ESSSigningCertificateV2, MessageDigest, ContentType and SigningTime attributes. • SignedAttributes o MessageDigest o ContentType o SigningTime o ESSSigningCertificateV2 ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 15 TC ID Description Pass criteria Signature attributes CAdES/BBN/5 Verify a CAdES-B-B signature having a wrong signature (the hash that was signed isn't the hash computed on the content being signed together with the signed attributes) Negative validation because the hash that was signed isn't the hash of the specified MessageDigest attribute. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate and ESSSigningCertificateV2 attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime CAdES/BBN/6 Verify a CAdES-B-B signature created with an untrusted signing certificate Negative validation because the signing certificate is untrusted. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate and ESSSigningCertificateV2 attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime CAdES/BBN/7 Verify a CAdES-B-B signature created with an expired signing certificate Negative validation because the signing certificate is expired (at the time specified in signingTime attribute). The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate and ESSSigningCertificateV2 attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime CAdES/BBN/8 Verify a CAdES-B-B signature created with a revoked/suspended signing certificate Negative validation because the signing certificate is revoked/suspended (at the time specified in signingTime attribute). The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate and ESSSigningCertificateV2 attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime CAdES/BBN/9 Verify a CAdES-B-B signature created with a signing certificate generated by a CA whose certificate is revoked/suspended Negative validation because the signing certificate is generated by a CA whose certificate is revoked/suspended (at the time specified in signingTime attribute). The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate and ESSSigningCertificateV2 attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime CAdES/BBN/10 Verify a CAdES-B-B signature that includes a SignaturePolicyIdentifier attribute with explicit SignaturePolicyId. However its value of SignaturePolicyId.sigPolicyHa sh field does *NOT* match to the hash value of signature policy file Negative validation because the hash value in SignaturePolicyId.sigPolicyHash included in SignaturePolicyIdentifier attribute does not match to the hash value of signer policy file. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate, SignaturePolicyIdentifier and ESSSigningCertificateV2 attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime o SignaturePolicyIdentifier ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 16 TC ID Description Pass criteria Signature attributes CAdES/BBN/11 Verify a CAdES-B-B signature in which the hash value of the signing certificate is different from the hash value in ESS signing certificate V2 attribute Negative validation because the certHash value in ESSSigningCertificateV2 attribute does not match to the hash value of signing certificate. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate and ESSSigningCertificateV2 attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 10.2 CAdES-B-T signatures test cases | The test cases in this clause have been defined for CAdES-B-T signatures. Table 7 summarizes negative test cases for CAdES-B-T signatures. Table 7: Negative test cases for CAdES-B-T signatures TC ID Description Pass criteria Signature attributes CAdES/BTN/1 Verify a CAdES-B-T signature in which, at the time in SignatureTimeStamp, the signer certificate had been already expired Negative validation because at the time in SignatureTimeStamp, the signing certificate had been already expired. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp CAdES/BTN/2 Verify a CAdES-B-T signature in which, at the time in SignatureTimeStamp, the signer certificate had been already revoked Negative validation because at the time in SignatureTimeStamp, the signing certificate had been already revoked. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp CAdES/BTN/3 Verify a CAdES-B-T signature in which the hash value of messageImprint in SignatureTimeStamp does *NOT* match to the hash value of corresponding signature value in signerInfo Negative validation because the hash value of messageImprint in SignatureTimeStamp does *NOT* match to the hash value of corresponding signature value of signerInfo. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp CAdES/BTN/4 Verify a CAdES-B-T signature in which, at the time in SignatureTimeStamp, the timestamp signer certificate had been already revoked Negative validation because at the time in SignatureTimeStamp, the timestamp signing certificate had been already revoked. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 17 TC ID Description Pass criteria Signature attributes CAdES/BTN/5 Verify a CAdES-B-T signature in which, at the time in SignatureTimeStamp, the timestamp signer certificate had been already expired Negative validation because at the time in SignatureTimeStamp, the timestamp signing certificate had been already expired. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp CAdES/BTN/6 Verify a CAdES-B-T signature in which the timestamp signer certificate was generated by an untrusted CA Negative validation because the anchor CA of the SignatureTimeStamp signing chain trust is unknown. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp CAdES/BTN/7 Verify a CAdES-B-T signature in which the timestamp signer certificate was generated by a CA whose certificate was revoked/suspended at the time of timestamp signer certificate generation Negative validation because the anchor CA of the SignatureTimeStamp signing chain trust is revoked/suspended. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate ESSSigningCertificateV2 and SignatureTimeStamp attributes. • Certificates o SigningCertificate • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp |
8c6aa05a3ff29e7e35f3f09979852c3d | 119 124-2 | 10.3 CAdES-B-LTA signatures test cases | The test cases in this clause have been defined for CAdES-B-LTA signatures. Table 8 summarizes negative test cases for CAdES-B-LTA signatures. Table 8: Negative test cases for CAdES-B-LTA signatures TC ID Description Pass criteria Signature attributes CAdES/BLTAN/1 Verify a CAdES-B-LTA signature in which the time in the SignatureTimeStamp is ulterior than the time in ATSv3 Negative validation because the time in the SignatureTimeStamp is ulterior than the time in ArchiveTimeStampV3. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate, ESSSigningCertificateV2, SignatureTimeStamp and ArchiveTimeStampV3 attributes. • Certificates • Crls.crl • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp o ArchiveTimeStampV3 o ats-hash-index-v3 CAdES/BLTAN/2 Verify a CAdES-B-LTA signature in which the content in ats-hash-index-v3 element has not the right value related to the signature itself to which the ATSv3 has been applied Negative validation because the content in ats-hash-index-v3 element has not the right value related to the CAdES signature to which the ArchiveTimeStampV3 has been applied. The signature shall contain ContentType, SigningTime, MessageDigest, SigningCertificate, ESSSigningCertificateV2, SignatureTimeStamp and ArchiveTimeStampV3 attributes. • Certificates • Crls.crl • SignedAttributes o MessageDigest o ESSSigningCertificateV2 o ContentType o SigningTime • UnsignedAttributes o SignatureTimeStamp o ArchiveTimeStampV3 o ats-hash-index-v3 ETSI ETSI TS 119 124-2 V1.1.1 (2016-06) 18 History Document history V1.1.1 June 2016 Publication |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 1 Scope | The present document specifies the architectural options, resources and procedures needed to pre-provision and maintain devices in the Field Domain (e.g. ADN, ASN/MN) in order to establish M2M Service Layer operation between the device's AE and/or CSE and a Registrar and/Hosting CSE. The resources and procedures includes information about the Registrar CSE and/or Hosting CSE needed by the AE or CSE to begin M2M Service Layer operation. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 2 References | |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 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 111: "oneM2M; Common Terminology (oneM2M TS-0011)". [2] ETSI TS 118 101: "oneM2M; Functional Architecture (oneM2M TS-0001)". [3] ETSI TS 118 103: "oneM2M; Security solutions (oneM2M TS-0003)". [4] ETSI TS 118 104: "oneM2M; Service Layer Core Protocol Specification (oneM2M TS-0004)". [5] ETSI TS 118 105: "oneM2M; Management Enablement (OMA) (oneM2M TS-0005)". [6] ETSI TS 118 106: "oneM2M; Management Enablement (BBF) (oneM2M TS-0006)". [7] IETF RFC 6920: "Naming Things with Hashes". [8] IANA Transport Layer Security (TLS) Parameters. [9] ETSI TS 118 132: "MAF and MEF Interface Specification (oneM2M TS-0032)". [10] FIPS PUB 180-4: "Secure Hash Standard (SHS)". |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 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. [i.2] Broadband Forum TR-069: "CPE WAN Management Protocol" Issue 1 Amendment 5, November 2013. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 7 oneM2M TS-0022 version 4.5.1 Release 4 [i.3] OMA-DM: "OMA Device Management Protocol", Version 1.3, Open Mobile Alliance. [i.4] LWM2M: "OMA LightweightM2M", Version 1.0, Open Mobile Alliance. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 3 Definition of terms, symbols and abbreviations | |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 3.1 Terms | For the purposes of the present document, the terms given in ETSI TS 118 111 [1], ETSI TS 118 101 [2] and the following apply: application configuration: procedure that configures an AE on an M2M Node in the Field Domain for M2M Service Layer operation authentication profile: security information needed to establish mutually-authenticated secure communications configuration AE: AE whose role is to configure the M2M System, including the M2M Node in the Field Domain configuration IPE: IPE that provides the capability to configure the M2M Node in the Field Domain by interworking the exchange of information between the M2M Node and the M2M System credential object: end-point of a security protocol (oneM2M) security principal: CSE or AE or Node or M2M Device which can be authenticated NOTE: When the Security Principal is a Node or M2M Device, then Node or M2M Device is acting on behalf of the CSE and/or AE executing on the Node or M2M Device. service layer configuration: procedure that configures a CSE on an M2M Node in the Field Domain for M2M Service Layer operation |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 3.2 Symbols | Void. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 3.3 Abbreviations | For the purposes of the present document, the abbreviations given in ETSI TS 118 111 [1], ETSI TS 118 101 [2] and the following apply: NP Not Present XML eXtensible Markup Language XSD XML Schema Definition |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 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]. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 8 oneM2M TS-0022 version 4.5.1 Release 4 |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 5 Introduction | Devices in the Field Domain that host oneM2M AEs and CSEs require configuration that permits the AE or CSE to successfully operate in the M2M Service Layer. ETSI TS 118 101 [2] and ETSI TS 118 103 [3] specifies much of what is needed to configure these devices in the Field Domain (i.e. ADN, ASN/MN). Specifically, ETSI TS 118 101 [2] provides: • Guidance on how a CSE is minimally provisioned in Annex E of the specification including how a user AE is established within a Hosting CSE. • Specification of the general communication flows across the Mca and Mcc reference points in clause 8. • Specifications for how ASN/MN and ADN nodes and M2M Applications are enrolled in the M2M System such that the node in the Field domain can establish connectivity with a CSE. TS-0001 heavily relies on Clause 6 and on the Remote Security Provisioning Framework (RSPF) of ETSI TS 118 103 [3] to specify how the security credentials of ASN/MN and ADN nodes and M2M Applications are established in the M2M System for the enrolment of the node or M2M Application in the M2M System. • Specifications for how the ADN and ASN/MN nodes in the Field Domain are managed using external management technologies in clause 6.2.4 of ETSI TS 118 101 [2]. • Guidance for how the ADN and ASN/MN nodes in the Field Domain can be configured without the support of external management technologies in clause 8.1.3 in the present document. The above clauses in ETSI TS 118 101 [2] assume that, for a M2M Application to operate in the M2M System, all required information needed to establish M2M Service operation between a Registrar or Hosting CSE and the AE or CSE in the Field Domain is configured before registration of the AE or CSE to the M2M System. The present document specifies the additional architectural elements, resources and procedures necessary to configure ASN/MN and ADN nodes in the Field Domain in order for that device to establish M2M Service Layer operation. These architectural elements, resources and procedures are in addition to the architectural elements, resources and procedures already defined in ETSI TS 118 101 [2] and ETSI TS 118 103 [3]. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6 Architectural Aspects | |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.1 Introduction | The information needed by the remote AE or CSE in the field domain to establish M2M Service Layer operation uses the architectural aspects of ETSI TS 118 101 [2] in order to convey the information elements to the ASN/MN or ADN nodes that host the AE or CSE prior to or during M2M Service Layer operation and to the AE or CSE during M2M Service Layer operation. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 9 oneM2M TS-0022 version 4.5.1 Release 4 Configuration AE Mca Infrastructure Domain Field Domain Configuration IPE unspecified IN-CSE Mca ASN/MN CSE AE Mca Mcc ADN AE Mca DM Server Mcn (ms) mc mc mc <mgmtObj> <mgmtObj> Figure 6.1-1: Architectural Aspects for Configuration of ASN/MN and ADN Nodes Figure 6.1-1 depicts three (3) methods, in which ADN or ASN/MN nodes are configured using the following: 1) Device Management technologies using the mc reference point defined in clause 6 of ETSI TS 118 101 [2]. Using this method, the information that is used to configure the ASN/MN or ADN is described as <mgmtObj> resource types that are hosted in the IN-CSE. 2) oneM2M Mcc and Mca reference point when M2M Service Layer operation has been established to the AE or CSE. Establishment of the M2M Service Layer operation includes actions such as setting up security associations and registration of the M2M entities as per ETSI TS 118 103 [3] and ETSI TS 118 101 [2]. 3) oneM2M IPE technology where the IPE interworks the information exchange between the ADN and ASN/MN and the IN-CSE. This type of IPE is called a Configuration IPE in order to depict the role and capabilities of the IPE related to the present document. NOTE: The reference point between the Configuration IPE and the ADN and ASN/MN is unspecified in the present document. In addition, figure 6.1-1 introduces an AE whose role is to configure the IN-CSE and nodes in the Field Domain with the information needed to establish M2M Service Layer operation. This type of AE is called a Configuration AE in order to depict the role and capabilities of the AE related to the present document. The information that is used to configure the ASN/MN or ADN is described as <mgmtObj> resource types that are hosted in the IN-CSE. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 10 oneM2M TS-0022 version 4.5.1 Release 4 |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2 Information needed for M2M Service Layer operation | |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.1 Introduction | The Configuration AE provisions the <mgmtObj> resource types in the IN-CSE and the IN-CSE then interacts with the DM Server, ADN or ASN/MN node or Configuration IPE in order to configure the AE or CSE on the nodes. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.2 Information elements required for M2M Service Layer operation | |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.2.1 Introduction | The ASN/MN and ADN in the Field Domain should support the capability to be configured with the <mgmtObj> resource types defined in the present document prior to initial registration with a registrar CSE (enrolment phase). When the AE or CSE has established M2M Service Layer operation with a Registrar CSE (operational phase), the AE or CSE shall provide the capability to be configured with the <mgmtObj> resource types defined in the present document. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.2.2 M2M Service Layer registration information elements | The information elements used for CSE or AEs to register with a Registrar CSE shall include the following information which depends on the M2M Service Provider: • PoA information of Registrar CSE. • Protocol binding to be used between AE or CSE and the Registrar CSE. • CSE-ID of the CSE hosted on the ASN/MN. • AE-ID of an AE hosted on an ASN/MN or ADN. This set of information elements may be linked to a set of authentication profile information elements (see clause 6.2.2.4) providing the configuration for security association establishment with the Registrar CSE. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.2.3 Application configuration information elements | In order for an AE to operate, the AE may need to know the resource location within the Hosting CSE to maintain its resource structure. In addition, for resources that are frequently provided by the AE to the Hosting CSE, the AE may be configured with information that defines how frequently the AE collects or measures the data as well as the frequency at which that the data is transmitted to the Hosting CSE. When the Hosting CSE is not the Registrar CSE of the AE, then this set of information elements may be linked to a set of authentication profile information elements (see clause 6.2.2.4) providing the configuration for establishing End-to- End Security of Primitives (ESPrim) with the Hosting CSE. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.2.4 Authentication profile information elements | Authentication profile information elements may be required to establish mutually-authenticated secure communications. The applicable security framework is identified via a Security Usage Identifier (SUID). Where the security framework uses TLS or DTLS, a set of permitted TLS cipher suites may be provided. Then the applicable credentials are identified - with the allowed type of credentials dictated by the SUID. A security framework can use a pre-provisioned or remotely provisioned symmetric key for establishing mutually-authenticated secure communications. In both cases, the identifier for the symmetric key is provided. If a symmetric key is remotely provisioned, then a Remote Security Provisioning Framework (RSPF) should be used as described in clause 8.3 of ETSI TS 118 103 [3]. Alternatively, the value of the symmetric key may be configured as an information element of the authentication profile. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 11 oneM2M TS-0022 version 4.5.1 Release 4 Certificate-based security frameworks may use one or more trust anchor certificates (also known as "root CA Certificates" or "root of trust certificates"). Information about trust anchor certificates is provided in the child trust anchor credential information elements (see clause 6.2.2.5) of the authentication profile. MAF-based security frameworks use a MAF to facilitate establishing a symmetric key to be used for mutual authentication. The MAF Client registration configuration credential information elements enable a MAF Client to perform MAF procedures with the MAF. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.2.5 My certificate file credential information elements | A security framework can use a certificate to authenticate the intended security principal in the Managed Entity to other security principals, as part of establishing mutually-authenticated secure communications. The certificate can be pre-provisioned or remotely provisioned, as discussed in ETSI TS 118 103 [3]. If a certificate is remotely provisioned, then a Remote Security Provisioning Framework (RSPF) should be used as described in clause 8.3 of ETSI TS 118 103 [3], or my certificate file credential information elements may be configured to the Managed Entity as described in the present document. My certificate file credential information elements include the media type of file containing the certificate, the file containing the certificate, and a list of Security Usage Identifiers (SUID) for which the certificate may be used. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.2.6 Trust anchor credential information elements | A security framework can use one or more trust anchor certificates (also known as "root Certificate Authority certificates" or" root of trust certificates"). These trust anchor certificates are used by a security principal on the Managed Entity for validating certificates of other security principals as part of establishing mutually-authenticated secure communications. The trust anchor credential information elements include a hash-value-based identifier of the trust anchor certificate, along with a URL from which the trust anchor certificate can be retrieved. The Managed Entity can compute the hash value for the locally stored trust anchor certificates to determine if there is a match with the hash value in the information elements. If there is no match for the trust anchor certificates in local storage, then the Managed Entity retrieves the trust anchor certificate from the URL, and verifies that the hash value of the retrieved trust anchor certificate is a match for the hash value in the information elements. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.2.7 MAF Client registration configuration information elements | A security framework can use a MAF to establish symmetric key in a security principal in the Managed Entity and one or more other security principals, with the symmetric key used for establishing mutually-authenticated secure communications between the security principals. In this case, the security principals are MAF Clients. The security principal in the Managed Entity shall perform the MAF Client registration procedure, described in clause 8.8.2.3 of ETSI TS 118 103 [3] before the MAF facilitates establishing the symmetric keys. The MAF Client registration configuration information elements configure the security principal in the Managed Entity for the MAF Client registration procedure, as described in clause 8.8.3.2 of ETSI TS 118 103 [3]. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 6.2.2.8 MEF Client registration configuration information elements | A security framework can use a MEF to provision credentials to a security principal (an MEF Client) in the Managed Entity for establishing mutually-authenticated secure communications between the security principal and another entity such as a security principal or MAF or MEF or device management server. The security principal in the Managed Entity shall perform the MEF Client registration procedure, described in clause 8.3.5.2.3 of ETSI TS 118 103 [3] before the MEF provisions credentials. The MEF Client registration configuration information elements configure the security principal in the Managed Entity for the MEF Client registration procedure, as described in clause 8.3.7.2 of ETSI TS 118 103 [3]. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 12 oneM2M TS-0022 version 4.5.1 Release 4 |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 7 Resource type and data format definitions | |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 7.1 <mgmtObj> Resource type specializations | |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 7.1.1 Introduction | The present clause specifies <mgmtObj> resource specializations used to configure AEs or CSEs on ADN or ASN/MN nodes in the Field Domain in order to establish M2M Service Layer operation. Table 7.1.1-1 shows a summary of <mgmtObj> resource specializations defined in the present document. Table 7.1.1-1: Summary of defined <mgmtObj> resources mgmtObj mgmtDefinition Intended use Note Registration 1020 Service Layer Configuration information needed to register an AE or CSE with a Registrar CSE. This is M2M Service Provider dependent. dataCollection 1021 Application Configuration information needed to establish collection of data within the AE and transmit the data to the Hosting CSE using <container> and <contentInstance> resource types. This is M2M Application dependent. authenticationProfile 1022 Security information needed to establish mutually-authenticated secure communications. myCertFileCred 1023 Configuring a file containing a certificate and associated information. trustAnchorCred 1024 Identifies a trust anchor certificate and provides a URL from which the certificate can be retrieved. The trust anchor certificate can be used to validate a certificate which the Managed Entity uses to authenticate another entity. MAFClientRegCfg 1025 Instructions for performing the MAF Client Registration procedure with a MAF. Links to an Authentication Profile instance. MEFClientRegCfg 1026 Instructions for performing the MEF Client Registration procedure with a MEF. Links to an Authentication Profile instance. OAuth2Authentication 1027 To store access token and refresh token used in OAuth2 security protocol. wificlient 1028 To store configuration of Wi-Fi® connection on the client device. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 7.1.2 Resource [registration] | This specialization of <mgmtObj> is used to convey the service layer configuration information needed to register an AE or CSE with a Registrar CSE. The [registration] resource shall contain the child resource specified in table 7.1.2-1. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 13 oneM2M TS-0022 version 4.5.1 Release 4 Table 7.1.2-1: Child resources of [registration] resource Child Resources of [registration] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of ETSI TS 118 101 [2] The [registration] resource shall contain the attributes specified in table 7.1.2-2. Table 7.1.2-2: Attributes of [registration] resource Attributes of [registration] Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. resourceID 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. resourceName 1 WO See clause 9.6.1.3 of ETSI TS 118 101 [2]. parentID 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. expirationTime 1 RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. creationTime 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. lastModifiedTime 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. labels 0..1(L) RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. mgmtDefinition 1 WO See clause 9.6.15 of ETSI TS 118 101 [2]. This attribute shall have the fixed value 1020 ("registration"). objectIDs 0..1 (L) WO See clause 9.6.15 of ETSI TS 118 101 [2]. objectPaths 0..1 (L) WO See clause 9.6.15 of ETSI TS 118 101 [2]. description 0..1 RW See clause 9.6.15 of ETSI TS 118 101 [2]. originatorID 0..1 RW CSE-ID of the CSE hosted on the ASN/MN or the AE-ID of an AE hosted on an ASN/MN or ADN node. If the setting is for a CSE, then this attribute shall be present. pointOfAccess 0..1(L) RW The point of access URI of the Registrar CSE. It represents the list of physical address used by AE/CSEs to connect to registrar CSE. EXAMPLE: http://172.25.0.10:8080/xyz coap://m2m.sp.com:5683 mqtt://172.25.0.10:1883 ws://10.222.254.26:80 See note. CSEBase 0..1 RW The resource identifier of the <CSEBase> resource representing Registrar CSE. CSE-ID 0..1 RW The CSE identifier of Registrar CSEin SP-relative CSE-ID format. appID 0..1 RW The App-ID of an AE. This attribute shall only be present when this resource is used for the registration of an AE. externalID 0..1 RW The M2M-Ext-ID of the ASN/MN CSE. This attribute can be present when the originatorID is a CSE-ID and the CSE uses the dynamic registration defined in clause 7.1.10 Trigger Recipient Identifier of ETSI TS 118 101 [2]. Trigger-Recipient-ID 0..1 RW The Trigger-Recipient-ID of the ASN/MN CSE. This attribute can be present when the originatorID is a CSE-ID and the CSE uses the dynamic registration defined in clause 7.1.10 Trigger Recipient Identifier of ETSI TS 118 101 [2]. mgmtLink 0..1 RW A link to a <mgmtObj> resource instance containing the information for establishing a security association with the Registrar CSE. M2M-Sub-ID 0..1 WO The identifier assigned by the M2M Service Provider for the M2M Service Subscription of the registree. NOTE: Protocol binding is determined from the protocol schema in this URI. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 14 oneM2M TS-0022 version 4.5.1 Release 4 |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 7.1.3 Resource [dataCollection] | This specialization of <mgmtObj> is used to convey the application configuration information needed by an AE to collect data and then transmit the data to a Hosting CSE. The [dataCollection] resource shall contain the child resource specified in table 7.1.3-1. Table 7.1.3-1: Child resources of [dataCollection] resource Child Resources of [dataCollection] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of ETSI TS 118 101 [2] The [dataCollection] resource shall contain the attributes specified in table 7.1.3-2. Table 7.1.3-2: Attributes of [dataCollection] resource Attributes of [dataCollection] Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. resourceID 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. resourceName 1 WO See clause 9.6.1.3 of ETSI TS 118 101 [2]. parentID 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. expirationTime 1 RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. creationTime 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. lastModifiedTime 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. labels 0..1(L) RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. mgmtDefinition 1 WO See clause 9.6.15 of ETSI TS 118 101 [2]. This attribute shall have the fixed value 1021 ("dataCollection"). objectIDs 0..1 (L) WO See clause 9.6.15 of ETSI TS 118 101 [2]. objectPaths 0..1 (L) WO See clause 9.6.15 of ETSI TS 118 101 [2]. description 0..1 RW See clause 9.6.15 of ETSI TS 118 101 [2]. containerPath 1 RW The URI of the <container> resource in the hosting CSE that stores the data transmitted by the device. reportingSchedule 0..1 RW The frequency interval, in seconds, used to transmit the data to the Hosting CSE. measurementSchedule 0..1 RW The frequency interval, in seconds, that the device will use to collect or measure the data. mgmtLink 0..1 RW A link to a <mgmtObj> resource instance containing the information for establishing End-to-End Security of Primitives (ESPrim) between AE and hosting CSE. ESPrim is specified in ETSI TS 118 103 [3]. NOTE: The present specification does not support configuration for End-to-End Security of Data (ESData) specified in ETSI TS 118 103 [3]. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 7.1.4 Resource [authenticationProfile] | The [authenticationProfile] specialization of the <mgmtObj> is used to convey the configuration information regarding establishing mutually-authenticated secure communications. The security principal using this configuration information can be a CSE or AE or the Managed ADN/ASN/MN acting as security principal on behalf of AEs on the Node. An [authenticationProfile] instance identifies a security framework, TLS cipher suites, and credentials to be used. The applicable security framework is identified by the SUID attribute. The interpretation of SUID is specified in table 7.1.4-3. NOTE 1: The present document does not support using [authenticationProfile] for identifying ESData credentials. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 15 oneM2M TS-0022 version 4.5.1 Release 4 The [authenticationProfile] resource does not include any credentials, but either identifies credentials which are stored locally on the Managed Entity or identifies an M2M Authentication Function (MAF) which is to be used to facilitate establishing symmetric keys. The intended security principal on the Managed Entity is the security principal which can use either all the credentials identified by the [authenticationProfile] resource, or (in the case that a MAF is identified) all of the credentials required for mutual authentication with the MAF. NOTE 2: The other security principal can be any of the following: CSE; AE; a Node terminating the security protocol on behalf of AE on Node; and an M2M Authentication Function (MAF). The [authenticationProfile] resource shall contain the child resource specified in table 7.1.4-1. Table 7.1.4-1: Child resources of [authenticationProfile] resource Child Resources of [authenticationProfile] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of ETSI TS 118 101 [2] The [authenticationProfile] resource shall contain the attributes specified in table 7.1.4-2. Table 7.1.4-2: Attributes of [authenticationProfile] resource Attributes of [authenticationProfile] Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. resourceID 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. resourceName 1 WO See clause 9.6.1.3 of ETSI TS 118 101 [2]. parentID 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. expirationTime 1 RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. creationTime 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. lastModifiedTime 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. labels 0..1(L) RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. mgmtDefinition 1 WO See clause 9.6.15 of ETSI TS 118 101 [2]. This attribute shall have the fixed value 1022 ("authenticationProfile"). objectIDs 0..1 (L) WO See clause 9.6.15 of ETSI TS 118 101 [2]. objectPaths 0..1 (L) WO See clause 9.6.15 of ETSI TS 118 101 [2]. description 0..1 RW See clause 9.6.15 of ETSI TS 118 101 [2]. SUID 1 WO Describes how the authentication profile is to be used. Further details about interpretation of each SUID are specified in table 7.1.4-3 of the present document. TLSCiphersuites 0..1(L) RW If the security framework identified by SUID uses TLS, then this attributes provides a list of allowed TLS cipher suites. symmKeyID 0..1 WO Present when a symmetric key is to be used for mutual authentication. Identifier for a symmetric key already stored locally on the Managed Entity, or to be provisioned to the Managed Entity. symmKeyValue 0..1 WO Optionally present when a symmetric key is to be used for mutual authentication. Contains the value of the symmetric key to be used for mutual authentication. MAFKeyRegLabels 0..1(L) WO Optionally present when a MAF is to be used to facilitate establishing a symmetric key for mutual authentication. Provides the content of the labels parameter in the MAF Key Registration request; see table 8.8.2.7-1, ETSI TS 118 103 [3]. MAFKeyRegDuration 0..1 WO Present when a MAF is to be used to facilitate establishing one or more symmetric keys for mutual authentication. Provides the maximum duration for which an established symmetric key may be used. mycertFingerprint 0..1 WO Present when certificate-based authentication is to be used. Provides a hash value for identifying the certificate to be used by the intended security principal on the Managed Entity to authenticate itself to other security principals. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 16 oneM2M TS-0022 version 4.5.1 Release 4 Attributes of [authenticationProfile] Multiplicity RW/ RO/ WO Description rawPubKeyID 0..1 WO Present when certificate-based authentication is to be used and the other security principal will authenticate itself with a Raw Public Key Certificate. M2M-Sub-ID 0..1 WO The identifier assigned by the M2M Service Provider for the M2M Service Subscription of the registree. mgmtLink 0..1(L) RW Present when MAF is to be used to facilitate establishing one or more symmetric keys for mutual authentication or certificate-based authentication is to be used. In the former case, the list contains one reference to a [MAFClientRegCfg] resource. In the latter case, the list contains one or more references pointing to [trustAnchorCred] resources. Table 7.1.4-3: SUID which are currently supported in the [authenticationProfile] resource, along with reference to the authentication procedure in ETSI TS 118 103 [3] and mapping to symmetric key Value Interpretation (see note) Authentication Procedure in ETSI TS 118 103 [3] Derived Symmetric Key DTLS/TLS Notes 10 A pre-provisioned symmetric key intended to be shared with a MEF 8.3.2.1 Kpm See TLS-PSK Profile in clause 10.2.2 of ETSI TS 118 103 [3] 11 A pre-provisioned symmetric key intended to be shared with a MAF 8.8.2.2 Km 12 A pre-provisioned symmetric key intended for use in a Security Associated Establishment Framework (SAEF) 8.2.2.1 Kpsa 13 A pre-provisioned symmetric key intended for use in End-to-End Security of Primitives (ESPrim) 8.4.2 pairwiseESPrimKey DTLS/TLS is not used 21 A symmetric key, provisioned via a Remote Security Provisioning Framework (RSPF), and intended to be shared with a MAF RSPF: 8.3.1.2 MAF: 8.8.2.2, 8.8.3.1 Km See TLS-PSK Profile in clause 10.2.2 of ETSI TS 118 103 [3] 22 A symmetric key, provisioned via a RSPF, and intended for use in a SAEF RSPF: 8.3.1.2 SAEF: 8.2.2.1, 9.1.1.1 Kpsa 23 A symmetric key, provisioned via a RSPF, and intended for use in ESPrim RSPF: 8.3.1.2 ESPrim: 8.4.2 pairwiseESPrimKey DTLS/TLS is not used 32 A MAF-distributed symmetric key intended for use in a SAEF MAF: 8.8.2.7, 8.8.3.3 SAEF: 8.2.2.3, 9.1.1.1 Kpsa See TLS-PSK Profile in clause 10.2.2 of ETSI TS 118 103 [3] 33 A MAF-distributed symmetric key intended for use in ESPrim MAF: 8.8.2.7, 8.8.3.3 ESPrim: 8.4.2 pairwiseESPrimKey 40 A certificate intended to be shared with a MEF 8.3.2.2 NP See certificate-based TLS profile in clause 10.2.3 of ETSI TS 118 103 [3] 41 A certificate intended to be shared with a MAF 8.8.2.2 NP 42 A certificate intended for use in a Security Associated Establishment Framework (SAEF) 8.2.2.2 NP 43 A certificate intended for use in End- to-End Security Certificate-based Key Establishment (ESCertKE) to establish a pairwiseESPrimKey for End-to-End Security of Primitives (ESPrim) ESCertKE: 8.7 ESPrim: 8.4.2 NP For ESCertKE, see certificate-based TLS profile in clause 10.2.3 of ETSI TS 118 103 [3]. For ESPrim, DTLS/TLS is not used NOTE: The interpretation is copied from definition of m2m:suid in ETSI TS 118 104 [4]. The ETSI TS 118 104 [4] description takes precedence. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 17 oneM2M TS-0022 version 4.5.1 Release 4 The Managed Entity shall allow only TLS cipher suites identified in TLSCiphersuites in the TLS Handshakes for a [authenticationProfile] instance. The final column of table 7.1.4-3 provides references to clauses in ETSI TS 118 103 [3] specifying the TLS Profiles to be used with the SUID values. The TLSCiphersuite attribute shall be present only when the value of SUID identifies a security framework that uses TLS or DTLS. If the value of SUID is 10, 11, 12, 21, 22 or 23, then the symmKeyID attribute shall be present. The symmKeyID provides the symmetric key identifier for a symmetric key which shall be retrieved from local storage on the Managed Entity for use in the TLS Handshake. The symmetric key value may be configured in the symmKeyValue. Otherwise, the symmetric key, and associated symmetric key identifier, may be provisioned to the Managed Entity before or after the [authenticationProfile] is configured. Pre-provisioning or Remote Security Provisioning Frameworks (RSPFs), specified in ETSI TS 118 103 [3], should be used whenever possible to establish symmetric keys. Special care is recommended to ensure the confidentiality and integrity of the credentials when using the symmKeyValue to configure symmetric keys. If the value of SUID is 32 or 33, then the MAFKeyRegDuration attribute shall be present, the MAFKeyRegLabels attribute may be present, and a [MAFClientRegCfg] specialization shall be configured as a child of the [authenticationProfile] resource. These attributes provide the configuration controlling how the Managed Entity shall interact with a MAF to establish the symmetric key subsequently used for mutual authentication. The fqdn attribute of the [MAFClientRegCfg] specialization identifies the MAF. • If the Managed Entity has not already performed MAF Client Registration procedure with the identified MAF, then the MAF shall perform MAF Client Registration procedure in clause 8.8.2.3 of ETSI TS 118 103 [3] using the information in the [MAFClientRegCfg] specialization of the <mgmtObj> specified in clause 7.1.7 of the present document. • The Managed Entity shall perform the MAF Key Registration Procedure in clause 8.8.2.7 of ETSI TS 118 103 [3] with the identified MAF, with the parameters of table 8.8.2.7-1 of ETSI TS 118 103 [3] set as follows: - The MAF-FQDN parameter shall be set to the value of the fqdn attribute in the [MAFClientRegCfg] specialization which is the child of the [authenticationProfile] resource. - The expirationTime Parameter shall be set to the time obtained by adding the MAFKeyRegDuration attribute to the present time. - If MAFKeyRegLabels attribute is present in the [authenticationProfile] resource, then the labels parameter shall be set to the value of the MAFKeyRegLabels attribute. Otherwise, the labels parameter shall not be present. - The SUID parameter shall be set to the SUID attribute. - The targetIDs parameter shall be set to the CSE-ID in the [registration] or [dataCollection] resource. If the value of SUID is 40, 41, 42, or 43, then the mycertFingerprint attribute shall be present, and either the rawPubKeyID attribute shall be present or one or more [trustAnchorCred] specializations shall be configured as children of the [authenticationProfile] resource. The Managed Entity shall use the certificate matching mycertFingerprint to authenticate itself. The hash value portion of mycertFingerprint shall be computed over the X.509 ASN.1 DER encoded certificate: • If the rawPubKeyID attribute is present, then the Managed Entity shall compare this value against the public key identifier (similar to a certificate fingerprint) generated from the raw public key certificate presented by the other entity, as specified in clause 10.1.2 of ETSI TS 118 103 [3]. If the rawPubKeyID attribute is present, the Managed Entity shall ignore [trustAnchorCred] resource(s) configured as children of the [authenticationProfile]. • If the rawPubKeyID attribute is not present, then the Managed Entity shall use the one or more [trustAnchorCred] resource instance(s) configured as children of the [authenticationProfile] resource instance to retrieve Certificate Authority certificates to be used by the Managed Entity as a trust anchor certificate (also known as a "root CA certificate" or "trust root certificate") when validating the certificate chains provided by other entities. The Managed Entity shall allow the TLS handshake only if the other entity provides a certificate chaining to one of these trust anchors, using the process specified in clause 8.1.2.2 in ETSI TS 118 103 [3]. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 18 oneM2M TS-0022 version 4.5.1 Release 4 [authenticationProfile] resources are expected to be protected by a secure environment on the Managed Entity, in order to preserve integrity of the attributes. Optimal protection is provided when the integrity protection of the management protocol message is verified in the secure environment. |
ebce105b6d97ede43cea618c70172b77 | 118 122 | 7.1.5 Resource [myCertFileCred] | This <mgmtObj> specialization is used to configure a certificate or certificate chain which the Managed Entity knows the private key. The [myCertFileCred] resource shall contain the child resource specified in table 7.1.5-1. Table 7.1.5-1: Child resources of [myCertFileCred] resource Child Resources of [myCertFileCred] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of ETSI TS 118 101 [2] The [myCertFileCred] resource shall contain the attributes specified in table 7.1.5-2. Table 7.1.5-2: Attributes of [myCertFileCred] resource Attributes of [myCertFileCred] Multiplicity RW/ RO/ WO Description resourceType 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. resourceID 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. resourceName 1 WO See clause 9.6.1.3 of ETSI TS 118 101 [2]. parentID 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. expirationTime 1 RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. accessControlPolicyIDs 0..1 (L) RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. creationTime 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. lastModifiedTime 1 RO See clause 9.6.1.3 of ETSI TS 118 101 [2]. labels 0..1(L) RW See clause 9.6.1.3 of ETSI TS 118 101 [2]. mgmtDefinition 1 WO See clause 9.6.15 of ETSI TS 118 101 [2]. This attribute shall have the fixed value 1023 ("myCertFileCred"). objectIDs 0..1 (L) WO See clause 9.6.15 of ETSI TS 118 101 [2]. objectPaths 0..1 (L) WO See clause 9.6.15 of ETSI TS 118 101 [2]. description 0..1 RW See clause 9.6.15 of ETSI TS 118 101 [2]. SUIDs 1 (L) RW Identifies the security framework(s) which may use this credential. myCertFileFormat 1 WO Media Type of myCertFileContent attribute. Default is "application/pkcs7-mime". myCertFileContent 1 WO Certificate or certificate chain. Default media-type is "application/pkcs7-mime". The SUIDs attribute lists the Security Usage Identifiers (SUIDs) of the security frameworks which shall be allowed using this credential for establishing mutually-authenticated secure communication. Any SUID which is not in this list shall be prevented from using this credential for establishing mutually-authenticated secure communication. The SUID values allowed in this attribute are listed in table 7.1.5-3. See table 7.1.4-3 for references to the corresponding authentication procedure in ETSI TS 118 103 [3] and DTLS/TLS notes. Table 7.1.5-3: SUID which are currently supported in the [myCertFileCred] resource Value Interpretation (see note) 40 A certificate intended to be shared with a MEF 41 A certificate intended to be shared with a MAF 42 A certificate intended for use in a Security Associated Establishment Framework (SAEF) 43 A certificate intended for use in End-to-End Security Certificate-based Key Establishment (ESCertKE) to establish a pairwiseESPrimKey for End-to-End Security of Primitives (ESPrim) NOTE: The interpretation is copied from the definition of m2m:suid in ETSI TS 118 104 [4]. The ETSI TS 118 104 [4] description takes precedence. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 19 oneM2M TS-0022 version 4.5.1 Release 4 The Certificate issuer should verify that the corresponding private key is known to the Managed Entity. The present specification does not provide a mechanism for such verification. NOTE: In many scenarios, if the device management session takes place over a TLS connection in which the Managed Entity is authenticated using an existing certificate (e.g. a manufacturer certificate), then it would be acceptable to issue a certificate with SubjectPublicKeyInfo copied from the existing certificate. Managed Entities shall support the default certificate-related media type. If the mycertFingerprint attribute in an [authenticationProfile] resource matches the certificate in a [myCertFileCred] resource, then the authentication protocol based on that [authenticationProfile] shall provide the certificate or certificate chain in the myCertFileContent, and shall use the corresponding private key to authenticate the Managed Entity. [myCertFileCred] instances are expected to be protected by a secure environment on the Managed Entity, in order to preserve confidentiality and integrity of the attributes. Optimal protection is provided when the decryption and integrity verification of the management protocol message occurs in the secure environment. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.