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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
20 #include "iotivity_config.h"
33 #include "oic_malloc.h"
34 #include "payload_logging.h"
37 #include "ocpayload.h"
38 #include "cainterface.h"
39 #include "ocserverrequest.h"
40 #include "resourcemanager.h"
41 #include "doxmresource.h"
42 #include "pstatresource.h"
43 #include "aclresource.h"
44 #include "amaclresource.h"
45 #include "pconfresource.h"
46 #include "dpairingresource.h"
47 #include "psinterface.h"
48 #include "srmresourcestrings.h"
49 #include "securevirtualresourcetypes.h"
50 #include "credresource.h"
51 #include "srmutility.h"
52 #include "pinoxmcommon.h"
54 #define TAG "SRM-DOXM"
56 /** Default cbor payload size. This value is increased in case of CborErrorOutOfMemory.
57 * The value of payload size is increased until reaching belox max cbor size. */
58 static const uint16_t CBOR_SIZE = 512;
60 /** Max cbor size payload. */
61 static const uint16_t CBOR_MAX_SIZE = 4400;
63 /** DOXM Map size - Number of mandatory items. */
64 static const uint8_t DOXM_MAP_SIZE = 9;
66 static OicSecDoxm_t *gDoxm = NULL;
67 static OCResourceHandle gDoxmHandle = NULL;
69 static OicSecOxm_t gOicSecDoxmJustWorks = OIC_JUST_WORKS;
70 static OicSecDoxm_t gDefaultDoxm =
72 NULL, /* OicUrn_t *oxmType */
73 0, /* size_t oxmTypeLen */
74 &gOicSecDoxmJustWorks, /* uint16_t *oxm */
75 1, /* size_t oxmLen */
76 OIC_JUST_WORKS, /* uint16_t oxmSel */
77 SYMMETRIC_PAIR_WISE_KEY,/* OicSecCredType_t sct */
78 false, /* bool owned */
79 {.id = {0}}, /* OicUuid_t deviceID */
81 {.id = {0}}, /* OicUuid_t owner */
82 {.id = {0}}, /* OicUuid_t rownerID */
86 * This method is internal method.
87 * the param roParsed is optionally used to know whether cborPayload has
88 * at least read only property value or not.
90 static OCStackResult CBORPayloadToDoxmBin(const uint8_t *cborPayload, size_t size,
91 OicSecDoxm_t **doxm, bool *roParsed);
93 void DeleteDoxmBinData(OicSecDoxm_t* doxm)
98 for (size_t i = 0; i < doxm->oxmTypeLen; i++)
100 OICFree(doxm->oxmType[i]);
102 OICFree(doxm->oxmType);
112 OCStackResult DoxmToCBORPayload(const OicSecDoxm_t *doxm, uint8_t **payload, size_t *size,
115 if (NULL == doxm || NULL == payload || NULL != *payload || NULL == size)
117 return OC_STACK_INVALID_PARAM;
119 size_t cborLen = *size;
127 OCStackResult ret = OC_STACK_ERROR;
131 char* strUuid = NULL;
133 int64_t cborEncoderResult = CborNoError;
134 uint8_t mapSize = DOXM_MAP_SIZE;
135 if (doxm->oxmTypeLen > 0)
139 if (doxm->oxmLen > 0)
144 uint8_t *outPayload = (uint8_t *)OICCalloc(1, cborLen);
145 VERIFY_NON_NULL(TAG, outPayload, ERROR);
146 cbor_encoder_init(&encoder, outPayload, cborLen, 0);
148 cborEncoderResult = cbor_encoder_create_map(&encoder, &doxmMap, mapSize);
149 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Doxm Map.");
151 //OxmType -- Not Mandatory
152 if (doxm->oxmTypeLen > 0)
155 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OXM_TYPE_NAME,
156 strlen(OIC_JSON_OXM_TYPE_NAME));
157 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmType Tag.");
158 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &oxmType, doxm->oxmTypeLen);
159 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmType Array.");
161 for (size_t i = 0; i < doxm->oxmTypeLen; i++)
163 cborEncoderResult = cbor_encode_text_string(&oxmType, doxm->oxmType[i],
164 strlen(doxm->oxmType[i]));
165 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmType Value.");
167 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &oxmType);
168 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing oxmType.");
171 //Oxm -- Not Mandatory
172 if (doxm->oxmLen > 0 && false == rwOnly)
175 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OXMS_NAME,
176 strlen(OIC_JSON_OXMS_NAME));
177 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmName Tag.");
178 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &oxm, doxm->oxmLen);
179 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmName Array.");
181 for (size_t i = 0; i < doxm->oxmLen; i++)
183 cborEncoderResult = cbor_encode_int(&oxm, doxm->oxm[i]);
184 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmName Value");
186 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &oxm);
187 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing oxmName.");
190 //OxmSel -- Mandatory
191 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OXM_SEL_NAME,
192 strlen(OIC_JSON_OXM_SEL_NAME));
193 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Sel Tag.");
194 cborEncoderResult = cbor_encode_int(&doxmMap, doxm->oxmSel);
195 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Sel Value.");
200 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_SUPPORTED_CRED_TYPE_NAME,
201 strlen(OIC_JSON_SUPPORTED_CRED_TYPE_NAME));
202 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Type Tag");
203 cborEncoderResult = cbor_encode_int(&doxmMap, doxm->sct);
204 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Type Value.");
208 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OWNED_NAME,
209 strlen(OIC_JSON_OWNED_NAME));
210 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owned Tag.");
211 cborEncoderResult = cbor_encode_boolean(&doxmMap, doxm->owned);
212 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owned Value.");
216 //DeviceId -- Mandatory
217 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_DEVICE_ID_NAME,
218 strlen(OIC_JSON_DEVICE_ID_NAME));
219 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Tag.");
220 ret = ConvertUuidToStr(&doxm->deviceID, &strUuid);
221 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
222 cborEncoderResult = cbor_encode_text_string(&doxmMap, strUuid, strlen(strUuid));
223 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Value.");
228 //devownerid -- Mandatory
229 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_DEVOWNERID_NAME,
230 strlen(OIC_JSON_DEVOWNERID_NAME));
231 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owner Id Tag.");
232 ret = ConvertUuidToStr(&doxm->owner, &strUuid);
233 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
234 cborEncoderResult = cbor_encode_text_string(&doxmMap, strUuid, strlen(strUuid));
235 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owner Id Value.");
239 //ROwner -- Mandatory
240 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_ROWNERID_NAME,
241 strlen(OIC_JSON_ROWNERID_NAME));
242 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Tag.");
243 ret = ConvertUuidToStr(&doxm->rownerID, &strUuid);
244 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
245 cborEncoderResult = cbor_encode_text_string(&doxmMap, strUuid, strlen(strUuid));
246 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Value.");
250 //x.org.iotivity.dpc -- not Mandatory(vendor-specific), but this type is boolean, so instance always has a value.
251 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_DPC_NAME,
252 strlen(OIC_JSON_DPC_NAME));
253 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding DPC Tag.");
254 cborEncoderResult = cbor_encode_boolean(&doxmMap, doxm->dpc);
255 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding DPC Value.");
259 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_RT_NAME,
260 strlen(OIC_JSON_RT_NAME));
261 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Name Tag.");
262 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &rtArray, 1);
263 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Value.");
264 for (size_t i = 0; i < 1; i++)
266 cborEncoderResult = cbor_encode_text_string(&rtArray, OIC_RSRC_TYPE_SEC_DOXM,
267 strlen(OIC_RSRC_TYPE_SEC_DOXM));
268 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding RT Value.");
270 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &rtArray);
271 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing RT.");
275 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_IF_NAME,
276 strlen(OIC_JSON_IF_NAME));
277 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Name Tag.");
278 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &ifArray, 1);
279 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Value.");
280 for (size_t i = 0; i < 1; i++)
282 cborEncoderResult = cbor_encode_text_string(&ifArray, OC_RSRVD_INTERFACE_DEFAULT,
283 strlen(OC_RSRVD_INTERFACE_DEFAULT));
284 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding IF Value.");
286 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &ifArray);
287 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing IF.");
289 cborEncoderResult = cbor_encoder_close_container(&encoder, &doxmMap);
290 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing DoxmMap.");
292 if (CborNoError == cborEncoderResult)
294 *size = encoder.ptr - outPayload;
295 *payload = outPayload;
299 if ((CborErrorOutOfMemory == cborEncoderResult) && (cborLen < CBOR_MAX_SIZE))
301 OIC_LOG(DEBUG, TAG, "Memory getting reallocated.");
302 // reallocate and try again!
304 // Since the allocated initial memory failed, double the memory.
305 cborLen += encoder.ptr - encoder.end;
306 OIC_LOG_V(DEBUG, TAG, "Doxm reallocation size : %zd.", cborLen);
307 cborEncoderResult = CborNoError;
308 ret = DoxmToCBORPayload(doxm, payload, &cborLen, rwOnly);
312 if ((CborNoError != cborEncoderResult) || (OC_STACK_OK != ret))
318 ret = OC_STACK_ERROR;
324 OCStackResult CBORPayloadToDoxm(const uint8_t *cborPayload, size_t size,
325 OicSecDoxm_t **secDoxm)
327 return CBORPayloadToDoxmBin(cborPayload, size, secDoxm, NULL);
330 static OCStackResult CBORPayloadToDoxmBin(const uint8_t *cborPayload, size_t size,
331 OicSecDoxm_t **secDoxm, bool *roParsed)
333 if (NULL == cborPayload || NULL == secDoxm || NULL != *secDoxm || 0 == size)
335 return OC_STACK_INVALID_PARAM;
338 OCStackResult ret = OC_STACK_ERROR;
342 CborError cborFindResult = CborNoError;
343 char* strUuid = NULL;
347 cbor_parser_init(cborPayload, size, 0, &parser, &doxmCbor);
349 OicSecDoxm_t *doxm = (OicSecDoxm_t *)OICCalloc(1, sizeof(*doxm));
350 VERIFY_NON_NULL(TAG, doxm, ERROR);
352 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OXM_TYPE_NAME, &doxmMap);
353 //OxmType -- not Mandatory
354 if (CborNoError == cborFindResult && cbor_value_is_array(&doxmMap))
358 cborFindResult = cbor_value_get_array_length(&doxmMap, &doxm->oxmTypeLen);
359 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding oxmTypeLen.")
360 VERIFY_SUCCESS(TAG, doxm->oxmTypeLen != 0, ERROR);
362 doxm->oxmType = (OicUrn_t *)OICCalloc(doxm->oxmTypeLen, sizeof(*doxm->oxmType));
363 VERIFY_NON_NULL(TAG, doxm->oxmType, ERROR);
365 cborFindResult = cbor_value_enter_container(&doxmMap, &oxmType);
366 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering oxmType Array.")
370 while (cbor_value_is_valid(&oxmType) && cbor_value_is_text_string(&oxmType))
372 cborFindResult = cbor_value_dup_text_string(&oxmType, &doxm->oxmType[i++],
374 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding omxType text string.")
375 cborFindResult = cbor_value_advance(&oxmType);
376 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing oxmType.")
380 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OXMS_NAME, &doxmMap);
381 //Oxm -- not Mandatory
382 if (CborNoError == cborFindResult && cbor_value_is_array(&doxmMap))
385 cborFindResult = cbor_value_get_array_length(&doxmMap, &doxm->oxmLen);
386 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding oxmName array Length.")
387 VERIFY_SUCCESS(TAG, doxm->oxmLen != 0, ERROR);
389 doxm->oxm = (OicSecOxm_t *)OICCalloc(doxm->oxmLen, sizeof(*doxm->oxm));
390 VERIFY_NON_NULL(TAG, doxm->oxm, ERROR);
392 cborFindResult = cbor_value_enter_container(&doxmMap, &oxm);
393 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering oxmName Array.")
396 while (cbor_value_is_valid(&oxm) && cbor_value_is_integer(&oxm))
400 cborFindResult = cbor_value_get_int(&oxm, &tmp);
401 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding oxmName Value")
402 doxm->oxm[i++] = (OicSecOxm_t)tmp;
403 cborFindResult = cbor_value_advance(&oxm);
404 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing oxmName.")
414 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
415 doxm->oxm = (OicSecOxm_t *) OICCalloc(gDoxm->oxmLen, sizeof(*doxm->oxm));
416 VERIFY_NON_NULL(TAG, doxm->oxm, ERROR);
417 doxm->oxmLen = gDoxm->oxmLen;
418 for (size_t i = 0; i < gDoxm->oxmLen; i++)
420 doxm->oxm[i] = gDoxm->oxm[i];
424 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OXM_SEL_NAME, &doxmMap);
425 if (CborNoError == cborFindResult && cbor_value_is_integer(&doxmMap))
429 cborFindResult = cbor_value_get_int(&doxmMap, &oxmSel);
430 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Sel Name Value.")
431 doxm->oxmSel = (OicSecOxm_t)oxmSel;
433 else // PUT/POST JSON may not have oxmsel so set it to the gDoxm->oxmSel
435 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
436 doxm->oxmSel = gDoxm->oxmSel;
439 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_SUPPORTED_CRED_TYPE_NAME, &doxmMap);
440 if (CborNoError == cborFindResult && cbor_value_is_integer(&doxmMap))
444 cborFindResult = cbor_value_get_int(&doxmMap, &sct);
445 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Sct Name Value.")
446 doxm->sct = (OicSecCredType_t)sct;
453 else // PUT/POST JSON may not have sct so set it to the gDoxm->sct
455 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
456 doxm->sct = gDoxm->sct;
459 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OWNED_NAME, &doxmMap);
460 if (CborNoError == cborFindResult && cbor_value_is_boolean(&doxmMap))
462 cborFindResult = cbor_value_get_boolean(&doxmMap, &doxm->owned);
463 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Owned Value.")
465 else // PUT/POST JSON may not have owned so set it to the gDomx->owned
467 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
468 doxm->owned = gDoxm->owned;
471 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_DPC_NAME, &doxmMap);
472 if (CborNoError == cborFindResult && cbor_value_is_boolean(&doxmMap))
474 cborFindResult = cbor_value_get_boolean(&doxmMap, &doxm->dpc);
475 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding DPC Value.")
477 else // PUT/POST JSON may not have dpc so set it to the gDomx->dpc
479 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
480 doxm->dpc = gDoxm->dpc;
483 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_DEVICE_ID_NAME, &doxmMap);
484 if (CborNoError == cborFindResult && cbor_value_is_text_string(&doxmMap))
486 cborFindResult = cbor_value_dup_text_string(&doxmMap, &strUuid , &len, NULL);
487 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Device Id Value.");
488 ret = ConvertStrToUuid(strUuid , &doxm->deviceID);
489 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
500 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
501 memcpy(doxm->deviceID.id, &gDoxm->deviceID.id, sizeof(doxm->deviceID.id));
504 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_DEVOWNERID_NAME, &doxmMap);
505 if (CborNoError == cborFindResult && cbor_value_is_text_string(&doxmMap))
507 cborFindResult = cbor_value_dup_text_string(&doxmMap, &strUuid , &len, NULL);
508 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Owner Value.");
509 ret = ConvertStrToUuid(strUuid , &doxm->owner);
510 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
516 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
517 memcpy(doxm->owner.id, gDoxm->owner.id, sizeof(doxm->owner.id));
520 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_ROWNERID_NAME, &doxmMap);
521 if (CborNoError == cborFindResult && cbor_value_is_text_string(&doxmMap))
523 cborFindResult = cbor_value_dup_text_string(&doxmMap, &strUuid , &len, NULL);
524 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding ROwner Value.");
525 ret = ConvertStrToUuid(strUuid , &doxm->rownerID);
526 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
532 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
533 memcpy(doxm->rownerID.id, gDoxm->rownerID.id, sizeof(doxm->rownerID.id));
540 if (CborNoError != cborFindResult)
542 OIC_LOG (ERROR, TAG, "CBORPayloadToDoxm failed!!!");
543 DeleteDoxmBinData(doxm);
546 ret = OC_STACK_ERROR;
552 * @todo document this function including why code might need to call this.
553 * The current suspicion is that it's not being called as much as it should.
555 static bool UpdatePersistentStorage(OicSecDoxm_t * doxm)
561 // Convert Doxm data into CBOR for update to persistent storage
562 uint8_t *payload = NULL;
564 OCStackResult res = DoxmToCBORPayload(doxm, &payload, &size, false);
565 if (payload && (OC_STACK_OK == res)
566 && (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_DOXM_NAME, payload, size)))
574 if (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_DOXM_NAME, NULL, 0))
583 static bool ValidateQuery(const char * query)
585 // Send doxm resource data if the state of doxm resource
586 // matches with the query parameters.
587 // else send doxm resource data as NULL
588 // TODO Remove this check and rely on Policy Engine
589 // and Provisioning Mode to enforce provisioning-state
590 // access rules. Eventually, the PE and PM code will
591 // not send a request to the /doxm Entity Handler at all
592 // if it should not respond.
593 OIC_LOG (DEBUG, TAG, "In ValidateQuery");
599 bool bOwnedQry = false; // does querystring contains 'owned' query ?
600 bool bOwnedMatch = false; // does 'owned' query value matches with doxm.owned status?
601 bool bDeviceIDQry = false; // does querystring contains 'deviceid' query ?
602 bool bDeviceIDMatch = false; // does 'deviceid' query matches with doxm.deviceid ?
603 bool bInterfaceQry = false; // does querystring contains 'if' query ?
604 bool bInterfaceMatch = false; // does 'if' query matches with oic.if.baseline ?
606 OicParseQueryIter_t parseIter = {.attrPos = NULL};
608 ParseQueryIterInit((unsigned char*)query, &parseIter);
610 while (GetNextQuery(&parseIter))
612 if (strncasecmp((char *)parseIter.attrPos, OIC_JSON_OWNED_NAME, parseIter.attrLen) == 0)
615 if ((strncasecmp((char *)parseIter.valPos, OIC_SEC_TRUE, parseIter.valLen) == 0) &&
620 else if ((strncasecmp((char *)parseIter.valPos, OIC_SEC_FALSE, parseIter.valLen) == 0)
627 if (strncasecmp((char *)parseIter.attrPos, OIC_JSON_DEVICE_ID_NAME, parseIter.attrLen) == 0)
630 OicUuid_t subject = {.id={0}};
632 memcpy(subject.id, parseIter.valPos, parseIter.valLen);
633 if (0 == memcmp(&gDoxm->deviceID.id, &subject.id, sizeof(gDoxm->deviceID.id)))
635 bDeviceIDMatch = true;
639 if (strncasecmp((char *)parseIter.attrPos, OC_RSRVD_INTERFACE, parseIter.attrLen) == 0)
641 bInterfaceQry = true;
642 if ((strncasecmp((char *)parseIter.valPos, OC_RSRVD_INTERFACE_DEFAULT, parseIter.valLen) == 0))
644 bInterfaceMatch = true;
646 return (bInterfaceQry ? bInterfaceMatch: true);
650 return ((bOwnedQry ? bOwnedMatch : true) && (bDeviceIDQry ? bDeviceIDMatch : true));
653 static OCEntityHandlerResult HandleDoxmGetRequest (const OCEntityHandlerRequest * ehRequest)
655 OCEntityHandlerResult ehRet = OC_EH_OK;
657 OIC_LOG(DEBUG, TAG, "Doxm EntityHandle processing GET request");
659 //Checking if Get request is a query.
660 if (ehRequest->query)
662 OIC_LOG_V(DEBUG,TAG,"query:%s",ehRequest->query);
663 OIC_LOG(DEBUG, TAG, "HandleDoxmGetRequest processing query");
664 if (!ValidateQuery(ehRequest->query))
671 * For GET or Valid Query request return doxm resource CBOR payload.
672 * For non-valid query return NULL json payload.
673 * A device will 'always' have a default Doxm, so DoxmToCBORPayload will
674 * return valid doxm resource json.
676 uint8_t *payload = NULL;
679 if (ehRet == OC_EH_OK)
681 if (OC_STACK_OK != DoxmToCBORPayload(gDoxm, &payload, &size, false))
683 OIC_LOG(WARNING, TAG, "DoxmToCBORPayload failed in HandleDoxmGetRequest");
687 OIC_LOG(DEBUG, TAG, "Send payload for doxm GET request");
688 OIC_LOG_BUFFER(DEBUG, TAG, payload, size);
690 // Send response payload to request originator
691 ehRet = ((SendSRMResponse(ehRequest, ehRet, payload, size)) == OC_STACK_OK) ?
692 OC_EH_OK : OC_EH_ERROR;
699 static OCEntityHandlerResult HandleDoxmPostRequest(const OCEntityHandlerRequest * ehRequest)
701 OIC_LOG (DEBUG, TAG, "Doxm EntityHandle processing POST request");
702 OCEntityHandlerResult ehRet = OC_EH_ERROR;
703 OicUuid_t emptyOwner = {.id = {0} };
704 static uint16_t previousMsgId = 0;
707 * Convert CBOR Doxm data into binary. This will also validate
708 * the Doxm data received.
710 OicSecDoxm_t *newDoxm = NULL;
712 if (ehRequest->payload)
714 uint8_t *payload = ((OCSecurityPayload *)ehRequest->payload)->securityData;
715 size_t size = ((OCSecurityPayload *)ehRequest->payload)->payloadSize;
716 bool roParsed = false;
717 OCStackResult res = CBORPayloadToDoxmBin(payload, size, &newDoxm, &roParsed);
718 if (newDoxm && OC_STACK_OK == res)
720 // Check request on RO property
721 if (true == roParsed)
723 OIC_LOG(ERROR, TAG, "Not acceptable request because of read-only propertys");
724 ehRet = OC_EH_NOT_ACCEPTABLE;
729 if (true == gDoxm->owned)
731 // update writable properties
732 gDoxm->oxmSel = newDoxm->oxmSel;
733 memcpy(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t));
734 memcpy(&(gDoxm->rownerID), &(newDoxm->rownerID), sizeof(OicUuid_t));
736 if(gDoxm->owned != newDoxm->owned)
738 gDoxm->owned = newDoxm->owned;
741 //Update new state in persistent storage
742 if (UpdatePersistentStorage(gDoxm) == true)
748 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
755 if ((false == gDoxm->owned) && (false == newDoxm->owned))
757 if (OIC_JUST_WORKS == newDoxm->oxmSel)
760 * If current state of the device is un-owned, enable
761 * anonymous ECDH cipher in tinyDTLS so that Provisioning
762 * tool can initiate JUST_WORKS ownership transfer process.
764 if (memcmp(&(newDoxm->owner), &emptyOwner, sizeof(OicUuid_t)) == 0)
766 OIC_LOG (INFO, TAG, "Doxm EntityHandle enabling AnonECDHCipherSuite");
768 ehRet = (CAEnableAnonECDHCipherSuite(true) == CA_STATUS_OK) ? OC_EH_OK : OC_EH_ERROR;
769 #endif //__WITH_DTLS__
775 //Save the owner's UUID to derive owner credential
776 memcpy(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t));
778 // Update new state in persistent storage
779 if (true == UpdatePersistentStorage(gDoxm))
785 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
790 * Disable anonymous ECDH cipher in tinyDTLS since device is now
793 CAResult_t caRes = CA_STATUS_OK;
794 caRes = CAEnableAnonECDHCipherSuite(false);
795 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
796 OIC_LOG(INFO, TAG, "ECDH_ANON CipherSuite is DISABLED");
799 #define TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 0xC0AE
800 CASelectCipherSuite(TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8,
801 ehRequest->devAddr.adapter);
802 #endif //__WITH_X509__
803 #endif //__WITH_DTLS__
806 else if (OIC_RANDOM_DEVICE_PIN == newDoxm->oxmSel)
809 * If current state of the device is un-owned, enable
810 * anonymous ECDH cipher in tinyDTLS so that Provisioning
811 * tool can initiate JUST_WORKS ownership transfer process.
813 if(memcmp(&(newDoxm->owner), &emptyOwner, sizeof(OicUuid_t)) == 0)
815 gDoxm->oxmSel = newDoxm->oxmSel;
816 //Update new state in persistent storage
817 if ((UpdatePersistentStorage(gDoxm) == true))
823 OIC_LOG(WARNING, TAG, "Failed to update DOXM in persistent storage");
828 CAResult_t caRes = CA_STATUS_OK;
830 caRes = CAEnableAnonECDHCipherSuite(false);
831 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
832 OIC_LOG(INFO, TAG, "ECDH_ANON CipherSuite is DISABLED");
834 caRes = CASelectCipherSuite(TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA_256,
835 ehRequest->devAddr.adapter);
836 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
838 char ranPin[OXM_RANDOM_PIN_SIZE + 1] = {0,};
839 //TODO ehRequest->messageID for copa over TCP always is null. Find reason why.
840 if(ehRequest->devAddr.adapter == OC_ADAPTER_IP && previousMsgId != ehRequest->messageID)
842 if(OC_STACK_OK == GeneratePin(ranPin, OXM_RANDOM_PIN_SIZE + 1))
844 //Set the device id to derive temporal PSK
845 SetUuidForRandomPinOxm(&gDoxm->deviceID);
848 * Since PSK will be used directly by DTLS layer while PIN based ownership transfer,
849 * Credential should not be saved into SVR.
850 * For this reason, use a temporary get_psk_info callback to random PIN OxM.
852 caRes = CARegisterDTLSCredentialsHandler(GetDtlsPskForRandomPinOxm);
853 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
858 OIC_LOG(ERROR, TAG, "Failed to generate random PIN");
864 if(OC_STACK_OK == GeneratePin(ranPin, OXM_RANDOM_PIN_SIZE + 1))
866 //Set the device id to derive temporal PSK
867 SetUuidForRandomPinOxm(&gDoxm->deviceID);
870 * Since PSK will be used directly by DTLS layer while PIN based ownership transfer,
871 * Credential should not be saved into SVR.
872 * For this reason, use a temporary get_psk_info callback to random PIN OxM.
875 caRes = CAregisterTlsCredentialsHandler(GetDtlsPskForRandomPinOxm);
877 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
882 OIC_LOG(ERROR, TAG, "Failed to generate random PIN");
887 #endif //__WITH_DTLS__
892 //Save the owner's UUID to derive owner credential
893 memcpy(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t));
895 //Update new state in persistent storage
896 if (UpdatePersistentStorage(gDoxm) == true)
902 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
911 * When current state of the device is un-owned and Provisioning
912 * Tool is attempting to change the state to 'Owned' with a
913 * qualified value for the field 'Owner'
915 if ((false == gDoxm->owned) && (true == newDoxm->owned) &&
916 (memcmp(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t)) == 0))
918 //Change the SVR's resource owner as owner device.
919 OCStackResult ownerRes = SetAclRownerId(&gDoxm->owner);
920 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
925 ownerRes = SetAmaclRownerId(&gDoxm->owner);
926 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
931 ownerRes = SetCredRownerId(&gDoxm->owner);
932 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
937 ownerRes = SetPstatRownerId(&gDoxm->owner);
938 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
943 ownerRes = SetDpairingRownerId(&gDoxm->owner);
944 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
949 ownerRes = SetPconfRownerId(&gDoxm->owner);
950 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
957 memcpy(&gDoxm->rownerID, &gDoxm->owner, sizeof(OicUuid_t));
959 // Update new state in persistent storage
960 if (UpdatePersistentStorage(gDoxm))
962 //Update default ACE of security resource to prevent anonymous user access.
963 if(OC_STACK_OK == UpdateDefaultSecProvACE())
969 OIC_LOG(ERROR, TAG, "Failed to remove default ACL for security provisioning");
975 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
983 if(OC_EH_OK != ehRet)
987 * If some error is occured while ownership transfer,
988 * ownership transfer related resource should be revert back to initial status.
992 if(!gDoxm->owned && previousMsgId != ehRequest->messageID)
994 OIC_LOG(WARNING, TAG, "The operation failed during handle DOXM request,"\
995 "DOXM will be reverted.");
996 RestoreDoxmToInitState();
997 RestorePstatToInitState();
1002 OIC_LOG(ERROR, TAG, "Invalid DOXM resource.");
1007 previousMsgId = ehRequest->messageID;
1010 //Send payload to request originator
1011 ehRet = ((SendSRMResponse(ehRequest, ehRet, NULL, 0)) == OC_STACK_OK) ?
1012 OC_EH_OK : OC_EH_ERROR;
1014 DeleteDoxmBinData(newDoxm);
1019 OCEntityHandlerResult DoxmEntityHandler(OCEntityHandlerFlag flag,
1020 OCEntityHandlerRequest * ehRequest,
1021 void* callbackParam)
1023 (void)callbackParam;
1024 OCEntityHandlerResult ehRet = OC_EH_ERROR;
1026 if(NULL == ehRequest)
1031 if (flag & OC_REQUEST_FLAG)
1033 OIC_LOG(DEBUG, TAG, "Flag includes OC_REQUEST_FLAG");
1035 switch (ehRequest->method)
1038 ehRet = HandleDoxmGetRequest(ehRequest);
1042 ehRet = HandleDoxmPostRequest(ehRequest);
1046 ehRet = ((SendSRMResponse(ehRequest, ehRet, NULL, 0)) == OC_STACK_OK) ?
1047 OC_EH_OK : OC_EH_ERROR;
1055 OCStackResult CreateDoxmResource()
1057 OCStackResult ret = OCCreateResource(&gDoxmHandle,
1058 OIC_RSRC_TYPE_SEC_DOXM,
1059 OC_RSRVD_INTERFACE_DEFAULT,
1066 if (OC_STACK_OK != ret)
1068 OIC_LOG (FATAL, TAG, "Unable to instantiate Doxm resource");
1069 DeInitDoxmResource();
1075 * Checks if DeviceID is generated during provisioning for the new device.
1076 * If DeviceID is NULL then generates the new DeviceID.
1077 * Once DeviceID is assigned to the device it does not change for the lifetime of the device.
1079 static OCStackResult CheckDeviceID()
1081 OCStackResult ret = OC_STACK_ERROR;
1082 bool validId = false;
1083 for (uint8_t i = 0; i < UUID_LENGTH; i++)
1085 if (gDoxm->deviceID.id[i] != 0)
1094 if (OCGenerateUuid(gDoxm->deviceID.id) != RAND_UUID_OK)
1096 OIC_LOG(FATAL, TAG, "Generate UUID for Server Instance failed!");
1101 if (!UpdatePersistentStorage(gDoxm))
1103 //TODO: After registering PSI handler in all samples, do ret = OC_STACK_OK here.
1104 OIC_LOG(FATAL, TAG, "UpdatePersistentStorage failed!");
1115 * Get the default value.
1117 * @return the default value of doxm, @ref OicSecDoxm_t.
1119 static OicSecDoxm_t* GetDoxmDefault()
1121 OIC_LOG(DEBUG, TAG, "GetDoxmToDefault");
1122 return &gDefaultDoxm;
1125 const OicSecDoxm_t* GetDoxmResourceData()
1130 OCStackResult InitDoxmResource()
1132 OCStackResult ret = OC_STACK_ERROR;
1134 //Read DOXM resource from PS
1135 uint8_t *data = NULL;
1137 ret = GetSecureVirtualDatabaseFromPS(OIC_JSON_DOXM_NAME, &data, &size);
1138 // If database read failed
1139 if (OC_STACK_OK != ret)
1141 OIC_LOG (DEBUG, TAG, "ReadSVDataFromPS failed");
1145 // Read DOXM resource from PS
1146 ret = CBORPayloadToDoxm(data, size, &gDoxm);
1149 * If SVR database in persistent storage got corrupted or
1150 * is not available for some reason, a default doxm is created
1151 * which allows user to initiate doxm provisioning again.
1153 if ((OC_STACK_OK != ret) || !data || !gDoxm)
1155 gDoxm = GetDoxmDefault();
1158 //In case of the server is shut down unintentionally, we should initialize the owner
1159 if(false == gDoxm->owned)
1161 OicUuid_t emptyUuid = {.id={0}};
1162 memcpy(&gDoxm->owner, &emptyUuid, sizeof(OicUuid_t));
1165 ret = CheckDeviceID();
1166 if (ret == OC_STACK_OK)
1168 OIC_LOG_V(DEBUG, TAG, "Initial Doxm Owned = %d", gDoxm->owned);
1169 //Instantiate 'oic.sec.doxm'
1170 ret = CreateDoxmResource();
1174 OIC_LOG (ERROR, TAG, "CheckDeviceID failed");
1180 OCStackResult DeInitDoxmResource()
1182 OCStackResult ret = OCDeleteResource(gDoxmHandle);
1183 if (gDoxm != &gDefaultDoxm)
1185 DeleteDoxmBinData(gDoxm);
1189 if (OC_STACK_OK == ret)
1195 return OC_STACK_ERROR;
1199 OCStackResult GetDoxmDeviceID(OicUuid_t *deviceID)
1201 if (deviceID && gDoxm)
1203 *deviceID = gDoxm->deviceID;
1206 return OC_STACK_ERROR;
1209 OCStackResult SetDoxmDeviceID(const OicUuid_t *deviceID)
1213 if(NULL == deviceID)
1215 return OC_STACK_INVALID_PARAM;
1219 OIC_LOG(ERROR, TAG, "Doxm resource is not initialized.");
1220 return OC_STACK_NO_RESOURCE;
1223 //Check the device's OTM state
1225 #ifdef __WITH_DTLS__}
1226 //for normal device.
1227 if(true == gDoxm->owned)
1229 OIC_LOG(ERROR, TAG, "This device owned by owner's device.");
1230 OIC_LOG(ERROR, TAG, "Device UUID cannot be changed to guarantee the reliability of the connection.");
1231 return OC_STACK_ERROR;
1233 #endif //__WITH_DTLS
1235 //Save the previous UUID
1237 memcpy(tempUuid.id, gDoxm->deviceID.id, sizeof(tempUuid.id));
1240 memcpy(gDoxm->deviceID.id, deviceID->id, sizeof(deviceID->id));
1243 memcpy(gDoxm->owner.id, deviceID->id, sizeof(deviceID->id));
1244 memcpy(gDoxm->rownerID.id, deviceID->id, sizeof(deviceID->id));
1248 if(!UpdatePersistentStorage(gDoxm))
1250 //revert UUID in case of update error
1251 memcpy(gDoxm->deviceID.id, tempUuid.id, sizeof(tempUuid.id));
1254 memcpy(gDoxm->owner.id, tempUuid.id, sizeof(tempUuid.id));
1255 memcpy(gDoxm->rownerID.id, tempUuid.id, sizeof(tempUuid.id));
1258 OIC_LOG(ERROR, TAG, "Failed to update persistent storage");
1259 return OC_STACK_ERROR;
1264 OCStackResult GetDoxmDevOwnerId(OicUuid_t *devownerid)
1266 OCStackResult retVal = OC_STACK_ERROR;
1269 OIC_LOG_V(DEBUG, TAG, "GetDoxmDevOwnerId(): gDoxm owned = %d.", \
1273 *devownerid = gDoxm->owner;
1274 retVal = OC_STACK_OK;
1280 OCStackResult GetDoxmRownerId(OicUuid_t *rowneruuid)
1282 OCStackResult retVal = OC_STACK_ERROR;
1287 *rowneruuid = gDoxm->rownerID;
1288 retVal = OC_STACK_OK;
1295 * Function to restore doxm resurce to initial status.
1296 * This function will use in case of error while ownership transfer
1298 void RestoreDoxmToInitState()
1302 OIC_LOG(INFO, TAG, "DOXM resource will revert back to initial status.");
1304 OicUuid_t emptyUuid = {.id={0}};
1305 memcpy(&(gDoxm->owner), &emptyUuid, sizeof(OicUuid_t));
1306 gDoxm->owned = false;
1307 gDoxm->oxmSel = OIC_JUST_WORKS;
1309 if(!UpdatePersistentStorage(gDoxm))
1311 OIC_LOG(ERROR, TAG, "Failed to revert DOXM in persistent storage");