1 //******************************************************************
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
25 #include "oic_malloc.h"
26 #include "ocpayload.h"
27 #include "payload_logging.h"
28 #include "resourcemanager.h"
29 #include "pstatresource.h"
30 #include "doxmresource.h"
31 #include "psinterface.h"
32 #include "srmresourcestrings.h"
33 #include "srmutility.h"
35 #define TAG "SRM-PSTAT"
37 /** Default cbor payload size. This value is increased in case of CborErrorOutOfMemory.
38 * The value of payload size is increased until reaching below max cbor size. */
39 static const uint16_t CBOR_SIZE = 512;
41 // Max cbor size payload.
42 static const uint16_t CBOR_MAX_SIZE = 4400;
44 // PSTAT Map size - Number of mandatory items
45 static const uint8_t PSTAT_MAP_SIZE = 7;
47 static OicSecDpom_t gSm = SINGLE_SERVICE_CLIENT_DRIVEN;
48 static OicSecPstat_t gDefaultPstat =
51 (OicSecDpm_t)(BOOTSTRAP_SERVICE | SECURITY_MANAGEMENT_SERVICES |
52 PROVISION_CREDENTIALS | PROVISION_ACLS), // OicSecDpm_t cm
53 (OicSecDpm_t)(TAKE_OWNER | BOOTSTRAP_SERVICE | SECURITY_MANAGEMENT_SERVICES |
54 PROVISION_CREDENTIALS | PROVISION_ACLS), // OicSecDpm_t tm
55 {.id = {0}}, // OicUuid_t deviceID
56 SINGLE_SERVICE_CLIENT_DRIVEN, // OicSecDpom_t om */
57 1, // the number of elts in Sms
58 &gSm, // OicSecDpom_t *sm
59 0, // uint16_t commitHash
60 {.id = {0}}, // OicUuid_t rownerID
63 static OicSecPstat_t *gPstat = NULL;
65 static OCResourceHandle gPstatHandle = NULL;
67 void DeletePstatBinData(OicSecPstat_t* pstat)
71 //Clean 'supported modes' field
79 OCStackResult PstatToCBORPayload(const OicSecPstat_t *pstat, uint8_t **payload, size_t *size)
81 if (NULL == pstat || NULL == payload || NULL != *payload || NULL == size)
83 return OC_STACK_INVALID_PARAM;
86 size_t cborLen = *size;
95 OCStackResult ret = OC_STACK_ERROR;
101 int64_t cborEncoderResult = CborNoError;
103 uint8_t *outPayload = (uint8_t *)OICCalloc(1, cborLen);
104 VERIFY_NON_NULL(TAG, outPayload, ERROR);
105 cbor_encoder_init(&encoder, outPayload, cborLen, 0);
107 cborEncoderResult = cbor_encoder_create_map(&encoder, &pstatMap, PSTAT_MAP_SIZE);
108 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Pstat Map.");
110 cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_ISOP_NAME,
111 strlen(OIC_JSON_ISOP_NAME));
112 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ISOP Name Tag.");
113 cborEncoderResult = cbor_encode_boolean(&pstatMap, pstat->isOp);
114 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ISOP Name Value.");
116 cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_DEVICE_ID_NAME,
117 strlen(OIC_JSON_DEVICE_ID_NAME));
118 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Tag.");
119 ret = ConvertUuidToStr(&pstat->deviceID, &strUuid);
120 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
121 cborEncoderResult = cbor_encode_text_string(&pstatMap, strUuid, strlen(strUuid));
122 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Value.");
126 cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_CM_NAME,
127 strlen(OIC_JSON_CM_NAME));
128 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding CM Name Tag.");
129 cborEncoderResult = cbor_encode_int(&pstatMap, pstat->cm);
130 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding CM Name Value.");
132 cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_TM_NAME,
133 strlen(OIC_JSON_TM_NAME));
134 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding TM Name Tag.");
135 cborEncoderResult = cbor_encode_int(&pstatMap, pstat->tm);
136 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding TM Name Value.");
138 cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_OM_NAME,
139 strlen(OIC_JSON_OM_NAME));
140 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding OM Name Tag.");
141 cborEncoderResult = cbor_encode_int(&pstatMap, pstat->om);
142 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding OM Name Value.");
144 cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_SM_NAME,
145 strlen(OIC_JSON_SM_NAME));
146 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding SM Name Tag.");
147 cborEncoderResult = cbor_encode_int(&pstatMap, pstat->sm[0]);
148 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding SM Name Value.");
150 cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_ROWNERID_NAME,
151 strlen(OIC_JSON_ROWNERID_NAME));
152 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Tag.");
153 ret = ConvertUuidToStr(&pstat->rownerID, &strUuid);
154 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
155 cborEncoderResult = cbor_encode_text_string(&pstatMap, strUuid, strlen(strUuid));
156 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Value.");
160 cborEncoderResult = cbor_encoder_close_container(&encoder, &pstatMap);
161 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Closing PSTAT Map.");
163 if (CborNoError == cborEncoderResult)
165 *size = encoder.ptr - outPayload;
166 *payload = outPayload;
170 if ((CborErrorOutOfMemory == cborEncoderResult) && (cborLen < CBOR_MAX_SIZE))
172 // reallocate and try again!
174 // Since the allocated initial memory failed, double the memory.
175 cborLen += encoder.ptr - encoder.end;
176 cborEncoderResult = CborNoError;
177 ret = PstatToCBORPayload(pstat, payload, &cborLen);
178 if (OC_STACK_OK == ret)
184 if ((CborNoError != cborEncoderResult) || (OC_STACK_OK != ret))
190 ret = OC_STACK_ERROR;
196 OCStackResult CBORPayloadToPstat(const uint8_t *cborPayload, const size_t size,
197 OicSecPstat_t **secPstat)
199 if (NULL == cborPayload || NULL == secPstat || NULL != *secPstat)
201 return OC_STACK_INVALID_PARAM;
204 OCStackResult ret = OC_STACK_ERROR;
209 CborError cborFindResult = CborNoError;
210 char *strUuid = NULL;
217 cbor_parser_init(cborPayload, cborLen, 0, &parser, &pstatCbor);
218 CborValue pstatMap = { .parser = NULL };
220 OicSecPstat_t *pstat = NULL;
221 cborFindResult = cbor_value_enter_container(&pstatCbor, &pstatMap);
222 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding PSTAT Map.");
224 pstat = (OicSecPstat_t *)OICCalloc(1, sizeof(OicSecPstat_t));
225 VERIFY_NON_NULL(TAG, pstat, ERROR);
227 cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_ISOP_NAME, &pstatMap);
228 if (CborNoError == cborFindResult && cbor_value_is_boolean(&pstatMap))
230 cborFindResult = cbor_value_get_boolean(&pstatMap, &pstat->isOp);
231 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding isOp Value.");
234 cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_DEVICE_ID_NAME, &pstatMap);
235 if (CborNoError == cborFindResult && cbor_value_is_text_string(&pstatMap))
237 cborFindResult = cbor_value_dup_text_string(&pstatMap, &strUuid , &len, NULL);
238 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Device Id Value.");
239 ret = ConvertStrToUuid(strUuid , &pstat->deviceID);
240 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
245 cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_CM_NAME, &pstatMap);
246 if (CborNoError == cborFindResult && cbor_value_is_integer(&pstatMap))
248 cborFindResult = cbor_value_get_int(&pstatMap, (int *) &pstat->cm);
249 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding CM.");
252 cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_TM_NAME, &pstatMap);
253 if (CborNoError == cborFindResult && cbor_value_is_integer(&pstatMap))
255 cborFindResult = cbor_value_get_int(&pstatMap, (int *) &pstat->tm);
256 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding TM.");
259 cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_OM_NAME, &pstatMap);
260 if (CborNoError == cborFindResult && cbor_value_is_integer(&pstatMap))
262 cborFindResult = cbor_value_get_int(&pstatMap, (int *) &pstat->om);
263 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding OM.");
266 cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_SM_NAME, &pstatMap);
267 if (CborNoError == cborFindResult && cbor_value_is_integer(&pstatMap))
270 pstat->sm = (OicSecDpom_t*)OICCalloc(pstat->smLen, sizeof(OicSecDpom_t));
271 cborFindResult = cbor_value_get_int(&pstatMap, (int *) &pstat->sm[0]);
272 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding SM.");
276 cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_ROWNERID_NAME, &pstatMap);
277 if (CborNoError == cborFindResult && cbor_value_is_text_string(&pstatMap))
279 cborFindResult = cbor_value_dup_text_string(&pstatMap, &strUuid , &len, NULL);
280 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding ROwner Id Value.");
281 ret = ConvertStrToUuid(strUuid , &pstat->rownerID);
282 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
291 if (CborNoError != cborFindResult)
293 OIC_LOG(ERROR, TAG, "CBORPayloadToPstat failed");
294 DeletePstatBinData(pstat);
297 ret = OC_STACK_ERROR;
304 * Function to update persistent storage
306 static bool UpdatePersistentStorage(OicSecPstat_t *pstat)
311 uint8_t *cborPayload = NULL;
312 OCStackResult ret = PstatToCBORPayload(pstat, &cborPayload, &size);
313 if (OC_STACK_OK == ret)
315 if (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_PSTAT_NAME, cborPayload, size))
319 OICFree(cborPayload);
327 * The entity handler determines how to process a GET request.
329 static OCEntityHandlerResult HandlePstatGetRequest (const OCEntityHandlerRequest * ehRequest)
331 OIC_LOG(INFO, TAG, "HandlePstatGetRequest processing GET request");
333 // Convert ACL data into CBOR for transmission
335 uint8_t *payload = NULL;
336 OCStackResult res = PstatToCBORPayload(gPstat, &payload, &size);
338 // A device should always have a default pstat. Therefore, payload should never be NULL.
339 OCEntityHandlerResult ehRet = (res == OC_STACK_OK) ? OC_EH_OK : OC_EH_ERROR;
341 // Send response payload to request originator
342 SendSRMCBORResponse(ehRequest, ehRet, payload, size);
348 * The entity handler determines how to process a POST request.
349 * Per the REST paradigm, POST can also be used to update representation of existing
350 * resource or create a new resource.
351 * For pstat, it updates only tm and om.
353 static OCEntityHandlerResult HandlePstatPutRequest(const OCEntityHandlerRequest *ehRequest)
355 OCEntityHandlerResult ehRet = OC_EH_ERROR;
356 OIC_LOG(INFO, TAG, "HandlePstatPutRequest processing PUT request");
357 OicSecPstat_t *pstat = NULL;
359 if (ehRequest->resource)
361 uint8_t *payload = ((OCSecurityPayload *) ehRequest->payload)->securityData1;
362 size_t size = ((OCSecurityPayload *) ehRequest->payload)->payloadSize;
363 VERIFY_NON_NULL(TAG, payload, ERROR);
365 OCStackResult ret = CBORPayloadToPstat(payload, size, &pstat);
367 VERIFY_NON_NULL(TAG, pstat, ERROR);
368 if (OC_STACK_OK == ret)
370 if (false == (pstat->cm & TAKE_OWNER) && false == pstat->isOp)
372 gPstat->cm = pstat->cm;
373 OIC_LOG (INFO, TAG, "State changed to Ready for Provisioning");
375 else if (false == (pstat->cm & TAKE_OWNER) && true == pstat->isOp)
377 gPstat->isOp =pstat->isOp;
378 OIC_LOG (INFO, TAG, "State changed to Ready for Normal Operation");
382 OIC_LOG(DEBUG, TAG, "Invalid Device provisionig state");
384 if (pstat->om != MULTIPLE_SERVICE_SERVER_DRIVEN && gPstat)
387 * Check if the operation mode is in the supported provisioning services
388 * operation mode list.
390 for (size_t i=0; i< gPstat->smLen; i++)
392 if(gPstat->sm[i] == pstat->om)
394 gPstat->om = pstat->om;
399 // Convert pstat data into CBOR for update to persistent storage
400 if (UpdatePersistentStorage(gPstat))
407 if(OC_EH_OK != ehRet)
410 * If some error is occured while ownership transfer,
411 * ownership transfer related resource should be revert back to initial status.
413 RestoreDoxmToInitState();
414 RestorePstatToInitState();
417 //Send payload to request originator
418 if(OC_STACK_OK != SendSRMCBORResponse(ehRequest, ehRet, NULL, 0))
420 OIC_LOG (ERROR, TAG, "SendSRMResponse failed in HandlePstatPostRequest");
422 DeletePstatBinData(pstat);
427 * This internal method is the entity handler for pstat resources.
429 OCEntityHandlerResult PstatEntityHandler(OCEntityHandlerFlag flag,
430 OCEntityHandlerRequest * ehRequest,
434 OCEntityHandlerResult ehRet = OC_EH_ERROR;
435 // This method will handle REST request (GET/POST) for /oic/sec/pstat
436 if (flag & OC_REQUEST_FLAG)
438 OIC_LOG(INFO, TAG, "Flag includes OC_REQUEST_FLAG");
439 switch (ehRequest->method)
442 ehRet = HandlePstatGetRequest(ehRequest);
445 ehRet = HandlePstatPutRequest(ehRequest);
449 SendSRMCBORResponse(ehRequest, ehRet, NULL, 0);
457 * This internal method is used to create '/oic/sec/pstat' resource.
459 OCStackResult CreatePstatResource()
461 OCStackResult ret = OCCreateResource(&gPstatHandle,
462 OIC_RSRC_TYPE_SEC_PSTAT,
469 if (OC_STACK_OK != ret)
471 OIC_LOG(FATAL, TAG, "Unable to instantiate pstat resource");
472 DeInitPstatResource();
478 * Get the default value.
480 * @return the gDefaultPstat pointer.
482 static OicSecPstat_t* GetPstatDefault()
484 return &gDefaultPstat;
487 OCStackResult InitPstatResource()
489 OCStackResult ret = OC_STACK_ERROR;
491 // Read Pstat resource from PS
492 uint8_t *data = NULL;
494 OicUuid_t emptyUuid = {.id={0}};
495 ret = GetSecureVirtualDatabaseFromPS(OIC_JSON_PSTAT_NAME, &data, &size);
496 // If database read failed
497 if (OC_STACK_OK != ret)
499 OIC_LOG (DEBUG, TAG, "ReadSVDataFromPS failed");
503 // Read ACL resource from PS
504 ret = CBORPayloadToPstat(data, size, &gPstat);
508 * If SVR database in persistent storage got corrupted or
509 * is not available for some reason, a default pstat is created
510 * which allows user to initiate pstat provisioning again.
512 if ((OC_STACK_OK != ret) || !gPstat)
514 gPstat = GetPstatDefault();
516 VERIFY_NON_NULL(TAG, gPstat, FATAL);
518 //In case of Pstat's device id is empty, fill the device id as doxm's device id.
519 if(0 == memcmp(&gPstat->deviceID, &emptyUuid, sizeof(OicUuid_t)))
521 OicUuid_t doxmUuid = {.id={0}};
522 if(OC_STACK_OK == GetDoxmDeviceID(&doxmUuid))
524 memcpy(&gPstat->deviceID, &doxmUuid, sizeof(OicUuid_t));
528 // Instantiate 'oic.sec.pstat'
529 ret = CreatePstatResource();
532 if (OC_STACK_OK != ret)
534 DeInitPstatResource();
539 OCStackResult DeInitPstatResource()
541 if (gPstat != &gDefaultPstat)
543 DeletePstatBinData(gPstat);
546 return OCDeleteResource(gPstatHandle);
550 * Function to restore pstat resurce to initial status.
551 * This function will use in case of error while ownership transfer
553 void RestorePstatToInitState()
557 OIC_LOG(INFO, TAG, "PSTAT resource will revert back to initial status.");
559 gPstat->cm = (OicSecDpm_t)(gPstat->cm | TAKE_OWNER);
560 gPstat->tm = (OicSecDpm_t)(gPstat->tm & (~TAKE_OWNER));
561 gPstat->om = SINGLE_SERVICE_CLIENT_DRIVEN;
562 if(gPstat->sm && 0 < gPstat->smLen)
564 gPstat->sm[0] = SINGLE_SERVICE_CLIENT_DRIVEN;
567 if (!UpdatePersistentStorage(gPstat))
569 OIC_LOG(ERROR, TAG, "Failed to revert PSTAT in persistent storage");
574 OCStackResult SetPstatRownerId(const OicUuid_t* newROwner)
576 OCStackResult ret = OC_STACK_ERROR;
577 uint8_t *cborPayload = NULL;
579 OicUuid_t prevId = {.id={0}};
581 if(NULL == newROwner)
583 ret = OC_STACK_INVALID_PARAM;
587 ret = OC_STACK_NO_RESOURCE;
590 if(newROwner && gPstat)
592 memcpy(prevId.id, gPstat->rownerID.id, sizeof(prevId.id));
593 memcpy(gPstat->rownerID.id, newROwner->id, sizeof(newROwner->id));
595 ret = PstatToCBORPayload(gPstat, &cborPayload, &size);
596 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
598 ret = UpdateSecureResourceInPS(OIC_JSON_PSTAT_NAME, cborPayload, size);
599 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
601 OICFree(cborPayload);
607 OICFree(cborPayload);
608 memcpy(gPstat->rownerID.id, prevId.id, sizeof(prevId.id));
613 * This function returns the "isop" status of the device.
615 * @return true iff pstat.isop == 1, else false
622 OCStackResult GetPstatRownerId(OicUuid_t *rowneruuid)
624 OCStackResult retVal = OC_STACK_ERROR;
627 *rowneruuid = gPstat->rownerID;
628 retVal = OC_STACK_OK;