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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
21 #define __STDC_LIMIT_MACROS
31 #include "cainterface.h"
32 #include "payload_logging.h"
36 #include "ocserverrequest.h"
37 #include "oic_malloc.h"
38 #include "ocpayload.h"
40 #include "credresource.h"
41 #include "doxmresource.h"
42 #include "pstatresource.h"
43 #include "iotvticalendar.h"
45 #include "resourcemanager.h"
46 #include "srmresourcestrings.h"
47 #include "srmutility.h"
48 #include "psinterface.h"
49 #include "pinoxmcommon.h"
55 #define TAG "SRM-CREDL"
57 /** Default cbor payload size. This value is increased in case of CborErrorOutOfMemory.
58 * The value of payload size is increased until reaching belox max cbor size. */
59 static const uint16_t CBOR_SIZE = 2048;
61 /** Max cbor size payload. */
62 static const uint16_t CBOR_MAX_SIZE = 4400;
64 /** CRED size - Number of mandatory items. */
65 static const uint8_t CRED_ROOT_MAP_SIZE = 2;
66 static const uint8_t CRED_MAP_SIZE = 3;
69 static OicSecCred_t *gCred = NULL;
70 static OCResourceHandle gCredHandle = NULL;
73 * This function frees OicSecCred_t object's fields and object itself.
75 static void FreeCred(OicSecCred_t *cred)
79 OIC_LOG(ERROR, TAG, "Invalid Parameter");
82 //Note: Need further clarification on roleID data type
85 OICFree(cred->roleIds);
90 OICFree(cred->publicData.data);
94 OICFree(cred->privateData.data);
97 OICFree(cred->period);
99 //Clean Cred node itself
103 void DeleteCredList(OicSecCred_t* cred)
107 OicSecCred_t *credTmp1 = NULL, *credTmp2 = NULL;
108 LL_FOREACH_SAFE(cred, credTmp1, credTmp2)
110 LL_DELETE(cred, credTmp1);
116 static size_t OicSecCredCount(const OicSecCred_t *secCred)
119 for (const OicSecCred_t *cred = secCred; cred; cred = cred->next)
126 OCStackResult CredToCBORPayload(const OicSecCred_t *credS, uint8_t **cborPayload,
129 if (NULL == credS || NULL == cborPayload || NULL != *cborPayload || NULL == cborSize)
131 return OC_STACK_INVALID_PARAM;
134 OCStackResult ret = OC_STACK_ERROR;
136 CborError cborEncoderResult = CborNoError;
137 uint8_t *outPayload = NULL;
138 size_t cborLen = *cborSize;
141 const OicSecCred_t *cred = credS;
142 CborEncoder encoder = { {.ptr = NULL }, .end = 0 };
143 CborEncoder credArray = { {.ptr = NULL }, .end = 0 };
144 CborEncoder credRootMap = { {.ptr = NULL }, .end = 0 };
151 outPayload = (uint8_t *)OICCalloc(1, cborLen);
152 VERIFY_NON_NULL(TAG, outPayload, ERROR);
153 cbor_encoder_init(&encoder, outPayload, cborLen, 0);
155 // Create CRED Root Map (creds, rownerid)
156 cborEncoderResult = cbor_encoder_create_map(&encoder, &credRootMap, CRED_ROOT_MAP_SIZE);
157 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Root Map");
160 cborEncoderResult = cbor_encode_text_string(&credRootMap, OIC_JSON_CREDS_NAME,
161 strlen(OIC_JSON_CREDS_NAME));
162 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding creds Name Tag.");
165 cborEncoderResult = cbor_encoder_create_array(&credRootMap, &credArray, OicSecCredCount(cred));
166 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Array.");
170 CborEncoder credMap = { {.ptr = NULL }, .end = 0, .added = 0, .flags = 0 };
171 size_t mapSize = CRED_MAP_SIZE;
172 char *subject = NULL;
178 if (SIGNED_ASYMMETRIC_KEY == cred->credType && cred->publicData.data)
182 #endif /* __WITH_X509__ */
183 if (cred->privateData.data)
187 cborEncoderResult = cbor_encoder_create_map(&credArray, &credMap, mapSize);
188 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Map");
190 //CredID -- Mandatory
191 cborEncoderResult = cbor_encode_text_string(&credMap, OIC_JSON_CREDID_NAME,
192 strlen(OIC_JSON_CREDID_NAME));
193 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Id Tag. ");
194 cborEncoderResult = cbor_encode_int(&credMap, cred->credId);
195 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Id Value.");
197 //Subject -- Mandatory
198 cborEncoderResult = cbor_encode_text_string(&credMap, OIC_JSON_SUBJECTID_NAME,
199 strlen(OIC_JSON_SUBJECTID_NAME));
200 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Subject Tag.");
201 ret = ConvertUuidToStr(&cred->subject, &subject);
202 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
203 cborEncoderResult = cbor_encode_text_string(&credMap, subject, strlen(subject));
204 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding Subject Id Value.");
207 //CredType -- Mandatory
208 cborEncoderResult = cbor_encode_text_string(&credMap, OIC_JSON_CREDTYPE_NAME,
209 strlen(OIC_JSON_CREDTYPE_NAME));
210 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Type Tag.");
211 cborEncoderResult = cbor_encode_int(&credMap, cred->credType);
212 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Cred Type Value.");
215 //PublicData -- Not Mandatory
216 if (SIGNED_ASYMMETRIC_KEY == cred->credType && cred->publicData.data)
218 CborEncoder publicMap = { {.ptr = NULL }, .end = 0, .added = 0, .flags = 0 };
219 const size_t publicMapSize = 2;
221 cborEncoderResult = cbor_encode_text_string(&credMap, OIC_JSON_PUBLICDATA_NAME,
222 strlen(OIC_JSON_PUBLICDATA_NAME));
223 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding PublicData Tag.");
225 cborEncoderResult = cbor_encoder_create_map(&credMap, &publicMap, publicMapSize);
226 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding PublicData Map");
228 cborEncoderResult = cbor_encode_text_string(&publicMap, OIC_JSON_DATA_NAME,
229 strlen(OIC_JSON_DATA_NAME));
230 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Pub Data Tag.");
231 cborEncoderResult = cbor_encode_byte_string(&publicMap, cred->publicData.data,
232 cred->publicData.len);
233 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Pub Value.");
235 // TODO: Need to data strucure modification for OicSecCert_t.
236 cborEncoderResult = cbor_encode_text_string(&publicMap, OIC_JSON_ENCODING_NAME,
237 strlen(OIC_JSON_ENCODING_NAME));
238 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Public Encoding Tag.");
239 cborEncoderResult = cbor_encode_text_string(&publicMap, OIC_SEC_ENCODING_RAW,
240 strlen(OIC_SEC_ENCODING_RAW));
241 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Public Encoding Value.");
243 cborEncoderResult = cbor_encoder_close_container(&credMap, &publicMap);
244 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing PublicData Map.");
246 #endif /*__WITH_X509__*/
247 //PrivateData -- Not Mandatory
248 if(cred->privateData.data)
250 CborEncoder privateMap = { {.ptr = NULL }, .end = 0, .added = 0, .flags = 0 };
251 const size_t privateMapSize = 2;
253 cborEncoderResult = cbor_encode_text_string(&credMap, OIC_JSON_PRIVATEDATA_NAME,
254 strlen(OIC_JSON_PRIVATEDATA_NAME));
255 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding PrivateData Tag.");
257 cborEncoderResult = cbor_encoder_create_map(&credMap, &privateMap, privateMapSize);
258 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding PrivateData Map");
260 cborEncoderResult = cbor_encode_text_string(&privateMap, OIC_JSON_DATA_NAME,
261 strlen(OIC_JSON_DATA_NAME));
262 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Priv Tag.");
263 cborEncoderResult = cbor_encode_byte_string(&privateMap, cred->privateData.data,
264 cred->privateData.len);
265 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Priv Value.");
267 // TODO: Need to data strucure modification for OicSecKey_t.
268 cborEncoderResult = cbor_encode_text_string(&privateMap, OIC_JSON_ENCODING_NAME,
269 strlen(OIC_JSON_ENCODING_NAME));
270 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Private Encoding Tag.");
271 cborEncoderResult = cbor_encode_text_string(&privateMap, OIC_SEC_ENCODING_RAW,
272 strlen(OIC_SEC_ENCODING_RAW));
273 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Private Encoding Value.");
275 cborEncoderResult = cbor_encoder_close_container(&credMap, &privateMap);
276 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing PrivateData Map.");
279 //Period -- Not Mandatory
282 cborEncoderResult = cbor_encode_text_string(&credMap, OIC_JSON_PERIOD_NAME,
283 strlen(OIC_JSON_PERIOD_NAME));
284 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Period Name Tag.");
285 cborEncoderResult = cbor_encode_text_string(&credMap, cred->period,
286 strlen(cred->period));
287 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Period Name Value.");
291 cborEncoderResult = cbor_encoder_close_container(&credArray, &credMap);
292 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing Cred Map.");
296 cborEncoderResult = cbor_encoder_close_container(&credRootMap, &credArray);
297 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing Cred Array.");
304 cborEncoderResult = cbor_encode_text_string(&credRootMap, OIC_JSON_ROWNERID_NAME,
305 strlen(OIC_JSON_ROWNERID_NAME));
306 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding rownerid Name.");
307 ret = ConvertUuidToStr(&cred->rownerID, &rowner);
308 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
309 cborEncoderResult = cbor_encode_text_string(&credRootMap, rowner, strlen(rowner));
310 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding rownerid Value.");
314 // Close CRED Root Map
315 cborEncoderResult = cbor_encoder_close_container(&encoder, &credRootMap);
316 VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing CRED Root Map.");
318 if (CborNoError == cborEncoderResult)
320 OIC_LOG(DEBUG, TAG, "CredToCBORPayload Successed");
321 *cborPayload = outPayload;
322 *cborSize = encoder.ptr - outPayload;
325 OIC_LOG(DEBUG, TAG, "CredToCBORPayload OUT");
327 if (CborErrorOutOfMemory == cborEncoderResult)
329 OIC_LOG(DEBUG, TAG, "CredToCBORPayload:CborErrorOutOfMemory : retry with more memory");
330 // reallocate and try again!
332 // Since the allocated initial memory failed, double the memory.
333 cborLen += encoder.ptr - encoder.end;
334 cborEncoderResult = CborNoError;
335 ret = CredToCBORPayload(credS, cborPayload, &cborLen);
339 if (CborNoError != cborEncoderResult)
341 OIC_LOG(ERROR, TAG, "Failed to CredToCBORPayload");
346 ret = OC_STACK_ERROR;
352 OCStackResult CBORPayloadToCred(const uint8_t *cborPayload, size_t size,
353 OicSecCred_t **secCred)
355 if (NULL == cborPayload || NULL == secCred || NULL != *secCred)
357 return OC_STACK_INVALID_PARAM;
360 OCStackResult ret = OC_STACK_ERROR;
361 CborValue credCbor = { .parser = NULL };
362 CborParser parser = { .end = NULL };
363 CborError cborFindResult = CborNoError;
364 cbor_parser_init(cborPayload, size, 0, &parser, &credCbor);
366 OicSecCred_t *headCred = (OicSecCred_t *) OICCalloc(1, sizeof(OicSecCred_t));
368 // Enter CRED Root Map
369 CborValue CredRootMap = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
370 cborFindResult = cbor_value_enter_container(&credCbor, &CredRootMap);
371 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Entering CRED Root Map.");
373 while (cbor_value_is_valid(&CredRootMap))
375 char* tagName = NULL;
377 CborType type = cbor_value_get_type(&CredRootMap);
378 if (type == CborTextStringType)
380 cborFindResult = cbor_value_dup_text_string(&CredRootMap, &tagName, &len, NULL);
381 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Name in CRED Root Map.");
382 cborFindResult = cbor_value_advance(&CredRootMap);
383 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Value in CRED Root Map.");
387 if (strcmp(tagName, OIC_JSON_CREDS_NAME) == 0)
392 CborValue credArray = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
393 cborFindResult = cbor_value_enter_container(&CredRootMap, &credArray);
394 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Cred Array.");
396 while (cbor_value_is_valid(&credArray))
399 //CredId -- Mandatory
400 CborValue credMap = { .parser = NULL, .ptr = NULL, .remaining = 0, .extra = 0, .type = 0, .flags = 0 };
401 cborFindResult = cbor_value_enter_container(&credArray, &credMap);
402 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Cred Map.");
403 OicSecCred_t *cred = NULL;
411 cred = (OicSecCred_t *) OICCalloc(1, sizeof(OicSecCred_t));
412 OicSecCred_t *temp = headCred;
420 VERIFY_NON_NULL(TAG, cred, ERROR);
422 while(cbor_value_is_valid(&credMap))
425 CborType type = cbor_value_get_type(&credMap);
426 if (type == CborTextStringType)
428 cborFindResult = cbor_value_dup_text_string(&credMap, &name, &len, NULL);
429 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Name in CRED Map.");
430 cborFindResult = cbor_value_advance(&credMap);
431 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing Value in CRED Map.");
436 if (strcmp(name, OIC_JSON_CREDID_NAME) == 0)
438 cborFindResult = cbor_value_get_uint64(&credMap, (uint64_t *) &cred->credId);
439 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding CredId.");
442 if (strcmp(name, OIC_JSON_SUBJECTID_NAME) == 0)
444 char *subjectid = NULL;
445 cborFindResult = cbor_value_dup_text_string(&credMap, &subjectid, &len, NULL);
446 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding subjectid Value.");
447 ret = ConvertStrToUuid(subjectid, &cred->subject);
448 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
452 if (strcmp(name, OIC_JSON_CREDTYPE_NAME) == 0)
454 cborFindResult = cbor_value_get_uint64(&credMap, (uint64_t *) &cred->credType);
455 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding CredType.");
458 if (strcmp(name, OIC_JSON_PRIVATEDATA_NAME) == 0)
460 CborValue privateMap = { .parser = NULL };
461 cborFindResult = cbor_value_enter_container(&credMap, &privateMap);
463 while (cbor_value_is_valid(&privateMap))
465 char* privname = NULL;
466 CborType type = cbor_value_get_type(&privateMap);
467 if (type == CborTextStringType)
469 cborFindResult = cbor_value_dup_text_string(&privateMap, &privname,
471 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get text");
472 cborFindResult = cbor_value_advance(&privateMap);
473 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance value");
477 // PrivateData::privdata -- Mandatory
478 if (strcmp(privname, OIC_JSON_DATA_NAME) == 0)
480 cborFindResult = cbor_value_dup_byte_string(&privateMap, &cred->privateData.data,
481 &cred->privateData.len, NULL);
482 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding PrivateData.");
484 // PrivateData::encoding -- Mandatory
485 if (strcmp(privname, OIC_JSON_ENCODING_NAME) == 0)
487 // TODO: Need to update data structure, just ignore encoding value now.
490 if (cbor_value_is_valid(&privateMap))
492 cborFindResult = cbor_value_advance(&privateMap);
493 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing privatedata Map.");
500 if (strcmp(name, OIC_JSON_PUBLICDATA_NAME) == 0)
502 CborValue pubMap = { .parser = NULL };
503 cborFindResult = cbor_value_enter_container(&credMap, &pubMap);
505 while (cbor_value_is_valid(&pubMap))
507 char* pubname = NULL;
508 CborType type = cbor_value_get_type(&pubMap);
509 if (type == CborTextStringType)
511 cborFindResult = cbor_value_dup_text_string(&pubMap, &pubname,
513 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to get text");
514 cborFindResult = cbor_value_advance(&pubMap);
515 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed to advance value");
519 // PrivateData::privdata -- Mandatory
520 if (strcmp(pubname, OIC_JSON_DATA_NAME) == 0)
522 cborFindResult = cbor_value_dup_byte_string(&pubMap, &cred->publicData.data,
523 &cred->publicData.len, NULL);
524 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding PubData.");
526 // PublicData::encoding -- Mandatory
527 if (strcmp(pubname, OIC_JSON_ENCODING_NAME) == 0)
529 // TODO: Need to update data structure, just ignore encoding value now.
532 if (cbor_value_is_valid(&pubMap))
534 cborFindResult = cbor_value_advance(&pubMap);
535 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing publicdata Map.");
540 #endif //__WITH_X509__
542 if (0 == strcmp(OIC_JSON_PERIOD_NAME, name))
544 cborFindResult = cbor_value_dup_text_string(&credMap, &cred->period, &len, NULL);
545 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Period.");
548 if (cbor_value_is_valid(&credMap))
550 cborFindResult = cbor_value_advance(&credMap);
551 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing CRED Map.");
557 if (cbor_value_is_valid(&credArray))
559 cborFindResult = cbor_value_advance(&credArray);
560 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing CRED Array.");
565 //ROwner -- Mandatory
566 if (strcmp(tagName, OIC_JSON_ROWNERID_NAME) == 0)
568 char *stRowner = NULL;
569 cborFindResult = cbor_value_dup_text_string(&CredRootMap, &stRowner, &len, NULL);
570 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Rownerid Value.");
572 ret = ConvertStrToUuid(stRowner, &headCred->rownerID);
573 VERIFY_SUCCESS(TAG, ret == OC_STACK_OK, ERROR);
578 if (cbor_value_is_valid(&CredRootMap))
580 cborFindResult = cbor_value_advance(&CredRootMap);
581 VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Advancing CRED Root Map.");
589 if (CborNoError != cborFindResult)
591 DeleteCredList(headCred);
594 ret = OC_STACK_ERROR;
600 OicSecCred_t * GenerateCredential(const OicUuid_t * subject, OicSecCredType_t credType,
601 const OicSecCert_t * publicData, const OicSecKey_t* privateData,
602 const OicUuid_t * rownerID)
605 OCStackResult ret = OC_STACK_ERROR;
607 OicSecCred_t *cred = (OicSecCred_t *)OICCalloc(1, sizeof(*cred));
608 VERIFY_NON_NULL(TAG, cred, ERROR);
610 //CredId is assigned before appending new cred to the existing
611 //credential list and updating svr database in AddCredential().
614 VERIFY_NON_NULL(TAG, subject, ERROR);
615 memcpy(cred->subject.id, subject->id , sizeof(cred->subject.id));
617 VERIFY_SUCCESS(TAG, credType < (NO_SECURITY_MODE | SYMMETRIC_PAIR_WISE_KEY |
618 SYMMETRIC_GROUP_KEY | ASYMMETRIC_KEY | SIGNED_ASYMMETRIC_KEY | PIN_PASSWORD), ERROR);
619 cred->credType = credType;
622 if (publicData && publicData->data)
624 cred->publicData.data = (uint8_t *)OICCalloc(1, publicData->len);
625 VERIFY_NON_NULL(TAG, cred->publicData.data, ERROR);
626 memcpy(cred->publicData.data, publicData->data, publicData->len);
627 cred->publicData.len = publicData->len;
629 #endif // __WITH_X509__
631 if (privateData && privateData->data)
633 cred->privateData.data = (uint8_t *)OICCalloc(1, privateData->len);
634 VERIFY_NON_NULL(TAG, cred->privateData.data, ERROR);
635 memcpy(cred->privateData.data, privateData->data, privateData->len);
636 cred->privateData.len = privateData->len;
639 VERIFY_NON_NULL(TAG, rownerID, ERROR);
640 memcpy(&cred->rownerID, rownerID, sizeof(OicUuid_t));
644 if (OC_STACK_OK != ret)
646 DeleteCredList(cred);
652 static bool UpdatePersistentStorage(const OicSecCred_t *cred)
656 // Convert Cred data into JSON for update to persistent storage
659 uint8_t *payload = NULL;
661 OCStackResult res = CredToCBORPayload(cred, &payload, &size);
662 if ((OC_STACK_OK == res) && payload)
664 if (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_CRED_NAME, payload, size))
671 else //Empty cred list
673 if (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_CRED_NAME, NULL, 0))
682 * Compare function used LL_SORT for sorting credentials.
684 * @param first pointer to OicSecCred_t struct.
685 * @param second pointer to OicSecCred_t struct.
687 *@return -1, if credId of first is less than credId of second.
688 * 0, if credId of first is equal to credId of second.
689 * 1, if credId of first is greater than credId of second.
691 static int CmpCredId(const OicSecCred_t * first, const OicSecCred_t *second)
693 if (first->credId < second->credId)
697 else if (first->credId > second->credId)
706 * GetCredId goes through the cred list and returns the next
707 * available credId. The next credId could be the credId that is
708 * available due deletion of OicSecCred_t object or one more than
709 * credId of last credential in the list.
711 * @return next available credId if successful, else 0 for error.
713 static uint16_t GetCredId()
715 //Sorts credential list in incremental order of credId
716 LL_SORT(gCred, CmpCredId);
718 OicSecCred_t *currentCred = NULL, *credTmp = NULL;
719 uint16_t nextCredId = 1;
721 LL_FOREACH_SAFE(gCred, currentCred, credTmp)
723 if (currentCred->credId == nextCredId)
733 VERIFY_SUCCESS(TAG, nextCredId < UINT16_MAX, ERROR);
741 * Get the default value.
743 * @return NULL for now.
745 static OicSecCred_t* GetCredDefault()
747 // TODO:Update it when we finalize the default info.
751 OCStackResult AddCredential(OicSecCred_t * newCred)
753 OCStackResult ret = OC_STACK_ERROR;
754 VERIFY_SUCCESS(TAG, NULL != newCred, ERROR);
756 //Assigning credId to the newCred
757 newCred->credId = GetCredId();
758 VERIFY_SUCCESS(TAG, newCred->credId != 0, ERROR);
760 //Append the new Cred to existing list
761 LL_APPEND(gCred, newCred);
763 if (UpdatePersistentStorage(gCred))
772 OCStackResult RemoveCredential(const OicUuid_t *subject)
774 OCStackResult ret = OC_STACK_ERROR;
775 OicSecCred_t *cred = NULL;
776 OicSecCred_t *tempCred = NULL;
777 bool deleteFlag = false;
779 LL_FOREACH_SAFE(gCred, cred, tempCred)
781 if (memcmp(cred->subject.id, subject->id, sizeof(subject->id)) == 0)
783 LL_DELETE(gCred, cred);
791 if (UpdatePersistentStorage(gCred))
793 ret = OC_STACK_RESOURCE_DELETED;
801 * Remove all credential data on credential resource and persistent storage
804 * OC_STACK_OK - no errors
805 * OC_STACK_ERROR - stack process error
807 OCStackResult RemoveAllCredentials(void)
809 DeleteCredList(gCred);
810 gCred = GetCredDefault();
812 if (!UpdatePersistentStorage(gCred))
814 return OC_STACK_ERROR;
821 * Internal function to fill private data of owner PSK.
823 * @param receviedCred recevied owner credential from OBT(PT)
824 * @param ownerAdd address of OBT(PT)
825 * @param doxm current device's doxm resource
828 * true successfully done and valid ower psk information
829 * false Invalid owner psk information or failed to owner psk generation
831 static bool FillPrivateDataOfOwnerPSK(OicSecCred_t* receviedCred, const CAEndpoint_t* ownerAddr,
832 const OicSecDoxm_t* doxm)
834 //Derive OwnerPSK locally
835 const char* oxmLabel = GetOxmString(doxm->oxmSel);
836 VERIFY_NON_NULL(TAG, oxmLabel, ERROR);
838 uint8_t ownerPSK[OWNER_PSK_LENGTH_128] = {0};
839 CAResult_t pskRet = CAGenerateOwnerPSK(ownerAddr,
840 (uint8_t*)oxmLabel, strlen(oxmLabel),
841 doxm->owner.id, sizeof(doxm->owner.id),
842 doxm->deviceID.id, sizeof(doxm->deviceID.id),
843 ownerPSK, OWNER_PSK_LENGTH_128);
844 VERIFY_SUCCESS(TAG, pskRet == CA_STATUS_OK, ERROR);
846 OIC_LOG(DEBUG, TAG, "OwnerPSK dump :");
847 OIC_LOG_BUFFER(DEBUG, TAG, ownerPSK, OWNER_PSK_LENGTH_128);
849 //Generate owner credential based on recevied credential information
850 receviedCred->privateData.data = (uint8_t *)OICCalloc(1, OWNER_PSK_LENGTH_128);
851 VERIFY_NON_NULL(TAG, receviedCred->privateData.data, ERROR);
852 receviedCred->privateData.len = OWNER_PSK_LENGTH_128;
853 memcpy(receviedCred->privateData.data, ownerPSK, OWNER_PSK_LENGTH_128);
855 OIC_LOG(INFO, TAG, "PrivateData of OwnerPSK was calculated successfully");
857 //Verify OwnerPSK information
858 return (memcmp(&(receviedCred->subject), &(doxm->owner), sizeof(OicUuid_t)) == 0 &&
859 receviedCred->credType == SYMMETRIC_PAIR_WISE_KEY);
861 //receviedCred->privateData.data will be deallocated when deleting credential.
865 #endif //__WITH_DTLS__
867 static OCEntityHandlerResult HandlePutRequest(const OCEntityHandlerRequest * ehRequest)
869 OCEntityHandlerResult ret = OC_EH_ERROR;
870 OIC_LOG(DEBUG, TAG, "HandleCREDPutRequest IN");
872 //Get binary representation of cbor
873 OicSecCred_t *cred = NULL;
874 uint8_t *payload = (((OCSecurityPayload*)ehRequest->payload)->securityData1);
875 size_t size = (((OCSecurityPayload*)ehRequest->payload)->payloadSize);
876 OCStackResult res = CBORPayloadToCred(payload, size, &cred);
877 if (res == OC_STACK_OK)
880 OicUuid_t emptyUuid = {.id={0}};
881 const OicSecDoxm_t* doxm = GetDoxmResourceData();
882 if(false == doxm->owned && memcmp(&(doxm->owner), &emptyUuid, sizeof(OicUuid_t)) != 0)
884 //in case of owner PSK
885 switch(cred->credType)
887 case SYMMETRIC_PAIR_WISE_KEY:
889 OCServerRequest *request = (OCServerRequest *)ehRequest->requestHandle;
890 if(FillPrivateDataOfOwnerPSK(cred, (CAEndpoint_t *)&request->devAddr, doxm))
892 if(OC_STACK_RESOURCE_DELETED == RemoveCredential(&cred->subject))
894 OIC_LOG(WARNING, TAG, "The credential with the same subject ID was detected!");
897 OIC_LOG(ERROR, TAG, "OwnerPSK was generated successfully.");
898 if(OC_STACK_OK == AddCredential(cred))
900 ret = OC_EH_RESOURCE_CREATED;
904 OIC_LOG(ERROR, TAG, "Failed to save the OwnerPSK as cred resource");
910 OIC_LOG(ERROR, TAG, "Failed to verify receviced OwnerPKS.");
914 if(OC_EH_RESOURCE_CREATED == ret)
917 * in case of random PIN based OxM,
918 * revert get_psk_info callback of tinyDTLS to use owner credential.
920 if(OIC_RANDOM_DEVICE_PIN == doxm->oxmSel)
922 OicUuid_t emptyUuid = { .id={0}};
923 SetUuidForRandomPinOxm(&emptyUuid);
925 if(CA_STATUS_OK != CARegisterDTLSCredentialsHandler(GetDtlsPskCredentials))
927 OIC_LOG(ERROR, TAG, "Failed to revert DTLS credential handler.");
933 //Select cipher suite to use owner PSK
934 if(CA_STATUS_OK != CAEnableAnonECDHCipherSuite(false))
936 OIC_LOG(ERROR, TAG, "Failed to disable anonymous cipher suite");
941 OIC_LOG(INFO, TAG, "Anonymous cipher suite is DISABLED");
945 CASelectCipherSuite(TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA_256))
947 OIC_LOG(ERROR, TAG, "Failed to select cipher suite");
954 case SYMMETRIC_GROUP_KEY:
956 case SIGNED_ASYMMETRIC_KEY:
958 case ASYMMETRIC_ENCRYPTION_KEY:
960 OIC_LOG(WARNING, TAG, "Unsupported credential type for owner credential.");
966 OIC_LOG(WARNING, TAG, "Unknow credential type for owner credential.");
972 if(OC_EH_RESOURCE_CREATED != ret)
975 * If some error is occured while ownership transfer,
976 * ownership transfer related resource should be revert back to initial status.
978 RestoreDoxmToInitState();
979 RestorePstatToInitState();
985 * If the post request credential has credId, it will be
986 * discarded and the next available credId will be assigned
987 * to it before getting appended to the existing credential
988 * list and updating svr database.
990 ret = (OC_STACK_OK == AddCredential(cred))? OC_EH_RESOURCE_CREATED : OC_EH_ERROR;
992 #else //not __WITH_DTLS__
994 * If the post request credential has credId, it will be
995 * discarded and the next available credId will be assigned
996 * to it before getting appended to the existing credential
997 * list and updating svr database.
999 ret = (OC_STACK_OK == AddCredential(cred))? OC_EH_RESOURCE_CREATED : OC_EH_ERROR;
1000 #endif//__WITH_DTLS__
1003 if (OC_EH_RESOURCE_CREATED != ret)
1005 if(OC_STACK_OK != RemoveCredential(&cred->subject))
1007 OIC_LOG(WARNING, TAG, "Failed to remove the invalid credential");
1011 OIC_LOG(DEBUG, TAG, "HandleCREDPutRequest OUT");
1015 static OCEntityHandlerResult HandlePostRequest(const OCEntityHandlerRequest * ehRequest)
1017 OCEntityHandlerResult ret = OC_EH_ERROR;
1019 //Get binary representation of CBOR
1020 OicSecCred_t *cred = NULL;
1021 uint8_t *payload = ((OCSecurityPayload*)ehRequest->payload)->securityData1;
1022 size_t size = ((OCSecurityPayload*)ehRequest->payload)->payloadSize;
1023 OCStackResult res = CBORPayloadToCred(payload, size, &cred);
1024 if ((OC_STACK_OK == res) && cred)
1026 //If the Post request credential has credId, it will be
1027 //discarded and the next available credId will be assigned
1028 //to it before getting appended to the existing credential
1029 //list and updating svr database.
1030 ret = (OC_STACK_OK == AddCredential(cred))? OC_EH_RESOURCE_CREATED : OC_EH_ERROR;
1036 static OCEntityHandlerResult HandleDeleteRequest(const OCEntityHandlerRequest *ehRequest)
1038 OIC_LOG(DEBUG, TAG, "Processing CredDeleteRequest");
1040 OCEntityHandlerResult ehRet = OC_EH_ERROR;
1042 if (NULL == ehRequest->query)
1047 OicParseQueryIter_t parseIter = { .attrPos=NULL };
1048 OicUuid_t subject = {.id={0}};
1050 //Parsing REST query to get the subject
1051 ParseQueryIterInit((unsigned char *)ehRequest->query, &parseIter);
1052 while (GetNextQuery(&parseIter))
1054 if (strncasecmp((char *)parseIter.attrPos, OIC_JSON_SUBJECTID_NAME,
1055 parseIter.attrLen) == 0)
1057 OCStackResult ret = ConvertStrToUuid((const char*)parseIter.valPos, &subject);
1058 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
1062 if (OC_STACK_RESOURCE_DELETED == RemoveCredential(&subject))
1064 ehRet = OC_EH_RESOURCE_DELETED;
1071 OCEntityHandlerResult CredEntityHandler(OCEntityHandlerFlag flag,
1072 OCEntityHandlerRequest * ehRequest,
1073 void* callbackParameter)
1075 (void)callbackParameter;
1076 OCEntityHandlerResult ret = OC_EH_ERROR;
1082 if (flag & OC_REQUEST_FLAG)
1084 OIC_LOG (DEBUG, TAG, "Flag includes OC_REQUEST_FLAG");
1085 //TODO : Handle PUT/DEL methods
1086 switch (ehRequest->method)
1089 ret = OC_EH_FORBIDDEN;
1092 ret = HandlePutRequest(ehRequest);
1095 ret = HandlePostRequest(ehRequest);
1097 case OC_REST_DELETE:
1098 ret = HandleDeleteRequest(ehRequest);
1106 //Send payload to request originator
1107 ret = (SendSRMCBORResponse(ehRequest, ret, NULL, 0) == OC_STACK_OK) ?
1113 OCStackResult CreateCredResource()
1115 OCStackResult ret = OCCreateResource(&gCredHandle,
1116 OIC_RSRC_TYPE_SEC_CRED,
1123 if (OC_STACK_OK != ret)
1125 OIC_LOG (FATAL, TAG, "Unable to instantiate Cred resource");
1126 DeInitCredResource();
1131 OCStackResult InitCredResource()
1133 OCStackResult ret = OC_STACK_ERROR;
1135 //Read Cred resource from PS
1136 uint8_t *data = NULL;
1138 ret = GetSecureVirtualDatabaseFromPS(OIC_JSON_CRED_NAME, &data, &size);
1139 // If database read failed
1140 if (ret != OC_STACK_OK)
1142 OIC_LOG (DEBUG, TAG, "ReadSVDataFromPS failed");
1146 // Read ACL resource from PS
1147 ret = CBORPayloadToCred(data, size, &gCred);
1151 * If SVR database in persistent storage got corrupted or
1152 * is not available for some reason, a default Cred is created
1153 * which allows user to initiate Cred provisioning again.
1155 if (ret != OC_STACK_OK || !data || !gCred)
1157 gCred = GetCredDefault();
1159 //Instantiate 'oic.sec.cred'
1160 ret = CreateCredResource();
1165 OCStackResult DeInitCredResource()
1167 OCStackResult result = OCDeleteResource(gCredHandle);
1168 DeleteCredList(gCred);
1173 const OicSecCred_t* GetCredResourceData(const OicUuid_t* subject)
1175 OicSecCred_t *cred = NULL;
1177 if ( NULL == subject)
1182 LL_FOREACH(gCred, cred)
1184 if(memcmp(cred->subject.id, subject->id, sizeof(subject->id)) == 0)
1193 #if defined(__WITH_DTLS__)
1194 int32_t GetDtlsPskCredentials(CADtlsPskCredType_t type,
1195 const uint8_t *desc, size_t desc_len,
1196 uint8_t *result, size_t result_length)
1207 case CA_DTLS_PSK_HINT:
1208 case CA_DTLS_PSK_IDENTITY:
1210 OicUuid_t deviceID = {.id={}};
1211 // Retrieve Device ID from doxm resource
1212 if ( OC_STACK_OK != GetDoxmDeviceID(&deviceID) )
1214 OIC_LOG (ERROR, TAG, "Unable to retrieve doxm Device ID");
1218 if (result_length < sizeof(deviceID.id))
1220 OIC_LOG (ERROR, TAG, "Wrong value for result_length");
1223 memcpy(result, deviceID.id, sizeof(deviceID.id));
1224 return (sizeof(deviceID.id));
1228 case CA_DTLS_PSK_KEY:
1230 OicSecCred_t *cred = NULL;
1231 LL_FOREACH(gCred, cred)
1233 if (cred->credType != SYMMETRIC_PAIR_WISE_KEY)
1238 if ((desc_len == sizeof(cred->subject.id)) &&
1239 (memcmp(desc, cred->subject.id, sizeof(cred->subject.id)) == 0))
1242 * If the credentials are valid for limited time,
1243 * check their expiry.
1247 if(IOTVTICAL_VALID_ACCESS != IsRequestWithinValidTime(cred->period, NULL))
1249 OIC_LOG (INFO, TAG, "Credentials are expired.");
1256 result_length = cred->privateData.len;
1257 memcpy(result, cred->privateData.data, result_length);
1258 return result_length;
1266 OIC_LOG (ERROR, TAG, "Wrong value passed for CADtlsPskCredType_t.");
1276 * Add temporal PSK to PIN based OxM
1278 * @param[in] tmpSubject UUID of target device
1279 * @param[in] credType Type of credential to be added
1280 * @param[in] pin numeric characters
1281 * @param[in] pinSize length of 'pin'
1282 * @param[in] rownerID Resource owner's UUID
1283 * @param[out] tmpCredSubject Generated credential's subject.
1285 * @return OC_STACK_OK for success and errorcode otherwise.
1287 OCStackResult AddTmpPskWithPIN(const OicUuid_t* tmpSubject, OicSecCredType_t credType,
1288 const char * pin, size_t pinSize,
1289 const OicUuid_t * rownerID, OicUuid_t* tmpCredSubject)
1291 OCStackResult ret = OC_STACK_ERROR;
1292 OIC_LOG(DEBUG, TAG, "AddTmpPskWithPIN IN");
1294 if(NULL == tmpSubject || NULL == pin || 0 == pinSize || NULL == tmpCredSubject)
1296 return OC_STACK_INVALID_PARAM;
1299 uint8_t privData[OWNER_PSK_LENGTH_128] = {0,};
1300 OicSecKey_t privKey = {privData, OWNER_PSK_LENGTH_128};
1301 OicSecCred_t* cred = NULL;
1302 int dtlsRes = DeriveCryptoKeyFromPassword((const unsigned char *)pin, pinSize, rownerID->id,
1303 UUID_LENGTH, PBKDF_ITERATIONS,
1304 OWNER_PSK_LENGTH_128, privData);
1305 VERIFY_SUCCESS(TAG, (0 == dtlsRes) , ERROR);
1307 cred = GenerateCredential(tmpSubject, credType, NULL,
1308 &privKey, rownerID);
1311 OIC_LOG(ERROR, TAG, "GeneratePskWithPIN() : Failed to generate credential");
1312 return OC_STACK_ERROR;
1315 memcpy(tmpCredSubject->id, cred->subject.id, UUID_LENGTH);
1317 ret = AddCredential(cred);
1318 if( OC_STACK_OK != ret)
1320 RemoveCredential(tmpSubject);
1321 OIC_LOG(ERROR, TAG, "GeneratePskWithPIN() : Failed to add credential");
1323 OIC_LOG(DEBUG, TAG, "AddTmpPskWithPIN OUT");
1329 #endif /* __WITH_DTLS__ */
1330 #ifdef __WITH_X509__
1331 #define CERT_LEN_PREFIX (3)
1332 #define BYTE_SIZE (8) //bits
1333 #define PUB_KEY_X_COORD ("x")
1334 #define PUB_KEY_Y_COORD ("y")
1335 #define CERTIFICATE ("x5c")
1336 #define PRIVATE_KEY ("d")
1338 static uint32_t parseCertPrefix(uint8_t *prefix)
1343 for (int i = 0; i < CERT_LEN_PREFIX; ++i)
1345 res |= (((uint32_t) prefix[i]) << ((CERT_LEN_PREFIX - 1 -i) * BYTE_SIZE));
1351 static OCStackResult GetCAPublicKeyData(CADtlsX509Creds_t *credInfo)
1353 OCStackResult ret = OC_STACK_ERROR;
1354 uint8_t *ccPtr = credInfo->certificateChain;
1355 for (uint8_t i = 0; i < credInfo->chainLen - 1; ++i)
1357 ccPtr += CERT_LEN_PREFIX + parseCertPrefix(ccPtr);
1360 ByteArray cert = { .data = ccPtr + CERT_LEN_PREFIX, .len = parseCertPrefix(ccPtr) };
1361 CertificateX509 certStruct;
1363 VERIFY_SUCCESS(TAG, PKI_SUCCESS == DecodeCertificate(cert, &certStruct), ERROR);
1365 INC_BYTE_ARRAY(certStruct.pubKey, 2);
1367 memcpy(credInfo->rootPublicKeyX, certStruct.pubKey.data, PUBLIC_KEY_SIZE / 2);
1368 memcpy(credInfo->rootPublicKeyY, certStruct.pubKey.data + PUBLIC_KEY_SIZE / 2, PUBLIC_KEY_SIZE / 2);
1375 int GetDtlsX509Credentials(CADtlsX509Creds_t *credInfo)
1378 VERIFY_NON_NULL(TAG, credInfo, ERROR);
1381 VERIFY_SUCCESS(TAG, OC_STACK_OK == InitCredResource(), ERROR);
1384 OicSecCred_t *cred = NULL;
1385 LL_SEARCH_SCALAR(gCred, cred, credType, SIGNED_ASYMMETRIC_KEY);
1386 VERIFY_NON_NULL(TAG, cred, ERROR);
1388 if (cred->publicData.len > MAX_CERT_MESSAGE_LEN || cred->privateData.len > PRIVATE_KEY_SIZE)
1392 credInfo->chainLen = 2;
1393 memcpy(credInfo->certificateChain, cred->publicData.data, cred->publicData.len);
1394 memcpy(credInfo->devicePrivateKey, cred->privateData.data, cred->privateData.len);
1395 credInfo->certificateChainLen = cred->publicData.len;
1396 GetCAPublicKeyData(credInfo);
1403 #undef CERT_LEN_PREFIX
1404 #endif /* __WITH_X509__ */
1406 OCStackResult SetCredRownerId(const OicUuid_t* newROwner)
1408 OCStackResult ret = OC_STACK_ERROR;
1409 uint8_t *cborPayload = NULL;
1411 OicUuid_t prevId = {.id={0}};
1413 if(NULL == newROwner)
1415 ret = OC_STACK_INVALID_PARAM;
1419 ret = OC_STACK_NO_RESOURCE;
1422 if(newROwner && gCred)
1424 memcpy(prevId.id, gCred->rownerID.id, sizeof(prevId.id));
1425 memcpy(gCred->rownerID.id, newROwner->id, sizeof(newROwner->id));
1427 ret = CredToCBORPayload(gCred, &cborPayload, &size);
1428 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
1430 ret = UpdateSecureResourceInPS(OIC_JSON_CRED_NAME, cborPayload, size);
1431 VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
1433 OICFree(cborPayload);
1439 OICFree(cborPayload);
1440 memcpy(gCred->rownerID.id, prevId.id, sizeof(prevId.id));