7 Resource types definitions

7.1 Namespaces used for resource and data types

Representations of resources applicable to the MAF and MEF Interfaces employ the namespace prefix "sec:" for global XML elements associated with a resource type. Data types of the attributes and complex-type elements of these resource types may use any of the name space identifiers listed in table 7.1‑1

Any data types of XML elements defined for use in present document shall be one of name spaces in table 7.1‑1.

Table 7.1‑1: Namespaces applicable to resource types defined in the present document

Name space
prefix
Name space definition
Types defined in
oneM2M Security
sec:
http://www.onem2m.org/xml/securityProtocols
the present document and TS-0003 [2]
oneM2M protocol CDT
m2m:
http://www.onem2m.org/xml/protocol
TS-0004 [3]
Device Configuration
dcfg:
http://www.onem2m.org/xml/deviceConfig
TS-0022 [9]

7.2 Resource Type

The resource shall represent a MAF.

The resource shall contain the child resources specified in table 7.2‑1.

Table 7.2‑1: Child resources of resource

Child Resources of
Child Resource Type
Multiplicity
Description
[variable]
0..n
[variable]
0..n

The resource shall contain the attributes specified in table 7.2‑2.

Table 7.2‑2: Attributes of resource

Attributes of
Multiplicity
RW /
RO /
WO
Description
resourceType
1
RO
See clause 9.6.1.3 of [1].
resourceID
1
RO
See clause 9.6.1.3 of [1].
resourceName
1
RO
See clause 9.6.1.3 of [1]. Shall be fixed to "maf".
creationTime
1
RO
See clause 9.6.1.3 of [1].
labels
1
RO
See clause 9.6.1.3 of [1].

7.3 Resource Type

The resource shall represent a MEF.

The resource shall contain the child resources specified in table 7.3‑1.

Table 7.3‑1: Child resources of resource

Child Resources of
Child Resource Type
Multiplicity
Description
[variable]
0..n
[variable]
0..n

The resource shall contain the attributes specified in table 7.3‑2.

Table 7.3‑2: Attributes of resource

Attributes of
Multiplicity
RW /
RO /
WO
Description
resourceType
1
RO
See clause 9.6.1.3 of [1].
resourceID
1
RO
See clause 9.6.1.3 of [1].
resourceName
1
RO
See clause 9.6.1.3 of [1]. Shall be fixed to "mef".
creationTime
1
RO
See clause 9.6.1.3 of [1].
labels
1
RO
See clause 9.6.1.3 of [1].

7.4 Resource Type

The resource shall represent a MAF Client enrolled with an M2M SP or M2M Trust Enabler (MTE).

NOTE: A single MAF Client can be enrolled with at most one M2M SP and any number of MTEs (typically enabling end-to-end security to MAF Clients outside the MAF Client's M2M SP's domain). Consequently, a single MAF Client can be associated with multiple resources on multiple MAFs. It is also possible that a single MAF Client can be associated with multiple resources on a single MAF acting on behalf of multiple administrating stakeholders.

The resource shall contain no child resources.

The resource shall contain the attributes specified in table 7.4‑1.

Table 7.4‑1: Attributes of resource

Attributes of
Multiplicity
RW /
RO /
WO
Description
resourceType
1
RO
See clause 9.6.1.3 of [1].
resourceID
1
RO
See clause 9.6.1.3 of [1].
resourceName
1
RO
See clause 9.6.1.3 of [1].
parentID
1
RO
See clause 9.6.1.3 of [1].
creationTime
1
RO
See clause 9.6.1.3 of [1].
labels
1
RW
See clause 9.6.1.3 of [1].
expirationTime
1
WO
See clause 9.6.1.3 of [1].
creator
1
WO
This attribute shall include the identifier of the MAF client which has created this resource.
adminFQDN
1
WO
FQDN of the M2M SP or MTE who is the administrating stakeholder of this enrolment.
assignedSymmKeylID
0..1
RO
When the MAF Client uses a symmetric key to authenticate to the MAF, then the MAF may use this attribute to provide a symmetry key identifier within the domain of the MAF. Assigned by the MAF.

7.5 Resource Type

The resource shall represent a MEF Client enrolled with an M2M SP or M2M Trust Enabler (MTE).

NOTE: A single MEF Client can be enrolled with at most one M2M SP and any number of MTEs (typically enabling end-to-end security to MEF Clients outside the MEF Client's M2M SP's domain). Consequently, a single MEF Client can be associated with multiple resources on multiple MEFs. It is also possible that a single MEF Client can be associated with multiple resources on a single MEF acting on behalf of multiple administrating stakeholders.

The resource shall contain no child resources.

The resource shall contain the child resources specified in table 7.5‑1.

Table 7.5‑1: Child resources of resource

Child Resources of
Child Resource Type
Multiplicity
Description
"cmd "
1

The resource shall contain the attributes specified in table 7.5‑2.

Table 7.5‑2 : Attributes of <mefClientReg> resource

Attributes of
Multiplicity
RW /
RO /
WO
Description
resourceType
1
RO
See clause 9.6.1.3 of [1].
resourceID
1
RO
See clause 9.6.1.3 of [1].
resourceName
1
RO
See clause 9.6.1.3 of [1].
parentID
1
RO
See clause 9.6.1.3 of [1].
creationTime
1
RO
See clause 9.6.1.3 of [1].
labels
1
RW
See clause 9.6.1.3 of [1].
expirationTime
1
WO
See clause 9.6.1.3 of [1].
creator
1
WO
This attribute shall include the identifier of the MEF client which has created this resource.
adminFQDN
1
WO
FQDN of the M2M SP or MTE who is the administrating stakeholder of this enrolment.
assignedSymmKeylID
0..1
RO
When the MEF Client uses a symmetric key to authenticate to the MEF, then the MEF may use this attribute to provide a symmetry key identifier within the domain of the MEF. Assigned by the MEF.
sourceIDs
0..1
RW
List of AE-IDs and CSE-IDs associated with a MEF client acting on behalf of a Node. This attribute shall be supplied if the creator attribute includes a Node-ID.

7.6 Resource Type

The resource shall represent a symmetric key that a source MAF Client or a source MEF Client has established with the MAF or MEF, respectively, for distributing to authorized Target MAF or MEF Clients and/or another MAF or MEF. The MAF or MEF Client provides a list of authorized Targets when the resource is created - the present document does not specify how the MAF or MEF associates the list with the resource. The MAF or MEF, in coordination with the identified administrating stakeholder (M2M SP or MTE), can modify the list of authorized Targets and the expirationTime.

The resource shall contain no child resources.

The resource shall contain the attributes specified in table 7.6‑1.

Table 7.6‑1: Attributes of resource

Attributes of
Multiplicity
RW /
RO /
WO
Description
resourceType
1
RO
See clause 9.6.1.3 of [1].
resourceID
1
RO
See clause 9.6.1.3 of [1].
resourceName
1
RO
See clause 9.6.1.3 of [1]. This value is used as the relative part of the identifier for the symmetric key in security protocols.
parentID
1
RO
See clause 9.6.1.3 of [1].
creationTime
1
RO
See clause 9.6.1.3 of [1].
labels
0..1
RW
See clause 9.6.1.3 of [1].
expirationTime
1
WO
See clause 9.6.1.3 of [1].
creator
1
RO
See clause 9.6.1.3 of [1].
adminFQDN
1
WO
FQDN of the administrating stakeholder (M2M SP or MTE) associated with this enrolment.
SUID
1
WO
An SUID constraining the use of the symmetric key associated with this resource.
targetIDs
1 (L)
RW
List of AE-ID(s) and/or CSE-ID(s) and/or and/or Node-ID(s) identifying the AE(s) and/or CSE(s) and/or Node(s) authorized to retrieve the resource. Only the creator and administrating stakeholder (identified by adminFQDN) are authorized to access this attribute.
keyValue
1
WO
The value of the key to be provided to the identifier targets. May be provided in the Create request or derived by the MAF or MEF Client and MAF or MEF from the TLS handshake parameters.

7.7 Resource Type

A resource includes instructions for the MEF client associated with the parent resource to be executed.

The resource shall contain no child resources.

The resource shall contain the attributes specified in table 7.7‑1.

Table 7.7‑1 : Attributes of resource

Attributes of
Multiplicity
RW/
RO/
WO
Description
resourceType
1
RO
See clause 9.6.1.3 of [1].
resourceID
1
RO
See clause 9.6.1.3 of [1].
resourceName
1
RO
See clause 9.6.1.3 of [1].
parentID
1
RO
See clause 9.6.1.3 of [1].
creationTime
1
RO
See clause 9.6.1.3 of [1].
labels
1
RW
See clause 9.6.1.3 of [1].
expirationTime
1
WO
See clause 9.6.1.3 of [1].
cmdID
1
RW
This attribute shall include a MEF-assigned identifier of a command issued by the MEF. See clause 8.3.9.1 of [2] for further details.
cmdDescription
1
RO
This attribute provides the description of a command issued by the MEF to be executed by the MEF client. See clause 8.3.9.5 of [2] for further details.
cmdStatusCode
1
RW
This attribute shall be used forthe status of the command issued by the MEF. See clause 8.3.9.6 of [2] for further details.