hash stringlengths 32 32 | doc_id stringlengths 7 13 | section stringlengths 3 121 | content stringlengths 0 2.2M |
|---|---|---|---|
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.15.3 Retrieve <triggerRequest> | This procedure shall be used for retrieving the attributes of a <triggerRequest> resource. Table 10.2.15.3-1: <triggerRequest> RETRIEVE <triggerRequest> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.49 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.15.4 Update <triggerRequest> | This procedure shall be used for updating attributes of a <triggerRequest> resource. Table 10.2.15.4-1: <triggerRequest> UPDATE <triggerRequest> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.49. Processing at Originator before sending Request According to clause 10.1.4. The Originator determines that a trigger that is still being processed needs to be updated (i.e. replaced). The Originator initiates a device trigger replace by updating the <triggerRequest> resource. Processing at Receiver According to clause 10.1.4 with the following modifications: The CSE shall: • Check whether the trigger request can be updated or not by checking the triggerStatus. If the triggerStatus is PROCESSING, the CSE shall continue to process the UPDATE request. Otherwise, the CSE shall return an error response to the Originator and shall not update the triggerStatus attribute. • Determine which NSE to send the trigger update request to. The CSE may determine which NSE based on locally provisioned information or based on a DNS lookup of the M2M-Ext-ID. If an NSE cannot be determined, the IN-CSE sets the triggerStatus attribute to ERROR-NSE-NOT-FOUND. • Submit a trigger update request to the appropriate NSE using the appropriate Mcn protocol. The message shall contain information needed by the NSE to update the trigger request for the corresponding underlying network. For example, for a 3GPP trigger update request the required information needed within the trigger request message is captured in ETSI TS 118 126 [15]. • Upon receipt of trigger update response(s) from the NSE, the CSE shall determine whether to set the triggerStatus attribute of the <triggerRequest> resource. If the CSE receives a confirmation from the NSE that the trigger update was accepted, the CSE shall update the applicable <triggerRequest> attributes included in the request and set the triggerStatus attribute to TRIGGER-SUBMITTED. If the CSE receives an indication that the trigger update request was not accepted, the CSE shall return an error response to the Originator and shall not update the <triggerRequest> resource. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 431 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.15.5 Delete <triggerRequest> | This procedure shall be used for deleting a <triggerRequest> resource. Table 10.2.15.5-1: <triggerRequest> DELETE <triggerRequest> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.5. The Originator determines that a trigger, that is still being processed needs to be deleted (i.e. recalled). The Originator initiates a device trigger recall by deleting the <triggerRequest> resource. Processing at Receiver According to clause 10.1.5 with the following modifications: The CSE shall: • Check whether the trigger request can be recalled or not by checking the triggerStatus. If the triggerStatus is PROCESSING, the CSE shall continue to process the DELETE request. Otherwise, the CSE shall return an error response to the Originator and shall not update the triggerStatus attribute. • Determine which NSE to send the trigger recall request to. The CSE may determine which NSE based on locally provisioned information or based on a DNS lookup of the M2M-Ext-ID. If an NSE cannot be determined, the IN-CSE sets the triggerStatus attribute to ERROR-NSE-NOT-FOUND. • Submit a trigger recall request to the appropriate NSE using the appropriate Mcn protocol. The message shall contain information needed by the NSE to recall the trigger request for the corresponding underlying network. For example, for a 3GPP trigger recall request the required information needed within the trigger request message is captured in ETSI TS 118 126 [15]. • Upon receipt of trigger recall response(s) from the NSE, the CSE shall determine whether to set the triggerStatus attribute of the <triggerRequest> resource. If the CSE receives a confirmation from the NSE that the trigger recall was accepted, the CSE shall delete the applicable <triggerRequest> resource and return a successful response to the Originator. If the CSE receives an indication that the trigger recall request was not accepted, the CSE shall return an error response to the Originator and shall not update the <triggerRequest> resource. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. 10.2.16 Procedure for Managing Change in AE Registration Point |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.16.1 Procedure at IN-CSE | The IN-CSE may determine that an AE has changed registration point either by: • Observing the creation on an <AEAnnc> resource with an AE-ID-Stem that it had previously assigned for a different Registrar CSE (Case e) of clause 10.2.2.2). • Receiving a NOTIFY request from a Registrar CSE whose content includes the SP-relative-Resource-ID before and after the change in registration point (Case f) of clause 10.2.2.2). In both cases, the IN-CSE shall send a NOTIFY request to the CSEs, so that these may update the references to the <AE> resources for the AE that has changed its registration point. If the IN-CSE maintains an <AEContactList> resource, the IN-CSE shall determine which CSEs are affected, and shall send the NOTIFY request only to these. If the IN-CSE does not maintain an <AEContactList> resource, the IN-CSE shall send the NOTIFY request to all CSEs. The Content parameter of the NOTIFY request shall contain the SP-relative-Resource-ID at the prior registration point and at the new registration point. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 432 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.16.2 Procedure at any CSE | Upon receiving a NOTIFY request regarding a change in AE registration point: • if the receiving CSE hosts references to the SP-Relative-Resource-ID (e.g. in Announce links, Notification targets, group Member IDs, <accessControlPolicy> resource OriginatorID lists) tied to the prior AE registration point, the receiving CSE shall update these to refer to the new AE registration point; • if the receiving CSE hosts the registration of the prior AE registration point, the receiving CSE shall update the status of this registration to "INACTIVE". 10.2.17 Schedule Management |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.17.1 Introduction | This clause describes the procedures for creation, retrieval, update and deletion of the <schedule> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.17.2 Create <schedule> | This procedure shall be used for creating an <schedule> resource Table 10.2.17.2-1: <schedule> CREATE <schedule> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.9. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.17.3 Retrieve <schedule> | This procedure shall be used for retrieving the representation of the <schedule> resource. Table 10.2.17.3-1: <schedule> RETRIEVE <schedule> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <schedule> resource as defined in clause 9.6.9. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 433 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.17.4 Update <schedule> | This procedure shall be used for updating the attributes and the actual data of an <schedule> resource. Table 10.2.17.4-1: <schedule> UPDATE <schedule> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <schedule> resource as defined in clause 9.6.9 which need be updated. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.17.5 Delete <schedule> | This procedure shall be used for deleting the <schedule> resource with all related information. Table 10.2.17.5-1: <schedule> DELETE <schedule> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. 10.2.18 Transaction Management |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.18.1 Introduction | This clause describes procedures for managing oneM2M transactions via the <transactionMgmt> and <transaction> resources. When an Originator creates a <transactionMgmt> resource, the <transactionMgmt> Hosting CSE shall create corresponding child <transaction> resources for each oneM2M request primitive specified in the requestPrimitives attribute. Each <transaction> resource shall be created as a child of the resource targeted by its corresponding request primitive. The transactionState attribute shall be used by the <transactionMgmt> Hosting CSE to reflect the current state of the transaction. The transactionControl attribute shall be used by the <transactionMgmt> resource creator or Hosting CSE to manage the atomic execution of the transaction via controlling the state of the transaction. The transactionLockTime, transactionExecuteTime and transactionCommitTime attributes shall be used by the <transactionMgmt> Hosting CSE to coordinate the locking of the resources targeted by the individual oneM2M request primitives, executing the oneM2M request primitives and committing of the transaction. Using these attributes, the <transactionMgmt> Hosting CSE shall configure the corresponding transactionLockTime, transactionExecuteTime and transactionCommitTime attributes for each corresponding <transaction> resource. The transactionExpirationTime attribute shall be used by the <transactionMgmt> Hosting CSE to manage the expiration of the transaction. If the transaction is not successfully committed before this time, the Hosting CSE shall abort the transaction. Before creating <transaction> resources for each oneM2M request primitive specified in the requestPrimitives attribute, the <transactionMgmt> Hosting CSE shall first perform a consistency check to validate that the From request parameter of each oneM2M request primitive is the same as the Originator that created the <transactionMgmt> resource. This check ensures that the transaction functionality cannot be used by an AE to impersonate other AEs. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 434 (oneM2M TS-0001 version 4.15.0 Release 4) The transactionMode attribute shall be used by the <transactionMgmt> Hosting CSE to detect whether it is responsible for managing the state of the transactionControl attribute and in turn the atomic execution of the transaction on behalf of the creator or whether the creator is to manage the state of the transactionControl attribute itself. When transactionMode is set to "CREATOR_CONTROLLED" then the creator shall be responsible for controlling the state of transactionContol. When transactionMode is set to "CSE_CONTROLLED" then the <transactionMgmt> Hosting CSE shall be responsible for controlling the state of transactionControl. When the transactionControl attribute of the <transactionMgmt> resource is updated, the <transactionMgmt> Hosting CSE shall make corresponding updates to the transactionControl attributes of all the <transaction> resources affiliated with the transaction. These updates shall trigger the <transaction> Hosting CSE(s) to take corresponding action to lock the targeted resource, execute the specified primitive on the locked resource, commit the executed results or abort the transaction. As a result, the atomic execution of the transaction can be explicitly controlled. The decision to update the transactionControl attribute of the <transactionMgmt> resource shall be based on the collective transactionState of the individual <transaction> resources. When consistent state is detected (E.g. all <transaction> resources indicate their transactionState is "LOCKED"), then transaction state may be updated (e.g. update <transactionMgmt> transactionControl to "EXECUTE"). When inconsistent state is detected (e.g. one <transaction> resource indicates a transactionState of "ERROR"), then the transaction may be retried or aborted (e.g. update the <transactionMgmt> transactionControl to "ABORT"). To facilitate the gathering of this collective transactionState, each <transaction> Hosting CSE shall share transactionState information with the <transactionMgmt> Hosting CSE. This transactionState shall be shared in the <transaction> create and update responses that a <transaction> Hosting CSE returns to the <transactionMgmt> Hosting CSE. The <transactionMgmt> Hosting CSE shall in turn update the transactionState attribute of the <transactionMgmt> resource to reflect the collective state of the <transaction> resources. The creator of <transactionMgmt> resource may subscribe to the transactionState attribute of the <transactionMgmt> resource to receive notifications for any state changes. Table 10.2.18.1-1 defines the valid transactionControl values permitted in an update request to a <transactionMgmt> resource based on the current value of the <transactionMgmt> resource's transactionState. A <transactionMgmt> Hosting CSE shall only allow an update to transactionControl for the combinations listed. Table 10.2.18.1-1: Valid <transactionMgmt> transactionControl update values Current transactionState Valid transactionControl update values INITIAL LOCK LOCKED EXECUTE, ABORT EXECUTED COMMIT, ABORT ERROR ABORT, INITIAL COMMITTED INITIAL ABORTED INITIAL Figure 10.2.18.1-1 defines the legal state transitions of the transactionState attribute of the <transactionMgmt> resource as well as the criteria for each state transition. The value of the transactionMode attribute shall determine whether the <transactionMgmt> Hosting CSE or the creator of the <transactionMgmt> resource shall be responsible for adhering to these valid state transitions. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 435 (oneM2M TS-0001 version 4.15.0 Release 4) LOCKED COMMITTED INITIAL ERROR EXECUTED transactionState of all <transaction> resources is LOCKED transactionState of all <transaction> resources is EXECUTED transactionState of all <transaction> resources is COMMITTED transactionState of one or more <transaction> resources is ERROR <transactionMgmt> CREATE request Retry if no response and retry limit not reached Retry if no response and retry limit not reached Retry if no response and retry limit not reached transactionState of one or more <transaction> resources is ERROR transactionState of one or more <transaction> resources is ERROR ABORTED transactionState of one or more <transaction> resources is ABORTED or max retry limit reached transactionControl of <transactionMgmt> resource updated to INITIAL transactionControl of <transactionMgmt> resource updated to INITIAL Retry if retry limit not reached Figure 10.2.18.1-1: <transactionMgmt> transactionState State Diagram If the transactionMaxRetries attribute is configured to a non-zero value, the <transactionMgmt> Hosting CSE may retry a transaction if it detects a timeout condition or one or more <transaction> resources that have a transactionState of "ERROR". To retry a transaction, the <transactionMgmt> Hosting CSE may retry sending request(s) that timed out or that resulted in an error. Care should be taken by the <transactionMgmt> Hosting CSE when retrying requests. The <transactionMgmt> Hosting CSE should evaluate whether a retry makes sense. For example, if a transaction resulted in an error due to the corresponding request primitive not having the proper permissions to access a targeted resource, then the transaction should not be retried since it will have the same results and only waste network bandwidth. An exhaustive list of scenarios for which the Hosting CSE should and should not retry a transaction is not specified in the present document. If not set or if the max number of retries is exhausted, and the <transactionMgmt> Hosting CSE detects an "ERROR" transactionState from one or more <transaction> Hosting CSEs, then the transactionState of the <transactionMgmt> resource shall be updated to "ABORTED". The <transactionMgmt> Hosting CSE supports transaction expiration functionality to detect when the processing of transactions by one or more <transaction> Hosting CSEs exceeds the transactionExpirationTime. If this occurs, the <transactionMgmt> Hosting CSE shall abort the transaction by updating the transactionState attribute of each <transaction> resource to "ABORT". When a CSE receives a request to create a new <transaction> resource, the CSE shall first check if the targeted resource is already locked. To perform this check, the CSE shall check whether any other <transaction> resources exist for the targeted resource. If yes, the CSE shall check the transactionState and transactionLockType of these other <transaction> resource(s). If no other <transaction> resources exist or the transactionState of the existing <transaction> resources is "COMMITTED" or "ABORTED", the CSE shall consider the targeted resource unlocked, otherwise it shall consider it locked. If the targeted resource is locked, the CSE may return an error to the Originator of the <transaction> create request. Alternatively, the CSE may buffer requests that target the resource until the resource is unlocked. Note, the details of how a CSE manages this buffering are currently outside the scope of the present document. If a CSE does support buffering for locked resources, then the CSE should also support a timeout mechanism to detect the case where a lock is not released in a timely manner and returning an error to the Originator. Once the <transaction> Hosting CSE obtains a lock for the targeted resource or determines that a lock cannot be obtained, it responds to the Originator of the <transaction> create request. In this response, the transactionState is included. If the lock is obtained, then the transactionState shall have a value of "LOCKED". If the lock cannot be obtained, then the transactionState shall have a value of "ERROR". ETSI ETSI TS 118 101 V4.15.0 (2022-09) 436 (oneM2M TS-0001 version 4.15.0 Release 4) When a <transaction> Hosting CSE receives a request to update the transactionControl attribute of an existing <transaction> resource, the CSE shall first compare the current value of the transactionState and transactionControl attributes to ensure they are consistent (e.g. if transactionControl has a value of "LOCK" then transactionState should have a value of "LOCKED"). This check ensures that the <transaction> Hosting CSE is not already in the process of changing the state of the transaction. In addition, the <transaction> Hosting CSE shall also compare the value of transactionControl specified in the <transaction> update request with the current value of transactionControl in the <transaction> resource to ensure the value specified in the update request is a legal next state (e.g. if transactionState has a value of "LOCKED" then valid transactionControl values are "EXECUTE or "ABORT"). If any of these checks fail, the <transaction> Hosting CSE shall return an error. If these checks pass, the <transaction> Hosting CSE shall perform the update to transactionControl and in turn perform the corresponding actions associated with transitioning the transaction into this new state. Table 10.2.18.1-2: Valid <transaction> transactionContol values Current transactionState Valid transactionControl update values LOCKED EXECUTE, ABORT EXECUTED COMMIT, ABORT ERROR ABORT, LOCK COMMITTED LOCK ABORTED LOCK Figure 10.2.18.1-2 defines the legal state transitions of the transactionState attribute of the <transaction> resource as well as the criteria for each state transition. The creator of the <transaction> resource is responsible for adhering to these valid state transitions. EXECUTED COMMITTED LOCKED ERROR Receive <transaction> UPDATE to set transactionControl to EXECUTE and requestPrimitive successfully executed on targeted resource Receive <transaction> CREATE request Timeout Timeout Receive <transaction> UPDATE to set transactionControl to COMMIT and results of requestPrimitive execution successfully committed to targeted resource Receive <transaction> UPDATE to set transactionControl to ABORT or error occurred when trying to lock or execute resource targeted by requestPrimitive Receive <transaction> UPDATE to set transactionControl to ABORT Receive <transaction> UPDATE to set transactionControl to LOCK Receive <transaction> UPDATE to set transactionControl to LOCK ABORTED Receive <transaction> UPDATE to set transactionControl to LOCK Figure 10.2.18.1-2: <transaction> transactionState State Diagram If transactionControl is updated to "EXECUTE", then the <transaction> Hosting CSE shall perform the request specified in the requestPrimitive attribute and update the responsePrimitive attribute with the results. If the execution of the primitive is successful the <transaction> Hosting CSE shall update the transactionState attribute to "EXECUTED". Otherwise, if the execution of the primitive is not successful the <transaction> Hosting CSE shall update the transactionState attribute to "ERROR". If transactionControl is updated to "COMMIT", then the <transaction> Hosting CSE shall make the results of the requestPrimitive persistent and visible by updating the transactionState attribute to "COMMITTED" which effectively releases the lock on the targeted resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 437 (oneM2M TS-0001 version 4.15.0 Release 4) If transactionControl is updated to "ABORT", the <transaction> Hosting CSE shall roll back the transaction by returning the state of the targeted resource to the same state the resource was in before the processing of this transaction began. It shall also update the transactionState attribute to "ABORTED" which effectively releases the lock on the targeted resource. Once the <transaction> Hosting CSE completes processing any actions associated with updating the transactionControl attribute and changing the state of transaction, it shall return a response back to the Originator of the <transaction> update request. In this response, the attributes of the <transaction> resource shall be included to allow the Originator to check the transactionState and aggregate the responsePrimitive. If a <transaction> delete request is received, the <transaction> Hosting CSE shall check the transactionState. If the <transaction> resource has a transactionState of "INITIAL", "LOCKED", "EXECUTED" or "ERROR", the <transaction> Hosting CSE shall roll back the transaction by returning the state of the targeted resource to the same state the resource was in before the processing of this transaction began. It shall also set the transactionState attribute to "ABORTED" in the <transaction> delete response. If a <transaction> resource is deleted by a delete request that targets the parent or ancestor of the <transaction> resource, the <transaction> Hosting CSE shall check the transactionState. If the <transaction> resource has a transactionState of "INITIAL", "LOCKED", "EXECUTED" or "ERROR", the <transaction> Hosting CSE shall roll back the transaction by returning the state of the targeted resource to the same state the resource was in before the processing of the transaction began. AE CSE CSE CSE ... Create <transactionMgmt> [requestPrimitives] Create <transaction> [transactionControl = LOCK, requestPrimitive] transactioState = LOCKED Create <transaction> [transactionControl = LOCK, requestPrimitive] transactioState = LOCKED OK Update <transaction> [transactionControl = EXECUTE] transactioState = EXECUTED Update <transaction> [transactionControl = EXECUTE] transactioState = EXECUTED Update <transaction> [transactionControl = COMMIT] transactioState = COMMITTED Update <transaction> [transactionControl = COMMITED] transactioState = COMMITTED, responsePrimitive Notify [transactionState = COMMITTED, reponsePrimitives] OK Figure 10.2.18.1-3: Transaction Management using <transactionMgmt> - Successful Case ETSI ETSI TS 118 101 V4.15.0 (2022-09) 438 (oneM2M TS-0001 version 4.15.0 Release 4) AE CSE CSE CSE ... Create <transactionMgmt> [requestPrimitives] Create <transaction> [transactionControl = LOCK, requestPrimitive] transactioState = LOCKED Create <transaction> [transactionControl = LOCK, requestPrimitive] transactioState = LOCKED OK Update <transaction> [transactionControl = EXECUTE] transactioState = EXECUTED Update <transaction> [transactionControl = EXECUTE] transactioState = ERROR Update <transaction> [transactionControl = ABORT] transactioState = ABORTED Update <transaction> [transactionControl = ABORT] transactioState = ABORTED. responsePrimitive Notify [transactionState = ABORTED, reponsePrimitives] OK Figure 10.2.18.1-4: Transaction Management using <transactionMgmt> - Failure Case The <transaction> resource may be used independent of the <transactionMgmt> resource. In this case, an AE shall be responsible for creating multiple <transaction> resources on the corresponding Hosting CSE(s) and controlling the state of each of these transactions. To coordinate the lock, execute and commit times of the individual <transaction> resources, an AE may configure the transactionLockTime, transactionExecuteTime and transactionCommitTime attributes to configure the <transaction> Hosting CSE to manage the transactionControl attribute itself. Alternatively, an AE may perform UPDATEs to the transactionControl attribute itself to manage the state of the transaction. Either method may be used by an AE to coordinate the locking, execution and committal of the distributed transaction. Figure 10.2.18.1-5 shows the procedure of an AE managing a transaction. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 439 (oneM2M TS-0001 version 4.15.0 Release 4) AE CSE CSE CSE ... Create <transaction> OK Create <transaction> Create <transaction> Check if the transaction can be successfully executed OK OK Execute the request primitive at the specified time Figure 10.2.18.1-5: Transaction Management by an AE - Successful Case AE CSE CSE CSE ... Create <transaction> OK Create <transaction> Create <transaction> Check if the transaction can be successfully executed OK Failure Delete <transaction> Delete <transaction> Figure 10.2.18.1-6: Transaction Management by an AE - Failure Case |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.18.2 Create <transactionMgmt> | This procedure shall be used for creating a <transactionMgmt> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 440 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.18.2-1: <transactionMgmt> CREATE <transactionMgmt> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.46. Processing at Originator before sending Request The Originator shall request to Create a <transactionMgmt> resource by using the CREATE operation. The request shall address a <CSEBase>, <remoteCSE> or <AE> resource of a Hosting CSE. The Originator shall be an AE. The Originator shall configure the requestPrimitives attribute with a list of requests. The Originator may also configure other optional attributes defined in clause 9.6.47. Processing at Receiver For the CREATE procedure, the Receiver shall: • Check if the Originator has CREATE permissions on the target resource. • Check the validity of the provided attributes. • Upon successful validation of the provided attributes, create a new <transactionMgmt> resource. • Process the request as described in clause 10.2.18.1. • Respond to the Originator with the appropriate generic Response with the representation of the <transactionMgmt> resource, and the address of the created <transactionMgmt> resource if the CREATE was successful. Information in Response message The representation of the <transactionMgmt> resource. Processing at Originator after receiving Response If the transactionMode attribute is set to CREATOR_CONTROLLED, then the Originator shall perform subsequent update(s) to the transactionControl attribute to manage the transaction. Exceptions No change from the basic procedure in clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.18.3 Retrieve <transactionMgmt> | This procedure shall be used for retrieving <transactionMgmt> resource. Table 10.2.18.3-1: <transactionMgmt> RETRIEVE <transactionMgmt> RETRIEVE Information in Request message From: Identifier of the AE that initiates the Request. To: The address of the <transactionMgmt> resource. Processing at Originator before sending Request The Originator shall request to obtain <transactionMgmt> resource information by using the RETRIEVE operation. The request shall address the specific <transactionMgmt> resource of a Hosting CSE. The Originator shall be an AE. Processing at Receiver No change from the basic procedure in clause 10.1.3. Information in Response message No change from the basic procedure in clause 10.1.3. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 441 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.18.4 Update <transactionMgmt> | This procedure shall be used for updating an existing <transactionMgmt> resource. Table 10.2.18.4-1: <transactionMgmt> UPDATE <transactionMgmt> UPDATE Information in Request message From: Identifier of the AE that initiates the Request. To: The address of the <transactionMgmt> resource. Processing at Originator before sending Request The Originator shall request to update attributes of an existing <transactionMgmt> resource by using an UPDATE operation. The Request shall address the specific <transactionMgmt> resource of a CSE. The Originator shall be an AE. Processing at Receiver The UPDATE procedure shall be: • Check if the Originator has UPDATE permissions on the <transactionMgmt> resource. • Check the validity of provided attributes. • Upon successful validation of the provided attributes, update the <transactionMgmt> resource on the Hosting CSE. • Process the request as described in clause 10.2.18.1. • Respond to the Originator with the appropriate generic response with the representation of the <transactionMgmt> resource if the UPDATE is successful. Information in Response message The representation of the <transactionMgmt> resource. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.18.5 Delete <transactionMgmt> | This procedure shall be used for deleting an existing <transactionMgmt> resource. Table 10.2.18.5-1: <transactionMgmt> DELETE <transactionMgmt> DELETE Information in Request message From: Identifier of the AE that initiates the Request. To: The address of the <transactionMgmt> resource. Processing at Originator before sending Request The Originator shall request to delete an existing <transactionMgmt> resource by using the DELETE operation. The request shall address the specific <transactionMgmt> resource of a Hosting CSE. The Originator shall be an AE. Processing at Receiver Besides the basic procedure in clause 10.1.5, the receiver shall process the request as described in clause 10.2.18.1. Information in Response message No change from the basic procedure in clause 10.1.5. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.18.6 Create <transaction> | This procedure shall be used for creating a <transaction> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 442 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.18.6-1: <transaction> CREATE <transaction> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.48. Processing at Originator before sending Request The Originator shall request to Create a <transaction> resource by using the CREATE operation. The Originator shall be a CSE hosting a <transactionMgmt> resource or an AE. Processing at Receiver For the CREATE procedure, the Receiver shall: • Check if the Originator has CREATE permissions on the target resource. • Check the validity of the provided attributes. • Upon successful validation of the provided attributes, create a new <transaction> resource. • Process the request as described in clause 10.2.18.1. • Respond to the Originator with the appropriate generic Response with the representation of the <transaction> resource, and the address of the created <transaction> resource if the CREATE was successful. Information in Response message The representation of the <transaction> resource. Processing at Originator after receiving Response • See clause 10.2.18.1. Exceptions No change from the basic procedure in clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.18.7 Retrieve <transaction> | This procedure shall be used for retrieving <transaction> resource. Table 10.2.18.7-1: <transaction> RETRIEVE <transaction> RETRIEVE Information in Request message From: Identifier of the CSE that initiates the Request. To: The address of the <transaction> resource. Processing at Originator before sending Request The Originator shall request to obtain <transaction> resource information by using the RETRIEVE operation. The request shall address the specific <transaction> resource of a Hosting CSE. The Originator shall be a CSE hosting a <transactionMgmt> resource or an AE. Processing at Receiver No change from the basic procedure in clause 10.1.3. Information in Response message No change from the basic procedure in clause 10.1.3. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 443 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.18.8 Update <transaction> | This procedure shall be used for updating an existing <transaction> resource. Table 10.2.18.8-1: <transaction> UPDATE <transaction> UPDATE Information in Request message From: Identifier of the CSE that initiates the Request. To: The address of the <transaction> resource. Processing at Originator before sending Request The Originator shall request to update attributes of an existing <transaction> resource by using an UPDATE operation. The Request shall address the specific <transaction> resource of a CSE. The Originator shall be a CSE hosting a <transactionMgmt> resource or an AE. Processing at Receiver The UPDATE procedure shall be: • Check if the Originator has UPDATE permissions on the <transaction> resource. • Check the validity of provided attributes. • Upon successful validation of the provided attributes, update the <transaction> resource on the Hosting CSE. • Process the request as described in clause 10.2.18.1. • Respond to the Originator with the appropriate generic response with the representation of the <transaction> resource if the UPDATE is successful. Information in Response message The representation of the <transaction> resource. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.4. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.18.9 Delete <transaction> | This procedure shall be used for deleting an existing <transaction> resource. Table 10.2.18.9-1: <transaction> DELETE <transaction> DELETE Information in Request message From: Identifier of the CSE that initiates the Request. To: The address of the <transaction> resource. Processing at Originator before sending Request The Originator shall request to delete an existing <transaction> resource by using the DELETE operation. The request shall address the specific <transaction> resource of a Hosting CSE. The Originator shall be a CSE hosting a <transactionMgmt> resource or an AE. Processing at Receiver Besides the basic procedure in clause 10.1.5, the receiver shall process the request as described in clause 10.2.18.1. Information in Response message No change from the basic procedure in clause 10.1.5. Processing at Originator after receiving Response None. Exceptions No change from the basic procedure in clause 10.1.5. 10.2.19 Multimedia session management |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.19.1 Create <multimediaSession> | This procedure shall be used for creating an <multimediaSession> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 444 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.19.1-1: <multimediaSession> CREATE <multimediaSession> CREATE Information in Request message All parameters defined in table 8.1.2-2 apply with the specific details for: To: Address of <AE>. Only an originating AE shall create an multimediaSession resource over Mca. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2 with the following complement: The hosting CSE shall check if the <AE> resource has a sessionCapabilities attribute that is set, and if not the request shall be rejected. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response The Originator shall create the <subscription> resource as the child of created <multimediaSession> resource to get notified of session acceptance, status. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.19.2 Retrieve <multimediaSession> | This procedure shall be used for retrieving the attributes of an <multimediaSession> resource. Table 10.2.19.2-1: <multimediaSession> RETRIEVE <multimediaSession> RETRIEVE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.19.3 Update <multimediaSession> | This procedure shall be used for updating attributes of an <multimediaSession> resource. Table 10.2.19.3-1: <multimediaSession> UPDATE < multimediaSession > UPDATE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver The Hosting CSE shall first check if the UPDATE is modifying the sessionState, offeredSessionDescriptions or acceptedSessionDescription attributes. If the request is not, then it will be processed according to clause 10.1.4. Otherwise, the Hosting CSE shall perform special handling of the UPDATE according to the following procedure. The Hosting CSE shall check if the sessionState attribute has a value of ONLINE. If ONLINE, and the UPDATE is not modifying sessionState to OFFLINE but the UPDATE is modifying offered SessionDescriptions or acceptedSessionDescription then the Hosting CSE shall reject the request and return and error to the originator. Otherwise the Hosting CSE shall perform the UPDATE. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 445 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.19.4 Delete <multimediaSession> | This procedure shall be used for deleting an <multimediaSession> resource. Table 10.2.19.4-1: <multimediaSession> DELETE <multimediaSession> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 10.2.20 Background Data Transfer Management |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.20.1 Introduction | This clause describes the procedures for creation, retrieval, update and deletion of the <backgroundDataTransfer> resource. The corresponding procedures over the Mcn reference point are described in ETSI TS 118 126 [15]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.20.2 Create <backgroundDataTransfer> | This procedure shall be used for creating an <backgroundDataTransfer> resource Table 10.2.20.2-1: <backgroundDataTransfer> CREATE <backgroundDataTransfer> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.9. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.20.3 Retrieve <backgroundDataTransfer> | This procedure shall be used for retrieving the representation of the <backgroundDataTransfer> resource. Table 10.2.20.3-1: <backgroundDataTransfer> RETRIEVE <backgroundDataTransfer> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <backgroundDataTransfer> resource as defined in clause 9.6.9 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 446 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.20.4 Update <backgroundDataTransfer> | This procedure shall be used for updating the attributes and the actual data of an <backgroundDataTransfer> resource. Table 10.2.20.4-1: <backgroundDataTransfer> UPDATE <backgroundDataTransfer> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <backgroundDataTransfer> resource as defined in clause 9.6.9 which need be updated Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.20.5 Delete <backgroundDataTransfer> | This procedure shall be used for deleting the <backgroundDataTransfer> resource with all related information. Table 10.2.20.5-1: <backgroundDataTransfer> DELETE <backgroundDataTransfer> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 10.2.21 Action Triggering |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.1 Introduction | This clause describes the procedure for managing oneM2M action triggering via the <action> and <dependency> resources. A oneM2M <action> resource is created whenever an Originator desires a primitive to be sent in response to the detection of a oneM2M event. An event has a subject resource associated with it - a change on this subject resource causes the Hosting CSE to trigger the procedure as outlined in clause 10.2.21.2. This is referred to as "action triggering". The subject resource is identified by the subjectResourceID attribute of the <action> resource and the evalCriteria attribute of the <action> resource defines the primary event expression and determines if an action is triggered, subject to any dependencies also being satisfied. When an <action> resource is created, the Hosting CSE checks the evalMode attribute to see if an event is enabled for monitoring. The evalMode attribute has one of four valid values: off, once, periodic, or continuous. If evalMode is off, then no event is monitored by the Hosting CSE. For all other values, the Hosting CSE shall monitor events. When evalMode has a value of "once", the Hosting CSE shall immediately enable monitoring the primary event and shall only allow the primary event to trigger once. After the primary event triggers, the Hosting CSE shall disable further monitoring. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 447 (oneM2M TS-0001 version 4.15.0 Release 4) When evalMode has a value of either "periodic" or "continuous", the Hosting CSE shall also evaluate the evalControlParam attribute to determine how to monitor the primary event. For "periodic" evalMode, the evalControlParam attribute determines the periodicity of monitoring the primary event. The Hosting CSE shall start monitoring the primary event at the indicated periodicity and only allow the primary event to trigger once within the indicated period. For "continuous" evalMode, the evalControlParam attribute determines the number of times the Hosting CSE shall trigger an event. When in this mode, the Hosting CSE shall resume monitoring for the occurrence of the next primary event upon the triggering of a prior primary event; hence, there is no lapse in monitoring. To handle more complex events, one or more <dependency> resources may be created as child resources of the <action> resource. Within a <dependency> resource, the referencedResourceID attribute identifies the resource for which the evalCriteria of the <dependency> resource are applicable to. The evalCriteria attribute of the <dependency> resource determines whether the dependency condition is met. The sufficient attribute determines whether the dependency condition alone is sufficient for triggering the action or not. Finally, the dependencies attribute of the <action> resource defines the prioritized order in which the Hosting CSE shall evaluate the child <dependency> resources. Once a Hosting CSE has determined that the conditions of the primary event and any dependencies have been satisfied, it then triggers performing the action using the actionPrimitive, objectResourceID, and input attributes to create the associated action. The actionPrimitive attribute defines the primitive that the Hosting CSE sends. The objectResourceID attribute is used to derive the To and Resource Type parameters which are overwritten in the primitive to be sent. If present, the input attribute is used to derive the Content parameter which is overwritten in the primitive to be sent. If the input attribute is not present, the primitive that is sent maintains the parameters provided in the actionPrimitive. The Hosting CSE shall store the received response primitive, associated with the actionPrimitive, in the actionResult attribute of the <action> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.2 Action Triggering Procedure | This clause describes the procedure a Hosting CSE performs to manage the monitoring of events and, when they occur, the triggering of actions, as detailed by the following the steps: Step 1: Create <action> resource either as the child resource of a subject resource or elsewhere in the resource tree. The subject resource can be any of the resources defined in oneM2M and is indicated by the subjectResourceID attribute. One or more <dependency> resources may be created as child resources of the <action> resource. Changes to the subject resource trigger the evaluation of the evalCriteria. Step 2: The content of subject resource is updated. Step 3: The Hosting CSE gets the updated result and evaluates the updated subject resource, and if it matches the criteria defined in the evalCriteria attribute of the <action> resource, the primary event is considered triggered. If the subject resource does not match the criteria defined in the evalCriteria attribute of the <action> resource, the Hosting CSE returns to step 2, waiting for further subject resource updates. Step 4: After a primary event is triggered in step 3, if there is at least one <dependency> child resource of the <action> resource defined in the dependencies attribute, then the Hosting CSE performs the following for each <dependency> child resource(s) in the order provided in the dependencies attribute. The Hosting CSE shall maintain a local "dependencies satisfied" flag and initialize it to a value of FALSE. For each of the <dependency> child resources in the parent's dependencies attribute, the Hosting CSE retrieves the resource specified by the referencedResourceID attribute and evaluates it against the criteria defined in the evalCriteria attribute to check if the dependency is met. If the dependency is met (i.e. the resource identified by referencedResourceID meets the criteria specified by evalCriteria) and: • the sufficient attribute has a value TRUE, then the Hosting CSE shall set the "dependencies satisfied" flag to TRUE and proceed to step 5; or • the sufficient attribute has a value FALSE and there are additional entries in the dependencies attribute, then the Hosting CSE shall set the "dependencies satisfied" flag to TRUE and repeat step 4 for the next <dependency> child resource; or ETSI ETSI TS 118 101 V4.15.0 (2022-09) 448 (oneM2M TS-0001 version 4.15.0 Release 4) • the sufficient attribute has a value FALSE and there are no additional entries in the dependencies attribute, then the Hosting CSE shall set the "dependencies satisfied" flag to TRUE and proceed to step 5. If the dependency is not met (i.e. the resource identified by referencedResourceID does not meet the criteria specified by evalCriteria) and: • the sufficient attribute has a value TRUE and there are additional entries in the dependencies attribute, then the hosting CSE repeats step 4 for the next <dependency> child resource; or • the sufficient attribute has a value TRUE and there are no additional entries in the dependencies attribute, then the hosting CSE proceeds to step 5; or • the sufficient attribute has a value FALSE, then the Hosting CSE shall set the "dependencies satisfied" flag to FALSE and proceed to step 5. Step 5: If the "dependencies satisfied" flag is set to TRUE, then proceed to step 6. If the "dependencies satisfied" flag is set to FALSE, the Hosting CSE shall proceed to step 2 and monitor for the occurrence of the next primary event if the evalMode has a value of "periodic" or "continuous", or stop monitoring for the occurrence of the primary event if the evalMode has a value of "once". Step 6: The Hosting CSE shall compose the request primitive for the object resource for triggering the action by populating it with the content of the actionPrimitive attribute. If the objectResource attribute is present, the Hosting CSE shall determine its type (e.g. by performing a retrieve operation). The Hosting CSE shall overwrite the To and Resource Type parameters of the primitive to be sent with the values determined from objectResourceID. If the input attribute is present and is a string, the Hosting CSE shall overwrite the Content parameter of the primitive to be sent with the string. If the input attribute is present and is a resource identifier, the Hosting CSE shall retrieve the resource and overwrite the Content parameter of the primitive to be sent with the retrieved resource representation. If the input attribute is present and is a URI of a resource attribute, the Hosting CSE shall retrieve the resource attribute and overwrites the Content parameter of the primitive to be sent with the value of the given resource attribute. If the input attribute is not present, the Content parameter of the primitive to be sent remains populated as indicated by the actionPrimitive attribute. Step 7: The Hosting CSE shall send the composed primitive request to the object resource. Step 8: After receiving the response of the request from step 7, the Hosting CSE shall store the response primitive in the actionResult attribute. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.3 <action> Resource Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.3.1 Create <action> | The hosting CSE shall use this procedure to create an <action> resource according to the resource identifier of the parent resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 449 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.21.3.1-1: <action> CREATE <action> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.61 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 After successfully creating the <action> resource, the Receiver shall perform the procedure specified in clause 10.2.21.2 Information in Response message According to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.3.2 Retrieve <action> | This procedure shall be used for retrieving the attributes of an <action> resource. Table 10.2.21.3.2-1: <action> RETRIEVE <action> RETRIEVE Information in Request message All parameters defined in table 8.1.2-2 apply Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.3.3 Update <action> | This procedure shall be used for updating attributes of an <action> resource. Table 10.2.21.3.3-1: <action> UPDATE <action> UPDATE Information in Request message All parameters defined in table 8.1.2-2 apply Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 After successfully updating the <action> resource, the Receiver shall perform the procedure specified in clause 10.2.21.2 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 450 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.3.4 Delete <action> | This procedure shall be used for deleting an <action> resource. Table 10.2.21.3.4-1: <action> DELETE <action> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 After successfully deleting the <action> resource, the Receiver shall stop the event monitoring procedure specified in clause 10.2.21.2 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.4 <dependency> Resource Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.4.1 Create <dependency> | The hosting CSE shall use this procedure to create an <dependency> resource according to the resource identifier of the parent resource. Table 10.2.21.4.1-1: <dependency> CREATE <dependency> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.62 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2 After successfully creating the <dependency> resource, the Receiver shall perform the procedure specified in clause 10.2.21.2 Information in Response message According to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.4.2 Retrieve <dependency> | This procedure shall be used for retrieving the attributes of an <dependency> resource. Table 10.2.21.4.2-1: <dependency> RETRIEVE <dependency> RETRIEVE Information in Request message All parameters defined in table 8.1.2-2 apply Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 451 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.4.3 Update <dependency> | This procedure shall be used for updating attributes of an <dependency> resource. Table 10.2.21.4.3-1: <dependency> UPDATE <dependency> UPDATE Information in Request message All parameters defined in table 8.1.2-2 apply Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 After successfully updating the <dependency> resource, the Receiver shall perform the procedure specified in clause 10.2.21.2 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.21.4.4 Delete <dependency> | This procedure shall be used for deleting an <dependency> resource. Table 10.2.21.4.4-1: <dependency> DELETE <dependency> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5 After successfully deleting the <dependency> resource, the Receiver shall perform the procedure specified in clause 10.2.21.2 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 10.2.22 End-to-End QoS |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.22.1 Introduction | This clause describes the procedures for creation, retrieval, update and deletion of the <e2eQosSession> resource. The corresponding procedures over the Mcn reference point are described in ETSI TS 118 126 [15] when the underlying network is 3GPP. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 452 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.22.2 Create <e2eQosSession> | This procedure shall be used for creating an <e2eQosSession> resource Table 10.2.22.2-1: <e2eQosSession> CREATE <e2eQosSession> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.63 Processing at Originator before sending Request According to clause 10.1.2 Processing at Receiver According to clause 10.1.2. The Receiver shall interact with the underlying network to setup the end-to-end QoS sessions. In the case of interworking with 3GPP networks, the Receiver shall perform the operations defined in clause 7.9.3.1 in ETSI TS 118 126 [15] Information in Response message According to clause 10.1.2 Processing at Originator after receiving Response According to clause 10.1.2 Exceptions According to clause 10.1.2 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.22.3 Retrieve <e2eQosSession> | This procedure shall be used for retrieving the representation of the <e2eQosSession> resource. Table 10.2.22.3-1: <e2eQosSession> RETRIEVE <e2eQosSession> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <e2eQosSession> resource as defined in clause 9.6.63 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 453 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.22.4 Update <e2eQosSession> | This procedure shall be used for updating the attributes and the actual data of an <e2eQosSession> resource. Table 10.2.22.4-1: <e2eQosSession> UPDATE <e2eQosSession> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <e2eQosSession> resource as defined in clause 9.6.63 which need be updated Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4. The Receiver shall interact with the underlying network to setup the end-to-end QoS sessions. In the case of interworking with 3GPP networks, the Receiver shall perform the operations defined in clauses 7.9.3.1, 7.9.3.2 and 7.9.3.3 in ETSI TS 118 126 [15] Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.22.5 Delete <e2eQosSession> | This procedure shall be used for deleting the <e2eQosSession> resource with all related information. Table 10.2.22.5-1: <e2eQosSession> DELETE <e2eQosSession> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5. The Receiver shall interact with the underlying network to setup the end to end QoS sessions. In the case of interworking with 3GPP networks, the Receiver shall perform the operations defined in clause 7.9.3.3 in ETSI TS 118 126 [15] Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 10.2.23 Network Monitoring Request |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.23.1 Introduction | This clause describes the procedures for creation, retrieval, update and deletion of the <nwMonitoringReq> resource. The corresponding procedures over the Mcn reference point are described in ETSI TS 118 126 [15] when the underlying network is 3GPP. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 454 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.23.2 Create <nwMonitoringReq> | This procedure shall be used for creating an <nwMonitoringReq> resource. Table 10.2.23.2-1: <nwMonitoringReq> CREATE <nwMonitoringReq> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.64. Processing at Originator before sending Request According to clause 10.1.2 with the following modifications: The Originator shall set the monitorStatus attribute to DISABLED. Processing at Receiver According to clause 10.1.2. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2 with the following modifications: The Originator shall create the <subscription> resource as the child of <nwMonitoringReq> resource to get notified of network monitoring status. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.23.3 Retrieve <nwMonitoringReq> | This procedure shall be used for retrieving the representation of the <nwMonitoringReq> resource. Table 10.2.23.3-1: <nwMonitoringReq> RETRIEVE <nwMonitoringReq> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 Processing at Originator before sending Request According to clause 10.1.3 Processing at Receiver According to clause 10.1.3 Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <nwMonitoringReq> resource as defined in clause 9.6.64 Processing at Originator after receiving Response According to clause 10.1.3 Exceptions According to clause 10.1.3 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.23.4 Update <nwMonitoringReq> | This procedure shall be used for updating the attributes and the actual data of an <nwMonitoringReq> resource. Table 10.2.23.4-1: <nwMonitoringReq> UPDATE <nwMonitoringReq> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <nwMonitoringReq> resource as defined in clause 9.6.64 which need be updated. Processing at Originator before sending Request According to clause 10.1.4 with the following additions: • If the Originator sends a request for congestion status in an area, the Originator shall set the monitorEnable attribute to MonitorCongestion, and set the congestionLevel attribute and geographicArea attribute. • If the Originator sends a request for number of devices in an area, the Originator shall set the monitorEnable attribute to MonitorDeviceNumber, and set the geographicArea attribute. • The Originator may also configure other optional attributes defined in clause 9.6.64. • If the value of monitorStatus is set to ENABLED, the Originator shall not send a request. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 455 (oneM2M TS-0001 version 4.15.0 Release 4) <nwMonitoringReq> UPDATE Processing at Receiver According to clause 10.1.4 with the following additions: If the value of monitorEnable is MonitorCongestion, the Receiver shall check if congestionLevel attribute and geographicArea attribute are included in the request: • If the attributes are present, the Receiver shall set the value of monitorStatus to ENABLED, and the subsequent Update procedures of the Receiver shall be performed for the resource. Then, the Receiver shall interact with the NSE to request network status information. In the case of interworking with 3GPP networks, the Receiver shall perform the operations defined in clause 7.15.3 in ETSI TS 118 126 [15]. • If the attributes are not present, the Receiver shall respond with an error. If the value of monitorEnable is MonitorDeviceNumber, the Receiver shall check if geographicArea attribute is included in the request: • If the attributes are present, the Receiver shall set the value of monitorStatus to ENABLED, and the subsequent Update procedures of the Receiver shall be performed for the resource. Then, the Receiver shall interact with the NSE to request network status information. In the case of interworking with 3GPP networks, the Receiver shall perform the operations defined in clause 7.15.3 in ETSI TS 118 126 [15]. • If the attribute is not present, the Receiver shall respond with an error. • If the value of monitorStatus is ENABLED, the Receiver shall respond with an error. • If the Receiver receives a request for deletion of monitorEnable attribute, the Receiver shall set the value of monitorStatus to DISABLED. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4 with the following additions: If the value of failureReason is set to FORBIDDEN, the Originator may be configured with the values within the range defined by MNO policies. If the value of failureReason is set to PAYLOAD_TOO_LARGE, the Originator may retry the request without optional attribute(s). If the value of failureReason is set to TOO_MANY_REQUESTS, the Originator may reduce the frequency of requests or avoid immediate retries. Exceptions According to clause 10.1.4 with the following additions: If the Hosting CSE receives a successful response from the NSE, the Hosting CSE shall set the response of the NSE with the corresponding attributes of the <nwMonitoringReq> resource, and shall send a notification request of <nwMonitoringReq> resource to the Originator. If the Hosting CSE receives an error response from the NSE, the Hosting CSE shall set the value of monitorStatus to FAILED, and shall map the error response to the value of failureReason. Then, the Hosting CSE shall send a notification request of <nwMonitoringReq> resource to the Originator (see note). If the value of failureReason is set to BAD_REQUEST, UNAUTHORIZED, NOT_FOUND, LENGTH_REQUIRED or UNSUPPORTED_MEDIA_TYPE, the Hosting CSE may be configured with the parameters which the NSE is able to support. NOTE: How to map the error response to the value of failureReason depends on the support of the Underlying Network. In the case of interworking with 3GPP networks, the Receiver shall apply the operations defined in clause 7.15.3 in ETSI TS 118 126 [15]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.23.5 Delete <nwMonitoringReq> | This procedure shall be used for deleting the <nwMonitoringReq> resource with all related information. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 456 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.23.5-1: <nwMonitoringReq> DELETE <nwMonitoringReq> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5 with the following modifications: • Depending on the procedures of the Underlying Network, the CSE shall submit a network monitoring delete request to the appropriate NSE using the appropriate Mcn protocol. The message shall contain information needed by the NSE to delete the network monitoring request for the corresponding underlying network. For example, for a 3GPP network monitoring delete request the required information needed within the network monitoring request message is captured in ETSI TS 118 126 [15]. • If the CSE receives a confirmation from the NSE that the network monitoring delete was accepted, the CSE shall delete the applicable <nwMonitoringReq> resource and return a successful response to the Originator. If the CSE receives an indication that the network monitoring delete request was not accepted, the CSE shall return an error response to the Originator and shall not update the <nwMonitoringReq> resource. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. 10.2.24 Time Management |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.24.1 Introduction | This clause describes the different types of time management features supported by the oneM2M system. The oneM2M system supports three different time management features that can be used by entities to help manage and synchronize their current time values with one another. The first feature is the capability for a CSE to be configured via a <timeSyncBeacon> resource to send out time beacon notifications that include the current time value of the CSE to other entities in the M2M system. This information can be used by the receiving entities to adjust and synchronize their current time value to the CSE's. This is further described in clause 10.2.24.2. This feature is well-suited for entities that prefer, and that are capable of receiving and processing, time beacon notifications from a CSE rather than polling a CSE to retrieve its current time value. The second feature is the capability for a CSE to perform time compensation on behalf of other entities by adjusting oneM2M defined time related metadata sourced from or targeted towards these entities. This is further described in clause 10.2.24.3. This feature is well-suited for entities that do not have the capability or preference to perform time management themselves (e.g. keep their time value synchronized with the CSE). In this case, they can offload this operation to the CSE to make adjustments to oneM2M defined time related metadata in their requests and responses to compensate for any time offset that may exist between themselves and the CSE. The third feature is the capability for a CSE to make its current time available via the currentTime attribute of its <CSEBase> resource such that other entities can retrieve the CSE's current time if/when desired and use it to synchronize their current time to the CSE's. This is further described in clause 10.2.24.4. This feature is well-suited for entities that prefer to retrieve the CSE's current time if/when needed rather than receiving time beacon notifications from a CSE. For example, this feature may be well-suited for entities that interact with a CSE on an infrequent and/or non-periodic basis. Before interacting with the CSE, the entity can first retrieve the current time from the CSE and synchronize their current time to the CSE's current time. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 457 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.24.2 Time Synchronization Beaconing | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.24.2.0 Overview | When an Originator creates a <timeSyncBeacon> resource, the Hosting CSE shall generate time synchronization beacon notifications based on the information specified within the <timeSyncBeacon> resource. If the beaconCriteria attribute of the <timeSyncBeacon> resource has a value of "Periodic", which is the default value, then the Hosting CSE shall send periodic notifications to the specified beaconNotificationURIs with a periodic interval defined by the beaconInterval attribute. If the beaconInterval attribute is not configured, then the Hosting CSE shall use a default periodic interval value based on local policies. If the beaconCriteria attribute of the <timeSyncBeacon> resource has a value of "Loss of Synchronization", then the Hosting CSE shall monitor the current time of the entity specified by the beaconRequester attribute and compare it to its own current time. The current time of the entity shall be monitored by the Hosting CSE using Originating Timestamp parameters present in the request and response messages sent by the entity to the Hosting CSE. If these parameters are not present and the Hosting CSE is unable to monitor the current time of the entity, then the Hosting CSE shall not send beacon notifications. If the Hosting CSE computes an offset between its current time and the current time of the entity that exceeds the value specified by the beaconThreshold attribute, then the Hosting CSE shall send notifications to the specified beaconNotificationURIs. If the beaconThreshold attribute is not configured, then the Hosting CSE shall use a default threshold value based on local policies. The beacon notifications sent by the Hosting CSE shall contain the current time of the Hosting CSE. If the beacon notification is sent due to a "Loss of Synchronization", it shall also include the computed time offset. Upon receiving the beacon notification, the receiving entity may extract the current time of the Hosting CSE and offset (if present) and use this information to synchronize its current time to the current time of the Hosting CSE. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.24.2.1 Create <timeSyncBeacon> | This procedure shall be used for creating a <timeSyncBeacon> resource. Table 10.2.24.2.1-1: <timeSyncBeacon> CREATE <timeSyncBeacon> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.69. Processing at Originator before sending Request The Originator shall request to Create a <timeSyncBeacon> resource by using the CREATE operation. The request shall address a <CSEBase>, <remoteCSE> or <AE> resource of a Hosting CSE. The Originator shall be an AE or CSE. The Originator shall specify one or more beaconNotificationURIs. The Originator may also configure other optional attributes defined in clause 9.6.69. Processing at Receiver According to clause 10.1.2. In addition, the Receiver shall process the request as described in clause 10.2.24.2. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <timeSyncBeacon> resource, according to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 458 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.24.2.2 Retrieve <timeSyncBeacon> | This procedure shall be used for retrieving <timeSyncBeacon> resource. Table 10.2.24.2.2-1: <timeSyncBeacon> RETRIEVE <timeSyncBeacon> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message According to clause 10.1.3. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.24.2.3 Update <timeSyncBeacon> | This procedure shall be used for updating an existing <timeSyncBeacon> resource. Table 10.2.24.2.3-1: <timeSyncBeacon> UPDATE <timeSyncBeacon> UPDATE Information in Request message From: Identifier of the AE or the CSE that initiates the Request To: The address of the target <timeSyncBeacon> resource Content: The attributes which are to be updated Processing at Originator before sending Request According to clause 10.1.4 Processing at Receiver According to clause 10.1.4 Information in Response message According to clause 10.1.4 Processing at Originator after receiving Response According to clause 10.1.4 Exceptions According to clause 10.1.4 |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.24.2.4 Delete <timeSyncBeacon> | This procedure shall be used for deleting an existing <timeSyncBeacon> resource. Table 10.2.24.2.4-1: <timeSyncBeacon> DELETE <timeSyncBeacon> DELETE Information in Request message From: Identifier of the AE or the CSE that initiates the Request To: The address of the target <timeSyncBeacon> resource Processing at Originator before sending Request The Originator shall request to delete an existing <timesyncBeacon> resource by using the DELETE operation. The request shall address the specific <timeSyncBeacon> resource of a Hosting CSE Processing at Receiver According to clause 10.1.5 Information in Response message According to clause 10.1.5 Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 459 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.24.3 Time Offset Compensation | When the enableTimeCompensation attribute of an <AE> or <remoteCSE> resource is configured to a value of "TRUE" for a respective Registree AE or CSE, the Registrar CSE shall perform time offset compensation functionality on behalf of the Registree AE or CSE. To perform time offset compensation, a Registrar CSE shall monitor the current time of the Registree AE or CSE and compare this time to its own current time. The current time of the Registree shall be monitored by the Registrar CSE using an Originating Timestamp parameter present in the request and response messages issued by the Registree to the Registrar CSE. The Hosting CSE shall compute a time offset between its current time and the current time of the Registree. Based on this time offset, the Registrar CSE shall compensate for the offset by making adjustments to oneM2M timing related metadata contained within the oneM2M requests it receives from the Registree. In doing so, a Registree's messages can be time synchronized to the current time of the Registrar CSE without burdening the Registree with having to maintain time synchronization with the Registrar CSE. For requests received from a Registree, that target the Registrar CSE and that have an Originating Timestamp parameter present, the Registrar CSE shall perform time offset compensation if the Registree's enableTimeCompensation is set to TRUE. For responses to these requests that are returned by the Registrar CSE to a Registree, the Registrar CSE shall also perform time offset compensation. For requests received from a Registree, that target a remote CSE and that have an Originating Timestamp parameter present, the Registrar CSE may perform time offset compensation if enableTimeCompensation set to TRUE. If the Registrar CSE does perform time offset compensation on these requests, then it shall also perform time offset compensation on the responses that it returns to the Registree AE or CSE for these requests. For notifications generated by the Registrar CSE and that target a Registree having enableTimeCompensation set to TRUE, the Registrar CSE may perform time offset compensation if the Registrar CSE is aware of the time offset of the Registree (e.g. Registrar CSE has received a recent request from the Registree having an Originating Timestamp parameter). For notifications generated by a remote CSE, received by the Registrar CSE and that are re-targeted to a Registree having enableTimeCompensation set to TRUE, the Registrar CSE may perform time offset compensation if the Registrar CSE is aware of the time offset of the Registree (e.g. Registrar CSE has received a recent request from the Registree having an Originating Timestamp parameter). If a request or response message from a Registree to a Registrar CSE does not include the Originating Timestamp parameter, and the Registrar CSE is not aware of the time offset of the Registree, then the Registrar CSE shall not perform time offset compensation. When performing time offset compensation, a Registrar CSE shall adjust all oneM2M timing related metadata within request and response messages that is expressed in absolute format (e.g. 20141003T112032). For example, the Request Expiration Timestamp, Result Expiration Timestamp, expirationTime, etc. oneM2M timing related metadata expressed in a relative format (e.g. a time duration) is not adjusted. The procedure for time offset compensation follows the message flow description depicted in figure 10.2.24.3-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 460 (oneM2M TS-0001 version 4.15.0 Release 4) Registree AE/CSE Registrar CSE Step 1: Create <AE>or <remoteCSE> [enableTimeCompensation = TRUE] Step 2 : Create <AE> or <remoteCSE> resource and enable time compensation Step 3: <AE> or <remoteCSE> Create Response Step 4: Other Request [Originating Timestamp = 20160706T112045] . . . Step 5 : Compute time offset between Registrar and Registree Step 8: Response [compensated time values that align with Registree’s current time] Step 6 : Compensate/Correct times within request to synchronize with Registrar’s current time Step 7 : Compensate/Correct times within response to synchronize with Registree’s current time Figure 10.2.24.3-1: Procedure for time offset compensation Step 1: An AE or CSE registers to a Registrar CSE by issuing a CREATE request for an <AE> or <remoteCSE> resource. Within this request, the AE or CSE enables time offset compensation by setting the enableTimeCompensation attribute to a value of TRUE. Step 2: The Registrar CSE creates the <AE> or <remoteCSE> resource and enables time offset compensation functionality for the Registree. Step 3: The Registrar CSE generates a response. Step 4: The Registree sends a subsequent request to the Registrar CSE sometime later. In this request, the Registree includes an Originating Timestamp request parameter configured with its current time. Step 5: The Registrar CSE computes the time offset between its current time and the current time of the Registree specified in the Originating Timestamp request parameter. Step 6: The Registrar CSE performs time offset compensation to the incoming request by adjusting any time stamp related metadata that is expressed in absolute time format. The adjustment is performed using the computed time offset to adjust time stamp related metadata within the request to compensate for any time offset. Step 7: The Registrar CSE performs time offset compensation to the outgoing response by adjusting any time stamp related metadata that is expressed in absolute time format. The adjustment is performed using the computed time offset to align time stamp related metadata within the response to account for any time offset between the Registree and Registrar CSE. Step 8: The Registrar CSE returns a response. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 461 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.24.4 currentTime Retrieval | A Hosting CSE may support the capability for other entities to retrieve its current time by supporting the currentTime attribute within its <CSEBase> resource. If the currentTime attribute is supported, then other entities (e.g. a Registree AE) may retrieve it if they have the proper access control privileges to do so. Upon retrieving the currentTime attribute, an entity may compare the current time of the Hosting CSE against its own current time and compute a time offset, if any. Based on this time offset, the entity may adjust its current time to synchronize it with the current time of the Hosting CSE. The procedure for currentTime retrieval follows the message flow description depicted in figure 10.2.24.4-1. Registree AE/CSE Registrar CSE Step 1: Retrieve <CSEBase>/currentTime attribute Step 2 : Sample current time Step 3: <CSEBase>/currentTime Retrieve Response Step 4 : Compute time offset between Registrar and Registree Step 5 : Adjust Registree’s current time to synchronize with Registrar’s current time Figure 10.2.24.4-1: Procedure for retrieving current time Step 1: A Registree AE or CSE issues a request to retrieve the currentTime attribute of a Registrar's <CSEBase> resource. Step 2: The Registrar CSE receives and processes the request by sampling its current time. Step 3: The Registrar CSE generates a response that includes its current time value. Step 4: The Registree computes a time offset, if any, between its own current time and the current time of the Registrar CSE. Step 5: Using the computed offset, the Registree updates its current time to synchronize it with the Registrar's current time. 10.2.25 Primitive Profile |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.25.1 Introduction | A Hosting CSE may host one or more <primitiveProfile> resources. Each <primitiveProfile> resource comprises one or more values of parameters and attributes associated with respective type(s) of oneM2M primitives (i.e. oneM2M request or response message) that may be received or generated by the Hosting CSE. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 462 (oneM2M TS-0001 version 4.15.0 Release 4) If a Hosting CSE receives a request message from an Originator (e.g. an AE hosted on a device) that contains a Primitive Profile Identifier parameter, then the Hosting CSE shall attempt to access the <primitiveProfile> resource referenced by the Primitive Profile Identifier parameter. If accessible, the Hosting CSE shall check whether the IDList, resourceTypes, operations, resourceIDs, releaseVersions and applicability attributes of the referenced <primitiveProfile> resource match the received request. If a match exists, the Hosting CSE shall apply the profile by adding/replacing or deleting any applicable request parameters or attributes defined in the additions or deletions attributes of the <primitiveProfile> resource to the request. If a match does not exist, the Hosting CSE shall attempt to process the request without applying the <primitiveProfile> resource. If the <primitiveProfile> resource is not present or not accessible the Hosting CSE shall not process the request and shall return a primitive profile error in the response as defined in ETSI TS 118 104 [3]. If a Hosting CSE generates a response to a request from an Originator that contains a Primitive Profile Identifier parameter that is found to match a <primitiveProfile> resource, then the Hosting CSE shall attempt to apply the <primitiveProfile> resource to the response if the applicability attribute indicates that the <primitiveProfile> resource is applicable to the generated response. The Hosting CSE shall apply the profile by adding/replacing or deleting any applicable response parameters or attributes defined in the additions or deletions attributes of the <primitiveProfile> resource to the response. When applying the profile to the Content parameter of the response, the Hosting CSE shall only apply the profile to the representation of the requested resource. If the Content parameter of the response includes nested representations of child resource(s) and their descendant(s), the Hosting CSE shall not apply the profile to these child resource(s) or descendant(s). The mandatory request and response parameters of Operation, To, From, Request Identifier, Release Version Indicator and Response Status Code are not permitted in the additions or deletions attributes of a <primitiveProfile> resource. The optional request and response parameters of Filter Criteria, OriginatingTime, GroupRequestIdentifier, Tokens and AssignedTokenIdentifiers are also not permitted in the additions or deletions attributes of a <primitiveProfile> resource. If a <subscription> resource Hosting CSE generates a notification request for a <subscription> resource that has a primitiveProfileID attribute configured with a resource identifier of a <primitiveProfile> resource, then the <subscription> resource Hosting CSE shall apply the <primitiveProfile> resource to the notifications that the Hosting CSE originates as defined in clauses 9.6.8 and 10.2.10. When processing a request in a non-blocking asynchronous manner and the request has a Primitive Profile Identifier parameter configured with the resource identifier of a <primitiveProfile> resource, the Hosting CSE shall apply the <primitiveProfile> resource to the notification that it generates for returning the response to the Originator. When processing a request in a non-blocking synchronous manner and the request has a Primitive Profile Identifier parameter configured with the resource identifier of a <primitiveProfile> resource, the Hosting CSE shall apply the <primitiveProfile> resource to the response that it stores within the operationResult attribute of the <request> resource. If a CSE receives a request having a Primitive Profile Identifier parameter and it is not the Hosting CSE, i.e. the CSE-ID in the To parameter does not match its own CSE-ID, the CSE shall ignore the Primitive Profile Identifier parameter. The CSE shall attempt to forward the request based on the normal forwarding procedure specified in ETSI TS 118 104 [3] without attempting to apply a <primitiveProfile> resource to the request. The Hosting CSE shall include the Primitive Profile Identifier parameter in the forwarded request. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.25.2 Create <primitiveProfile> | This procedure shall be used for creating a <primitiveProfile> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 463 (oneM2M TS-0001 version 4.15.0 Release 4) Table 10.2.25.2-1: <primitiveProfile> CREATE <primitiveProfile> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.73. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: Address of the created <primitiveProfile> resource, according to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. The Receiver shall perform a mutual exclusivity check on the names of the attributes or parameters specified in the additions and deletions attributes of the <primitiveProfile> CREATE request to ensure these names have only a single occurrence across additions or deletions. Otherwise, the Receiver shall respond with an error. The Receiver shall check that the names of any request and response parameters specified in the additions and deletions attributes of the <primitiveProfile> CREATE request do not include Operation, To, From, Request Identifier, Release Version Indicator, Response Status Code, Filter Criteria, OriginatingTime, GroupRequestIdentifier, Tokens or AssignedTokenIdentifiers. If any are present, the Receiver shall respond with an error. The Receiver shall check the names and values of any resource attributes defined in the additions attribute defined within the CREATE request to verify that they are valid names and values of attributes for any types of resources defined by the resourceTypes or resourceIDs attributes of the <primitiveProfile> CREATE request. If any invalid attribute names or values are detected, the Receiver shall respond with an error. The Receiver shall check the names of any resource attributes in the deletions attribute defined within the CREATE request do not include the names of mandatory attributes for any types of resources defined by the resourceTypes or resourceIDs attributes of the <primitiveProfile> CREATE request. If any mandatory attribute names are detected, the Receiver shall respond with an error. The Receiver shall check that the additions attribute defined within the CREATE request does not include attributes or parameters having complex data types as specified in ETSI TS 118 104 [3]). If any are detected, the Receiver shall respond with an error. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.25.3 Retrieve <primitiveProfile> | This procedure shall be used for retrieving the attributes of a <primitiveProfile> resource. Table 10.2.25.3-1: <primitiveProfile> RETRIEVE <primitiveProfile> RETRIEVE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: void. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply with the specific details for: Content: attributes of the <primitiveProfile> resource as defined in clause 9.6.73. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 464 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.25.4 Update <primitiveProfile> | This procedure shall be used for updating the attributes and the actual data of a <primitiveProfile> resource. Table 10.2.25.4-1: <primitiveProfile> UPDATE <primitiveProfile> UPDATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: attributes of the <primitiveProfile> resource as defined in clause 9.6.73 which need be updated. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. The Receiver shall perform a mutual exclusivity check on the names of the attributes or parameters specified in the additions and deletions attributes of the <primitiveProfile> resource and UPDATE request to ensure the updated names will have only a single occurrence across additions and deletions. Otherwise, the Receiver shall respond with an error. The Receiver shall check that the names of any request and response parameters specified in the additions and deletions attributes of the <primitiveProfile> UPDATE request to ensure these names do not include the Operation, To, From, Request Identifier, Release Version Indicator, Response Status Code, Filter Criteria, OriginatingTime, GroupRequestIdentifier, Tokens or AssignedTokenIdentifiers. If any are present, the Receiver shall respond with an error. The Receiver shall check that the additions attribute defined within the UPDATE request does not include attributes or parameters having complex data types as specified in ETSI TS 118 104 [3]). If any are present, the Receiver shall respond with an error. Before performing the UPDATE, the Receiver shall check that the resulting set of names and values of any resource attributes defined in the additions attribute of the <primitiveProfile> resource targeted by the UPDATE are valid names and values of attributes for any resulting types of resources defined by the resourceTypes or resourceIDs attributes of the <primitiveProfile> resource. If any invalid names or values of attributes are detected, the Receiver shall respond with an error. Before performing the UPDATE, the Receiver shall check that the resulting set of names of any resource attributes defined in the deletions attribute of the <primitiveProfile> resource targeted by the UPDATE do not include the names of mandatory attributes for any resulting types of resources defined by the resourceTypes or resourceIDs attributes of the <primitiveProfile> resource. If any mandatory attributes are detected, the Receiver shall respond with an error. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.25.5 Delete <primitiveProfile> | This procedure shall be used for deleting a <primitiveProfile> resource. Table 10.2.25.5-1: <primitiveProfile> DELETE <primitiveProfile> DELETE Information in Request message All parameters defined in table 8.1.2-3 apply Processing at Originator before sending Request According to clause 10.1.5 Processing at Receiver According to clause 10.1.5. Information in Response message According to clause 10.1.5 ETSI ETSI TS 118 101 V4.15.0 (2022-09) 465 (oneM2M TS-0001 version 4.15.0 Release 4) <primitiveProfile> DELETE Processing at Originator after receiving Response According to clause 10.1.5 Exceptions According to clause 10.1.5 10.2.26 Void 10.2.27 Process Management |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.1 Introduction | If a Hosting CSE supports the capability to manage processes, then it shall support the <state>, <processManagement>, <action> and <dependency> resource types. This clause describes the procedure for managing a oneM2M process via the <state> and <processManagement> resources. A process is defined and managed by an AE creating a <processManagement> resource at a Hosting CSE. The <state> resources corresponding to the states in the process are then created by an AE as child resources of the <processManagement> resource. The <action> resources corresponding to the action performed by the Hosting CSE for each state are also created as child resources of the <state> resources and linked via the stateAction attribute. The evalCriteria defined by child <action> resource of each <state> resource are not monitored by a Hosting CSE until the process is activated and the process has transitioned to the state defined by each <state> resource. If no evalCriteria are defined for a child <action> resource of a <state> resource, then the Hosting CSE shall perform the corresponding action when the process is activated and the process has transitioned to the state defined by the <state> resource. The activateConditions and endConditions attributes are configured by an AE to define the criteria that the Hosting CSE uses to trigger the activation and ending of the process. The defined criteria shall be monitored by the Hosting CSE once the process is enabled by the AE. The first state in the process is configured by an AE via the initialState attribute of the <processManagement> resource. The processControl attribute of the <processManagement> resource is updated by an AE to instruct the Hosting CSE to enable, disable, pause and reactivate the process. While managing the process, the Hosting shall monitor the criteria attributes (e.g. activateConditions, endConditions, stateTransitions) defined within <processManagement> and <state> resources of the process to determine if/when to perform corresponding actions defined by the <action> resources of the process. While managing the process, the Hosting CSE shall update the status attributes (e.g. stateActive, processStatus, currentState) defined within <processManagement> and <state> resources of the process. When entering a state, the Hosting CSE shall update the currentState attribute of the <processManagement> resource to the resource identifier of the <state> resource actively being processed, update the value of the stateActive attribute of this <state> resource to "True", and check the <action> resource that is defined in the stateAction attribute. For an unconditional action whose evalCriteria is empty, the Hosting CSE shall perform the action immediately when processing of the <state> begins. Otherwise, the Hosting CSE shall monitor the evalCriteria attribute of the <action> resource to determine if/when the action shall be performed. The Hosting CSE shall also monitor the evalCriteria parameter defined in the stateTransitions attribute of the <state> resource. If/when any of the criteria defined in the stateTransitions are met, the Hosting CSE shall perform a state transition. If the Hosting CSE is performing an action when the stateTransitions criteria are met, the Hosting CSE shall complete the action before transitioning to the next state. When performing a state transition, the Hosting CSE shall update the stateActive attribute of the current <state> resource to "False" and the stateActive attribute of the next <state> resource to "True". If a next <state> resource is not applicable (e.g. the Hosting CSE has completed processing a final state in the process, the Hosting shall end the process by updating the processStatus attribute of the <processManagement> resource to a value of "Completed". While the Hosting CSE is managing a process, it shall also monitor the criteria defined in the endConditions attribute of the <processManagement> resource. If/when any of the criteria defined in the endConditions are met, the Hosting CSE shall end the process by updating the stateActive attribute of the current <state> resource to "False" and the processStatus attribute of the <processManagement> resource to a value of "Completed". If the Hosting CSE is performing an action when the endTransitions criteria are met, the Hosting CSE shall complete the action before ending the process. While the Hosting CSE is managing a process, if it encounters an error condition (e.g. a <state> or <action> resource is not accessible to the Hosting CSE), the Hosting CSE shall abort the process by updating the stateActive attribute of the current <state> resource to "False" and the processStatus attribute of the <processManagement> resource to a value of "Aborted". ETSI ETSI TS 118 101 V4.15.0 (2022-09) 466 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.2 Process Management Procedure | This clause describes the procedure a Hosting CSE performs to manage a process as detailed by the following steps. AE <processManagement> Hosting CSE Referenced resource Hosting CSE Referenced resource Hosting CSE ... 1. Create <processManagement> resource 3a. Create <action> resource(s) 2a. Create <state> resource(s) 4a. processControl = Enable 4b. Check the existence and accessibility of resources related to process 5b. processStatus = Activated; currentState = initialState; Monitor endConditions 5a. activateConditions met or equal to NULL 4c. processStatus = Enabled; Monitor activateConditions 6. Transition through states and perform actions related to process 7a. endConditions met Or stateTransitions = NULL 7b. processStatus = Completed 3b. Update <state> resource(s) 2b. Update <processManagement> resource Figure 10.2.27.2-1: Process Management by an AE Step 1: An AE creates a <processManagement> resource. Step 2: The AE creates all the <state> resources that are involved in the process. The <state> resources are created as child resources of the <processManagement> resource. If there is more than one <state> resource created, the stateTransitions attribute(s) of the <state> resource(s) are configured by the AE to define the transitions between the states of the process. The initialState attribute of the <processManagemen> resource is then updated by the AE with the resource identifier of the first <state> resource in the process. Step 3: The AE creates all the <action> resources that are involved in the process. The <action> resources are created as child resources of each corresponding <state> resource. The <action> resources are linked with the corresponding <state> resources by the AE updating the stateAction attribute of each <state> resource. Step 4: The AE enables the process by updating the processControl attribute of the <processManagement> resource to a value of "Enable". The Hosting CSE shall validate each of the resources defined in the process to verify if each resource exists and is accessible to the AE enabling the process. If the validation is successful, the Hosting CSE shall update the value of processStatus to "Enabled". The Hosting CSE shall then start to monitor the criteria defined in the activateConditions attribute of the <processManagement> resource. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 467 (oneM2M TS-0001 version 4.15.0 Release 4) Step 5: If/when the criteria defined in the activateConditions attribute are met or the activateConditions attribute is not present, the Hosting CSE shall set the processStatus attribute of the <processManagement> resource to a value of "Activated". The Hosting CSE shall also set the currentState attribute to the value configured in the initialState attribute. The Hosting CSE shall stop monitoring the criteria defined in the activateConditions attribute and start monitoring the criteria defined in endConditions. Step 6: The Hosting shall process each <state> resource in the process starting from the state defined by the initialState attribute of the <processManagement> resource. The Hosting CSE shall evaluate and perform the action that is linked via the stateAction attribute to a state if/when their criteria have been met. The Hosting CSE shall also monitor the state transition criteria defined in the stateTransitions attribute of the state. Whenever the Hosting CSE detects that a state transition is required based on the stateTransitions attribute defined within the current <state> resource, the Hosting CSE shall update the currentState attribute with the resource identifier of the next <state> resource: • If an AE updates the processControl attribute of the <processManagement> resource to "Pause", the Hosting CSE shall set the processStatus attribute to "Paused". Thereafter, the Hosting CSE shall reactivate the process if the processControl attribute is updated to "Reactivate" or shall end the process if the processControl attribute is updated to "Disable". • If an AE updates the processControl attribute of the <processManagement> resource to "Disable", the Hosting CSE shall set the processStatus attribute to "Disabled". The Hosting CSE shall set the stateActive attributes of all child <state> resources to "False". The Hosting CSE shall set the currentState attribute to NULL. The Hosting CSE shall stop monitoring the criteria defined in the endConditions attribute. Step 7: If/when the criteria defined in the endConditions attribute of the <processManagement> resource is met or the Hosting CSE detects that there are no further state transitions defined, the Hosting CSE shall set the processStatus attribute to "Completed". The Hosting CSE shall set the stateActive attributes of all child <state> resources to "False". The Hosting CSE shall stop monitoring the criteria defined in endConditions attribute: • A process that has completed may be restarted by an AE by updating the processControl to "Disable" and then updating the processControl to "Enable". When the processStatus is "Disabled", the Hosting CSE shall allow child <state> resources to be added, modified or deleted from the process. Otherwise, the Hosting CSE shall reject requests to add, modify or delete <state> resources from the process. When the processStatus is "Disabled", the Hosting CSE shall allow the activateConditions, endConditions and initialState attributes of the <processManagement> resources to be updated. Otherwise, the Hosting CSE shall reject requests to update these attributes. When the processStatus transitions from "Disabled" to "Enabled", The Hosting CSE shall check that all the required resources related to the process are present and the AE enabling the process has the necessary privileges to perform the process related operations on these resources. The necessary privileges include RETRIEVE privileges to the resources as well as CREATE, UPDATE and DELETE privileges if/when applicable (e.g. the process includes an <action> resource that results in an UPDATE operation on a targeted resource). In addition, the Hosting CSE shall also check that the AE enabling the process has the necessary privileges to perform operations on all process related resources if/when the Hosting CSE performs operations on these resources during the management of the process. If at any time, the Hosting CSE determines that the AE enabling the process does not have sufficient privileges, the Hosting CSE shall not enable the process if it is not already enabled and shall abort the process if it is enabled or activated. In addition to the <processManagement> resource, the following is a list of other potential resources that shall relate to the process: • child <state> resources of the <processManagement> resource; • child <action> resources of the <state> resources referenced via the stateAction attribute of each <state> resource; • resources referenced via the stateTransitions attribute of each <state> resource; • resources referenced via the actionSubjectResources, objectResourceID, subjectResourceID, evalCriteria attributes of each related <action> resource; • <accessControlPolicy> resources referenced by the <processManagement> resource and all other related resources. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 468 (oneM2M TS-0001 version 4.15.0 Release 4) When the Hosting CSE is managing an "Enabled" or "Activated" process and encounters an error condition (e.g. is unable to access a <state> or <action> resource), the Hosting CSE shall abort the process by updating the stateActive attribute of the current <state> resource to "False" and the processStatus attribute of the <processManagement> resource to "Aborted". Table 10.2.27.2-1 defines the valid processControl values permitted in an update request to a <processManagement> resource based on the current value of the processStatus attribute of the <processManagement> resource. A <processManagement> Hosting CSE shall only allow an update to processControl for the combinations listed. Table 10.2.27.2-1: Valid <processManagement> processControl update values Current processStatus value Valid processControl update values Disabled Enable Enabled Disable Activated Pause, Disable Paused Disable, Reactivate Completed Disable Aborted Disable Figure 10.2.27.2-2 defines the legal state transitions of the processStatus attribute of the <processManagement> resource as well as the criteria for each transition. Disabled Paused Enabled Activated Completed Aborted <processManagement> created <processManagement> deleted processControl = Disable Error encountered processControl = Disable processControl = Enable processControl = Disable processControl = Disable processControl = Disable processControl = Reactivate processControl = Pause stateTransitions not present or endConditions met Error encountered activateCondition not present or activateConditions met Figure 10.2.27.2-2: <processManagement> processStatus State Diagram ETSI ETSI TS 118 101 V4.15.0 (2022-09) 469 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.3 State Transition Procedure | This clause describes the procedure a Hosting CSE shall perform when entering a new state, e.g. after a state transition, or a process is initialized when the activateConditions are met. Step 1: The Hosting CSE shall set the value of the stateActive attribute of the <state> resource indicated in the currentState attribute of the <processManagement> resource to "True". Step 2: When a <state> resource is activated, the Hosting CSE shall evaluate the stateAction attribute of the <state> resource. For an <action> resource in which the evalCriteria attribute is not present (i.e. an unconditional action), the Hosting shall perform the corresponding actions defined by the <action> resource immediately upon transition to the <state> resource. For an <action> resource in which the evalCriteria attribute is present (i.e. a conditional action), the Hosting CSE shall monitor the evalCriteria attribute of the <action> resource to determine if/when to trigger and perform the action. Step 3: The Hosting CSE shall monitor the criteria specified in the stateTransitions attribute of the <state> resource. Step 4: If any of the criteria defined in stateTransitions attribute is detected to have been met by the Hosting CSE, the Hosting CSE shall update the stateActive of the current <state> resource to "False", and update the currentState attribute of the <processManagement> resource with the resource identifier of the next <state> resource, if any. The Hosting CSE shall then transition to the next state. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.4 <state> Resource Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.4.1 Create <state> | The Hosting CSE shall use this procedure to create a <state> resource according to the resource identifier of the parent resource. Table 10.2.27.4.1-1: <state> CREATE <state> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.74. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. The Receiver shall check the existence and accessibility of any <state> resource(s) defined in the stateTransitions attribute. If any of the referenced resources do not exist or are not accessible by the Originator, the Receiver responds with an error. Once the <state> resource is successfully created, the Receiver shall use the <state> resource per the process management procedure as defined in clauses 10.2.27.2 and 10.2.27.3. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 470 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.4.2 Retrieve <state> | This procedure shall be used for retrieving the attributes of a <state> resource. Table 10.2.27.4.2-1: <state> RETRIEVE <state> RETRIEVE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.4.3 Update <state> | This procedure shall be used for updating attributes of a <state> resource. Table 10.2.27.4.3-1: <state> UPDATE <state> UPDATE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. If the stateActive attribute of the targeted <state> resource is "True", then the Receiver responds with an error. The Receiver shall check the existence and accessibility of the <state> resource(s) defined in stateTransitions, the <action> resource defined in stateAction, and any resources referenced by these resources. If any of the referenced resources do not exist or are not accessible by the Originator, the Receiver responds with an error. Once the <state> resource is successfully updated, the Receiver shall use the <state> resource per the process management procedure as defined in clauses 10.2.27.2 and 10.2.27.3. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 471 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.4.4 Delete <state> | This procedure shall be used for deleting a <state> resource. Table 10.2.27.4.4-1: <state> DELETE <state> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. If the stateActive attribute of the targeted <state> resource is "True", the Receiver responds with an error. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.5 <processManagement> Resource Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.5.1 Create <processManagement> | The Hosting CSE shall use this procedure to create a <processManagement> resource according to the resource identifier of the parent resource. Table 10.2.27.5.1-1: <processManagement> CREATE < processManagement > CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.75. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. The Receiver shall check the existence and accessibility of the resource(s) referenced in the activateConditions and endConditions attributes. If any of the referenced resources do not exist or are not accessible by the Originator, the Receiver responds with an error. Once the <processManagement> resource is successfully created, the Receiver shall perform the process management procedure as defined in clauses 10.2.27.2 and 10.2.27.3. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 472 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.5.2 Retrieve <processManagement> | This procedure shall be used for retrieving the attributes of a <processManagement> resource. Table 10.2.27.5.2-1: <processManagement> RETRIEVE <processManagement> RETRIEVE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.5.3 Update <processManagement> | This procedure shall be used for updating attributes of a <processManagement> resource. Table 10.2.27.5.3-1: <processManagement> UPDATE <processManagement> UPDATE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. If the processStatus attribute has a value other than "Disabled" and the request is attempting to update the initialState, activateConditions or endConditions attributes, the Receiver responds with an error. If the processControl is requested to be updated, the Receiver shall check whether it is a legal transition as defined by figure 10.2.27.2-1. If the transition is not legal, the Receiver responds with an error. The Receiver shall check the existence and accessibility of the resource(s) referenced in the activateConditions and endConditions attributes, and the <state> resource defined in initialState attribute. If any of the referenced resources do not exist or are not accessible by the Originator, the Receiver responds with an error. After successfully updating the <processManagement> resource, the Receiver shall perform the procedure specified in clauses 10.2.27.2 and 10.2.27.3. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 473 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.27.5.4 Delete <processManagement> | This procedure shall be used for deleting a <processManagement> resource. Table 10.2.27.5.4-1: <processManagement> DELETE <processManagement> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. If the processStatus is not "Disabled", the Receiver responds with an error. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. 10.2.28 Software Management |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.28.1 Introduction | This clause describes the procedure for software management by a Hosting CSE via the <softwareCampaign> resource. An Originator (e.g. IN-AE) can instruct a Hosting CSE (e.g. IN-CSE) to install, uninstall, activate or deactivate software on its Registree entities (e.g. CSEs or AEs) on behalf of the Originator by creating <softwareCampaign> resource(s) at the Hosting CSE. A <softwareCampaign> resource specifies the version, softwareName and URL of the software to be installed. The Hosting CSE shall copy this information to the corresponding attributes when creating or updating [software] specializations. The target nodes where the software is to be installed, uninstalled, activated or deactivated are specified in the softwareTargets attribute. The software operation to perform on these target nodes is specified in the softwareOperation attribute. The Hosting CSE shall monitor the campaignEnabled attribute, the conditions defined in the softwareTriggerCriteria attribute and the <schedule> child resources of the <softwareCampaign> resource to determine if/when to perform the software operation on these nodes. Figure 10.2.28.1-1 defines the legal state transitions of the campaignStatus attribute of the <softwareCampaign> resource as well as the criteria for each state transition. The Hosting CSE of the <softwareCampaign> resource shall adhere to these valid state transitions. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 474 (oneM2M TS-0001 version 4.15.0 Release 4) PENDING CANCELLED INITIATED FINISHED CANCELLING <softwareCampaign> resource created and campaignEnabled set to FALSE campaignEnabled set to TRUE campaignEnabled set to FALSE campaignEnabled set to TRUE campaignEnabled set to FALSE aggregatedSoftwareStatus set to SUCCESSFUL or FAILURE STATUS_NOT_CANCELLABLE Hosting CSE is able to cancel software campaign Hosting CSE is not able to cancel software campaign campaignEnabled set to True <softwareCampaign> resource deleted <softwareCampaign> resource deleted <softwareCampaign> resource deleted <softwareCampaign> resource deleted Figure 10.2.28.1-1: <softwareCampaign> campaignStatus State Diagram Upon creation of the <softwareCampaign> resource, if the campaignEnabled attribute is explicitly or by default set to "FALSE", the campaignStatus attribute of the <softwareCampaign> resource shall be set to "PENDING" by the Hosting CSE. Upon creation or update of the <softwareCampaign> resource, if the campaignEnabled attribute is set to "TRUE", the campaignStatus attribute of the <softwareCampaign> resource shall be set to "INITIATED" by the Hosting CSE and the values of the individualSoftwareStatuses and softwareLinks attributes shall be set to NULL and the value of the aggregatedSoftwareStatus attribute shall be set to "UNINITIALIZED". The Hosting CSE shall then monitor any conditions defined by the softwareTriggerCriteria attribute and any time windows defined by the union of child <schedule> resources of the <softwareCampaign> resource. When the softwareTriggerCriteria and schedule conditions are met or if no softwareTriggerCriteria or schedule conditions are specified, the Hosting CSE shall create or update the [software] specialization(s) to perform the operation specified by the softwareOperation attribute. If the softwareTriggerCriteria conditions are met at a time that does not match the time windows defined by the union of the child <schedule> resource(s), then the Hosting CSE shall defer the creation or update of the [software] specialization(s) until the next scheduled time window. While deferring, the Hosting CSE shall maintain a value of "INITIATED" in the campaignStatus attribute. When creating or updating the [software] specialization(s), the Hosting CSE shall configure the expirationTime attribute of each [software] specialization to a value that is less than or equal to the value of the expirationTime attribute of the <softwareCampaign> resource such that [software] specializations do not outlive the <softwareCampaign> resource they are associated with. The Hosting shall also record the resource identifier of each [software] specialization in the softwareLinks attribute. The Hosting shall also create an entry in the individualSoftwareStatuses attribute to record the status of each [software] specialization and update the aggregatedSoftwareStatus attribute to reflect the aggregated status of all the [software] specializations per the aggregated status definitions defined in table 9.6.76-2. The Hosting CSE shall also create or update subscription(s) to the created [software] specialization(s) to receive notifications of changes in their status. If the softwareOperation attribute has a value of INSTALL or UNINSTALL, the Hosting CSE shall set the install or uninstall attribute to TRUE for each [software] specialization linked through the softwareLinks attribute. When the Hosting CSE receives a notification that the installStatus attribute of a [software] specialization has been updated, the Hosting CSE shall update the corresponding entry in the individualSoftwareStatuses attribute with the same value and update the aggregatedSoftwareStatus attribute to reflect the aggregated status of all the [software] specializations. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 475 (oneM2M TS-0001 version 4.15.0 Release 4) If the softwareOperation attribute has a value of ACTIVATE or DEACTIVATE, the Hosting CSE shall set the activate or deactivate attribute to TRUE for each [software] specialization linked through the softwareLinks attribute. When the Hosting CSE receives a notification that the activeStatus attribute of a [software] specialization has been updated, the Hosting CSE shall update the corresponding entry in the individualSoftwareStatuses attribute with the same value and update the aggregatedSoftwareStatus attribute to reflect the aggregated status of all the [software] specializations. If the Hosting CSE is not able to successfully create or update all the [software] specialization(s), or successfully create or update child <subscription> resources to the [software] specialization(s), and/or the Hosting CSE receives a notification indicating that a child <subscription> resource of a [software] specialization is being deleted before the operation defined by the [software] specialization has completed by the target, then the Hosting CSE shall update the corresponding entry(s) in the individualSoftwareStatuses attribute with the value "FAILURE" and update the aggregatedSoftwareStatus attribute to reflect the aggregated status of all the [software] specializations. When the Hosting CSE sets the aggregatedSoftwareStatus attribute to a value of "SUCCESSFUL" or "FAILURE" while the campaignEnabled attribute is "TRUE" (i.e. the software campaign has not been cancelled), it shall set the campaignStatus attribute to a value of "FINISHED". If the campaignStatus attribute has a value of "FINISHED", and the campaignEnabled attribute is set to a value of "FALSE", the Hosting CSE shall set the campaignStatus attribute to a value of "PENDING". If the campaignStatus attribute has a value of "INITIATED" and the campaignEnabled is set to a value of "FALSE", the Hosting CSE shall set the value of the campaignStatus attribute to "CANCELLING". The Hosting CSE shall then attempt to cancel the software campaign. To cancel a software campaign, the Hosting CSE shall stop creating or updating [software] specializations for any of the softwareTargets that it has yet to create or update [software] specializations for. For any of the softwareTargets that it has already created or updated [software] specializations for, but it has not yet set the install, uninstall, activate or deactivate attribute to a value of "TRUE" to begin the software operation, the Hosting CSE shall leave the value "FALSE" and not initiate the software operation. For any of the softwareTargets that it has already updated the [software] specialization's install, uninstall, activate or deactivate attribute to a value of "TRUE", based on local policy, the Hosting CSE may choose to let the operation finish or attempt to cancel the operation (e.g. by updating the install, uninstall, activate or deactivate attribute to a value of "FALSE"). For any of the softwareTargets that the Hosting CSE does not perform a software operation upon due to cancelling the software campaign, the Hosting CSE shall update the corresponding entry(s) in the individualSoftwareStatuses attribute with the value "FAILURE". For any of the softwareTargets that the Hosting CSE performs the software operation upon even though the software campaign was cancelled, the Hosting CSE shall update the corresponding entry(s) in the individualSoftwareStatuses attribute with the status it receives from the [software] specialization(s). After updating the individualSoftwareStatuses attribute, the Hosting CSE shall also update the aggregatedSoftwareStatus attribute to reflect the aggregated status of all the [software] specializations. If the Hosting CSE successfully cancels all the software operations, then the Hosting CSE shall set the campaignStatus attribute to a value of "CANCELLED". If the Hosting CSE is not able to successfully cancel all the software operations, the Hosting CSE shall set the campaignStatus attribute to a value of "STATUS_NOT_CANCELLABLE". While the campaignStatus attribute has a value of "CANCELLED" or "STATUS_NOT_CANCELLABLE", and campaignEnabled is set to a value of "TRUE", the Hosting CSE shall set the campaignStatus attribute to a value of "INITIATED" and set the values of the individualSoftwareStatuses and softwareLinks attributes to NULL and set the value of the aggregatedSoftwareStatus attribute to "UNINITIALIZED". The Hosting CSE shall then attempt to initiate a new software campaign contingent upon any conditions defined by the softwareTriggerCriteria attribute and any time windows defined by the union of child <schedule> resources of the <softwareCampaign> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.28.2 Software Management Procedure | This clause describes the software management procedure performed by a Hosting CSE on a Registree entity via the <softwareCampaign> resource. Note, this procedure does not cover the scenario in which a software campaign is initiated and then cancelled. For details regarding a cancelled software campaign refer to clause 10.2.28.1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 476 (oneM2M TS-0001 version 4.15.0 Release 4) Originator (CSE or AE) Hosting CSE Registree (CSE or AE) Create <remoteCSE> or <AE> Create [software] Create [software] Step 0 Step 5 Update [software] Step 6 Create <remoteCSE> or <AE> Step 1. Discover/retrieve <remoteCSE> or <AE> Create <softwareCampaign> Step 3. Detect softwareTriggerCriteria is met and <schedule> permits starting operation Step 4. Identify software targets Step 7. Update <softwareCampaign> resource Step 8. NOTIFY Create <schedule> Create <subscrption> Step 2 Install/uninstall/activate/ deactivate software SUBSCRIBE NOTIFY Create <softwareCampaign> Figure 10.2.28.2-1: Software Management by a CSE ETSI ETSI TS 118 101 V4.15.0 (2022-09) 477 (oneM2M TS-0001 version 4.15.0 Release 4) Step 0: The Registree(s) register to the Hosting CSE (i.e. Registrar CSE) by creating <remoteCSE> or <AE> resource(s). The nodeLink attribute of a Registree <remoteCSE> or <AE> resource is configured with the resource identifier of the Registree's <node> resource. Step 1: An Originator discovers/retrieves the <remoteCSE> and/or <AE> resource(s) of the Registree(s) to obtain the resource identifiers of the corresponding <node> resources. Step 2: The Originator creates or updates <softwareCampaign> resource(s) on the Hosting CSE which the Hosting CSE uses to manage (on the Originator's behalf) the software of the Registree(s). The Originator configures the attributes of the <softwareCampaign> resource(s) to specify the software operation to perform, the targeted nodes to perform the software operation on and trigger criteria to control if/when the Hosting CSE is to perform the software operation. The Hosting CSE shall check that the request to create or update the <softwareCampaign> does not conflict with any existing <softwareCampaign> resources that are still pending. The Hosting CSE shall perform this check by verifying that <node> resources referenced by the softwareTargets attribute are not present in the softwareTargets attribute of other <softwareCampaign> resources that have their campaignEnabled attribute set to a value of TRUE and that are hosted by the Hosting CSE: • Optionally, the Originator may also create or update a <schedule> child resource of the <softwareCampaign> resource to define the time windows of when software management operations may be performed by the Hosting CSE once triggered. • Optionally, the Originator may also create or update a <subscription> child resource of the <softwareCampaign> resource to receive notifications if/when the Hosting CSE performs software management operations. Step 3: The Originator configures the campaignEnabled attribute of the <softwareCampaign> resource to a value of TRUE. The Hosting CSE shall set the campaignStatus attribute to a value of "INITIATED" and shall monitor and detect when the criteria defined by the softwareTriggerCriteria attribute of the <softwareCampaign> resource have been met. If the criteria are met, the Hosting CSE shall check if one or more <schedule> child resources exist for the <softwareCampaign> resource. If <schedule> resource(s) exist, the Hosting CSE shall check the union of the defined schedule time windows of the <schedule> resource(s) to determine if the triggered software management operation can be performed immediately. Otherwise, the Hosting CSE shall buffer any triggered software management operations until the defined time windows allow the Hosting CSE to perform the operations. Step 4: The Hosting CSE shall identify the target nodes to perform software management operations upon based on the softwareTargets attribute. Step 5: The Hosting CSE shall create a new or update an existing child [software] specialization associated with this <softwareCampaign> resource under each applicable <node> resource specified by the softwareTargets attribute. The Hosting CSE shall configure the version, softwareName and URL attributes of the [software] specialization(s) based on the corresponding attributes and values configured in the <softwareCampaign> resource. The Hosting CSE shall configure the expirationTime attribute of each [software] specialization to a value that is less than or equal to the value of the expirationTime attribute of the <softwareCampaign> resource. The Hosting CSE shall also update the softwareLinks attribute of the <softwareCampaign> resource with the resource identifiers of the created or updated [software] specializations. After the [software] specialization(s) are created or updated, the Hosting CSE shall subscribe to the [software] specialization(s) to receive notifications for changes to the installStatus or activeStatus attributes of the [software] specialization(s). The Hosting shall also create an entry in the individualSoftwareStatuses attribute to record the status of each [software] specialization and update the aggregatedSoftwareStatus attribute to reflect the aggregated status of all the [software] specializations per the aggregated status definitions defined in table 9.6.76-2. If the Hosting CSE is not able to create, update or successfully subscribe to [software] specialization(s), the Hosting CSE shall set the corresponding entries in the individualSoftwareStatuses attribute to a value of "FAILURE". The Hosting CSE shall discontinue performing software management operations on these [software] specialization(s). For any [software] specialization(s) that the Hosting CSE is able to successfully subscribe to, the Hosting CSE shall continue to perform software management operations. NOTE 1: Before creating or updating a [software] specialization on a targeted node, the Hosting CSE may check the version, softwareName and URL attributes of the <softwareCampaign> resource to determine if the specified software is compatible with the targeted node. If not compatible, the Hosting CSE may choose not to perform the software management operation on the targeted node and set the corresponding entries in the individualSoftwareStatuses attribute to a value of "FAILURE". The method used by the Hosting CSE to determine if the specified software is compatible with the targeted node is out of scope of the present document. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 478 (oneM2M TS-0001 version 4.15.0 Release 4) Step 6: According to the softwareOperation specified by the <softwareCampaign> resource, the Hosting CSE shall perform the specified operation on each [software] specialization by performing an update to set the corresponding install, uninstall, activate or deactivate attribute of the [software] specialization to a value of "TRUE". The Hosting CSE shall wait to receive notifications that the software management operations for each [software] specialization has completed, or that the [software] specialization expiration time has been exceeded resulting in the Hosting CSE receiving a notification indicating the <subscription> child resource (and [software] specialization) have been deleted. Step 7: As the Hosting CSE detects the successful or unsuccessful completion of each software management operation performed via monitoring of the installStatus or activeStatus of each individual [software] specialization, it shall update the individualSoftwareStatuses attribute accordingly and update the aggregatedSoftwareStatus attribute to reflect the aggregated status of all the [software] specializations per the aggregated status definitions defined in table 9.6.76-2. When the aggregatedSoftwareStatus attribute is set to a value or "SUCCESSFUL" or "FAILURE", the Hosting CSE shall set the campaignStatus attribute to a value of "FINISHED". NOTE 2: Since the expirationTime attributes of the [software] specializations are configured with values that are less than or equal to the expirationTime attribute of the <softwareCampaign> resource, if the <softwareCampaign> resource expires, the Hosting CSE will delete the <softwareCampaign> resource without waiting for the individual [software] specializations to complete. Step 8: If the <softwareCampaign> resource has a <subscription> child resource, the Hosting CSE shall generate notification(s) if the eventNotificationCriteria have been met based on the update of the <softwareCampaign> resource. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.28.3 <softwareCampaign> Resource Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.28.3.1 Create <softwareCampaign> | The Hosting CSE shall use this procedure to create a <softwareCampaign> resource according to the resource identifier of the parent resource. Table 10.2.28.3.1-1: <softwareCampaign> CREATE <softwareCampaign> CREATE Information in Request message All parameters defined in table 8.1.2-3 apply with the specific details for: Content: The resource content shall provide the information as defined in clause 9.6.76. Processing at Originator before sending Request According to clause 10.1.2. Processing at Receiver According to clause 10.1.2. The Receiver shall check the existence of the <node> resources referenced by the softwareTargets attribute. If any of the referenced <node> resources do not exist, then the Receiver shall respond with an error. The Receiver shall check the accessibility of the <node> resources referenced by the softwareTargets attribute. If the Originator does not have privileges to create [software] specialization child resources for any of the referenced <node> resources, then the Receiver shall respond with an error. The Receiver shall check that <node> resources referenced by the softwareTargets attribute within the request are not present in the softwareTargets attribute of other <softwareCampaign> resources hosted by the Receiver. If one or more <node> resources are present in the softwareTargets attribute of another <softwareCampaign> resource, and the campaignEnabled attribute of this other <softwareCampaign> resource has a value of TRUE, the Receiver shall respond with an error. The Receiver shall check the existence of the resources referenced by softwareTriggerCriteria attribute, if present. If any of the referenced resources do not exist, the Receiver shall respond with an error. The Receiver shall check the accessibility of the resources referenced by softwareTriggerCriteria attribute, if present. If the Originator does not have retrieve privileges to these resources, the Receiver shall respond with an error. If the value of the campaignEnabled attribute is TRUE, then the Receiver shall set the value of the campaignStatus attribute to "INITIATED". Otherwise, the Receiver shall set the value of the campaignStatus attribute to "PENDING". ETSI ETSI TS 118 101 V4.15.0 (2022-09) 479 (oneM2M TS-0001 version 4.15.0 Release 4) <softwareCampaign> CREATE Once the <softwareCampaign> resource is successfully created, the Receiver shall use the <softwareCampaign> resource to perform the software management procedure as defined in clause 10.2.28.2. Information in Response message According to clause 10.1.2. Processing at Originator after receiving Response According to clause 10.1.2. Exceptions According to clause 10.1.2. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.28.3.2 Retrieve <softwareCampaign> | This procedure shall be used for retrieving the attributes of a <softwareCampaign> resource. Table 10.2.28.3.2-1: <softwareCampaign> RETRIEVE <softwareCampaign> RETRIEVE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.3. Processing at Receiver According to clause 10.1.3. Information in Response message All parameters defined in table 8.1.3-1 apply. Processing at Originator after receiving Response According to clause 10.1.3. Exceptions According to clause 10.1.3. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.28.3.3 Update <softwareCampaign> | This procedure shall be used for updating attributes of a <softwareCampaign> resource. Table 10.2.28.3.3-1: <softwareCampaign> UPDATE <softwareCampaign> UPDATE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.4. Processing at Receiver According to clause 10.1.4. If the aggregatedSoftwareStatus attribute is "PENDING" or "IN PROGRESS", and the request is attempting to update the version, name, URL, softwareTargets, softwareOperation or softwareTriggerCriteria attributes, the Receiver shall respond with an error. Once the <softwareCampaign> resource is successfully updated, the Receiver shall use the <softwareCampaign> resource to perform the software management procedure as defined in clause 10.2.28.2. Information in Response message According to clause 10.1.4. Processing at Originator after receiving Response According to clause 10.1.4. Exceptions According to clause 10.1.4. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 480 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 10.2.28.3.4 Delete <softwareCampaign> | This procedure shall be used for deleting a <softwareCampaign> resource. Table 10.2.28.3.4-1: <softwareCampaign> DELETE <softwareCampaign> DELETE Information in Request message All parameters defined in table 8.1.2-2 apply. Processing at Originator before sending Request According to clause 10.1.5. Processing at Receiver According to clause 10.1.5. If the value of the campaignStatus attribute of the resource is "INITIATED" or "CANCELLING", the Receiver shall reject the request and return an error. Information in Response message According to clause 10.1.5. Processing at Originator after receiving Response According to clause 10.1.5. Exceptions According to clause 10.1.5. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11 Trust Enabling Architecture | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.0 Overview | The Trust Enabling Architecture serves the purpose of establishing security and trust between all parties involved in the M2M ecosystem. It comprises the following infrastructure functions which may be external to the CSEs: • M2M Enrolment Functions (MEF), which manage the enrolment and configuration of M2M Nodes and M2M applications for access to M2M Services provided by an M2M Service Provider, prior to service operation (see clause 11.2). The credentials provisioned by a MEF can be used for Security Association Establishment Framework, End-to-End Security of Primitives or End-to-End Security of Data. • M2M Authentication Functions (MAF), which may facilitate identification and authentication of CSEs and AEs (see clause 11.3), End-to-End Security of Primitives (see clause 11.4.2) and End-to-End Security of Data (see clause 11.4.1) during M2M service operation. A single MAF may support all of the above security services or only a selection of them. • Dynamic Authorization Systems and Role Authorities, which manage authorization privileges to access resources that may be assigned during operation (see clauses 11.3.4 and 11.5). • Distributed Authorization Systems allow for four authorization functional components (i.e. PEP, PDP, PRP and PIP) to be distributed in different CSEs (see clauses 11.3.4 and 11.6). • Privacy Policy Managers that assist in the management of privacy preferences expressed by data subject with respect to service requirements and applicable regulations. The above functionalities are assumed to be operated by trusted parties (generally M2M Service Providers but possibly other trusted third parties called M2M Trust Enablers (MTE)). These functions are all detailed in ETSI TS 118 103 [2]. A MAF interacts with a Security Principal via the reference point Mmaf. A MEF interacts with a Security Principal via the reference point Mmef. The Mmef reference point optionally supports triggering Device Configuration (defined in ETSI TS 118 122 [10]) and Certificate Provisioning (specified in ETSI TS 118 103 [2]). The communication protocols used on the reference points Mmaf and Mmef are specified in ETSI TS 118 132 [13]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 481 (oneM2M TS-0001 version 4.15.0 Release 4) 11.1 Enrolling M2M Nodes and M2M Applications for oneM2M Services Though M2M Nodes in the field domain are assumed to communicate without human involvement, individuals or organizations remain responsible for setting the access control policies used to authorize their M2M Nodes to access M2M services. In the following text, M2M Nodes refers to M2M field nodes. In particular, individuals or organizations acquiring M2M Nodes can subscribe to a contract with an M2M Service provider (M2M Service Subscription) under which they enrol their M2M Nodes (e.g. using identifiers pre-provisioned on the nodes, such as Node-ID). This in turn may require an M2M Service provisioning step (including Security provisioning) that takes place on the target M2M Nodes themselves, for which interoperable procedures are specified by oneM2M (see clause 11.2.1). Following M2M service provisioning, the nodes can be identified and authenticated for association with an M2M Service Subscription, whose properties reflect the contractual agreement established between their holder and the M2M Service Provider. Similarly, it may be possible for an M2M Service Provider to mandate that an M2M Application accessing M2M services be associated with a security credentials used to authorize specific operations to instance of that M2M Application, i.e. AEs (see clause 11.2.2). This step facilitates the deployment and management of M2M Applications that are instantiated in great numbers, as it enables all instances of an M2M Application to be managed through common security policies that are set once for all. It also enables keeping control over M2M Applications issued by untrusted sources. The above steps may be delegated to an M2M trust enabler, when this role is not assumed by the M2M Service Provider. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.2 M2M Initial Provisioning Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.2.1 M2M Node Enrolment and Service Provisioning | M2M service provisioning is the process by which M2M Nodes are loaded with the specific information needed to seamlessly access the M2M Services offered by an M2M Service Provider. This is an initial step performed only when an M2M Node is enrolled for using the M2M services of an M2M Service Provider. Though this process can be performed during device manufacturing, there is a need to enable this process to take place during field deployment in an interoperable way. M2M service provisioning assumes the existence of an M2M service subscription contracted with the target M2M Service Provider for the target M2M Node. Remote provisioning scenarios require the M2M Node to be mutually authenticated using pre-existing credentials (e.g. Node-ID and associated credential) with an M2M enrolment function, to securely exchange the provisioning information with the contracted M2M Service Provider. The M2M Service Provisioning takes place between an M2M Node (without provisioned CSE) and an M2M Service Provider via an M2M enrolment function. As a result of provisioning, M2M Nodes are provided with necessary credentials and possibly other M2M service related parameters (e.g. CSE-ID, M2M-Sub-ID). The first step of M2M service provisioning is the security provisioning procedure, by which M2M service provider specific credentials are either shared between two M2M Nodes, or shared between the M2M Node in the field domain and an M2M authentication function in the infrastructure. Authenticated M2M Nodes can then be associated with an M2M Service Subscription used to determine their specific authorizations. The following security provisioning scenarios are supported by the oneM2M architecture: • Pre-provisioning: - Pre-provisioning includes all forms of out-of-band provisioning, e.g. provisioning M2M Nodes with M2M subscription information during the manufacturing stage. • Remote provisioning: - Remote provisioning relies on pre-existing credentials in M2M Nodes (e.g. digital certificates or network access credentials) to provision subscription related parameters through a secure session with an M2M Enrolment Function. This form of provisioning enables M2M Nodes already in the field (e.g. operational M2M Nodes) to be provisioned with M2M Service subscription. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 482 (oneM2M TS-0001 version 4.15.0 Release 4) - When supported, remote provisioning procedure shall be implemented as described in the ETSI TS 118 103 [2]. - Following M2M service provisioning, the provisioned entity securely stores credentials used for authentication, with an associated lifetime (e.g. corresponding to the duration of the contractual agreement embodied by the M2M service subscription). |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.2.2 M2M Application Enrolment | This procedure is an optional step that enables the M2M SP and/or M2M Application provider to control which M2M Applications are allowed to use the M2M services. It assumes that the M2M Application is associated of a credential used for controlling authorization to M2M services The security credential associated with the App-ID or AE-ID may be used to grant specific authorization to M2M Application instances to access an approved list of M2M services, or revoke access to all instances of undesirable M2M Applications. Such authorization shall take place between registrar CSE and AE as specified in the present document and the ETSI TS 118 103 [2]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.3 M2M Operational Security Procedures | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.3.0 Overview | This clause introduces the high level procedures, following M2M Enrolment, that shall be performed before any other procedure on Mcc and Mca can take place. These procedures shall be implemented as specified in the ETSI TS 118 103 [2]. NOTE: The detailed specifications of the security procedures in ETSI TS 118 103 [2] uses different labels for the steps shown in figures 11.3.0-1 and 11.3.0-2: Step 1: Provisioning maps to Credential Configuration; Step 2: Identification maps to Association Configuration; Step 3: Authentication maps to Association Handshake in ETSI TS 118 103 [2]. Secure Session established No Security Association between Registree CSE or AE and Registrar CSE Registree CSE or AE Registrar CSE 2. Identification: Registrar CSE-ID, (in some cases) other non-secret security parameters 2. Identification: (in some cases) other non-secret security parameters 3. Authentication: using credential(s) from Step 1 and (in some cases) non-secret security parameters from Step 2. 1. Provisioning: Pre- provisioning or remote security provisioning of credential to Registree CSE 1. Provisioning: Pre-provisioning or remote security provisioning of credential to Registrar CSE Secure session associated w/ Registrar CSE-ID from step 1. Security session associated w/ m2mServiceSubscriptionProfile and (if provided to Registrar CSE) previously assigned Registree CSE-ID or AE-ID 4. Any procedure applicable on Mcc or Mca including Authorization Figure 11.3.0-1: High Level Procedures on Mcc or Mca without MAF ETSI ETSI TS 118 101 V4.15.0 (2022-09) 483 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 11.3.0-2: MAF assisted High Level Procedures on Mcc or Mca |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.3.1 Identification of CSE and AE | Once a CSE or AE is provisioned with its security credentials, there is no need to configure long-term secret information to the CSE or AE. However, additional non-secret information may need to be configured using the same security procedures. Prior to a CSE or AE initiating security association establishment, the Registree CSE or AE is configured with the Registrar CSE-ID so that the Registree knows who to establish the security association with. This process is called "Association Configuration" in ETSI TS 118 103 [2]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.3.2 Authentication and Security Association of CSE and AE | The association security handshake (see ETSI TS 118 103 [2]) provides: a) mutual authentication of CSE and AE; and b) session key derivation. Prior to granting access to M2M services, the credentials resulting from the M2M Node and M2M application enrolment procedures shall be used, together with the information supplied in the identification step (clause 11.1), to perform mutual authentication of the Registree CSE or AE with the Registrar CSE. Upon mutual authentication: • Registree CSE or AE associates, with the Registrar CSE, the CSE-ID supplied in the identification step (clause 11.1). • If the Registree CSE or AE has previously registered successfully with the Registrar CSE and the Registrar CSE has retained the applicable M2M service subscription and CSE-ID or AE-ID, then the Registrar CSE can use this information. • In other cases, the Registrar CSE determines the applicable M2M service subscription and CSE-ID or AE-ID as described in clause 10.2.2 in the present document. The Registree receives authorization to access the M2M services defined in the <m2mServiceSubscription> resources by checking privileges defined in <accessControlPolicy>, <token> or <role> resources. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 484 (oneM2M TS-0001 version 4.15.0 Release 4) NOTE: The authorization procedure to access the M2M services is further described in clause 11.3.4 and specified in detail in clause 7 of ETSI TS 118 103 [2]. Session keys are then derived for providing desired security services to the communicating entities, such as confidentiality and/or integrity of information exchange (these security services may be provided through establishment of a secure channel between the communicating entities or through object based security where only relevant information is encrypted prior to being shared). The lifetime of a security association shall be shorter than the lifetime of the credential used for authentication from which it is derived: It may be valid for the duration of a communication session, or be determined according to the validity period of the protected data. In case of a security association between two AEs, the lifetime of the security association can result from a contractual agreement between the subscribers of the communicating AEs. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.3.3 M2M Authorization Procedure | The M2M authorization procedure controls access to resources and services by CSEs and AEs. This procedure requires that the Originator has been identified, mutually authenticated and associated with an M2M Service Subscription. Authorization depends on: • These privileges are set-up based on the access control policies associated with the accessed resource or service. They condition the allowed operations (e.g. CREATE) based on the Originator's privileges and other access control attributes (e.g. contextual attributes such as time or geographic location). • Role-IDs which have been associated with the Originator. The authorization/access grant involves an Access Decision step to determine what the authenticated CSE or AE can actually access, by evaluating applicable access control policies based on the CSE or AE privileges. Access Decision is described in ETSI TS 118 103 [2]. The following set of access control policy attributes shall be available for an Access Decision: • Access control attributes of Originator and Originator's Role (e.g. Role-IDs, CSE_IDs, AE-IDs, etc.). • Access control attributes of Environment/Context (e.g. time, day, IP address, M2M Service User, etc.). • Access control attributes of Operations (e.g. Create, Execute, etc.). • Access control attributes of Resources (e.g. a list of accessible attributes for a targeted resource, etc.). The M2M Service Provider/administrator and custodian of resources are responsible to establish access control policies that determine by whom, in what context and what operations may be performed upon those resources. The access control policies can also be established that determine the accessibility of individual attributes of resources. If the request satisfies the access control policy, then the access to the resource or individual attributes of the resource is granted. Dynamic Authorization: Dynamic Authorization encompasses: a) authorizing the creation of a limited-lifetime access control policy authorizing the Originator to perform specific operations on the requested resource; and b) issuing limited-lifetime Tokens associating the Originator with Role-IDs and/or access control policies for identified resources. Two forms of Dynamic Authorization are supported: Direct Dynamic Authorization and Indirect Dynamic Authorization. In the event that the request does not satisfy any of the custodian's access control policies, then Dynamic Authorization may be requested from Dynamic Authorization System (DAS) Servers; this is called Direct Dynamic Authorization, and relevant details are provided clause 11.5.2. The request is then re-evaluated to determine if the custodian's access control policy is now satisfied and access is granted. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 485 (oneM2M TS-0001 version 4.15.0 Release 4) If access is still denied, then the Originator is provided with Token Request Information used to request the issuance of Tokens by a Dynamic Authorization System. A Token identifies Role-IDs and/or access control policies (for identified resources) which have been temporarily associated with the Originator. The Originator then resends the request from the Originator, this time adding any Token or Token-IDs received from the Dynamic Authorization System. This is called Indirect Dynamic Authorization, and relevant details are provided clause 11.5.3. NOTE: A DAS Server can be triggered, by Dynamic Authorization, to update the access control policy configuration using oneM2M request primitives. In the event that the requesting entity does not satisfy the custodian's access control policy, a Hosting CSE shall check to see if the resource (or one of its parents) has a dynamicAuthorizationConsultationIDs which links to a valid <dynamicAuthorizationConsultation> resource. If there is no valid <dynamicAuthorizationConsultation> resource or if the dynamicAuthorizationEnabled attribute is set to "false", then then the Hosting CSE shall not attempt to perform direct dynamic authorization on behalf of the requesting entity. However, if there is a valid <dynamicAuthorizationConsultation> resource available and if the dynamicAuthorizationEnabled attribute is set to "true", then the Hosting CSE shall initiate a direct dynamic authorization request to the specified dynamicAuthorizationPoA. If direct dynamic authorization results in sufficient privileges being granted to the requesting entity, the Hosting CSE shall grant it access. In addition the Hosting CSE may also dynamically create a new access control policy and configure it with the granted privileges along with any specified lifetime associated with the privileges based on a resource creation process initiated by the dynamic authorization system. This function shall fetch the subscription related information in order to check if a Role-ID used in a request is allowed by the M2M service subscription. The authorization procedure shall be implemented as specified in the ETSI TS 118 103 [2]. Distributed Authorization A distributed authorization system may comprise four functional components: Policy Enforcement Point (PEP), Policy Decision Point (PDP), Policy Retrieval Point (PRP) and Policy Information Point (PIP). A PEP that coexists with the Hosting CSE enforces the access control decision. PDP, PRP and PIP are responsible for making access control decisions, providing applicable access control policies and obtaining access control information required by access control policy evaluation procedures respectively. In a distributed authorization system these components may be distributed in different CSEs. Details of these components are described in ETSI TS 118 103 [2]. Three resource types are defined for representing PDPs, PRPs and PIPs: <authorizationDecision>, <authorizationPolicy> and <authorizationInformation>. For details about these resource types see clauses 9.6.41, 9.6.42 and 9.6.43. Three attributes are defined in the <accessControlPolicy> resource type for providing the addresses of PDPs, PRPs and PIPs: authorizationDecisionResourceIDs, authorizationPolicyResourceIDs and authorizationInformationResourceIDs. For details about these resource attributes see clause 9.6.2. A high level description of the distributed authorization framework and procedures is provided in clause 11.6. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.3.4 M2M Service User Authentication | Once a security association is established between a Registrar CSE and a Registree AE, the resulting secure session may be used to secure messages that are exchanged between one or more M2M Service Users and a Registrar CSE for the purpose of authenticating the M2M Service Users associated with the Registree AE. Authentication of an M2M Service User allows the Registrar CSE to verify that the M2M Service User knows its M2M-User-ID and corresponding credential. There are many well-known methods for performing user-based authentication. Some examples, include HTTP username:password based authentication, LDAP based authentication, multifactor authentication, etc. The selection of which method to use typically depends on deployment requirements. For this reason, the definition of this message exchange is out of scope of the present document. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 486 (oneM2M TS-0001 version 4.15.0 Release 4) Once a M2M Service User is authenticated and its M2M-User-ID is trusted, the Registrar CSE shall check whether the M2M Service User is authorized to access the Registrar CSE via the Registree AE's established security association. The Registrar CSE shall first check the allowedUsers attribute of the Registree AE's <serviceSubscribedAppRule> resource. If configured, the Registrar CSE shall check each <serviceSubscribedUserProfile> resource referenced by allowedUsers. For each <serviceSubscribedUserProfile> resource, the Hosting CSE shall check the M2M-User-ID attribute to see if a match to the M2M-User-ID of the authenticated M2M Service User is found. If a match is found, then the Registrar CSE shall accept and process requests from the M2M Service User via the Registree AE's established security association. For each request the Registrar CSE receives via the Registree AE's established security association, the Registrar CSE shall check that the From parameter matches the AE-ID of the authenticated AE and the M2M Service User parameter matches the M2M-User-ID of the authenticated M2M Service User. The Registrar CSE shall reject requests that it receives from unauthenticated or unauthorized M2M Service Users. 11.4 Functional Architecture Specifications for End-to-End Security Procedures 11.4.1 Functional Architecture Specifications for End-to-End Security of Data (ESData) End-to-End Security for Data (ESData) provides an interoperable framework for protecting data that ends up transported using oneM2M reference points, in order that so transited CSEs do not need to be trusted with that data. The data shall comprise either: • All or part of the value of a single attribute (e.g. content attribute value of a <contentInstance> resource or customAttribute of a <flexContainer> resource) or a single addressable element within the attribute. • All or part of a single primitive parameter value (e.g. a signed, self-contained access token communicated in a request primitive to obtain dynamic authorization). 11.4.2 Functional Architecture Specifications for End-to-End Security of Primitives (ESPrim) End-to-End Security for Primitives (ESPrim) provides an interoperable framework for securing oneM2M primitives so CSEs do not need to be trusted with the confidentiality and integrity of the primitive. ESPrim provides mutual authentication, confidentiality, integrity protection and a freshness guarantee (bounding the age of secured primitives). The credential management aspects and data protection aspects for ESPrim are specified in ETSI TS 118 103 [2]. The present clause specifies the transport of secured primitives. The primitive to be secured is called the inner primitive, and the primitive which is used to transport a secured inner primitive is called the outer primitive. The inner primitive is protected using an encryption and integrity protection, which takes a symmetric key sessionESPrimKey as input. The sessionESPrimKey is derived from a pairwiseESPrimKey, established between the Originator and Receiver, and a receiverESPrimRandObject and originatorESPrimRandObject. The receiverESPrimRandObject and originatorESPrimRandObject are specified in ETSI TS 118 103 [2]. The transport details for the ESPrim Procedure are shown in figures 11.4.2-1 and 11.4.2-2, and described in the following text. NOTE 1: The outer primitive is not acting on resources because the outer primitive is only used to transport the ESPrim object securing the inner primitive. This is the reason that the NOTIFY procedure is used for the outer primitive. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 487 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 11.4.2-1: The transport details for establishing pairwiseESPrimKey and establishing sessionESPrimKey in the End-to-End Security of Primitives (ESPrim) Procedure This message flow shows the sequence of events for Blocking Mode: A. Establishing pairwiseESPrimKey: The pairwiseESPrimKey shall be established as specified in clause 8.4.2 "End-to-End Security of Primitives (ESPrim) Architecture" in ETSI TS 118 103 [2]. B. Establishing sessionESPrimKey: The Receiver shall select to either (a) pre-generate a receiverESPrimRandObject which is distributed for used by multiple Originators for establishing sessionESPrimKey, or (b) generate a unique receiverESPrimRand Object upon request (in which case no action is required prior to receiving such a request). B.1. (Optional) Receiver pre-generates and distributes receiverESPrimRandObject. If the Receiver selected to pre-generate and distribute a receiverESPrimRandObject, the Receiver performs the following steps every time the Receiver wishes to provide a new shared receiverESPrimRandObject: B.1a The Receiver shall generate a receiverESPrimRandObject as described in ETSI TS 118 103 [2]. B.1b The Receiver shall update the Receiver's <remoteCSE> or <AE> resource on all CSEs to which the Receiver is registered, with the sharedReceiverESPrimRand Object parameter of the e2eSecInfo attribute containing the generated receiverESPrimRandObject. In the latter case, the Receiver shall ensure that the sharedReceiverESPrimRandObject parameter is not present in the e2eSecInfo attribute in the Receiver's <remoteCSE> or <AE> resource on all CSEs to which the Receiver is registered. The absence of the sharedReceiverESPrimRand Object parameter indicates that the Receiver will provide a unique receiverESPrimRand Object upon request. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 488 (oneM2M TS-0001 version 4.15.0 Release 4) B.2. Originator obtains receiverESPrimRandObject: B.2a The Originator shall perform a Retrieve on the e2eSecInfo attribute in the Receiver's <remoteCSE> or <AE> resource on a CSE, here denoted CSE2, with which the Receiver is registered. B.2b If the e2eSecInfo attribute is present in the Receiver's <remoteCSE> or <AE> resource on CSE2, then CSE2 shall returns the e2eSecInfo attribute. Otherwise CSE2 shall return an appropriate error message. B.2c (This step is also described in ETSI TS 118 103 [2]. Where there is a conflict, ETSI TS 118 103 [2] is to be treated as the authoritative description). The Originator determines if the Receiver supports ESPrim, which requires that the e2eSecInfo attribute is present and the e2eSecInfo attribute indicates support for ESPrim. B.2c.1 If the Receiver does not support ESPrim, then the Originator aborts the procedure. B.2c.2 If the Receiver supports ESPrim, and the e2eSecInfo attribute includes a sharedReceiverESPrimRandObject parameter, then the Originator shall examine the ESPrimRandExpiry in this parameter to determine if the sharedReceiverESPrimRandObject has expired. If the sharedReceiverESPrimRandObject has not expired, then the Originator sets receiverESPrimRandObject to the value of receiverESPrimRandObject and proceeds to step B.2g. If the sharedReceiverESPrimRandObject has expired, then the Originator sets receiverESPrimRandObject to the value of receiverESPrimRandObject and proceeds to step B.2d. B.2c.3 If the Receiver supports ESPrim, and the e2eSecInfo attribute does not include a sharedReceiverESPrimRandObject parameter, then the Originator proceeds to step B.2d. B.2d The Originator shall send a NOTIFY request to the Receiver with the To parameter set to the address of the Receiver's <CSEBase> or <AE> resource, and the securityInfo Type element of the securityInfo object in the Content indicating that this NOTIFY request is a "receiverESPrimRandObject request". NOTE 2: When the Receiver is a CSE, the Originator can use the Receiver's CSE-ID followed by "/." as the address of the Receiver's <CSEBase>. B.2e The Receiver, upon receiving such a NOTIFY request, shall generate a receiverESPrimRandOject as described in ETSI TS 118 103 [2]. B.2f The Receiver shall send a NOTIFY response to the Originator with the securityInfoType element of the securityInfo object in the Content indicating that this is a "receiverESPrimRandObject request" and containing the receiverESPrimRandObject. B.2g The Originator shall generate an originatorESPrimRandObject as described in clause 8.4.2 of ETSI TS 118 103 [2]. B.2h The Originator shall generate the sessionESPrimKey from the pairwiseESPrimKey, originatorESPrimRandTuple and receiverESPrimRandObject as described in clause 8.4.2 of ETSI TS 118 103 [2]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 489 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 11.4.2-2: The transport details for Securing a Primitive Exchange in the End-to-End Security of Primitives (ESPrim) Procedure This message flow shows the sequence of events for Blocking Mode: C. Securing a Primitive Exchange C.1 The Originator selects the object security technology as described in clause 8.4.2 of ETSI TS 118 103 [2]. C.2 The Originator shall form the serialization of the inner request primitive. C.3 The Originator shall produce a ESPrim Object from the serialization of the inner request primitive by applying the selected object security technology using the established parameters, as described in clause 8.4.2 of ETSI TS 118 103 [2]. C.4 The Originator shall send the ESPrim Object to the Receiver in the securityInfo object in the Content of an outer request primitive, and including the indication that securityInfo contains an ESPrim Object. The outer request primitive shall be a NOTIFY request primitive with To set to the address of the Receiver's <CSEBase> or <AE> resource. See note 2. The parameters of the outer request primitive shall be assigned as described in table 11.4.2-1. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 490 (oneM2M TS-0001 version 4.15.0 Release 4) C.5 The Receiver shall process the outer request primitive as for normal NOTIFY request primitives. The Receiver shall extract securityInfo, process the indication that it contains an ESPrim Object, and extract the ESPrim Object containing the secured inner request primitive. C.6 The Receiver shall process the ESPrim Object according to the indicated object security technology resulting in the verified serialization of the inner request primitive. This processing is described in clause 8.4.2 of ETSI TS 118 103 [2]. C.6a If this processing is unsuccessful, then the Receiver shall generate an error message: C.6a.1 If the Receiver knows a currently valid sessionESPrimKey previously established with the Originator, then the receiver shall secure the error message using ESPrim as described in clause 8.4.2 of ETSI TS 118 103 [2]. In this case the message flow skips to step C.9. C.6a.2 If Receiver does not know a currently valid sessionESPrimKey previously established with the Originator, then the Receiver shall send a NOTIFY response with the (unsecured) error message in the Content parameter. The Originator processes the response as for a normal error case. C.7 The Receiver shall process the inner request primitive, resulting in a serialization of the corresponding inner response primitive. NOTE 3: Steps C.3 to C.7 are mirrored closely by C.10 to C.16, with the Originator and Receiver swapping their participation in the exchange, and the request primitives replaced by response primitives. C.8 The Receiver shall produce a ESPrim Object from the serialization of the inner response primitive by applying the selected object security technology using the established parameters, as described in clause 8.4.2 of ETSI TS 118 103 [2]. C.9 The Receiver shall send the ESPrim Object to the Originator in the securityInfo object of an outer response primitive, including the indication that securityInfo contains an ESPrim Object. The outer response primitive shall be a NOTIFY response primitive. The parameters of the outer request primitive shall be assigned as described in table 11.4.2-2. C.10 The Originator shall process the outer response primitive as for normal NOTIFY response primitives. The Originator shall extract the securityInfo object, process the indication in securityInfoType that securityInfo contains an ESPrim Object, and extract the ESPrim Object containing the secured inner response primitive. C.11 The Originator shall process the ESPrim Object according to the indicated object security technology resulting in the verified serialization of the inner response primitive or an error message. This processing is described in clause 8.4.2 of ETSI TS 118 103 [2]. C.12 The Originator shall process the inner response primitive or error message. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 491 (oneM2M TS-0001 version 4.15.0 Release 4) Table 11.4.2-1: NOTIFY Request Message Parameters when using ESPrim Request message parameter Mandatory/ Optional for ESPrim Details Mandatory Operation - operation to be executed M NOTIFY To - the address of the target resource on the target CSE M Address of the Receiver's <CSEBase> or <AE> resource From - the identifier of the message Originator M Request Identifier - uniquely identifies a Request message M May be independent of the Request Identifier of the inner request primitive Operation dependent Content - to be transferred NP Resource Type - of resource to be created N/A N/A Optional Originating Timestamp - when the message was built O Time when the outer request primitive was built Request Expiration Timestamp - when the request message expires O Copied from the corresponding parameter in the inner request primitive Result Expiration Timestamp - when the result message expires O Copied from the corresponding parameter in the inner request primitive Operational Execution Time - the time when the specified operation is to be executed by the target CSE N/A The operation execution here is the cryptographic operations performed by the Receiver, which shall be executed immediately Response Type - type of response that shall be sent to the Originator O Any mode may be applied. Result Persistence - the duration for which the reference containing the responses is to persist N/A N/A for NOTIFY Result Content - the expected components of the result N/A The result content here is the Result Content of the outer primitive, which is always ESPrim Object Event Category - indicates how and when the system should deliver the message O Copied from the corresponding parameter in the inner request primitive Delivery Aggregation - aggregation of requests to the same target CSE is to be used O Copied from the corresponding parameter in the inner request primitive Group Request Identifier - Identifier added to the group request that is to be fanned out to each member of the group N/A This parameter may be present in the inner request primitive, but shall not be present in the outer primitive Filter Criteria - conditions for filtered retrieve operation N/A N/A for NOTIFY Desired Identifier Result Type - format of resource identifiers returned N/A N/A for NOTIFY ETSI ETSI TS 118 101 V4.15.0 (2022-09) 492 (oneM2M TS-0001 version 4.15.0 Release 4) Table 11.4.2-2: NOTIFY Response Message Parameters when using ESPrim Response message parameter/success or not Mandatory/ Optional for ESPrim Details Request Identifier - uniquely identifies a Request message M Matches corresponding parameter in outer request primitive Content - to be transferred NP ESPrim Object To - the identifier of the Originator or the Transit CSE that sent the corresponding non-blocking request O As for NOTIFY From - the identifier of the Receiver O As for NOTIFY Originating Timestamp - when the message was built O Time when the outer request primitive was built Result Expiration Timestamp - when the message expires O Copied from the corresponding parameter in the inner request primitive Event Category - what event category shall be used for the response message O Copied from the corresponding parameter in the inner request primitive Content Status N/A N/A for NOTIFY Content Offset N/A N/A for NOTIFY 11.4.3 Functional Architecture Specifications for Direct End-to-End Security Certificate-based Key Establishment (ESCertKE) The ESCertKE procedure comprises the exchange of TLS handshake protocol parameters in four ESCertKE Messages, specified in ETSI TS 118 103 [2]. The AE or CSE initiating the procedure is the Initiating End-Point and the Terminating End-Point is the AE or CSE with which the ESCertKE Initiating End-Point intends to establish the pairwiseE2EKey. If an AE or CSE supports ESCertKE, then an indication shall be present in the e2eSecInfo attribute in an AE's <AE> resource, or a CSE's <CSEBase> resource or a CSE's <remoteCSE> resource. The ESCertKE messages and associated processing for ESCertKE are specified in clause 8.7 "End-to-End Certificate- based Key Establishment (ESCertKE)" in ETSI TS 118 103 [2]. The transport details for the ESCertKE Procedure are shown in figure 11.4.3-1, and described in the following text. NOTE: The outer primitive is not acting on resources because the outer primitive is only used to transport the ESCertKE messages. This is the reason that the NOTIFY procedure is used for the outer primitive. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 493 (oneM2M TS-0001 version 4.15.0 Release 4) Figure 11.4.3-1: The transport details for the ESCertKE Procedure A. Provisioning Certificates: Each End-Points shall be provisioned with their own private keys and corresponding certificate and optional certificate chain. B. Triggering: The Initiating End-Points decide to initiate the ESCertKE procedure with an identified Terminating End-Point. C. Establishing pairwiseE2EKey C.1 The Initiating End-Point and Terminating End-Point exchange the sequence of four ESCertKE Messages specified in clause 8.7 "End-to-End Certificate-based Key Establishment" in ETSI TS 118 103 [2]. The ESCertKE Messages are exchange in two sequential NOTIFY procedures: C.1a ESCertKE Message 1 is sent in a first NOTIFY request from the Initiating End-Point to the End- Point. The Terminating End-Point records the identity of the Initiating End-Point in the From primitive parameter. C.1b ESCertKE Message 2 is sent in the resulting NOTIFY response from the Terminating End-Point to the Initiating End-Point. C.1c ESCertKE Message 3 is sent in a second NOTIFY request from the Initiating End-Point to the End- Point. The Terminating End-Point shall correlate this ESCertKE message with the corresponding ESCertKE Message 1 using the identity of the Initiating End-Point in the From primitive parameter. C.1.d ESCertKE Message 4 is sent in the resulting NOTIFY response from the Terminating End-Point to the Initiating End-Point. The parameters of the NOTIFY primitives shall be assigned as per normal, with the following details specific to ESCertKE: - securityInfo Type: indicating that the Content contains an ESCertKE Message. - Content: an ESCertKE Message. C.2 If the TLS handshake protocol is successful, then the Initiating and Terminating End-Points shall generate and cache a pairwiseE2EKey as described 8.7 "End-to-End Certificate-based Key Establishment" in ETSI TS 118 103 [2]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 494 (oneM2M TS-0001 version 4.15.0 Release 4) 11.5 Functional Architecture Specifications for Dynamic Authorization |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.5.1 Dynamic Authorization Reference Model | The Dynamic Authorization reference model is shown in figure 11.5.1-1. Figure 11.5.1-1: Dynamic Authorization reference model The Dynamic Authorization reference model introduces the following systems and entities: • Dynamic Authorization System (DAS): A system supporting dynamically authorization on behalf of resources custodians. The present document does not describe the processing and exchange of messages within the Dynamic Authorization System. This system may reside either internally or externally within the service provider network. • Dynamic Authorization System (DAS) Server: A server configured with policies for dynamic authorization, and provided with credentials for issuing Tokens. The DAS Server may include an AE for interaction with the oneM2M system. The following Dynamic Authorization procedures are specified: • Direct Dynamic Authorization, summarized in figure 11.5.1-2. In this procedure, Hosting CSE interacts with the DAS Server to obtain Dynamic Authorization. When AE, Hosting CSE and the DAS server support to create the Authorization Relationship Mapping Record, steps 5 - 7 will be applied. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 495 (oneM2M TS-0001 version 4.15.0 Release 4) Originator (AE/CSE) Hosting CSE 1: Original request 2: Request to DAS Server: original request parameters, (opt) Role-IDs 4: Make access control decision DAS Server AE 3: Response from DAS Server: (opt) dynamicACPInfo, (opt) Token(s), (opt)AuthorSignReqInfo 5:Response: Token(s) or TokenID(s), (opt)Author SignReqInfo (opt)6:Send AuthorSign, Token(s) or TokenID(s) (opt)7: Request: AuthorSign, Token(s) or TokenID(s) Figure 11.5.1-2: Direct Dynamic Authorization • Indirect Dynamic Authorization, summarized in figure 11.5.1-3: - Steps 1 - 2: The Hosting CSE may provide the Originator with Token Request Information in the unsuccessful response. - Step 3: The Originator interacts with the DAS Server with the intention that the DAS Server issue Tokens authorizing the Originator, and the Originator is provided with the Token or a Token-ID. If the Originator is an AE, whose AE-ID-Stem is assigned by the registrar CSE, and both AE and DAS server support to create the Authorization Relationship Mapping Record, the DAS Server shall request the AE to create the authorization relationship mapping record. The interaction is not described in the present specification. - Step 4: If the DAS Server starts the process of Authorization Relationship Mapping Record creation in step 3, the AE shall request to create the Authorization Relationship Mapping Record in the DAS Server. - Steps 5 - 8: The Originator provides the Hosting CSE with a Token, Token-ID to indicate that the Token is to be considered in the access decision. In the case of a token-ID, the Hosting CSE retrieves the corresponding Token via an AE of the DAS Server. These are then used in the access decision. If the Authorization Relationship Mapping Record is created in step 4, the originator shall also indicate the related information to the Hosting CSE. The Hosting CSE may provide the Originator with a Local- Token-ID may be used to identify the Token. Figure 11.5.1-3: Indirect Dynamic Authorization ETSI ETSI TS 118 101 V4.15.0 (2022-09) 496 (oneM2M TS-0001 version 4.15.0 Release 4) |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.5.2 Direct Dynamic Authorization | The parameters exchanged for Direct Dynamic Authorization, and the corresponding processing, are specified in clause 7.3.2.2 of ETSI TS 118 103 [2]. The present clause specifies the transportation of parameters when oneM2M primitives are used. The step numbers are aligned with the procedure in clause 7.3.2.2, ETSI TS 118 103 [2]. Further details for each step in the present clause can be obtained by examining the corresponding steps in clause 7.3.2.2 of ETSI TS 118 103 [2]. The message flow for Direct Dynamic Authorization is shown in figure 11.5.2-1, and described in the following text. This call flow assumes that the Hosting CSE has already received the resource access request from the Originator. Hosting CSE DAS Server 2.1. Performs access decision unable to grant access for original request 2.2. Obtain DAS Server dynamicAuthoriztionPoA and collect Role-Ids (if any). 2.3. NOTIFY Request to DAS Server dynamicAuthoriztionPoA , securityInfoType = Direct Dynamic Authorization securityInfo object in Content includes original request parameters, (optional) Role-IDs 3.2. NOTIFY Response securityInfoType = Direct Dynamic Authorization securityInfo object in Content includes (opt) dynamicACPInfo (opt) Token(s) (opt)AuthorSignReqInfo 4.1. Process (opt) dynamicACPInfo, (opt) Token(s) 4.2. Repeat access decision 4.3. If access is granted, requested operation is performed Steps 3.1: Dynamic Authorization can include issue Token(s) &/or generate dynamicACPInfo AE AE Originator 1. Original request 5.Response: Token(s) or TokenID(s), (opt)AuthorSignReqInfo (opt) 6.1. Generate AuthorSign(s) from Token(s) or TokenID(s); (opt)6.2. NOTIFY Resquest: securityInfoType = Authorization Relationship Mapping security object in Content includes Token(s) or TokenID(s), AuthorSign AE (opt)7. NOTIFY Resquest to DAS Server DynamicAuthorizationPoA, securityInfoType = Authorization Relationship Mapping security object in Content includes Token(s) or TokenID(s), AuthorSign AE Reponse Reponse (opt)8. Create AuthorRelMapRecord Figure 11.5.2-1: Message flow showing transport details for Direct Dynamic Authorization • The Originator sends request (called the request from the Originator for this message flow) to the Hosting CSE. This request may include Tokens, Token IDs or LocalToken IDs; see the clause 11.5.3 "Indirect Dynamic Authorization". • Initial Hosting CSE processing: 2.1 If the request from the Originator includes Token, Token IDs s or Local Token IDs then these are processed as described in clause 11.5.3 "Indirect Dynamic Authorization". The Hosting CSE evaluates the access decision algorithm, but is unable to grant access for the request from the Originator based on configured access control policies. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 497 (oneM2M TS-0001 version 4.15.0 Release 4) 2.2 The Hosting CSE examines the <accessControlPolicy> resources and <dynamicAuthorizationConsultation> resources to obtain the DAS Server dynamicAuthorizationPoA with which it may perform Direct Dynamic Authorization. The Hosting CSE selects a DAS Server and forms the set of applicable Role-IDs (if any) to send to the corresponding DAS Server. 2.3 The Hosting CSE shall send a Notify request primitive to the DAS Server AE, with the following details specific to Direct Dynamic Authorization: The securityInfo Type element shall indicate that the Notify request primitive is for Direct Dynamic Authorization. The Content parameter shall contain information that the DAS Server can use in deciding what Dynamic Authorizations should be applied. This information includes primitive parameters from the request from the Originator and the set of applicable Role-IDs (if any). clauses 7.3.2.2, ETSI TS 118 103 [2] lists the primitive parameters to be included. • DAS Server processing: 3.1 The DAS Server shall extract and parse the Content parameter of the received message. The DAS Server may issue Token(s) and/or generate dynamicACPInfo which will be used by the Hosting CSE to create a dynamic <accesscontrolPolicy> resource. 3.2 The DAS Server shall send a Notify response primitive via the DAS Server AE to the Hosting CSE, with the following details specific to Direct Dynamic Authorization: The securityInfo Type element shall indicate that the Notify response primitive is for Direct Dynamic Authorization. If step 3.1 resulted in a Token(s) and/or dynamicACPInfo parameter, then these parameters shall be included in the Content parameter, otherwise the Content parameter shall not be present. In the case the DAS Server issues a Token(s), if in the step 3.1 DAS Server extracts the AuthorSignIndicator from the received message and the DAS server itself also supports to trigger creating the authorization relationship mapping record, an AuthorSignReqInfo shall be included in the Content parameter. • Hosting CSE Processing: 4.1 The Hosting CSE shall process the Content parameter (if present) of the NOTIFY Response from the DAS Server: The Hosting CSE shall verify and cache the Token(s) in the list (if present), described in clause 7.3.2.2 of ETSI TS 118 103 [2]. The Hosting CSE shall create a dynamic <accessControlPolicy> resource from dynamicACPInfo (if present). 4.2 The Hosting CSE repeats the access decision mechanism. 4.3 If access is granted, then the Hosting CSE performs the operation requested in the request from the Originator. • If in the step 4.1, the Hosting CSE gets AuthorSignReqInfo from the Content parameter, the Hosting CSE shall forward AuthorSignReqInfo in a response primitive to Originator to request the AuthorSign. If the AuthorSignReqInfo is not included in the Content, then the steps 6-8 are not applied. • Originator Processing: 6.1 If the Originator receives AuthorSignReqInfo, it shall generate AuthorSign for each Token. How the AuthorSign are generated is described in clause 7.3.2.2 of ETSI TS 118 103 [2]. 6.2 The Originator shall send a Notify request primitive to the Hosting CSE, with the following details: The securityInfo Type element shall indicate that the Notify request primitive is for Authorization Relationship Mapping. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 498 (oneM2M TS-0001 version 4.15.0 Release 4) AuthorSign with the corresponding Token(s) or TokenID(s) shall be included in the Content parameter. • The Hosting CSE Processing shall forward this Notify request primitive to the DAS Server AE. • The DAS server AE shall create authorization relationship mapping record using the AuthorSign described in clause 7.3.2.2 of ETSI TS 118 103 [2]. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.5.3 Indirect Dynamic Authorization | The parameters exchanged for Indirect Dynamic Authorization, and the corresponding processing, are specified in clause 7.3.2.3 of ETSI TS 118 103 [2]. The present clause specifies the transportation of parameters when oneM2M primitives are used. Further details for each step in the present clause can be obtained by examining the corresponding steps in clause 7.3.2.3 of ETSI TS 118 103 [2]. The message flow for the Indirect Dynamic Authorization Procedure is shown in figure 11.5.3-1, and described in the following text. Hosting CSE DAS Server (opt) 2.1. Performs access decision. Unable to grant access for original request (opt) 2.2. Form Token Request Info from identified DAS Server and Role-IDs (if any). 6.1 NOTIFY Request to DAS Server dynamicAuthorizationPoA, securityInfoType = Indirect Dynamic Authorization securityInfo object in Content includes Token-ID(s) 6.2. NOTIFY Response securityInfoType = Indirect Dynamic Authorization securityInfo object in Content includes ESData- protected Token(s) AE AE Originator (opt) 1. Original request 8. Response (opt) Assigned Token Identifiers (opt) 2.3 Unsuccessful Response Token Request Information (opt) 2.4 Select a DAS Server from Token Request Information 3. Originator requests DAS Server issue Tokens, optionally using information from Token Request Information. DAS Server provides Originator with Token-ID(s), and optionally ESData-protected Token(s) and/or other parameters from Token and optionally AuthorSignreq.Details of this exchange are not specified in the present specification. 5. Repeat request, adding new ESData-protected Tokens to Tokens or Token-ID(s) to Token IDs, (opt)AuthorRelIndicator 7.1 Verify Tokens. 7.2 (optional) Assign Local-Token-IDs to Tokens. Add (Local-Token-ID, Token-ID) mapping to Assigned Token Identifiers parameter 7.3 Perform access decision. If access is granted, requested operation is performed (opt)4.3 create AuthorRelMapRecord(s) (opt)4.2 Originator requests DAS Server create AuthorRelMapRecord(s) for each Token or each TokenID using the AuthorSign. (opt)4.1 Generate AuthorSign for each Token or each TokenID. Figure 11.5.3-1: Message flow for Indirect Dynamic Authorization ETSI ETSI TS 118 101 V4.15.0 (2022-09) 499 (oneM2M TS-0001 version 4.15.0 Release 4) • (Optional) The Originator sends request to the Hosting CSE. This request may include Tokens, Token IDs or Local Token IDs, but this message flow assumes that these do not provide sufficient permissions for accessing the requested resource. • (Optional) Initial Hosting CSE processing: 2.1 Hosting CSE performs the access decision for the request from the Originator. This call flow assumes that the request from the Originator is denied as a result of the access decision. 2.2 The Hosting CSE forms the Token Request Information primitive parameter. 2.3 The Hosting CSE shall send, to the Originator, an unsuccessful resource access response with the following details specific to the Indirect Dynamic Authorization procedure: The Response Status Code shall be set to "UNAUTHORIZED". The Token Request Information primitive parameter shall be included. 2.4 The Originator selects a DAS Server identified in Token Request Information primitive parameter. • The Originator shall interact with the DAS Server to request the issuance of one or more Tokens. The Originator can provide information for the DAS Server provided in the Token Request Information, and parameters from the original resource access request. If the Originator is AE and the AE-ID-Stem is assigned by the registrar CSE of the AE, and the Originator supports to create the authorization relationship mapping record, then the Originator shall provide AuthorSignIndicator parameter. The DAS Server issues a Token(s) and provides the Token-ID(s) and optionally the ESData-protected Token(s) to the Originator. The DAS Server can also provide the Originator with other parameters from the Token; for example, the time window in which the Token is valid. If DAS Server receives the AuthorSignIndicator from the Originator, and the DAS server supports to create the authorization relationship mapping record, then the DAS server shall provide the Originator with a AuthorSignReqInfo to request the Originator to return AuthorSign(s) for each Token. This interaction is specific to the Dynamic Authorization System technology being used. • If the Originator receives an AuthorSignReqInfo from DAS server, the Originator shall return the AuthorSignto DAS server: 4.1 The Originator generates AuthorSign for each Token described in clause 7.3.2.2 of ETSI TS 118 103 [2]. 4.2 The Originator sends AuthorSign to DAS server with the corresponding Token(s) or TokenID(s). 4.3 The DAS server shall create, for each Token, the authorization relationship mapping record containing the information listed in table 7.3.2.2-3 of ETSI TS 118 103 [2]. • The Originator shall repeat the original resource access request, with the following changes: - Tokens: add the ESData-protected Token(s) provided by the DAS Server; and - Token IDs: add Token-ID if the ESData-protected Token(s) was not provided by the DAS Server; - AuthorRelIndicator: add AuthorRelIndicator to indicate that the relationship between the AE and the Token(s) are maintained in the DAS server. • (Optional) If the request includes Token-DI(s), then for each Token-ID the Hosting CSE identifies the corresponding DAS Server AE from which to request the corresponding Token, and the following steps shall be performed. The Hosting CSE may collect the Token-ID(s) corresponding to a single DAS Server and perform the following steps once rather than repeating the steps for each token: 6.1 The Hosting CSE shall send a Notify request primitive to the DAS Server AE, with the following details specific to Indirect Dynamic Authorization [2]: The securityInfo Type object parameter shall indicate that the Notify request primitive is for Indirect Dynamic Authorization. The Content parameter shall contain the Token-ID(s) associated with that DAS Server. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 500 (oneM2M TS-0001 version 4.15.0 Release 4) 6.2 The DAS Server shall send a Notify response primitive via the DAS Server AE to the Hosting CSE, with the following details specific to Direct Dynamic Authorization: The securityInfo Type object parameter shall indicate that the Notify response primitive is for Indirect Dynamic Authorization. The Content parameter shall contain the valid ESData-protected Token(s) corresponding to the supplied Token-ID(s). The DAS Server shall provide only those Token(s) which are applicable to the Hosting CSE. • Hosting CSE Processing: 7.1 The Hosting CSE shall process the ESData-protected Token(s) to extract the authenticated Token(s). Additional checking shall also be applied The Hosting CSE may cache the Token(s), as described in clause 7.3.2.3 of ETSI TS 118 103 [2]. 7.2 The Hosting CSE may assign Local-Token-ID(s) to cached Token(s). 7.3 The Hosting CSE shall perform the access decision, including the Token(s) identified in the request. If access is granted, then the requested operation shall be performed. • Response: 8.1 The Hosting CSE may send a response to the Originator. For each new Local-Token-ID(s) has been assigned, the Local-Token-ID and corresponding Token-ID shall be included in the Assigned Token Identifiers parameter of the response. 8.2 The Originator shall associate the Local-Token-ID with Token-ID. In subsequent requests, the Originator may use the Local-Token-ID instead of the Token or Token-ID. |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.5.4 AE Authorization Relationship Update | |
2bd691fcce98b96819b9b3b005c72741 | 118 101 | 11.5.4.1 AE Direct Authorization Relationship Update | The parameters exchanged for AE Direct Authorization Relationship Update, and the corresponding processing, are specified in clause 7.3.2.7.1 of ETSI TS 118 103 [2]. The present clause specifies the transportation of parameters when oneM2M primitives are used. The step numbers are aligned with the procedure in clause 7.3.2.7.1 of ETSI TS 118 103 [2]. Further details for each step in the present clause can be obtained by examining the corresponding steps in clause 7.3.2.7.1 of ETSI TS 118 103 [2]. The message flow for the Direct Authorization Relationship Update is shown in figure 11.5.4.1-1, which is described in the following text. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 501 (oneM2M TS-0001 version 4.15.0 Release 4) Hosting CSE DAS Server AE 1. Original request: new AE-ID, Token or TokenID, resourceID 2.1. Perform access control 2.2. NOTIFY Request to DAS Server dynamicAuthorizationPoA, SecurityInfoType = Authorization Relationship Mapping SecurityInfo object in Content Includes AuthorSignReqInfo, the coresponding Token or TokenID, (opt) new AE-ID AE AE 3. NOTIFY Respone SecurityInfo Type = Authorization Relationship Mapping SecurityInfo object in Content includes Signature 4. Response: AuthorSignReqInfo 5. Repeat Request: new AE-ID, Token, resourceID,AuthorSign 6.1. Verify the AuthorSign 6.2. Update the cached Token Response Figure 11.5.4.1-1: AE Direct Authorization Relationship Update • An AE sends a resource access request message to a Hosting CSE, which carries the new AE-ID, and the Token or the TokenID issued for it. • Hosting CSE processing: 2.1 The Hosting CSE shall verify this Token or the Token identified by this TokenID. If the result is valid, and the custodian attribute of the Token is not equal to the new AE-ID of the originator, the Hosting CSE performs the following steps to verify whether the AE has the possession of the Token. 2.2 The Hosting CSE sends a Notify request primitive to DAS Server AE, with the following details: The securityInfo Type element shall indicate that the Notify request primitive is for Authorization Relationship Mapping. The Content parameter shall contain information: AuthorSignReqInfo, the corresponding Token or TokenID received from the AE. • The DAS Server AE shall extract and parse the Content parameter of the received message. The DAS Server shall examine its authorization relationship mapping record list. If there is a record whose Token parameter is equal to the Token included in the Content parameter or the Token identified by the Token ID in the Content parameter, the DAS Server AE sends a Notify response primitive to the Hosting CSE including the AuthorSign stored in this record: The securityInfo Type element shall indicate that the Notify response primitive is for Authorization Relationship Mapping. The Content parameter shall contain information: Signature which is described in table 7.3.2.2-3 of ETSI TS 118 103 [2]. • The Hosting CSE rejects the request to access the resource, including a AuthorSignReqInfo in the response message to indicate AE to return the AuthorSign for this Token. • The AE sends the repeat request including the information: AuthorSign, resourceID and Token. • After receiving the AuthorSign, Hosting CSE shall check whether the AuthorSign is equal to the Signature returned from DAS Server AE. And if they are the same, the Hosting CSE shall update the cached Token as described in clause 7.3.2.7.1 of ETSI TS 118 103 [2]. ETSI ETSI TS 118 101 V4.15.0 (2022-09) 502 (oneM2M TS-0001 version 4.15.0 Release 4) |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.