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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
32 #include "oic_malloc.h"
33 #include "payload_logging.h"
36 #include "ocpayload.h"
37 #include "cainterface.h"
38 #include "ocserverrequest.h"
39 #include "resourcemanager.h"
40 #include "doxmresource.h"
41 #include "pstatresource.h"
42 #include "aclresource.h"
43 #include "amaclresource.h"
44 #include "pconfresource.h"
45 #include "dpairingresource.h"
46 #include "psinterface.h"
47 #include "srmresourcestrings.h"
48 #include "securevirtualresourcetypes.h"
49 #include "credresource.h"
50 #include "srmutility.h"
51 #include "pinoxmcommon.h"
53 #define TAG "SRM-DOXM"
55 /** Default cbor payload size. This value is increased in case of CborErrorOutOfMemory.
56 * The value of payload size is increased until reaching belox max cbor size. */
57 static const uint16_t CBOR_SIZE = 512;
59 /** Max cbor size payload. */
60 static const uint16_t CBOR_MAX_SIZE = 4400;
62 /** DOXM Map size - Number of mandatory items. */
63 static const uint8_t DOXM_MAP_SIZE = 9;
65 static OicSecDoxm_t *gDoxm = NULL;
66 static OCResourceHandle gDoxmHandle = NULL;
68 static OicSecOxm_t gOicSecDoxmJustWorks = OIC_JUST_WORKS;
69 static OicSecDoxm_t gDefaultDoxm =
71 NULL, /* OicUrn_t *oxmType */
72 0, /* size_t oxmTypeLen */
73 &gOicSecDoxmJustWorks, /* uint16_t *oxm */
74 1, /* size_t oxmLen */
75 OIC_JUST_WORKS, /* uint16_t oxmSel */
76 SYMMETRIC_PAIR_WISE_KEY,/* OicSecCredType_t sct */
77 false, /* bool owned */
78 {.id = {0}}, /* OicUuid_t deviceID */
80 {.id = {0}}, /* OicUuid_t owner */
81 {.id = {0}}, /* OicUuid_t rownerID */
85 * This method is internal method.
86 * the param roParsed is optionally used to know whether cborPayload has
87 * at least read only property value or not.
89 static OCStackResult CBORPayloadToDoxmBin(const uint8_t *cborPayload, size_t size,
90 OicSecDoxm_t **doxm, bool *roParsed);
92 void DeleteDoxmBinData(OicSecDoxm_t* doxm)
97 for (size_t i = 0; i < doxm->oxmTypeLen; i++)
99 OICFree(doxm->oxmType[i]);
101 OICFree(doxm->oxmType);
111 OCStackResult DoxmToCBORPayload(const OicSecDoxm_t *doxm, uint8_t **payload, size_t *size,
114 if (NULL == doxm || NULL == payload || NULL != *payload || NULL == size)
116 return OC_STACK_INVALID_PARAM;
118 size_t cborLen = *size;
126 OCStackResult ret = OC_STACK_ERROR;
130 char* strUuid = NULL;
132 int64_t cborEncoderResult = CborNoError;
133 uint8_t mapSize = DOXM_MAP_SIZE;
134 if (doxm->oxmTypeLen > 0)
138 if (doxm->oxmLen > 0)
143 uint8_t *outPayload = (uint8_t *)OICCalloc(1, cborLen);
144 VERIFY_NON_NULL(TAG, outPayload, ERROR);
145 cbor_encoder_init(&encoder, outPayload, cborLen, 0);
147 cborEncoderResult = cbor_encoder_create_map(&encoder, &doxmMap, mapSize);
148 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Doxm Map.");
150 //OxmType -- Not Mandatory
151 if (doxm->oxmTypeLen > 0)
154 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OXM_TYPE_NAME,
155 strlen(OIC_JSON_OXM_TYPE_NAME));
156 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmType Tag.");
157 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &oxmType, doxm->oxmTypeLen);
158 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmType Array.");
160 for (size_t i = 0; i < doxm->oxmTypeLen; i++)
162 cborEncoderResult = cbor_encode_text_string(&oxmType, doxm->oxmType[i],
163 strlen(doxm->oxmType[i]));
164 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmType Value.");
166 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &oxmType);
167 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing oxmType.");
170 //Oxm -- Not Mandatory
171 if (doxm->oxmLen > 0 && false == rwOnly)
174 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OXMS_NAME,
175 strlen(OIC_JSON_OXMS_NAME));
176 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmName Tag.");
177 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &oxm, doxm->oxmLen);
178 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmName Array.");
180 for (size_t i = 0; i < doxm->oxmLen; i++)
182 cborEncoderResult = cbor_encode_int(&oxm, doxm->oxm[i]);
183 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmName Value");
185 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &oxm);
186 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing oxmName.");
189 //OxmSel -- Mandatory
190 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OXM_SEL_NAME,
191 strlen(OIC_JSON_OXM_SEL_NAME));
192 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Sel Tag.");
193 cborEncoderResult = cbor_encode_int(&doxmMap, doxm->oxmSel);
194 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Sel Value.");
199 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_SUPPORTED_CRED_TYPE_NAME,
200 strlen(OIC_JSON_SUPPORTED_CRED_TYPE_NAME));
201 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Type Tag");
202 cborEncoderResult = cbor_encode_int(&doxmMap, doxm->sct);
203 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Type Value.");
207 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OWNED_NAME,
208 strlen(OIC_JSON_OWNED_NAME));
209 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owned Tag.");
210 cborEncoderResult = cbor_encode_boolean(&doxmMap, doxm->owned);
211 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owned Value.");
215 //DeviceId -- Mandatory
216 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_DEVICE_ID_NAME,
217 strlen(OIC_JSON_DEVICE_ID_NAME));
218 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Tag.");
219 ret = ConvertUuidToStr(&doxm->deviceID, &strUuid);
220 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
221 cborEncoderResult = cbor_encode_text_string(&doxmMap, strUuid, strlen(strUuid));
222 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Value.");
227 //devownerid -- Mandatory
228 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_DEVOWNERID_NAME,
229 strlen(OIC_JSON_DEVOWNERID_NAME));
230 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owner Id Tag.");
231 ret = ConvertUuidToStr(&doxm->owner, &strUuid);
232 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
233 cborEncoderResult = cbor_encode_text_string(&doxmMap, strUuid, strlen(strUuid));
234 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owner Id Value.");
238 //ROwner -- Mandatory
239 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_ROWNERID_NAME,
240 strlen(OIC_JSON_ROWNERID_NAME));
241 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Tag.");
242 ret = ConvertUuidToStr(&doxm->rownerID, &strUuid);
243 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
244 cborEncoderResult = cbor_encode_text_string(&doxmMap, strUuid, strlen(strUuid));
245 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Value.");
249 //x.org.iotivity.dpc -- not Mandatory(vendor-specific), but this type is boolean, so instance always has a value.
250 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_DPC_NAME,
251 strlen(OIC_JSON_DPC_NAME));
252 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding DPC Tag.");
253 cborEncoderResult = cbor_encode_boolean(&doxmMap, doxm->dpc);
254 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding DPC Value.");
258 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_RT_NAME,
259 strlen(OIC_JSON_RT_NAME));
260 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Name Tag.");
261 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &rtArray, 1);
262 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Value.");
263 for (size_t i = 0; i < 1; i++)
265 cborEncoderResult = cbor_encode_text_string(&rtArray, OIC_RSRC_TYPE_SEC_DOXM,
266 strlen(OIC_RSRC_TYPE_SEC_DOXM));
267 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding RT Value.");
269 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &rtArray);
270 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing RT.");
274 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_IF_NAME,
275 strlen(OIC_JSON_IF_NAME));
276 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Name Tag.");
277 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &ifArray, 1);
278 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Value.");
279 for (size_t i = 0; i < 1; i++)
281 cborEncoderResult = cbor_encode_text_string(&ifArray, OC_RSRVD_INTERFACE_DEFAULT,
282 strlen(OC_RSRVD_INTERFACE_DEFAULT));
283 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding IF Value.");
285 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &ifArray);
286 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing IF.");
288 cborEncoderResult = cbor_encoder_close_container(&encoder, &doxmMap);
289 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing DoxmMap.");
291 if (CborNoError == cborEncoderResult)
293 *size = encoder.ptr - outPayload;
294 *payload = outPayload;
298 if ((CborErrorOutOfMemory == cborEncoderResult) && (cborLen < CBOR_MAX_SIZE))
300 OIC_LOG(DEBUG, TAG, "Memory getting reallocated.");
301 // reallocate and try again!
303 // Since the allocated initial memory failed, double the memory.
304 cborLen += encoder.ptr - encoder.end;
305 OIC_LOG_V(DEBUG, TAG, "Doxm reallocation size : %zd.", cborLen);
306 cborEncoderResult = CborNoError;
307 ret = DoxmToCBORPayload(doxm, payload, &cborLen, rwOnly);
311 if ((CborNoError != cborEncoderResult) || (OC_STACK_OK != ret))
317 ret = OC_STACK_ERROR;
323 OCStackResult CBORPayloadToDoxm(const uint8_t *cborPayload, size_t size,
324 OicSecDoxm_t **secDoxm)
326 return CBORPayloadToDoxmBin(cborPayload, size, secDoxm, NULL);
329 static OCStackResult CBORPayloadToDoxmBin(const uint8_t *cborPayload, size_t size,
330 OicSecDoxm_t **secDoxm, bool *roParsed)
332 if (NULL == cborPayload || NULL == secDoxm || NULL != *secDoxm || 0 == size)
334 return OC_STACK_INVALID_PARAM;
337 OCStackResult ret = OC_STACK_ERROR;
341 CborError cborFindResult = CborNoError;
342 char* strUuid = NULL;
346 cbor_parser_init(cborPayload, size, 0, &parser, &doxmCbor);
348 OicSecDoxm_t *doxm = (OicSecDoxm_t *)OICCalloc(1, sizeof(*doxm));
349 VERIFY_NON_NULL(TAG, doxm, ERROR);
351 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OXM_TYPE_NAME, &doxmMap);
352 //OxmType -- not Mandatory
353 if (CborNoError == cborFindResult && cbor_value_is_array(&doxmMap))
357 cborFindResult = cbor_value_get_array_length(&doxmMap, &doxm->oxmTypeLen);
358 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding oxmTypeLen.")
359 VERIFY_SUCCESS(TAG, doxm->oxmTypeLen != 0, ERROR);
361 doxm->oxmType = (OicUrn_t *)OICCalloc(doxm->oxmTypeLen, sizeof(*doxm->oxmType));
362 VERIFY_NON_NULL(TAG, doxm->oxmType, ERROR);
364 cborFindResult = cbor_value_enter_container(&doxmMap, &oxmType);
365 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering oxmType Array.")
369 while (cbor_value_is_valid(&oxmType) && cbor_value_is_text_string(&oxmType))
371 cborFindResult = cbor_value_dup_text_string(&oxmType, &doxm->oxmType[i++],
373 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding omxType text string.")
374 cborFindResult = cbor_value_advance(&oxmType);
375 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing oxmType.")
379 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OXMS_NAME, &doxmMap);
380 //Oxm -- not Mandatory
381 if (CborNoError == cborFindResult && cbor_value_is_array(&doxmMap))
384 cborFindResult = cbor_value_get_array_length(&doxmMap, &doxm->oxmLen);
385 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding oxmName array Length.")
386 VERIFY_SUCCESS(TAG, doxm->oxmLen != 0, ERROR);
388 doxm->oxm = (OicSecOxm_t *)OICCalloc(doxm->oxmLen, sizeof(*doxm->oxm));
389 VERIFY_NON_NULL(TAG, doxm->oxm, ERROR);
391 cborFindResult = cbor_value_enter_container(&doxmMap, &oxm);
392 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering oxmName Array.")
395 while (cbor_value_is_valid(&oxm) && cbor_value_is_integer(&oxm))
397 cborFindResult = cbor_value_get_int(&oxm, (int *) &doxm->oxm[i++]);
398 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding oxmName Value")
399 cborFindResult = cbor_value_advance(&oxm);
400 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing oxmName.")
410 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
411 doxm->oxm = (OicSecOxm_t *) OICCalloc(gDoxm->oxmLen, sizeof(*doxm->oxm));
412 VERIFY_NON_NULL(TAG, doxm->oxm, ERROR);
413 doxm->oxmLen = gDoxm->oxmLen;
415 for (i = 0; i < gDoxm->oxmLen; i++)
417 doxm->oxm[i] = gDoxm->oxm[i];
421 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OXM_SEL_NAME, &doxmMap);
422 if (CborNoError == cborFindResult && cbor_value_is_integer(&doxmMap))
424 cborFindResult = cbor_value_get_int(&doxmMap, (int *) &doxm->oxmSel);
425 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Sel Name Value.")
427 else // PUT/POST JSON may not have oxmsel so set it to the gDoxm->oxmSel
429 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
430 doxm->oxmSel = gDoxm->oxmSel;
433 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_SUPPORTED_CRED_TYPE_NAME, &doxmMap);
434 if (CborNoError == cborFindResult && cbor_value_is_integer(&doxmMap))
436 cborFindResult = cbor_value_get_int(&doxmMap, (int *) &doxm->sct);
437 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Sct Name Value.")
444 else // PUT/POST JSON may not have sct so set it to the gDoxm->sct
446 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
447 doxm->sct = gDoxm->sct;
450 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OWNED_NAME, &doxmMap);
451 if (CborNoError == cborFindResult && cbor_value_is_boolean(&doxmMap))
453 cborFindResult = cbor_value_get_boolean(&doxmMap, &doxm->owned);
454 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Owned Value.")
456 else // PUT/POST JSON may not have owned so set it to the gDomx->owned
458 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
459 doxm->owned = gDoxm->owned;
462 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_DPC_NAME, &doxmMap);
463 if (CborNoError == cborFindResult && cbor_value_is_boolean(&doxmMap))
465 cborFindResult = cbor_value_get_boolean(&doxmMap, &doxm->dpc);
466 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding DPC Value.")
468 else // PUT/POST JSON may not have dpc so set it to the gDomx->dpc
470 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
471 doxm->dpc = gDoxm->dpc;
474 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_DEVICE_ID_NAME, &doxmMap);
475 if (CborNoError == cborFindResult && cbor_value_is_text_string(&doxmMap))
477 cborFindResult = cbor_value_dup_text_string(&doxmMap, &strUuid , &len, NULL);
478 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Device Id Value.");
479 ret = ConvertStrToUuid(strUuid , &doxm->deviceID);
480 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
491 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
492 memcpy(doxm->deviceID.id, &gDoxm->deviceID.id, sizeof(doxm->deviceID.id));
495 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_DEVOWNERID_NAME, &doxmMap);
496 if (CborNoError == cborFindResult && cbor_value_is_text_string(&doxmMap))
498 cborFindResult = cbor_value_dup_text_string(&doxmMap, &strUuid , &len, NULL);
499 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Owner Value.");
500 ret = ConvertStrToUuid(strUuid , &doxm->owner);
501 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
507 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
508 memcpy(doxm->owner.id, gDoxm->owner.id, sizeof(doxm->owner.id));
511 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_ROWNERID_NAME, &doxmMap);
512 if (CborNoError == cborFindResult && cbor_value_is_text_string(&doxmMap))
514 cborFindResult = cbor_value_dup_text_string(&doxmMap, &strUuid , &len, NULL);
515 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding ROwner Value.");
516 ret = ConvertStrToUuid(strUuid , &doxm->rownerID);
517 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
523 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
524 memcpy(doxm->rownerID.id, gDoxm->rownerID.id, sizeof(doxm->rownerID.id));
531 if (CborNoError != cborFindResult)
533 OIC_LOG (ERROR, TAG, "CBORPayloadToDoxm failed!!!");
534 DeleteDoxmBinData(doxm);
537 ret = OC_STACK_ERROR;
543 * @todo document this function including why code might need to call this.
544 * The current suspicion is that it's not being called as much as it should.
546 static bool UpdatePersistentStorage(OicSecDoxm_t * doxm)
552 // Convert Doxm data into CBOR for update to persistent storage
553 uint8_t *payload = NULL;
555 OCStackResult res = DoxmToCBORPayload(doxm, &payload, &size, false);
556 if (payload && (OC_STACK_OK == res)
557 && (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_DOXM_NAME, payload, size)))
565 if (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_DOXM_NAME, NULL, 0))
574 static bool ValidateQuery(const char * query)
576 // Send doxm resource data if the state of doxm resource
577 // matches with the query parameters.
578 // else send doxm resource data as NULL
579 // TODO Remove this check and rely on Policy Engine
580 // and Provisioning Mode to enforce provisioning-state
581 // access rules. Eventually, the PE and PM code will
582 // not send a request to the /doxm Entity Handler at all
583 // if it should not respond.
584 OIC_LOG (DEBUG, TAG, "In ValidateQuery");
590 bool bOwnedQry = false; // does querystring contains 'owned' query ?
591 bool bOwnedMatch = false; // does 'owned' query value matches with doxm.owned status?
592 bool bDeviceIDQry = false; // does querystring contains 'deviceid' query ?
593 bool bDeviceIDMatch = false; // does 'deviceid' query matches with doxm.deviceid ?
594 bool bInterfaceQry = false; // does querystring contains 'if' query ?
595 bool bInterfaceMatch = false; // does 'if' query matches with oic.if.baseline ?
597 OicParseQueryIter_t parseIter = {.attrPos = NULL};
599 ParseQueryIterInit((unsigned char*)query, &parseIter);
601 while (GetNextQuery(&parseIter))
603 if (strncasecmp((char *)parseIter.attrPos, OIC_JSON_OWNED_NAME, parseIter.attrLen) == 0)
606 if ((strncasecmp((char *)parseIter.valPos, OIC_SEC_TRUE, parseIter.valLen) == 0) &&
611 else if ((strncasecmp((char *)parseIter.valPos, OIC_SEC_FALSE, parseIter.valLen) == 0)
618 if (strncasecmp((char *)parseIter.attrPos, OIC_JSON_DEVICE_ID_NAME, parseIter.attrLen) == 0)
621 OicUuid_t subject = {.id={0}};
623 memcpy(subject.id, parseIter.valPos, parseIter.valLen);
624 if (0 == memcmp(&gDoxm->deviceID.id, &subject.id, sizeof(gDoxm->deviceID.id)))
626 bDeviceIDMatch = true;
630 if (strncasecmp((char *)parseIter.attrPos, OC_RSRVD_INTERFACE, parseIter.attrLen) == 0)
632 bInterfaceQry = true;
633 if ((strncasecmp((char *)parseIter.valPos, OC_RSRVD_INTERFACE_DEFAULT, parseIter.valLen) == 0))
635 bInterfaceMatch = true;
637 return (bInterfaceQry ? bInterfaceMatch: true);
641 return ((bOwnedQry ? bOwnedMatch : true) && (bDeviceIDQry ? bDeviceIDMatch : true));
644 static OCEntityHandlerResult HandleDoxmGetRequest (const OCEntityHandlerRequest * ehRequest)
646 OCEntityHandlerResult ehRet = OC_EH_OK;
648 OIC_LOG(DEBUG, TAG, "Doxm EntityHandle processing GET request");
650 //Checking if Get request is a query.
651 if (ehRequest->query)
653 OIC_LOG_V(DEBUG,TAG,"query:%s",ehRequest->query);
654 OIC_LOG(DEBUG, TAG, "HandleDoxmGetRequest processing query");
655 if (!ValidateQuery(ehRequest->query))
662 * For GET or Valid Query request return doxm resource CBOR payload.
663 * For non-valid query return NULL json payload.
664 * A device will 'always' have a default Doxm, so DoxmToCBORPayload will
665 * return valid doxm resource json.
667 uint8_t *payload = NULL;
670 if (ehRet == OC_EH_OK)
672 if (OC_STACK_OK != DoxmToCBORPayload(gDoxm, &payload, &size, false))
674 OIC_LOG(WARNING, TAG, "DoxmToCBORPayload failed in HandleDoxmGetRequest");
678 OIC_LOG(DEBUG, TAG, "Send payload for doxm GET request");
679 OIC_LOG_BUFFER(DEBUG, TAG, payload, size);
681 // Send response payload to request originator
682 ehRet = ((SendSRMResponse(ehRequest, ehRet, payload, size)) == OC_STACK_OK) ?
683 OC_EH_OK : OC_EH_ERROR;
690 static OCEntityHandlerResult HandleDoxmPostRequest(const OCEntityHandlerRequest * ehRequest)
692 OIC_LOG (DEBUG, TAG, "Doxm EntityHandle processing POST request");
693 OCEntityHandlerResult ehRet = OC_EH_ERROR;
694 OicUuid_t emptyOwner = {.id = {0} };
695 static uint16_t previousMsgId = 0;
698 * Convert CBOR Doxm data into binary. This will also validate
699 * the Doxm data received.
701 OicSecDoxm_t *newDoxm = NULL;
703 if (ehRequest->payload)
705 uint8_t *payload = ((OCSecurityPayload *)ehRequest->payload)->securityData;
706 size_t size = ((OCSecurityPayload *)ehRequest->payload)->payloadSize;
707 bool roParsed = false;
708 OCStackResult res = CBORPayloadToDoxmBin(payload, size, &newDoxm, &roParsed);
709 if (newDoxm && OC_STACK_OK == res)
711 // Check request on RO property
712 if (true == roParsed)
714 OIC_LOG(ERROR, TAG, "Not acceptable request because of read-only propertys");
715 ehRet = OC_EH_NOT_ACCEPTABLE;
720 if (true == gDoxm->owned)
722 // update writable properties
723 gDoxm->oxmSel = newDoxm->oxmSel;
724 memcpy(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t));
725 memcpy(&(gDoxm->rownerID), &(newDoxm->rownerID), sizeof(OicUuid_t));
727 if(gDoxm->owned != newDoxm->owned)
729 gDoxm->owned = newDoxm->owned;
732 //Update new state in persistent storage
733 if (UpdatePersistentStorage(gDoxm) == true)
739 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
746 if ((false == gDoxm->owned) && (false == newDoxm->owned))
748 if (OIC_JUST_WORKS == newDoxm->oxmSel)
751 * If current state of the device is un-owned, enable
752 * anonymous ECDH cipher in tinyDTLS so that Provisioning
753 * tool can initiate JUST_WORKS ownership transfer process.
755 if (memcmp(&(newDoxm->owner), &emptyOwner, sizeof(OicUuid_t)) == 0)
757 OIC_LOG (INFO, TAG, "Doxm EntityHandle enabling AnonECDHCipherSuite");
759 ehRet = (CAEnableAnonECDHCipherSuite(true) == CA_STATUS_OK) ? OC_EH_OK : OC_EH_ERROR;
760 #endif //__WITH_DTLS__
766 //Save the owner's UUID to derive owner credential
767 memcpy(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t));
769 // Update new state in persistent storage
770 if (true == UpdatePersistentStorage(gDoxm))
776 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
781 * Disable anonymous ECDH cipher in tinyDTLS since device is now
784 CAResult_t caRes = CA_STATUS_OK;
785 caRes = CAEnableAnonECDHCipherSuite(false);
786 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
787 OIC_LOG(INFO, TAG, "ECDH_ANON CipherSuite is DISABLED");
790 #define TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 0xC0AE
791 CASelectCipherSuite(TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8);
792 #endif //__WITH_X509__
793 #endif //__WITH_DTLS__
796 else if (OIC_RANDOM_DEVICE_PIN == newDoxm->oxmSel)
799 * If current state of the device is un-owned, enable
800 * anonymous ECDH cipher in tinyDTLS so that Provisioning
801 * tool can initiate JUST_WORKS ownership transfer process.
803 if(memcmp(&(newDoxm->owner), &emptyOwner, sizeof(OicUuid_t)) == 0)
805 gDoxm->oxmSel = newDoxm->oxmSel;
806 //Update new state in persistent storage
807 if ((UpdatePersistentStorage(gDoxm) == true))
813 OIC_LOG(WARNING, TAG, "Failed to update DOXM in persistent storage");
818 CAResult_t caRes = CA_STATUS_OK;
820 caRes = CAEnableAnonECDHCipherSuite(false);
821 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
822 OIC_LOG(INFO, TAG, "ECDH_ANON CipherSuite is DISABLED");
824 caRes = CASelectCipherSuite(TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA_256);
825 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
827 if(previousMsgId != ehRequest->messageID)
829 char ranPin[OXM_RANDOM_PIN_SIZE + 1] = {0,};
830 if(OC_STACK_OK == GeneratePin(ranPin, OXM_RANDOM_PIN_SIZE + 1))
832 //Set the device id to derive temporal PSK
833 SetUuidForRandomPinOxm(&gDoxm->deviceID);
836 * Since PSK will be used directly by DTLS layer while PIN based ownership transfer,
837 * Credential should not be saved into SVR.
838 * For this reason, use a temporary get_psk_info callback to random PIN OxM.
840 caRes = CARegisterDTLSCredentialsHandler(GetDtlsPskForRandomPinOxm);
841 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
846 OIC_LOG(ERROR, TAG, "Failed to generate random PIN");
850 #endif //__WITH_DTLS__
855 //Save the owner's UUID to derive owner credential
856 memcpy(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t));
858 //Update new state in persistent storage
859 if (UpdatePersistentStorage(gDoxm) == true)
865 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
874 * When current state of the device is un-owned and Provisioning
875 * Tool is attempting to change the state to 'Owned' with a
876 * qualified value for the field 'Owner'
878 if ((false == gDoxm->owned) && (true == newDoxm->owned) &&
879 (memcmp(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t)) == 0))
881 //Change the SVR's resource owner as owner device.
882 OCStackResult ownerRes = SetAclRownerId(&gDoxm->owner);
883 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
888 ownerRes = SetAmaclRownerId(&gDoxm->owner);
889 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
894 ownerRes = SetCredRownerId(&gDoxm->owner);
895 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
900 ownerRes = SetPstatRownerId(&gDoxm->owner);
901 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
906 ownerRes = SetDpairingRownerId(&gDoxm->owner);
907 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
912 ownerRes = SetPconfRownerId(&gDoxm->owner);
913 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
920 memcpy(&gDoxm->rownerID, &gDoxm->owner, sizeof(OicUuid_t));
922 // Update new state in persistent storage
923 if (UpdatePersistentStorage(gDoxm))
925 //Update default ACE of security resource to prevent anonymous user access.
926 if(OC_STACK_OK == UpdateDefaultSecProvACE())
932 OIC_LOG(ERROR, TAG, "Failed to remove default ACL for security provisioning");
938 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
946 if(OC_EH_OK != ehRet)
950 * If some error is occured while ownership transfer,
951 * ownership transfer related resource should be revert back to initial status.
955 if(!gDoxm->owned && previousMsgId != ehRequest->messageID)
957 OIC_LOG(WARNING, TAG, "The operation failed during handle DOXM request,"\
958 "DOXM will be reverted.");
959 RestoreDoxmToInitState();
960 RestorePstatToInitState();
965 OIC_LOG(ERROR, TAG, "Invalid DOXM resource.");
970 previousMsgId = ehRequest->messageID;
973 //Send payload to request originator
974 ehRet = ((SendSRMResponse(ehRequest, ehRet, NULL, 0)) == OC_STACK_OK) ?
975 OC_EH_OK : OC_EH_ERROR;
977 DeleteDoxmBinData(newDoxm);
982 OCEntityHandlerResult DoxmEntityHandler(OCEntityHandlerFlag flag,
983 OCEntityHandlerRequest * ehRequest,
987 OCEntityHandlerResult ehRet = OC_EH_ERROR;
989 if(NULL == ehRequest)
994 if (flag & OC_REQUEST_FLAG)
996 OIC_LOG(DEBUG, TAG, "Flag includes OC_REQUEST_FLAG");
998 switch (ehRequest->method)
1001 ehRet = HandleDoxmGetRequest(ehRequest);
1005 ehRet = HandleDoxmPostRequest(ehRequest);
1009 ehRet = ((SendSRMResponse(ehRequest, ehRet, NULL, 0)) == OC_STACK_OK) ?
1010 OC_EH_OK : OC_EH_ERROR;
1018 OCStackResult CreateDoxmResource()
1020 OCStackResult ret = OCCreateResource(&gDoxmHandle,
1021 OIC_RSRC_TYPE_SEC_DOXM,
1022 OC_RSRVD_INTERFACE_DEFAULT,
1029 if (OC_STACK_OK != ret)
1031 OIC_LOG (FATAL, TAG, "Unable to instantiate Doxm resource");
1032 DeInitDoxmResource();
1038 * Checks if DeviceID is generated during provisioning for the new device.
1039 * If DeviceID is NULL then generates the new DeviceID.
1040 * Once DeviceID is assigned to the device it does not change for the lifetime of the device.
1042 static OCStackResult CheckDeviceID()
1044 OCStackResult ret = OC_STACK_ERROR;
1045 bool validId = false;
1046 for (uint8_t i = 0; i < UUID_LENGTH; i++)
1048 if (gDoxm->deviceID.id[i] != 0)
1057 if (OCGenerateUuid(gDoxm->deviceID.id) != RAND_UUID_OK)
1059 OIC_LOG(FATAL, TAG, "Generate UUID for Server Instance failed!");
1064 if (!UpdatePersistentStorage(gDoxm))
1066 //TODO: After registering PSI handler in all samples, do ret = OC_STACK_OK here.
1067 OIC_LOG(FATAL, TAG, "UpdatePersistentStorage failed!");
1078 * Get the default value.
1080 * @return the default value of doxm, @ref OicSecDoxm_t.
1082 static OicSecDoxm_t* GetDoxmDefault()
1084 OIC_LOG(DEBUG, TAG, "GetDoxmToDefault");
1085 return &gDefaultDoxm;
1088 const OicSecDoxm_t* GetDoxmResourceData()
1093 OCStackResult InitDoxmResource()
1095 OCStackResult ret = OC_STACK_ERROR;
1097 //Read DOXM resource from PS
1098 uint8_t *data = NULL;
1100 ret = GetSecureVirtualDatabaseFromPS(OIC_JSON_DOXM_NAME, &data, &size);
1101 // If database read failed
1102 if (OC_STACK_OK != ret)
1104 OIC_LOG (DEBUG, TAG, "ReadSVDataFromPS failed");
1108 // Read DOXM resource from PS
1109 ret = CBORPayloadToDoxm(data, size, &gDoxm);
1112 * If SVR database in persistent storage got corrupted or
1113 * is not available for some reason, a default doxm is created
1114 * which allows user to initiate doxm provisioning again.
1116 if ((OC_STACK_OK != ret) || !data || !gDoxm)
1118 gDoxm = GetDoxmDefault();
1121 //In case of the server is shut down unintentionally, we should initialize the owner
1122 if(false == gDoxm->owned)
1124 OicUuid_t emptyUuid = {.id={0}};
1125 memcpy(&gDoxm->owner, &emptyUuid, sizeof(OicUuid_t));
1128 ret = CheckDeviceID();
1129 if (ret == OC_STACK_OK)
1131 OIC_LOG_V(DEBUG, TAG, "Initial Doxm Owned = %d", gDoxm->owned);
1132 //Instantiate 'oic.sec.doxm'
1133 ret = CreateDoxmResource();
1137 OIC_LOG (ERROR, TAG, "CheckDeviceID failed");
1143 OCStackResult DeInitDoxmResource()
1145 OCStackResult ret = OCDeleteResource(gDoxmHandle);
1146 if (gDoxm != &gDefaultDoxm)
1148 DeleteDoxmBinData(gDoxm);
1152 if (OC_STACK_OK == ret)
1158 return OC_STACK_ERROR;
1162 OCStackResult GetDoxmDeviceID(OicUuid_t *deviceID)
1164 if (deviceID && gDoxm)
1166 *deviceID = gDoxm->deviceID;
1169 return OC_STACK_ERROR;
1172 OCStackResult GetDoxmDevOwnerId(OicUuid_t *devownerid)
1174 OCStackResult retVal = OC_STACK_ERROR;
1177 OIC_LOG_V(DEBUG, TAG, "GetDoxmDevOwnerId(): gDoxm owned = %d.", \
1181 *devownerid = gDoxm->owner;
1182 retVal = OC_STACK_OK;
1188 OCStackResult GetDoxmRownerId(OicUuid_t *rowneruuid)
1190 OCStackResult retVal = OC_STACK_ERROR;
1195 *rowneruuid = gDoxm->rownerID;
1196 retVal = OC_STACK_OK;
1203 * Function to restore doxm resurce to initial status.
1204 * This function will use in case of error while ownership transfer
1206 void RestoreDoxmToInitState()
1210 OIC_LOG(INFO, TAG, "DOXM resource will revert back to initial status.");
1212 OicUuid_t emptyUuid = {.id={0}};
1213 memcpy(&(gDoxm->owner), &emptyUuid, sizeof(OicUuid_t));
1214 gDoxm->owned = false;
1215 gDoxm->oxmSel = OIC_JUST_WORKS;
1217 if(!UpdatePersistentStorage(gDoxm))
1219 OIC_LOG(ERROR, TAG, "Failed to revert DOXM in persistent storage");