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 */
84 void DeleteDoxmBinData(OicSecDoxm_t* doxm)
89 for (size_t i = 0; i < doxm->oxmTypeLen; i++)
91 OICFree(doxm->oxmType[i]);
93 OICFree(doxm->oxmType);
103 OCStackResult DoxmToCBORPayload(const OicSecDoxm_t *doxm, uint8_t **payload, size_t *size)
105 if (NULL == doxm || NULL == payload || NULL != *payload || NULL == size)
107 return OC_STACK_INVALID_PARAM;
109 size_t cborLen = *size;
117 OCStackResult ret = OC_STACK_ERROR;
121 char* strUuid = NULL;
123 int64_t cborEncoderResult = CborNoError;
124 uint8_t mapSize = DOXM_MAP_SIZE;
125 if (doxm->oxmTypeLen > 0)
129 if (doxm->oxmLen > 0)
134 uint8_t *outPayload = (uint8_t *)OICCalloc(1, cborLen);
135 VERIFY_NON_NULL(TAG, outPayload, ERROR);
136 cbor_encoder_init(&encoder, outPayload, cborLen, 0);
138 cborEncoderResult = cbor_encoder_create_map(&encoder, &doxmMap, mapSize);
139 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Doxm Map.");
141 //OxmType -- Not Mandatory
142 if (doxm->oxmTypeLen > 0)
145 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OXM_TYPE_NAME,
146 strlen(OIC_JSON_OXM_TYPE_NAME));
147 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmType Tag.");
148 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &oxmType, doxm->oxmTypeLen);
149 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmType Array.");
151 for (size_t i = 0; i < doxm->oxmTypeLen; i++)
153 cborEncoderResult = cbor_encode_text_string(&oxmType, doxm->oxmType[i],
154 strlen(doxm->oxmType[i]));
155 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmType Value.");
157 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &oxmType);
158 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing oxmType.");
161 //Oxm -- Not Mandatory
162 if (doxm->oxmLen > 0)
165 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OXMS_NAME,
166 strlen(OIC_JSON_OXMS_NAME));
167 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmName Tag.");
168 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &oxm, doxm->oxmLen);
169 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmName Array.");
171 for (size_t i = 0; i < doxm->oxmLen; i++)
173 cborEncoderResult = cbor_encode_int(&oxm, doxm->oxm[i]);
174 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding oxmName Value");
176 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &oxm);
177 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing oxmName.");
180 //OxmSel -- Mandatory
181 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OXM_SEL_NAME,
182 strlen(OIC_JSON_OXM_SEL_NAME));
183 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Sel Tag.");
184 cborEncoderResult = cbor_encode_int(&doxmMap, doxm->oxmSel);
185 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Sel Value.");
188 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_SUPPORTED_CRED_TYPE_NAME,
189 strlen(OIC_JSON_SUPPORTED_CRED_TYPE_NAME));
190 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Type Tag");
191 cborEncoderResult = cbor_encode_int(&doxmMap, doxm->sct);
192 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Type Value.");
195 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_OWNED_NAME,
196 strlen(OIC_JSON_OWNED_NAME));
197 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owned Tag.");
198 cborEncoderResult = cbor_encode_boolean(&doxmMap, doxm->owned);
199 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owned Value.");
201 //DeviceId -- Mandatory
202 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_DEVICE_ID_NAME,
203 strlen(OIC_JSON_DEVICE_ID_NAME));
204 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Tag.");
205 ret = ConvertUuidToStr(&doxm->deviceID, &strUuid);
206 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
207 cborEncoderResult = cbor_encode_text_string(&doxmMap, strUuid, strlen(strUuid));
208 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Value.");
212 //devownerid -- Mandatory
213 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_DEVOWNERID_NAME,
214 strlen(OIC_JSON_DEVOWNERID_NAME));
215 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owner Id Tag.");
216 ret = ConvertUuidToStr(&doxm->owner, &strUuid);
217 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
218 cborEncoderResult = cbor_encode_text_string(&doxmMap, strUuid, strlen(strUuid));
219 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Owner Id Value.");
223 //ROwner -- Mandatory
224 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_ROWNERID_NAME,
225 strlen(OIC_JSON_ROWNERID_NAME));
226 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Tag.");
227 ret = ConvertUuidToStr(&doxm->rownerID, &strUuid);
228 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
229 cborEncoderResult = cbor_encode_text_string(&doxmMap, strUuid, strlen(strUuid));
230 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Value.");
234 //DPC -- not Mandatory, but this type is boolean, so instance always has a value.
235 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_DPC_NAME,
236 strlen(OIC_JSON_DPC_NAME));
237 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding DPC Tag.");
238 cborEncoderResult = cbor_encode_boolean(&doxmMap, doxm->dpc);
239 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding DPC Value.");
243 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_RT_NAME,
244 strlen(OIC_JSON_RT_NAME));
245 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Name Tag.");
246 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &rtArray, 1);
247 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Value.");
248 for (size_t i = 0; i < 1; i++)
250 cborEncoderResult = cbor_encode_text_string(&rtArray, OIC_RSRC_TYPE_SEC_DOXM,
251 strlen(OIC_RSRC_TYPE_SEC_DOXM));
252 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding RT Value.");
254 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &rtArray);
255 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing RT.");
259 cborEncoderResult = cbor_encode_text_string(&doxmMap, OIC_JSON_IF_NAME,
260 strlen(OIC_JSON_IF_NAME));
261 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Name Tag.");
262 cborEncoderResult = cbor_encoder_create_array(&doxmMap, &ifArray, 1);
263 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Value.");
264 for (size_t i = 0; i < 1; i++)
266 cborEncoderResult = cbor_encode_text_string(&ifArray, OC_RSRVD_INTERFACE_DEFAULT,
267 strlen(OC_RSRVD_INTERFACE_DEFAULT));
268 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding IF Value.");
270 cborEncoderResult = cbor_encoder_close_container(&doxmMap, &ifArray);
271 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing IF.");
273 cborEncoderResult = cbor_encoder_close_container(&encoder, &doxmMap);
274 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing DoxmMap.");
276 if (CborNoError == cborEncoderResult)
278 *size = encoder.ptr - outPayload;
279 *payload = outPayload;
283 if ((CborErrorOutOfMemory == cborEncoderResult) && (cborLen < CBOR_MAX_SIZE))
285 OIC_LOG(DEBUG, TAG, "Memory getting reallocated.");
286 // reallocate and try again!
288 // Since the allocated initial memory failed, double the memory.
289 cborLen += encoder.ptr - encoder.end;
290 OIC_LOG_V(DEBUG, TAG, "Doxm reallocation size : %zd.", cborLen);
291 cborEncoderResult = CborNoError;
292 ret = DoxmToCBORPayload(doxm, payload, &cborLen);
296 if ((CborNoError != cborEncoderResult) || (OC_STACK_OK != ret))
302 ret = OC_STACK_ERROR;
308 OCStackResult CBORPayloadToDoxm(const uint8_t *cborPayload, size_t size,
309 OicSecDoxm_t **secDoxm)
311 if (NULL == cborPayload || NULL == secDoxm || NULL != *secDoxm || 0 == size)
313 return OC_STACK_INVALID_PARAM;
316 OCStackResult ret = OC_STACK_ERROR;
320 CborError cborFindResult = CborNoError;
321 char* strUuid = NULL;
325 cbor_parser_init(cborPayload, size, 0, &parser, &doxmCbor);
327 OicSecDoxm_t *doxm = (OicSecDoxm_t *)OICCalloc(1, sizeof(*doxm));
328 VERIFY_NON_NULL(TAG, doxm, ERROR);
330 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OXM_TYPE_NAME, &doxmMap);
331 //OxmType -- not Mandatory
332 if (CborNoError == cborFindResult && cbor_value_is_array(&doxmMap))
336 cborFindResult = cbor_value_get_array_length(&doxmMap, &doxm->oxmTypeLen);
337 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding oxmTypeLen.")
338 VERIFY_SUCCESS(TAG, doxm->oxmTypeLen != 0, ERROR);
340 doxm->oxmType = (OicUrn_t *)OICCalloc(doxm->oxmTypeLen, sizeof(*doxm->oxmType));
341 VERIFY_NON_NULL(TAG, doxm->oxmType, ERROR);
343 cborFindResult = cbor_value_enter_container(&doxmMap, &oxmType);
344 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering oxmType Array.")
348 while (cbor_value_is_valid(&oxmType) && cbor_value_is_text_string(&oxmType))
350 cborFindResult = cbor_value_dup_text_string(&oxmType, &doxm->oxmType[i++],
352 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding omxType text string.")
353 cborFindResult = cbor_value_advance(&oxmType);
354 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing oxmType.")
358 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OXMS_NAME, &doxmMap);
359 //Oxm -- not Mandatory
360 if (CborNoError == cborFindResult && cbor_value_is_array(&doxmMap))
363 cborFindResult = cbor_value_get_array_length(&doxmMap, &doxm->oxmLen);
364 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding oxmName array Length.")
365 VERIFY_SUCCESS(TAG, doxm->oxmLen != 0, ERROR);
367 doxm->oxm = (OicSecOxm_t *)OICCalloc(doxm->oxmLen, sizeof(*doxm->oxm));
368 VERIFY_NON_NULL(TAG, doxm->oxm, ERROR);
370 cborFindResult = cbor_value_enter_container(&doxmMap, &oxm);
371 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering oxmName Array.")
374 while (cbor_value_is_valid(&oxm) && cbor_value_is_integer(&oxm))
376 cborFindResult = cbor_value_get_int(&oxm, (int *) &doxm->oxm[i++]);
377 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding oxmName Value")
378 cborFindResult = cbor_value_advance(&oxm);
379 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing oxmName.")
383 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OXM_SEL_NAME, &doxmMap);
384 if (CborNoError == cborFindResult && cbor_value_is_integer(&doxmMap))
386 cborFindResult = cbor_value_get_int(&doxmMap, (int *) &doxm->oxmSel);
387 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Sel Name Value.")
389 else // PUT/POST JSON may not have oxmsel so set it to the gDoxm->oxmSel
391 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
392 doxm->oxmSel = gDoxm->oxmSel;
395 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_SUPPORTED_CRED_TYPE_NAME, &doxmMap);
396 if (CborNoError == cborFindResult && cbor_value_is_integer(&doxmMap))
398 cborFindResult = cbor_value_get_int(&doxmMap, (int *) &doxm->sct);
399 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Sct Name Value.")
401 else // PUT/POST JSON may not have sct so set it to the gDoxm->sct
403 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
404 doxm->sct = gDoxm->sct;
407 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_OWNED_NAME, &doxmMap);
408 if (CborNoError == cborFindResult && cbor_value_is_boolean(&doxmMap))
410 cborFindResult = cbor_value_get_boolean(&doxmMap, &doxm->owned);
411 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Owned Value.")
413 else // PUT/POST JSON may not have owned so set it to the gDomx->owned
415 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
416 doxm->owned = gDoxm->owned;
419 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_DPC_NAME, &doxmMap);
420 if (CborNoError == cborFindResult && cbor_value_is_boolean(&doxmMap))
422 cborFindResult = cbor_value_get_boolean(&doxmMap, &doxm->dpc);
423 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding DPC Value.")
425 else // PUT/POST JSON may not have dpc so set it to the gDomx->dpc
427 VERIFY_NON_NULL(TAG, gDoxm, ERROR);
428 doxm->dpc = gDoxm->dpc;
431 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_DEVICE_ID_NAME, &doxmMap);
432 if (CborNoError == cborFindResult && cbor_value_is_text_string(&doxmMap))
434 cborFindResult = cbor_value_dup_text_string(&doxmMap, &strUuid , &len, NULL);
435 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Device Id Value.");
436 ret = ConvertStrToUuid(strUuid , &doxm->deviceID);
437 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
442 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_DEVOWNERID_NAME, &doxmMap);
443 if (CborNoError == cborFindResult && cbor_value_is_text_string(&doxmMap))
445 cborFindResult = cbor_value_dup_text_string(&doxmMap, &strUuid , &len, NULL);
446 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Owner Value.");
447 ret = ConvertStrToUuid(strUuid , &doxm->owner);
448 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
453 cborFindResult = cbor_value_map_find_value(&doxmCbor, OIC_JSON_ROWNERID_NAME, &doxmMap);
454 if (CborNoError == cborFindResult && cbor_value_is_text_string(&doxmMap))
456 cborFindResult = cbor_value_dup_text_string(&doxmMap, &strUuid , &len, NULL);
457 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding ROwner Value.");
458 ret = ConvertStrToUuid(strUuid , &doxm->rownerID);
459 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
468 if (CborNoError != cborFindResult)
470 OIC_LOG (ERROR, TAG, "CBORPayloadToDoxm failed!!!");
471 DeleteDoxmBinData(doxm);
474 ret = OC_STACK_ERROR;
480 * @todo document this function including why code might need to call this.
481 * The current suspicion is that it's not being called as much as it should.
483 static bool UpdatePersistentStorage(OicSecDoxm_t * doxm)
489 // Convert Doxm data into CBOR for update to persistent storage
490 uint8_t *payload = NULL;
492 OCStackResult res = DoxmToCBORPayload(doxm, &payload, &size);
493 if (payload && (OC_STACK_OK == res)
494 && (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_DOXM_NAME, payload, size)))
502 if (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_DOXM_NAME, NULL, 0))
511 static bool ValidateQuery(const char * query)
513 // Send doxm resource data if the state of doxm resource
514 // matches with the query parameters.
515 // else send doxm resource data as NULL
516 // TODO Remove this check and rely on Policy Engine
517 // and Provisioning Mode to enforce provisioning-state
518 // access rules. Eventually, the PE and PM code will
519 // not send a request to the /doxm Entity Handler at all
520 // if it should not respond.
521 OIC_LOG (DEBUG, TAG, "In ValidateQuery");
527 bool bOwnedQry = false; // does querystring contains 'owned' query ?
528 bool bOwnedMatch = false; // does 'owned' query value matches with doxm.owned status?
529 bool bDeviceIDQry = false; // does querystring contains 'deviceid' query ?
530 bool bDeviceIDMatch = false; // does 'deviceid' query matches with doxm.deviceid ?
531 bool bInterfaceQry = false; // does querystring contains 'if' query ?
532 bool bInterfaceMatch = false; // does 'if' query matches with oic.if.baseline ?
534 OicParseQueryIter_t parseIter = {.attrPos = NULL};
536 ParseQueryIterInit((unsigned char*)query, &parseIter);
538 while (GetNextQuery(&parseIter))
540 if (strncasecmp((char *)parseIter.attrPos, OIC_JSON_OWNED_NAME, parseIter.attrLen) == 0)
543 if ((strncasecmp((char *)parseIter.valPos, OIC_SEC_TRUE, parseIter.valLen) == 0) &&
548 else if ((strncasecmp((char *)parseIter.valPos, OIC_SEC_FALSE, parseIter.valLen) == 0)
555 if (strncasecmp((char *)parseIter.attrPos, OIC_JSON_DEVICE_ID_NAME, parseIter.attrLen) == 0)
558 OicUuid_t subject = {.id={0}};
560 memcpy(subject.id, parseIter.valPos, parseIter.valLen);
561 if (0 == memcmp(&gDoxm->deviceID.id, &subject.id, sizeof(gDoxm->deviceID.id)))
563 bDeviceIDMatch = true;
567 if (strncasecmp((char *)parseIter.attrPos, OC_RSRVD_INTERFACE, parseIter.attrLen) == 0)
569 bInterfaceQry = true;
570 if ((strncasecmp((char *)parseIter.valPos, OC_RSRVD_INTERFACE_DEFAULT, parseIter.valLen) == 0))
572 bInterfaceMatch = true;
574 return (bInterfaceQry ? bInterfaceMatch: true);
578 return ((bOwnedQry ? bOwnedMatch : true) && (bDeviceIDQry ? bDeviceIDMatch : true));
581 static OCEntityHandlerResult HandleDoxmGetRequest (const OCEntityHandlerRequest * ehRequest)
583 OCEntityHandlerResult ehRet = OC_EH_OK;
585 OIC_LOG(DEBUG, TAG, "Doxm EntityHandle processing GET request");
587 //Checking if Get request is a query.
588 if (ehRequest->query)
590 OIC_LOG_V(DEBUG,TAG,"query:%s",ehRequest->query);
591 OIC_LOG(DEBUG, TAG, "HandleDoxmGetRequest processing query");
592 if (!ValidateQuery(ehRequest->query))
599 * For GET or Valid Query request return doxm resource CBOR payload.
600 * For non-valid query return NULL json payload.
601 * A device will 'always' have a default Doxm, so DoxmToCBORPayload will
602 * return valid doxm resource json.
604 uint8_t *payload = NULL;
607 if (ehRet == OC_EH_OK)
609 if (OC_STACK_OK != DoxmToCBORPayload(gDoxm, &payload, &size))
611 OIC_LOG(WARNING, TAG, "DoxmToCBORPayload failed in HandleDoxmGetRequest");
615 // Send response payload to request originator
616 if (OC_STACK_OK != SendSRMResponse(ehRequest, ehRet, payload, size))
619 OIC_LOG(ERROR, TAG, "SendSRMResponse failed in HandleDoxmGetRequest");
627 static OCEntityHandlerResult HandleDoxmPostRequest(const OCEntityHandlerRequest * ehRequest)
629 OIC_LOG (DEBUG, TAG, "Doxm EntityHandle processing POST request");
630 OCEntityHandlerResult ehRet = OC_EH_ERROR;
631 OicUuid_t emptyOwner = {.id = {0} };
632 static uint16_t previousMsgId = 0;
635 * Convert CBOR Doxm data into binary. This will also validate
636 * the Doxm data received.
638 OicSecDoxm_t *newDoxm = NULL;
640 if (ehRequest->payload)
642 uint8_t *payload = ((OCSecurityPayload *)ehRequest->payload)->securityData;
643 size_t size = ((OCSecurityPayload *)ehRequest->payload)->payloadSize;
644 OCStackResult res = CBORPayloadToDoxm(payload, size, &newDoxm);
646 if (newDoxm && OC_STACK_OK == res)
648 if (OIC_JUST_WORKS == newDoxm->oxmSel)
650 if ((false == gDoxm->owned) && (false == newDoxm->owned))
653 * If current state of the device is un-owned, enable
654 * anonymous ECDH cipher in tinyDTLS so that Provisioning
655 * tool can initiate JUST_WORKS ownership transfer process.
657 if (memcmp(&(newDoxm->owner), &emptyOwner, sizeof(OicUuid_t)) == 0)
659 OIC_LOG (INFO, TAG, "Doxm EntityHandle enabling AnonECDHCipherSuite");
661 ehRet = (CAEnableAnonECDHCipherSuite(true) == CA_STATUS_OK) ? OC_EH_OK : OC_EH_ERROR;
662 #endif //__WITH_DTLS__
668 //Save the owner's UUID to derive owner credential
669 memcpy(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t));
671 // Update new state in persistent storage
672 if (true == UpdatePersistentStorage(gDoxm))
678 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
683 * Disable anonymous ECDH cipher in tinyDTLS since device is now
686 CAResult_t caRes = CA_STATUS_OK;
687 caRes = CAEnableAnonECDHCipherSuite(false);
688 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
689 OIC_LOG(INFO, TAG, "ECDH_ANON CipherSuite is DISABLED");
692 #define TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 0xC0AE
693 CASelectCipherSuite(TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8);
694 #endif //__WITH_X509__
695 #endif //__WITH_DTLS__
699 else if (OIC_RANDOM_DEVICE_PIN == newDoxm->oxmSel)
701 if ((false == gDoxm->owned) && (false == newDoxm->owned))
704 * If current state of the device is un-owned, enable
705 * anonymous ECDH cipher in tinyDTLS so that Provisioning
706 * tool can initiate JUST_WORKS ownership transfer process.
708 if(memcmp(&(newDoxm->owner), &emptyOwner, sizeof(OicUuid_t)) == 0)
710 gDoxm->oxmSel = newDoxm->oxmSel;
711 //Update new state in persistent storage
712 if ((UpdatePersistentStorage(gDoxm) == true))
718 OIC_LOG(WARNING, TAG, "Failed to update DOXM in persistent storage");
723 CAResult_t caRes = CA_STATUS_OK;
725 caRes = CAEnableAnonECDHCipherSuite(false);
726 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
727 OIC_LOG(INFO, TAG, "ECDH_ANON CipherSuite is DISABLED");
729 caRes = CASelectCipherSuite(TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA_256);
730 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
732 if(previousMsgId != ehRequest->messageID)
734 char ranPin[OXM_RANDOM_PIN_SIZE + 1] = {0,};
735 if(OC_STACK_OK == GeneratePin(ranPin, OXM_RANDOM_PIN_SIZE + 1))
737 //Set the device id to derive temporal PSK
738 SetUuidForRandomPinOxm(&gDoxm->deviceID);
741 * Since PSK will be used directly by DTLS layer while PIN based ownership transfer,
742 * Credential should not be saved into SVR.
743 * For this reason, use a temporary get_psk_info callback to random PIN OxM.
745 caRes = CARegisterDTLSCredentialsHandler(GetDtlsPskForRandomPinOxm);
746 VERIFY_SUCCESS(TAG, caRes == CA_STATUS_OK, ERROR);
751 OIC_LOG(ERROR, TAG, "Failed to generate random PIN");
754 previousMsgId = ehRequest->messageID;
756 #endif //__WITH_DTLS__
761 //Save the owner's UUID to derive owner credential
762 memcpy(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t));
764 //Update new state in persistent storage
765 if (UpdatePersistentStorage(gDoxm) == true)
771 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
780 * When current state of the device is un-owned and Provisioning
781 * Tool is attempting to change the state to 'Owned' with a
782 * qualified value for the field 'Owner'
784 if ((false == gDoxm->owned) && (true == newDoxm->owned) &&
785 (memcmp(&(gDoxm->owner), &(newDoxm->owner), sizeof(OicUuid_t)) == 0))
787 //Change the SVR's resource owner as owner device.
788 OCStackResult ownerRes = SetAclRownerId(&gDoxm->owner);
789 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
794 ownerRes = SetAmaclRownerId(&gDoxm->owner);
795 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
800 ownerRes = SetCredRownerId(&gDoxm->owner);
801 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
806 ownerRes = SetPstatRownerId(&gDoxm->owner);
807 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
812 ownerRes = SetDpairingRownerId(&gDoxm->owner);
813 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
818 ownerRes = SetPconfRownerId(&gDoxm->owner);
819 if(OC_STACK_OK != ownerRes && OC_STACK_NO_RESOURCE != ownerRes)
826 memcpy(&gDoxm->rownerID, &gDoxm->owner, sizeof(OicUuid_t));
828 // Update new state in persistent storage
829 if (UpdatePersistentStorage(gDoxm))
831 //Update default ACL of security resource to prevent anonymous user access.
832 if(OC_STACK_OK == UpdateDefaultSecProvACL())
838 OIC_LOG(ERROR, TAG, "Failed to remove default ACL for security provisioning");
844 OIC_LOG(ERROR, TAG, "Failed to update DOXM in persistent storage");
852 if(OC_EH_OK != ehRet)
854 OIC_LOG(WARNING, TAG, "The operation failed during handle DOXM request,"\
855 "DOXM will be reverted.");
858 * If some error is occured while ownership transfer,
859 * ownership transfer related resource should be revert back to initial status.
861 RestoreDoxmToInitState();
862 RestorePstatToInitState();
865 //Send payload to request originator
866 if (OC_STACK_OK != SendSRMResponse(ehRequest, ehRet, NULL, 0))
869 OIC_LOG(ERROR, TAG, "SendSRMResponse failed in HandleDoxmPostRequest");
871 DeleteDoxmBinData(newDoxm);
876 OCEntityHandlerResult DoxmEntityHandler(OCEntityHandlerFlag flag,
877 OCEntityHandlerRequest * ehRequest,
881 OCEntityHandlerResult ehRet = OC_EH_ERROR;
883 if(NULL == ehRequest)
888 if (flag & OC_REQUEST_FLAG)
890 OIC_LOG(DEBUG, TAG, "Flag includes OC_REQUEST_FLAG");
892 switch (ehRequest->method)
895 ehRet = HandleDoxmGetRequest(ehRequest);
899 ehRet = HandleDoxmPostRequest(ehRequest);
904 SendSRMResponse(ehRequest, ehRet, NULL, 0);
912 OCStackResult CreateDoxmResource()
914 OCStackResult ret = OCCreateResource(&gDoxmHandle,
915 OIC_RSRC_TYPE_SEC_DOXM,
916 OC_RSRVD_INTERFACE_DEFAULT,
923 if (OC_STACK_OK != ret)
925 OIC_LOG (FATAL, TAG, "Unable to instantiate Doxm resource");
926 DeInitDoxmResource();
932 * Checks if DeviceID is generated during provisioning for the new device.
933 * If DeviceID is NULL then generates the new DeviceID.
934 * Once DeviceID is assigned to the device it does not change for the lifetime of the device.
936 static OCStackResult CheckDeviceID()
938 OCStackResult ret = OC_STACK_ERROR;
939 bool validId = false;
940 for (uint8_t i = 0; i < UUID_LENGTH; i++)
942 if (gDoxm->deviceID.id[i] != 0)
951 if (OCGenerateUuid(gDoxm->deviceID.id) != RAND_UUID_OK)
953 OIC_LOG(FATAL, TAG, "Generate UUID for Server Instance failed!");
958 if (!UpdatePersistentStorage(gDoxm))
960 //TODO: After registering PSI handler in all samples, do ret = OC_STACK_OK here.
961 OIC_LOG(FATAL, TAG, "UpdatePersistentStorage failed!");
972 * Get the default value.
974 * @return the default value of doxm, @ref OicSecDoxm_t.
976 static OicSecDoxm_t* GetDoxmDefault()
978 OIC_LOG(DEBUG, TAG, "GetDoxmToDefault");
979 return &gDefaultDoxm;
982 const OicSecDoxm_t* GetDoxmResourceData()
987 OCStackResult InitDoxmResource()
989 OCStackResult ret = OC_STACK_ERROR;
991 //Read DOXM resource from PS
992 uint8_t *data = NULL;
994 ret = GetSecureVirtualDatabaseFromPS(OIC_JSON_DOXM_NAME, &data, &size);
995 // If database read failed
996 if (OC_STACK_OK != ret)
998 OIC_LOG (DEBUG, TAG, "ReadSVDataFromPS failed");
1002 // Read DOXM resource from PS
1003 ret = CBORPayloadToDoxm(data, size, &gDoxm);
1006 * If SVR database in persistent storage got corrupted or
1007 * is not available for some reason, a default doxm is created
1008 * which allows user to initiate doxm provisioning again.
1010 if ((OC_STACK_OK != ret) || !data || !gDoxm)
1012 gDoxm = GetDoxmDefault();
1015 //In case of the server is shut down unintentionally, we should initialize the owner
1016 if(false == gDoxm->owned)
1018 OicUuid_t emptyUuid = {.id={0}};
1019 memcpy(&gDoxm->owner, &emptyUuid, sizeof(OicUuid_t));
1022 ret = CheckDeviceID();
1023 if (ret == OC_STACK_OK)
1025 OIC_LOG_V(DEBUG, TAG, "Initial Doxm Owned = %d", gDoxm->owned);
1026 //Instantiate 'oic.sec.doxm'
1027 ret = CreateDoxmResource();
1031 OIC_LOG (ERROR, TAG, "CheckDeviceID failed");
1037 OCStackResult DeInitDoxmResource()
1039 OCStackResult ret = OCDeleteResource(gDoxmHandle);
1040 if (gDoxm != &gDefaultDoxm)
1042 DeleteDoxmBinData(gDoxm);
1046 if (OC_STACK_OK == ret)
1052 return OC_STACK_ERROR;
1056 OCStackResult GetDoxmDeviceID(OicUuid_t *deviceID)
1058 if (deviceID && gDoxm)
1060 *deviceID = gDoxm->deviceID;
1063 return OC_STACK_ERROR;
1066 OCStackResult GetDoxmDevOwnerId(OicUuid_t *devownerid)
1068 OCStackResult retVal = OC_STACK_ERROR;
1071 OIC_LOG_V(DEBUG, TAG, "GetDoxmDevOwnerId(): gDoxm owned = %d.", \
1075 *devownerid = gDoxm->owner;
1076 retVal = OC_STACK_OK;
1082 OCStackResult GetDoxmRownerId(OicUuid_t *rowneruuid)
1084 OCStackResult retVal = OC_STACK_ERROR;
1089 *rowneruuid = gDoxm->rownerID;
1090 retVal = OC_STACK_OK;
1097 * Function to restore doxm resurce to initial status.
1098 * This function will use in case of error while ownership transfer
1100 void RestoreDoxmToInitState()
1104 OIC_LOG(INFO, TAG, "DOXM resource will revert back to initial status.");
1106 OicUuid_t emptyUuid = {.id={0}};
1107 memcpy(&(gDoxm->owner), &emptyUuid, sizeof(OicUuid_t));
1108 gDoxm->owned = false;
1109 gDoxm->oxmSel = OIC_JUST_WORKS;
1111 if(!UpdatePersistentStorage(gDoxm))
1113 OIC_LOG(ERROR, TAG, "Failed to revert DOXM in persistent storage");