hash
stringlengths 32
32
| doc_id
stringlengths 7
13
| section
stringlengths 3
121
| content
stringlengths 0
3.82M
|
|---|---|---|---|
2395f30ff475e7568cf731adbfd6ffb0
|
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.
|
2395f30ff475e7568cf731adbfd6ffb0
|
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.
|
2395f30ff475e7568cf731adbfd6ffb0
|
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.
|
2395f30ff475e7568cf731adbfd6ffb0
|
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].
|
2395f30ff475e7568cf731adbfd6ffb0
|
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
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7 Resource type and data format definitions
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.1 <mgmtObj> Resource type specializations
| |
2395f30ff475e7568cf731adbfd6ffb0
|
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.
|
2395f30ff475e7568cf731adbfd6ffb0
|
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
|
2395f30ff475e7568cf731adbfd6ffb0
|
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].
|
2395f30ff475e7568cf731adbfd6ffb0
|
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.
|
2395f30ff475e7568cf731adbfd6ffb0
|
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.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.1.6 Resource [trustAnchorCred]
|
The [trustAnchorCred] <mgmtObj> specialization is read by AEs or CSEs on ADN or ASN/MN nodes in the Field Domain. A [trustAnchorCred] is configured as a child or children of [authenticationProfile] resources by means of a mgmtLink. A security principal acting on a [authenticationProfile] uses the information in the associated [trustAnchorCred] resources to identify a trust anchor certificate for validation of certificates. The [trustAnchorCred] resource shall contain the child resource specified in table 7.1.6-1. Table 7.1.6-1: Child resources of [trustAnchorCred] resource Child Resources of [trustAnchorCred] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of ETSI TS 118 101 [2] The [trustAnchorCred] resource shall contain the attributes specified in table 7.1.6-2. Table 7.1.6-2: Attributes of [trustAnchorCred] resource Attributes of [trustAnchorCred] 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 1024 ("trustAnchorCred"). 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]. certFingerprint 1 WO Provides a hash value for identifying a certificate authority certificate to be used for validating certificates presented by other entities. URI 1 RW A URI from which the trust anchor certificate may be retrieved. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 20 oneM2M TS-0022 version 4.5.1 Release 4 The certFingerprint attribute of the [trustAnchorCred] resource identifies a Certificate Authority certificate to be used by the Managed Entity as a trust anchor when validating the certificate chains provided by other entities. The hash value portion of the certFingerprint attribute shall be computed over the X.509 ASN.1 DER encoded certificate using the SHA-256 hash algorithm defined in FIPS PUB 180-4 [10]. The certFingerprint attribute shall be represented in the named information (ni) URI format defined in IETF RFC 6920 [7], see tables 7.2.6.1-2 and 7.3.2-1. Where the CA Certificate identified in a [trustAnchorCred] resource is not already in local storage, then the Managed Entity shall retrieve the certificate using the URI attribute in the [trustAnchorCred] resources. [trustAnchorCred] 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.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.1.7 Resource [MAFClientRegCfg]
|
This <mgmtObj> specialization is used to convey instructions regarding the MAF Client Registration procedure (clause 8.8.2.3 of ETSI TS 118 103 [3]). The [MAFClientRegCfg] resource shall contain the child resource specified in table 7.1.7-1. Table 7.1.7-1: Child resources of [MAFClientRegCfg] resource Child Resources of [MAFClientRegCfg] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of ETSI TS 118 101 [2] The [MAFClientRegCfg] resource shall contain the attributes specified in table 7.1.7-2. Table 7.1.7-2: Attributes of [MAFClientRegCfg] resource Attributes of [MAFClientRegCfg] 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 1025 ("MAFClientRegCfg"). 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]. fqdn 1 WO See clause 8.8.3.2 of ETSI TS 118 103 [3]. adminFQDN 1 WO See clause 8.8.3.2 of ETSI TS 118 103 [3]. httpPort 0..1 WO See clause 8.8.3.2 of ETSI TS 118 103 [3]. coapPort 0..1 WO See clause 8.8.3.2 of ETSI TS 118 103 [3]. websocketPort 0..1 WO See clause 8.8.3.2 of ETSI TS 118 103 [3]. mgmtLink 1 RW A link to a [authenticationProfile] resource containing the parameters for the MAF Client to establish mutually-authenticated secure communications with the MAF. The MAF Client shall perform the MAF Client Registration Procedure specified in clause 8.8.2.3 of ETSI TS 118 103 [3], using the linked authentication profile for mutual authentication of the MAF Client and MAF. The MOs configured to the Managed Entity via [MAFClientRegCfg] 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. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 21 oneM2M TS-0022 version 4.5.1 Release 4
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.1.8 Resource [MEFClientRegCfg]
|
This <mgmtObj> specialization is used to convey instructions regarding the MEF Client Registration procedure (clause 8.3.5.2.3 of ETSI TS 118 103 [3]). The [MEFClientRegCfg] resource shall contain the child resource specified in table 7.1.8-1. Table 7.1.8-1: Child resources of [MEFClientRegCfg] resource Child Resources of [MEFClientRegCfg] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of ETSI TS 118 101 [2] The [MEFClientRegCfg] resource shall contain the attributes specified in table 7.1.8-2. Table 7.1.8-2: Attributes of [MEFClientRegCfg] resource Attributes of [MEFClientRegCfg] 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 1026 ("MEFClientRegCfg"). 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]. Fqdn 1 WO See clause 8.3.7 of ETSI TS 118 103 [3]. adminFQDN 1 WO See clause 8.3.7 of ETSI TS 118 103 [3]. httpPort 0..1 WO See clause 8.3.7 of ETSI TS 118 103 [3]. coapPort 0..1 WO See clause 8.3.7 of ETSI TS 118 103 [3]. websocketPort 0..1 WO See clause 8.3.7 of ETSI TS 118 103 [3]. mgmtLink 1 RW A link to a [authenticationProfile] resource containing the parameters for the MEF Client to establish mutually-authenticated secure communications with the MEF. The MEF Client shall perform the MEF Client Registration Procedure specified in clause 8.8.2.3 of ETSI TS 118 103 [3], using the linked authentication profile for mutual authentication of the MEF Client and MEF. The MOs configured to the Managed Entity via [MEFClientRegCfg] 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.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.1.9 Resource [OAuth2Authentication]
|
This specialization of <mgmtObj> is used to store access token and refresh token used in OAuth2 security protocol The [OAuth2Authentication] resource shall contain the child resources specified in table 7.1.9-1. Table 7.1.9-1: Child resources of [OAuth2Authentication] resource Child Resources of [OAuth2Authentication] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of ETSI TS 118 101 [2] ETSI ETSI TS 118 122 V4.5.1 (2023-07) 22 oneM2M TS-0022 version 4.5.1 Release 4 The [OAuth2Authentication] resource shall contain the attributes specified in table 7.1.9-2. Table 7.1.9-2: Attributes of [OAuth2Authentication] resource Attributes of [OAuth2Authentication] 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 fixed value "OAuthAuthentication". 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]. accessToken 1 RW Indicates OAuth2 access token. refreshToken 1 RW Indicates OAuth2 refresh token.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.1.10 Resource [wifiClient]
|
This specialization of <mgmtObj> is used to store configuration of Wi-Fi® connection on the client device. The [wifiClient] resource shall contain the child resources specified in table 7.1.10-1. Table 7.1.10-1: Child resources of [wifiClient] resource Child Resources of [wifiClient] Child Resource Type Multiplicity Description [variable] <subscription> 0..n See clause 9.6.8 of ETSI TS 118 101 [2] The [wifiClient] resource shall contain the attributes specified in table 7.1.10-2. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 23 oneM2M TS-0022 version 4.5.1 Release 4 Table 7.1.10-2: Attributes of [wifiClient] resource Attributes of [wifiClient] 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 1027(wifiClient). 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]. ssid 1 RW Indicates ssid of Wi-Fi® network. This attribute is a specialization of [objectAttribute] attribute. credentials 0..1 RW Indicates encryption type and credentials used to authenticate connection. This attribute is a specialization of [objectAttribute] attribute. macAddress 0..1 RW Indicates MAC address of network's access point. This attribute is a specialization of [objectAttribute] attribute. channel 0..1 RO Indicates Wi-Fi® channel. This attribute is a specialization of [objectAttribute] attribute. connectionStatus 0..1 RW Indicates current status of the connection. This attribute is a specialization of [objectAttribute] attribute. scan 1 RW The action that allows to scan the environment to find available Wi-Fi® networks. The action is triggered by assigning value "TRUE" to this attribute. This attribute is a specialization of [objectAttribute] attribute. This action will provide all the available ssids in scanResult. scanResult 1 RW Indicates list of networks detected by the device. This attribute is a specialization of [objectAttribute] attribute. update 1 RW The action is to trigger the device to update its Wi-Fi® configuration based on the provided values (e.g. ssid, credentials, etc.).The action is triggered by assigning value "TRUE" to this attribute. This attribute is a specialization of [objectAttribute] attribute. updateStatus 1 RW Indicates status of update operation. This attribute is a specialization of [objectAttribute] attribute. toggleRadioStatus 0..1 RW The action that allows to turn on and turn off the Wi-Fi® sub-system on Wi-Fi® client device according to present radioStatus attribute value. The action is triggered by assigning value "TRUE" to this attribute. This attribute is a specialization of [objectAttribute] attribute. This action will switch radioStatus. radioStatus 0..1 RW Indicates whether the Wi-Fi® sub-system on Wi-Fi® client device is turned on or turned off. This attribute is a specialization of [objectAttribute] attribute.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2 Resource-Type specific procedures and definitions
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.1 Introduction
|
The present clause defines the resource-type specific details of the resource representations and protocol procedures for each <mgmtObj> specialization defined in clause 7.1. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 24 oneM2M TS-0022 version 4.5.1 Release 4
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.2 Resource [registration]
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.2.1 Introduction
|
This specialization of <mgmtObj> is used to convey the service layer configuration information needed to register an AE or CSE with a Registrar CSE. Table 7.2.2.1-1: Data Type Definition of [registration] Data Type ID File Name Note registration DCFG-registration.xsd Table 7.2.2.1-2: Resource specific attributes of [registration] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 of ETSI TS 118 104 [4] 1020 (registration). objectIDs O NP See clause 7.4.15 of ETSI TS 118 104 [4] objectPaths O NP See clause 7.4.15 of ETSI TS 118 104 [4] description O O See clause 7.4.15 of ETSI TS 118 104 [4] originatorID O O m2m:ID 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 O O m2m:poaList The point of access URI of the Registrar CSE. Note that protocol binding is determined from the protocol schema in this URI. CSEBase O O xs:anyURI No Defaults. CSE-ID O O m2m:ID No Defaults. appID O O m2m:ID The APP_ID of an AE. This attribute shall only be present when this resource is used for the registration of an AE. externalID O O m2m:externalID 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 O O m2m:triggerRecipientID 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 O O m2m:mgmtLinkRef 1 link to a [authenticationProfile] resource instance. See note. M2M-Sub-ID O NP m2m:ID NOTE: The SUID in the linked [authenticationProfile] instance constrains the security framework to be used with the Authentication Profile. The security frameworks used with the [registration] resource are Security Association Establishment Frameworks (SAEF). The entity composing a [registration] instance is expected to confirm that the linked Authentication Profile contains a SUID corresponding to an SAEF. The SAEF SUIDs are the values 12, 22, 32 or 42 as defined in ETSI TS 118 104 [4]. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 25 oneM2M TS-0022 version 4.5.1 Release 4
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.2.2 Resource specific procedure on CRUD operations
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of ETSI TS 118 104 [4], '<mgmtObj> specific procedures' shall be used. In addition to the generic procedures in clause 7.2.2 of ETSI TS 118 104 [4] for operations on this resource following check shall be done in CREATE and UPDATE operation: If appID attribute is set to a value starting with other than 'r', 'R' or 'N' then the Hosting CSE shall reject the request with "BAD_REQUEST" Response Status Code. NOTE: Use of 'r' will be forbidden when subsequently registering an AE that supports release 4 or above.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.3 Resource [dataCollection]
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.3.1 Introduction
|
Table 7.2.3.1-1: Data Type Definition of [dataCollection] Data Type ID File Name Note dataCollection DCFG-dataCollection.xsd Table 7.2.3.1-2: Resource specific attributes of [dataCollection] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 of ETSI TS 118 104 [4] 1021 (dataCollection). objectIDs O NP See clause 7.4.15 of ETSI TS 118 104 [4] objectPaths O NP See clause 7.4.15 of ETSI TS 118 104 [4] description O O See clause 7.4.15 of ETSI TS 118 104 [4] containerPath M O m2m:ID The URI of the <container> resource in the hosting CSE that stores the data transmitted by the device. reportingSchedule O O m2m:scheduleEntries The schedule, used to transmit the measured or collected data to the Hosting CSE. If the entity that reports the data misses a reporting interval, the entity shall wait until the next interval to report the data. measurementSchedule O O m2m:scheduleEntries The schedule, that the device will use to collect or measure the data. If the entity that measures or collects the data misses a measurement interval, the entity shall wait until the next interval to collect or measure the data. mgmtLink O O m2m:mgmtLinkRef 1 link to a [authenticationProfile]. See note. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 26 oneM2M TS-0022 version 4.5.1 Release 4 Attribute Name Request Optionality Data Type Default Value and Constraints Create Update NOTE: The SUID in the linked [authenticationProfile] instance constrains the security framework to be used with the Authentication Profile. The security frameworks used with the [dataCollection] resource are End-to-End Security of Primitives (ESPrim). The entity composing a [dataCollection] instance is expected to confirm that the linked Authentication Profile contains a SUID corresponding to ESPrim. The SUIDs corresponding to ESPrim security frameworks are the values 13, 23, 33 or 43 as defined in ETSI TS 118 104 [4].
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.3.2 Resource specific procedure on CRUD operations
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of ETSI TS 118 104 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of ETSI TS 118 104 [4] for operations on this resource. ETSI TS 118 105 [5] and ETSI TS 118 106 [6] provide the mapping of these resources into the technology specific protocol data model.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.4 Resource [authenticationProfile]
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.4.1 Introduction
|
Table 7.2.4.1-1: Data Type Definition of [authenticationProfile] Data Type ID File Name Note authenticationProfile DCFG-authenticationProfile.xsd Table 7.2.4.1-2: Resource specific attributes of [authenticationProfile] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 of ETSI TS 118 104 [4] 1022 (authenticationProfile). objectID O NP See clause 7.4.15 of ETSI TS 118 104 [4] objectPaths O NP See clause 7.4.15 of ETSI TS 118 104 [4] description O O See clause 7.4.15 of ETSI TS 118 104 [4] SUID M NP m2m:suid Allowed values are listed in table 7.1.4-3. TLSCiphersuites O O dcfg:listOfTLSCiphersuite symmKeyID O NP sec:credentialID symmKeyValue O NP xs:hexBinary The minimum key length is 256 bits. MAFKeyRegLabels O NP m2m:labels MAFKeyRegDuration O NP xs:duration mycertFingerprint O NP dcfg:niURI or dcfg:nihURI rawPubKeyID O NP dcfg:niURI or dcfg:nihURI M2M-Sub-ID O NP xs:string mgmtLink O O See clause 7.4.15 of ETSI TS 118 104 [4] Table 7.2.4.1-3: Child resources of [authenticationProfile] resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 of ETSI TS 118 104 [4] ETSI ETSI TS 118 122 V4.5.1 (2023-07) 27 oneM2M TS-0022 version 4.5.1 Release 4
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.4.2 Resource specific procedure on CRUD operations
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of ETSI TS 118 104 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of ETSI TS 118 104 [4] for operations on this resource. ETSI TS 118 105 [5] and ETSI TS 118 106 [6] provide the mapping of these resources into the technology specific protocol data model.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.5 Resource [myCertFileCred]
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.5.1 Introduction
|
Table 7.2.5.1-1: Data Type Definition of [myCertFileCred] Data Type ID File Name Note myCertFileCred DCFG-myCertFileCred.xsd Table 7.2.5.1-2: Resource specific attributes of [myCertFileCred] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 of ETSI TS 118 104 [4] 1023 (myCertFileCred) objectID O NP See clause 7.4.15 of ETSI TS 118 104 [4] objectPaths O NP See clause 7.4.15 of ETSI TS 118 104 [4] description O O See clause 7.4.15 of ETSI TS 118 104 [4] SUIDs M O xs:list of m2m:suid Allowed values are listed in table 7.1.5-3. myCertFileFormat M NP xs:anyURI Media Type of myCertFileContent attribute. Default is "application/pkcs7- mime". myCertFileContent M NP xs:string Certificate or certificate chain. Default media-type is "application/pkcs7-mime". Table 7.2.5.1-3: Child resources of [myCertFileCred] resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 of ETSI TS 118 104 [4]
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.5.2 Resource specific procedure on CRUD operations
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of ETSI TS 118 104 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of ETSI TS 118 104 [4] for operations on this resource. ETSI TS 118 105 [5] and ETSI TS 118 106 [6] provide the mapping of these resources into the technology specific protocol data model.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.6 Resource [trustAnchorCred]
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.6.1 Introduction
|
Table 7.2.6.1-1: Data Type Definition of [trustAnchorCred] Data Type ID File Name Note trustAnchorCred DCFG-trustAnchorCred.xsd ETSI ETSI TS 118 122 V4.5.1 (2023-07) 28 oneM2M TS-0022 version 4.5.1 Release 4 Table 7.2.6.1-2: Resource specific attributes of [trustAnchorCred] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 of ETSI TS 118 104 [4] 1024 (trustAnchorCred) objectID O NP See clause 7.4.15 of ETSI TS 118 104 [4] objectPaths O NP See clause 7.4.15 of ETSI TS 118 104 [4] description O O See clause 7.4.15 of ETSI TS 118 104 [4] certFingerprint M NP dcfg:niURI URI M O xs:anyURI Table 7.2.6.1-3: Child resources of [trustAnchorCred] resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 of ETSI TS 118 104 [4]
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.6.2 Resource specific procedure on CRUD operations
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of ETSI TS 118 104 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of ETSI TS 118 104 [4] for operations on this resource. ETSI TS 118 105 [5] and ETSI TS 118 106 [6] provide the mapping of these resources into the technology specific protocol data model.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.7 Resource [MAFClientRegCfg]
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.7.1 Introduction
|
Table 7.2.7.1-1: Data Type Definition of [MAFClientRegCfg] Data Type ID File Name Note MAFClientRegCfg DCFG-MAFClientRegCfg.xsd Table 7.2.7.1-2: Resource specific attributes of [MAFClientRegCfg] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 of ETSI TS 118 104 [4] 1025 (MAFClientRegCfg) fqdn M NP See table 12.4.2-1 of ETSI TS 118 103 [3] adminFQDN M NP See table 12.4.2-1 of ETSI TS 118 103 [3] httpPort O NP See table 12.4.2-1 of ETSI TS 118 103 [3] At least one of these attributes shall be present coapPort O NP See table 12.4.2-1 of ETSI TS 118 103 [3] websocketPort O NP See table 12.4.2-1 of ETSI TS 118 103 [3] mgmtLink M O m2m:mgmtLinkRef 1 link to a [authenticationProfile] resources instance NOTE: For further details of these attributes, see clauses 8.8.3.2 and 12.4.2 of ETSI TS 118 103 [3]. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 29 oneM2M TS-0022 version 4.5.1 Release 4 Table 7.2.7.1-3: Child resources of [MAFClientRegCfg] resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 of ETSI TS 118 104 [4]
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.7.2 Resource specific procedure on CRUD operations
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of ETSI TS 118 104 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of ETSI TS 118 104 [4] for operations on this resource. ETSI TS 118 105 [5] and ETSI TS 118 106 [6] provide the mapping of these resources into the technology specific protocol data model.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.8 Resource [MEFClientRegCfg]
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.8.1 Introduction
|
Table 7.2.8.1-1: Data Type Definition of [MEFClientRegCfg] Data Type ID File Name Note MEFClientRegCfg DCFG-MEFClientRegCfg.xsd Table 7.2.8.1-2: Resource specific attributes of [MEFClientRegCfg] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 of ETSI TS 118 104 [4] 1026 (MEFClientRegCfg) fqdn M NP See table 12.4.2-1 of ETSI TS 118 103 [3] adminFQDN M NP See table 12.4.2-1 of ETSI TS 118 103 [3] httpPort O NP See table 12.4.2-1 of ETSI TS 118 103 [3] At least one of these attributes shall be present coapPort O NP See table 12.4.2-1 of ETSI TS 118 103 [3] websocketPort O NP See table 12.4.2-1 of ETSI TS 118 103 [3] mgmtLink M O m2m:mgmtLinkRef 1 link to a [authenticationProfile] resources instance NOTE: For further details of these attributes, see clauses 8.3.7.2 and 12.4.2 of ETSI TS 118 103 [3]. Table 7.2.8.1-3: Child resources of [MEFClientRegCfg] resource Child Resource Type Child Resource Name Multiplicity Ref. to in Resource Type Definition <subscription> [variable] 0..n Clause 7.4.8 of ETSI TS 118 104 [4]
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.8.2 Resource specific procedure on CRUD operations
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of ETSI TS 118 104 [4], '<mgmtObj> specific procedures' shall be used. There is no change from the generic procedures in clause 7.2.2 of ETSI TS 118 104 [4] for operations on this resource. ETSI TS 118 105 [5] and ETSI TS 118 106 [6] provide the mapping of these resources into the technology specific protocol data model. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 30 oneM2M TS-0022 version 4.5.1 Release 4
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.9 Resource [OAuth2Authentication]
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.9.1 Introduction
|
7.2.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
9.1 Introduction
|
This specialization of <mgmtObj> is used to store access token and refresh token used in OAuth2 security protocol Table 7.2.9.1-1: Data Type Definition of [OAuth2Authentication] Data Type ID File Name Note OAuth2Authentication DCFG-OAuth2.xsd Table 7.2.9.1-2: Resource specific attributes of [OAuth2Authentication] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 of ETSI TS 118 104 [4] 1027 (OAuth2Authentication) objectIDs O NP See clause 7.4.15 of ETSI TS 118 104 [4] objectPaths O NP See clause 7.4.15 of ETSI TS 118 104 [4] description O O See clause 7.4.15 of ETSI TS 118 104 [4] accessToken M O xs:string refreshToken M O xs:string
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.9.2 Resource specific procedure on CRUD operations
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 in ETSI TS 118 104 [4],'<mgmtObj> specific procedures' shall be used. There are no change from the generic procedures in clause 7.2.2 of ETSI TS 118 104 [4] for operations on this resource.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.10 Resource [wifiClient]
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.10.1 Introduction
|
This specialization of <mgmtObj> is used to store configuration of Wi-Fi® connection on the client device. Table 7.2.10.1-1: Data Type Definition of [wifiClient] Data Type ID File Name Note wifiClient DCFG-wifiClient.xsd ETSI ETSI TS 118 122 V4.5.1 (2023-07) 31 oneM2M TS-0022 version 4.5.1 Release 4 Table 7.2.10.1-2: Resource specific attributes of [wifiClient] Attribute Name Request Optionality Data Type Default Value and Constraints Create Update mgmtDefinition M NP See clause 7.4.15 of ETSI TS 118 104 [4] 1028 (wifiClient) objectIDs O NP See clause 7.4.15 of ETSI TS 118 104 [4] objectPaths O NP See clause 7.4.15 of ETSI TS 118 104 [4] description O O See clause 7.4.15 of ETSI TS 118 104 [4] ssid M O dcfg:ssid credentials O O dcfg:wifiCredentials macAddress O O xs:string channel O O xs:integer update O O xs:boolean scan M O xs:boolean toggleRadioStatus O O xs:boolean scanResult O O dcfg:listOfSsids updateStatus O O m2m:actionStatus connectionStatus O O dcfg:wifiConnectionStatus radioStatus O O xs:boolean
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.2.10.2 Resource specific procedure on CRUD operations
|
When management is performed using technology specific protocols, the procedures defined in clause 7.4.15.2 of ETSI TS 118 104 [4],'<mgmtObj> specific procedures' shall be used. There are no change from the generic procedures in clause 7.2.2 of ETSI TS 118 104 [4] for operations on this resource except retrieve operation which is described below.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.3 Data formats for device configuration
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.3.1 Introduction
|
Clause 7.3 defines data formats of resource attributes and parameters used in present document. Any data types of XML elements defined for use in present document shall be one of name spaces in table 7.3.1-1. Table 7.3.1-1: Namespaces used in present document Name space prefix Name space definition oneM2M protocol CDT m2m: http://www.onem2m.org/xml/protocol Device Configuration dcfg: http://www.onem2m.org/xml/deviceConfig oneM2M Security sec: http://www.onem2m.org/xml/securityProtocols
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.3.2 Simple oneM2M data types for device configuration
|
Table 7.3.2-1 describes simple data type definitions specific to security. The types in table 7.3.2-1 are either: • Atomic data types derived from XML Schema data types by restrictions other than enumeration. • List data types constructed from other XML Schema or oneM2M-defined atomic data types. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 32 oneM2M TS-0022 version 4.5.1 Release 4 Table 7.3.2-1: oneM2M simple data types for device configuration XSD type name Used for Examples Description dcfg:TLSCiphersuite A TLS Ciphersuite identifier C0A5 Four hexadecimal characters representing a TLS Cipher suite identifier. The list of TLS cipher suites identifiers can be found at the IANA TLS Cipher Suite Registry [8]. dcfg:ListOfTLSCiphersu ite A list of TLS Ciphersuite identifiers xs:list of elements of data type dcfg:TLSCiphersuite. dcfg:niURI Identifying information with a hash value ni:///sha-256;UyaQV... ni:///1;UyaQV... ("1" is a short identifier for sha-256) An xs:anyURI conforming to the Named Information 'ni' URI scheme specified in IETF RFC 6920 [7], with no authority field. dcfg:nihURI Identifying information with a human speakable encoding of a hash value nih:sha-256-32;53269057;b nih:sha-256-32;5326-9057;b nih:6;5326-9057 ("6" is a short identifier for sha-256-32) An xs:anyURI conforming to the Human Speakable Named Information 'nih' URI scheme specified in IETF RFC 6920 [7], with no authority field. A checkdigit may be present. dcfg:ssid SSID of Wi-Fi® network The ssid of Wi-Fi® network. dcfg:listOfSsids List of SSIDs xs:list of elements of data type m2m:ssid.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.3.3 Enumerated oneM2M data types for device configuration
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.3.3.1 dcfg:wifiConnectionStatus
|
Used to indicate Wi-Fi® connection status. Table 7.3.3.1-1: Interpretation of dcfg:wifiConnectionStatus Value Interpretation Note 0 Disconnected 1 Connected 2 Idle Indicates the state when the device tries to establish the connection to the network. It expires after the set number of unsuccessful attempts or when the connection is established. 3 No SSID available 4 Scan completed 5 Failed 6 Lost
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.3.3.2 dcfg:wifiEncryptionType
|
Used for indicating which Wi-Fi® encryption protocol is used to provide security in wireless network. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 33 oneM2M TS-0022 version 4.5.1 Release 4 Table 7.3.3.2-1: Interpretation of dcfg:wifiEncyrptionType Value Interpretation Note 1 none 2 WEP 3 WPA Personal 4 WPA2 Personal 5 WPA3 Personal 6 WPA Enterprise 7 WPA2 Enterprise 8 WPA3 Enterprise
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.3.4 Complex type definitions
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
7.3.4.1 dcfg:wifiCredentials
|
Used for credentials in [wifiClient] Management Object resource. Values contained in username, password, wep.key and wpa.psk attributes shall not be readable. Each Retrieve request shall be forwarded to device and from there the data shall be retrieved. Table 7.3.4.1-1: Type Definition of dcfg:wifiCredentials Element Path Element Data Type Multiplicity Note encryptionType dcfg:wifiEncryptionType 1 Indicates type of encryption used to provide network security username xs:string 0..1 Indicates username used to authenticate user in WPA-Enterprise, WPA2-Enterprise or WPA3-Enterprise protocols Only valid if encryptionType = 6, 7 or 8 password xs:string 0..1 Indicates password used to authenticate user in WPA-Enterprise, WPA2-Enterprise or WPA3-Enterprise protocols Only valid if encryptionType = 6, 7 or 8 wepKey xs:string 0..1 Indicates key in case of WEP encryption. Only valid if field encryptionType = 2 wpaPsk xs:string 0..1 Indicates WPA Pre Shared Key Only valid if field encryptionType = 3, 4 or 5
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8 Procedures
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.1 <mgmtObj> life cycle procedures
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.1.1 Introduction
|
The life cycle of the <mgmtObj> resource in the Hosting CSE is established either through the: • Provisioning of the <mgmtObj> resource by the Configuration AE. • Discovery of the <mgmtObj> resource by the Hosting CSE using the methods described in clause 6.1. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 34 oneM2M TS-0022 version 4.5.1 Release 4
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.1.2 Setting configuration information on <mgmtObj> resource
|
The Configuration AE is able to configure the <mgmtObj> resources used for device configuration by either creating the <mgmtObj> resource or updating existing <mgmtObj> resources for the targeted AE or CSE. Likewise, the Configuration AE can delete the <mgmtObj> resource as part of a decommissioning process. In some scenarios the <mgmtObj> resource may already exist due to pre-provisioning or a previous discovery action by the IN-CSE's interaction with the Configuration IPE, DM Server or ASN/MN or ADN node. As such the Configuration AE needs to first discover if the <mgmtObj> resource exists in the Hosting CSE. As <mgmtObj> resources are represented under the <node> resource of the ASN/MN or ADN node, the discovery operation's scope can use the <node> resource within the discovery criteria. Based on the results of the discovery the Configuration AE will either create or update the <mgmtObj> resource. Figure 8.1.2-1 depicts this flow. Figure 8.1.2-1: Configuring attributes of a <mgmtObj> resource Likewise, the Configuration AE may use the same approach to discover when deleting the <mgmtObj> resource as part of a decommissioning process or retrieval of the <mgmtObj> resource. NOTE: In order for the IN-CSE to forward the request onto the DM Server, the <mgmtObj> resource is required to be configured with the path to the resource in the context of the technology specific protocol (e.g. LWM2M URI [i.4], OMA-DM path [i.3], BBF TR-069 path [i.2]). The fully qualified domain name can also be used if the IN-CSE does not know the address of the DM Server.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.1.3 Management of <mgmtObj> resource on ASN/MN/ADN nodes
| |
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.1.3.1 Introduction
|
Management of the <mgmtObj> object resources on ASN/MN or ADN nodes may be managed using one of the architectural methods described in clause 6.1.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.1.3.2 Management using device management technologies
|
Clause 10.2.8 '<mgmtObj> Resource Procedures' of ETSI TS 118 101 [2] describes the procedures for M2M Nodes to represent their technology specific data as oneM2M resources within the IN-CSE. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 35 oneM2M TS-0022 version 4.5.1 Release 4 Figure 8.1.3.2-1: Management using Device Management technologies 1) The Configuration AE issues a request for <mgmtObj> resource for an ASN/MN/ADN node that is managed using Device Management technologies. 2) The IN- CSE processes the request issued by Configuration AE. 3) The IN-CSE executes the Device Management command which is mapped from operation on <mgmtObj> resource to external management technologies. 4) The ASN/MN/ADN then creates, updates, deletes or retrieve the configuration parameters on the node, and returns the result of Device Management command.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.1.3.3 Management using the Mcc reference point
|
Once M2M Service Layer operation is established between the AE or CSE and the Registrar/Hosting CSE, <mgmtObj> resources may be managed using the Mcc reference point by the AE or CSE subscribing to receive changes to the <mgmtObj> resource using the subscription procedures defined in clause 10.2.11 of ETSI TS 118 101 [2]. Establishment of the M2M Service Layer operations includes actions such as establishing the appropriate security associations and registration of the CSEs and AEs. While not mentioned in clause 6.1 of the present document, <mgmtObj> specializations may be announced depending on the <mgmtObj> specialization type. The following <mgmtObj> specializations specified in the present document are announceable (i.e. announceable variants of this resource type are defined in the XSD of the respective <mgmtObj> specialization): [registration], [dataCollection] The following <mgmtObj> specializations specified in the present document are not announceable (i.e. announceable variants of this resource type are not defined in the XSD of the respective <mgmtObj> specialization): [authenticationProfile], [myCertFileCred], [trustAnchorCred], [MAFClientRegCfg], [MEFClientRegCfg] Configuration AE Hosting CSE <IN-CSE> Targeted Field Device ASN/ADN 2.CRUD <mgmtObj> resource 1.CRUD request for <mgmtObj> 3.Execute DM command 4. Create/Update/ Retrieve/Delete configuration parameters ETSI ETSI TS 118 122 V4.5.1 (2023-07) 36 oneM2M TS-0022 version 4.5.1 Release 4 Figure 8.1.3.3-1: Management using the Mcc reference point 1) Once M2M Service Layer operation is established, the AE or CSE on the ASN/MN/ADN node subscribes to the <mgmtObj> resource which is associated with the specific M2M Application functionality creating <subscription> resource. 2) When the Configurator AE creates, updates or delete the <mgmtObj> resource, the Configuration AE issues a request on the <mgmtObj> resource. 3) The Hosting CSE for the <mgmtObj> resource performs the operation on the resource as Receiver. 4) The Hosting CSE notifies the subscribed AE or CSE as the subscribed event message. 5) The AE or CSE configures the M2M Application on the ASN/MN or ADN node.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.1.3.4 Management using the oneM2M IPE technology
|
When ASN/MN or ADN nodes are configured using a Configuration IPE, the ASN/MN/ADN may periodically request the Configuration IPE to configure the ASN/MN/ADN node. The method that the ASN/MN/ADN uses to periodically request to be configured is unspecified in the present document. Once the Configuration IPE receives the request from the ASN/MN/ADN node, the Configuration IPE shall send a retrieve request to the Hosting CSE to obtain the applicable specialization of <mgmtObj> resources for the ASN/MN/ADN node. How the Configuration IPE maintains the mapping between the ASN/MN/ADN and the associated <node> and <mgmtObj> resources is unspecified in the present document. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 37 oneM2M TS-0022 version 4.5.1 Release 4 Figure 8.1.3.4-1: Management using oneM2M IPE technology 1) The Configuration AE issues a CRUD request to <mgmtObj> resource which is associated with the functionality of targeted field device. 2) The Hosting CSE processes the CRUD request. 3) When the ASN/MN/ADN determines it needs to be configured, the ASN/MN/ADN issues a request to the Configuration IPE. 4) The Configuration IPE determines <mgmtObj> resource to refer as the source of configuration parameter for the targeted field device, and issues an operation on the <mgmtObj> or <node> resource. 5) When the RETRIEVE request is successfully performed, the Configuration IPE transforms the <mgmtObj> resource into a form understandable by ASN/MN/ADN node. 6) The ASN/MN/ADN configures setting parameters for the M2M Application. NOTE: One possible method of exchanging information between the Configuration IPE and the ASN/MN/ADN is to simply serialize the <mgmtObj> resource using the MIME content types defined in clause 6.7 of ETSI TS 118 104 [4] 'oneM2M specific MIME media types'.
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.2 Obtaining authentication credential procedure
|
When an ASN/MN or ADN node is required to be authenticated, a mgmtLink 'authProfile' referring to the <mgmtObj> resource specialization for maintaining the Authentication Profiles shall be provided. The Authentication Profile contains following information: • Choice of TLS options. • mgmtLinkRef(s) to the <mgmtObj> which provides information required to obtain the credential(s). When an ASN/MN or ADN node is establishing the appropriate security associations, the <mgmtObj> specialization for Authentication Profile shall be used to identify the security related settings. Actual credential shall be obtained using the information on the <mgmtObj> specializations (Authentication Credential Configuration) which is referred by mgmtLinkRef(s) from Authentication Profile. Configuration AE Hosting CSE Targeted Field Device Configuration IPE 2.CRUD <mgmtObj> resource 3.Request configuration data 1. CRUD request for <mgmtObj> 4.Retrieve <mgmtObj> or <node> ASN/ADN 5.Return configuration data 6.Configure parameters of the M2M Application ETSI ETSI TS 118 122 V4.5.1 (2023-07) 38 oneM2M TS-0022 version 4.5.1 Release 4 Figure 8.2-1: Relationship between 'Authentication Profile' and 'Authentication Credential Configuration(s)'
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.3 AE and CSE registration procedure
|
When an ASN/MN or ADN node receives the information in the [registration] resource, the AE or CSE performs the registration procedure for that type of resource. If the resource is for CSE, then the CSE registration procedure which is defined in clause 10.1.1.2.1 of ETSI TS 118 101 [2] is used. If the resource is for AE, the Application Entity Registration procedure defined in clause 10.1.1.2.2 of ETSI TS 118 101 [2] is used. Required parameter for registration procedures is retrieved as attribute value of [registration] resource. Table 8.3-1: Required [registration] resource parameters for registration attribute of [registration] parameter in ETSI TS 118 101 [2]/TS-0004 [4] originatorID From primitive parameter PoA CSE-PoA (Point of Access) resourcePath To primitive parameter
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
8.4 Enabling data collection by [dataCollection] resource
|
When an AE needs to measure or collect data to be later reported to a Hosting CSE , report measured data to a CSE, the ASN/MN/ADN may be instructed when to measure/collect the data and then when to report the measured/collected data along with where to place the data within the Hosting CSE. Once AE is configured with the [dataCollection] resource AE performs CREATE operation for new <contentInstance> resource as the child resource of <container> resource which is specified as 'containerPath' attribute of [dataCollection] resource to report the measured/collected data. The frequency of collection/measurement and reporting are accordingly specified as 'reportingSchedule' and 'measurementSchedule' attributes of the [dataCollection] resource. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 39 oneM2M TS-0022 version 4.5.1 Release 4
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
9 Short Names
|
9.1 Introduction Short names are introduced in clause 8.2.1 of ETSI TS 118 104 [4]. The short names in ETSI TS 118 104 shall apply in addition to the short names defined in the present document. 9.2 Common and Field Device Configuration specific oneM2M Resource attributes In protocol bindings, resource attribute names shall be translated into short names of table 9.2-1 and in table 8.2.3-1 of ETSI TS 118 104 [4]. Table 9.2-1: Common and Field Device Configuration specific oneM2M Attribute Short Names Attribute Name Occurs in Short Name Notes resourceType All ty Defined in ETSI TS 118 104 [4]. resourceID All ri Defined in ETSI TS 118 104 [4]. resourceName All rn Defined in ETSI TS 118 104 [4]. parentID All pi Defined in ETSI TS 118 104 [4]. expirationTime All et Defined in ETSI TS 118 104 [4]. creationTime All ct Defined in ETSI TS 118 104 [4]. Labels All lbl Defined in ETSI TS 118 104 [4]. lastModifiedTime All lt Defined in ETSI TS 118 104 [4]. description All dc Defined in ETSI TS 118 104 [4]. mgmtDefinition All mgd Defined in ETSI TS 118 104 [4]. objectIDs All obis Defined in ETSI TS 118 104 [4]. objectPaths All obps Defined in ETSI TS 118 104 [4]. mgmtLink All cmlk Defined in ETSI TS 118 104 [4]. CSE-ID registration csi Defined in ETSI TS 118 104 [4]. CSEBase registration cb Defined in ETSI TS 118 104 [4]. originatorID registration oid pointOfAccess registration poa appID registration apid externalID registration eid Trigger-Recipient-ID registration tri Defined in ETSI TS 118 104 [4]. containerPath dataCollection cntp reportingSchedule dataCollection rpsc measurementSchedule dataCollection mesc SUID authenticationProfile suid TLSCiphersuites authenticationProfile tlcs symmKeyID authenticationProfile ski symmKeyValue authenticationProfile skv MAFKeyRegLabels authenticationProfile mkrl MAFKeyRegDuration authenticationProfile mkrd mycertFingerprint authenticationProfile mcfp rawPubKeyID authenticationProfile rpki SUIDs myCertFileCred suids myCertFileFormat myCertFileCred mcff myCertFileContent myCertFileCred mcfc certFingerprint trustAnchorCred cfp URI trustAnchorCred uri Defined in ETSI TS 118 104 [4]. Fqdn MEFClientRegCfg, MAFClientRegCfg fq Defined in ETSI TS 118 132 [9]. adminFQDN MEFClientRegCfg, MAFClientRegCfg adfq Defined in ETSI TS 118 132 [9]. httpPort MEFClientRegCfg, MAFClientRegCfg hpt Defined in ETSI TS 118 132 [9]. coapPort MEFClientRegCfg, MAFClientRegCfg copt Defined in ETSI TS 118 132 [9]. ETSI ETSI TS 118 122 V4.5.1 (2023-07) 40 oneM2M TS-0022 version 4.5.1 Release 4 Attribute Name Occurs in Short Name Notes websocketPort MEFClientRegCfg, MAFClientRegCfg wpt Defined in ETSI TS 118 132 [9]. accessToken OAuth2Authentication atk refreshToken OAuth2Authentication rtk ssid wifiClient ssid credentials wifiClient cred macAddress wifiClient maca channel wifiClient chan connectionStatus wifiClient cons scan wifiClient scan scanResult wifiClient scanr update wificlient, ud Defined in ETSI TS 118 104 [4]. updateStatus wifiClient uds Defined in ETSI TS 118 104 [4]. toggleRadioStatus wifiClient trdst radioStatus wifiClient rdst 9.3 Field Device Configuration specific oneM2M Resource types In protocol bindings, resource type names of the <mgmtObj> specializations shall be translated into the short names of table 9.3-1. Table 9.3-1: Field Device Configuration specific Resource Type Short Names ResourceType Name Short Name registration reg registrationAnnc regA dataCollection datc dataCollectionAnnc datcA authenticationProfile autp MAFClientRegCfg macrc MEFClientRegCfg mecrc myCertFileCred nycfc trustAnchorCred tac wifiClient wfct OAuth2Authentication oaan
|
2395f30ff475e7568cf731adbfd6ffb0
|
118 122
|
9.4 oneM2M Complex data type members
|
In protocol bindings, complex data types member names shall be translated into the short names of table 9.4-1. Table 9.4-1: oneM2M Complex data type member short names Member Name Occurs in Short Name Notes encryptionType dcfg:wifiCredentials enct username dcfg:wifiCredentials unm Defined in ETSI TS 118 104 [4]. password dcfg:wifiCredentials pwd Defined in ETSI TS 118 104 [4]. wepKey dcfg:wifiCredentials wepk wpaPsk dcfg:wifiCredentials wpap ETSI ETSI TS 118 122 V4.5.1 (2023-07) 41 oneM2M TS-0022 version 4.5.1 Release 4 History Document history V4.5.1 July 2023 Publication
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
1 Scope
|
The present document specifies a general structure and an XML format for reporting the validation of AdES digital signatures (specified in ETSI EN 319 122-1 [i.1], ETSI EN 319 132-1 [4], ETSI EN 319 142-1 [i.3] respectively). The present document is aligned with the requirements specified in ETSI EN 319 102-1 [1].
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
2 References
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-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 102-1 (V1.3.1): "Electronic Signatures and Infrastructures (ESI); Procedures for Creation and Validation of AdES Digital Signatures; Part 1: Creation and Validation". [2] W3C® Recommendation 11 April 2013: "XML Signature Syntax and Processing Version 1.1". [3] ETSI TS 101 903 (V1.3.2): "XML Advanced Electronic Signatures (XAdES)". [4] ETSI EN 319 132-1: "Electronic Signatures and Infrastructures (ESI); XAdES digital signatures; Part 1: Building blocks and XAdES baseline signatures". [5] ETSI EN 319 132-2: "Electronic Signatures and Infrastructures (ESI); XAdES digital signatures; Part 2: Extended XAdES signatures". [6] ETSI TS 119 612: "Electronic Signatures and Infrastructures (ESI); Trusted Lists". [7] ETSI TS 119 312: "Electronic Signatures and Infrastructures (ESI); Cryptographic Suites". [8] IETF RFC 3061: "A URN Namespace of Object Identifiers". [9] ISO 32000-1:2008: "Document management - Portable document format - Part 1: PDF 1.7". [10] W3C® Recommendation 5 April 2012: "XML Schema Definition Language (XSD) 1.1 Part 1: Structures". [11] ETSI TS 119 172-1: "Electronic Signatures and Infrastructures (ESI); Signature Policies; Part 1: Building blocks and table of contents for human readable signature policy documents". [12] IETF RFC 5035: "Enhanced Security Services (ESS) Update: Adding CertID Algorithm Agility". ETSI ETSI TS 119 102-2 V1.4.1 (2023-06) 11
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-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 EN 319 122-1: "Electronic Signatures and Infrastructures (ESI); CAdES digital signatures; Part 1: Building blocks and CAdES baseline signatures". [i.2] ETSI EN 319 122-2: "Electronic Signatures and Infrastructures (ESI); CAdES digital signatures; Part 2: Extended CAdES signatures". [i.3] ETSI EN 319 142-1: "Electronic Signatures and Infrastructures (ESI); PAdES digital signatures; Part 1: Building blocks and PAdES baseline signatures". [i.4] ETSI EN 319 142-2: "Electronic Signatures and Infrastructures (ESI); PAdES digital signatures; Part 2: Additional PAdES signatures profiles". [i.5] ETSI TS 119 182-1: "Electronic Signatures and Infrastructures (ESI); JAdES digital signatures; Part 1: Building blocks and JAdES baseline signatures". [i.6] IETF RFC 4998: "Evidence Record Syntax (ERS)". [i.7] IETF RFC 6283: "Extensible Markup Language Evidence Record Syntax (XMLERS)". [i.8] Regulation (EU) No 910/2014 of the European Parliament and of the Council of 23 July 2014 on electronic identification and trust services for electronic transactions in the internal market and repealing Directive 1999/93/EC. [i.9] Recommendation ITU-R TF.460-6: "Standard-frequency and time-signal emissions".
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
3 Definition of terms, symbols and abbreviations
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
3.1 Terms
|
For the purposes of the present document, the terms given in ETSI EN 319 102-1 [1] and the following apply: AdES (digital) signature: digital signature that is either a CAdES signature, or a PAdES signature or a XAdES signature advanced electronic signature: As defined in Regulation (EU) No 910/2014 [i.8]. CAdES signature: digital signature that satisfies the requirements specified within ETSI EN 319 122-1 [i.1] or ETSI EN 319 122-2 [i.2] Coordinated Universal Time (UTC): time scale based on the second as defined in Recommendation ITU-R TF.460-6 [i.9] data object: actual binary/octet data being operated on (transformed, digested, or signed) by an application data to be signed formatted: data created from the data to be signed objects by formatting them and placing them in the correct sequence for the computation of the data to be signed representation data to be signed representation: hash of the data to be signed formatted, which is used to compute the digital signature value ETSI ETSI TS 119 102-2 V1.4.1 (2023-06) 12 JAdES signature: digital signature that satisfies the requirements specified within ETSI TS 119 182-1 [i.5] PAdES signature: digital signature that satisfies the requirements specified within ETSI EN 319 142-1 [i.3] or ETSI EN 319 142-2 [i.4] public key: in a public key cryptographic system, that key of an entity's key pair which is publicly known qualified electronic signature: As defined in Regulation (EU) No 910/2014 [i.8]. signature validation report: See ETSI EN 319 102-1 [1]. NOTE: Clause 5.1.3 of ETSI EN 319 102-1 [1] specifies minimum requirements for the content of such a report. (electronic) time-stamp: data in electronic form which binds other electronic data to a particular time establishing evidence that these data existed at that time trusted list: list that provides information about the status and the status history of the trust services from trust service providers regarding compliance with the applicable requirements and the relevant provisions of the applicable legislation NOTE: In the context of European Union Member States, as specified in Regulation (EU) No 910/2014 [i.8], it refers to an EU Member State list including information related to the qualified trust service providers for which it is responsible, together with information related to the qualified trust services provided by them. In the context of non-EU countries or international organizations, it refers to a list meeting the requirements of ETSI TS 119 612 [6] and providing assessment scheme based approval status information about trust services from trust service providers, for compliance with the relevant provisions of the applicable approval scheme and the relevant legislation. XAdES signature: digital signature that satisfies the requirements specified within ETSI EN 319 132-1 [4] or ETSI EN 319 132-2 [5]
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
3.2 Symbols
|
Void.
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
3.3 Abbreviations
|
For the purposes of the present document, the following abbreviations apply: AdES Advanced Electronic Signature CRL Certificate Revocation List DA Driving Application DER Distinguished Encoding Rules DSS Digital Signature Service DTBSF Data To Be Signed Formatted DTBSR Data To Be Signed Representation OCSP Online Certificate Status Protocol OID Object IDentifier PDF Portable Document Format POE Proof Of Existence SD Signer's Document SDR Signer's Document Representation SVA Signature Validation Application TSP Trust Service Provider TU Time-stamping Unit URI Uniform Resource Identifier URL Uniform Resource Locator URN Uniform Resource Name UTC Coordinated Universal Time VRI Validation Related Information W3C World Wide Web Consortium ETSI ETSI TS 119 102-2 V1.4.1 (2023-06) 13 XML eXtensible Markup Language
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4 Signature Validation Report Structure
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1 General provisions
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1 Report Structure
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.1 General
|
The present document defines the structure of reporting the result of the validation of an AdES digital signature (specified in ETSI EN 319 122-1 [i.1], ETSI EN 319 132-1 [4], ETSI EN 319 142-1 [i.3] respectively). The Signature Validation Application (SVA) is assumed to follow the signature validation model specified in ETSI EN 319 102-1 [1] and illustrated by Figure 1. Figure 1: Conceptual Model of Signature Validation ETSI EN 319 102-1 [1] The signature validation report shall consist of: • One or more Signature Validation Report-elements, each element containing the overall signature validation status for one signature as well as additional information on the signature validation performed. Clause 4.3 describes this element. It may also contain: • A Signature Validation Objects-element, containing objects used during validation, such as trust anchors, CRLs, or time-stamps. Clause 4.4 describes this element. NOTE: Objects contained in a signature validation objects element can be trust anchor information, CRLs or time-stamps. Some of these objects tend to be large. The signature validation objects element acts a container allowing storing objects only once even when they are needed for more than one signature validation report element. ETSI ETSI TS 119 102-2 V1.4.1 (2023-06) 14 • A Validator Information Element, containing information on the entity validating the signature(s) and producing the report. Clause 4.5 describes this element. • A Validation Report Signature Element, containing a signature on the report. Clause 4.6 describes this element. Figure 2 illustrates this structure. Figure 3 shows the structure with the elements contained in each of the fields. The following clauses describe these elements. Signature Validation Report Validator Information Validation Report Signature Signature Validation Report Element Signature Validation Objects Element Signature Validation Report Element Signature Validation Report Element CRL CRL validation report Time-Stamp TS validation report OCSP OCSP validation report ... … validation report A dotted line indicates a reference to the validation object is contained in the signature validation report element Figure 2: Signature Validation Report Structure ETSI ETSI TS 119 102-2 V1.4.1 (2023-06) 15 Signed Validation Report Signature Validation Report Elem ent Signature Identification Element Signature Validation Status Indication Main Status Indication Status Sub-Indication Associated validation report data elements Validation Constraints Evaluation Report Formal Policy Policy Identifier Policy Name URLs Validation Constraint (1..n) Validation Constraint Identifier Validation Constraint Status (Applied, Disabled, Overridden) Constraint Validation Result Main status indication Status sub-indication Associated validation report data elements Signature Validation Time Info Time of validation Time of POE of signature Signer's Document Signature Attributes Signer Information Signature Quality Signature Validation Process Inform ation Validation Process (according to ETSI EN 319 102-1 [1]) Validation Service Policy Validation Service Practice Statement Other Signature Validation Report Element Signature Validation Report Element … Signature Validation Objects Elem ent Signature Validation Object Object Identifier Object Type Validation Objects Proof of Existence Signature Validation Object Validation Report Signature Validation Object Signature Validation Object … Validator Information Validation Report Signature Element Figure 3: Validation Report Structure and Elements Annex B of the present document references an XML Schema file for the present document. ETSI ETSI TS 119 102-2 V1.4.1 (2023-06) 16 For every element specified below, a clause provides an excerpt of that schema that is relevant for that element for information. In case of discrepancies between such xml schema excerpts provided in the present document and the XML Schema files, the XML Schema files shall take precedence. Conventional XML namespace prefixes are used in the present document: • The prefix vr: (or no prefix) stands for the namespace for the present document. • The prefix ds: stands for the W3C XML Signature namespace [2]. • The prefix XAdES: stands for the namespace defined in ETSI XML Advanced Electronic Signatures (XAdES) document [3]. • The prefix tsl: stands for the namespace defined in ETSI TS 119 612 [6]. • The prefix xs: stands for the XML schema namespace [10]. Table 1 shows the URI values of the XML namespaces and their corresponding prefixes used in the schema file and within the present document. Table 1: Namespaces with prefixes URI value of the XML Namespace Prefix http://uri.etsi.org/19102/v1.4.1# vr http://www.w3.org/2000/09/xmldsig# ds http://uri.etsi.org/01903/v1.3.2 XAdES http://uri.etsi.org/02231/v2# tsl http://www.w3.org/2001/XMLSchema xs The following elements are used throughout the following clauses.
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.2 Validation Object Reference Element
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.2.1 General
|
Validation object reference elements are used within a validation report to reference another element within the report. EXAMPLE: Signature validation objects or the Signature Identification Element can be such elements that are referenced.
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.2.2 XML
|
Validation object reference elements shall be type VOReferenceType that is defined as follows: <xs:complexType name="VOReferenceType"> <xs:sequence> <xs:any namespace="##any" processContents="lax" minOccurs="0"/> </xs:sequence> <xs:attribute name="VOReference" type="xs:IDREFS" use="required"/> </xs:complexType>
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.3 Typed Data Type
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.3.1 General
|
A typed data type element is a generic data structure that can be used for representing any Type-Value tuple. ETSI ETSI TS 119 102-2 V1.4.1 (2023-06) 17
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.3.2 XML
|
A typed data type element shall be of type TypedDataType that is defined as follows: <xs:complexType name="TypedDataType"> <xs:sequence> <xs:element name="Type" type="xs:anyURI"/> <xs:element name="Value" type="xs:anyType"/> </xs:sequence> </xs:complexType>
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.4 Any Type
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.4.1 General
|
Various validation report elements allow the inclusion of optional elements that can be of "any type". The AnyType element is a generic data structure that can be used for representing any such elements.
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.4.2 XML
|
An any type element shall be of type AnyType that is defined as follows: <xs:complexType name="AnyType" mixed="true"> <xs:sequence minOccurs="0" maxOccurs="unbounded"> <xs:any processContents="lax"/> </xs:sequence> </xs:complexType>
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.5 Signature Reference
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.5.1 General
|
A signature reference element references a specific electronic signature.
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.1.1.5.2 XML
|
A signature reference shall be of type SignatureReferenceType that is defined as follows: <xs:complexType name="SignatureReferenceType"> <xs:choice> <xs:sequence> <xs:element name="CanonicalizationMethod" type="xs:anyURI" minOccurs="0"/> <xs:element name="DigestMethod" type="xs:anyURI"/> <xs:element name="DigestValue" type="xs:base64Binary"/> </xs:sequence> <xs:element ref="vr:XAdESSignaturePtr"/> <xs:element name="PAdESFieldName" type="xs:string"/> <xs:element name="OtherInformation" type="vr:AnyType" minOccurs="0"/> </xs:choice> </xs:complexType> <xs:element name="XAdESSignaturePtr" type="vr:XAdESSignaturePtrType"/> <xs:complexType name="XAdESSignaturePtrType"> <xs:sequence> <xs:element name="NsPrefixMapping" type="vr:NsPrefixMappingType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="WhichDocument" type="xs:IDREF" use="optional"/> <xs:attribute name="XPath" type="xs:string" use="optional"/> <xs:attribute name="SchemaRefs" type="xs:IDREFS" use="optional"/> </xs:complexType> <xs:complexType name="NsPrefixMappingType"> <xs:sequence> <xs:element name="NamespaceURI" type="xs:anyURI"/> <xs:element name="NamespacePrefix" type="xs:string"/> </xs:sequence> </xs:complexType> ETSI ETSI TS 119 102-2 V1.4.1 (2023-06) 18
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.2 Validation-Report-Element
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.2.1 General
|
Presence: Mandatory Description: This element is the wrapper for reports on the validation of one or more signatures. Content: This element shall contain one or more signature-validation-report elements as specified in clause 4.3. It also may contain: a signature validation objects element as specified in clause 4.4; information on the entity validating the signature and creating the validation report as described in clause 4.5; and a validation-report-signature element as described in clause 4.6.
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.2.2 XML
|
The validation report element shall be contained in an element named ValidationReport of type ValidationReportType that is defined as follows: <xs:complexType name="ValidationReportType"> <xs:sequence> <xs:element name="SignatureValidationReport" type="vr:SignatureValidationReportType" maxOccurs="unbounded"/> <xs:element name="SignatureValidationObjects" type="vr:ValidationObjectListType" minOccurs="0"/> <xs:element name="SignatureValidator" type="vr:SignatureValidatorType" minOccurs="0"/> <xs:element ref="ds:Signature" minOccurs="0"/> </xs:sequence> </xs:complexType>
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.3 Signature-Validation-Report-Element
| |
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.3.1 General
|
Presence: Mandatory Description: This element represents the validation information for a single signature. Content: This element shall contain a sequence of elements described in clauses 4.3.3 to 4.3.12. NOTE: This element is also used in the validation report of a signature validation object (see clause 4.4.8). The rules whether an element contained within this element is mandatory or optional can be different in this case. This element may also contain any other information provided by the validation process. ETSI ETSI TS 119 102-2 V1.4.1 (2023-06) 19
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.3.2 XML
|
The signature validation report shall be contained in an element named SignatureValidationReport of type SignatureValidationReportType that is defined as follows: <xs:complexType name="SignatureValidationReportType"> <xs:sequence> <xs:element name="SignatureIdentifier" type="vr:SignatureIdentifierType" minOccurs="0"/> <xs:element name="ValidationConstraintsEvaluationReport" type="vr:ValidationConstraintsEvaluationReportType" minOccurs="0"/> <xs:element name="ValidationTimeInfo" type="vr:ValidationTimeInfoType" minOccurs="0"/> <xs:element name="SignersDocument" type="vr:SignersDocumentType" minOccurs="0"/> <xs:element name="SignatureAttributes" type="vr:SignatureAttributesType" minOccurs="0"/> <xs:element name="SignerInformation" type="vr:SignerInformationType" minOccurs="0"/> <xs:element name="SignatureQuality" type="vr:SignatureQualityType" minOccurs="0"/> <xs:element name="SignatureValidationProcess" type="SignatureValidationProcessType" minOccurs="0"/> <xs:element name="SignatureValidationStatus" type="ValidationStatusType"/> <xs:element name="OtherInformation" type="vr:AnyType" minOccurs="0"/> </xs:sequence> </xs:complexType>
|
2949bd5aae729487a8f07c15de132bb9
|
119 102-2
|
4.3.3 Signature Identification Element
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.