1 /* *****************************************************************
3 * Copyright 2016 Samsung Electronics All Rights Reserved.
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 #include "occloudprovisioning.h"
22 #include "oic_malloc.h"
23 #include "oic_string.h"
24 #include "srmutility.h"
25 #include "aclresource.h"
30 #define TAG "CLOUD-WRAPPER"
32 #define MAX_ID_LENGTH (64)
33 #define MAX_STRING_LENGTH (256)
35 #define UUID_EXAMPLE_1 "9cfbeb8e-5a1e-4d1c-9d01-2ae6fdb"
36 #define UUID_EXAMPLE_2 "123e4567-e89b-12d3-a456-4266554"
37 #define UUID_EXAMPLE_3 "987e6543-e21b-12d3-a456-4266554"
38 #define SUBJECT_ID_EXAMPLE "72616E64-5069-6E44-6576-557569643030"
40 #define ACL_ID_EXAMPLE "0f3d9f7fe5491d54077d"
41 #define ACE_ID_EXAMPLE "a0001"
43 #define ID_EXAMPLE_1 "78f98b4f25f21e2487e8"
44 #define ID_EXAMPLE_2 "6caa7009386290fd3681"
46 #define RESOURCE_URI_EXAMPLE "/a/light/0"
47 #define RESOURCE_TYPE_EXAMPLE "core.light"
48 #define INTERFACE_EXAMPLE "oic.if.baseline"
50 //in case of optional parameters absence should be sent NULL
51 #define OPTIONAL(str) (str[0] ? str : NULL)
54 * Skip special characters from stdin
56 static void skipSpecialCharacters()
58 for( ; 0x20<=getchar(); ); // for removing overflow garbages
59 // '0x20<=code' is character region
62 static bool readOptional(const char* description)
64 if (NULL == description)
69 printf("Do you want to Enter %s (y/n):\n", description);
75 skipSpecialCharacters();
79 case 'y': return true;
80 case 'n': return false;
81 default: printf("Wrong value entered. Please press 'y' or 'n'\n");
87 void readString(char* item, int length, const char* description, const char* example)
89 printf("Enter %s (f.e. %s):\n", description, example);
90 char template[8] = { 0 };
91 snprintf(template, sizeof(template), "%%%ds", length - 1);
92 scanf(template, item);
93 skipSpecialCharacters();
97 * Read user input (expect string value, but it is optional and can be skipped by user)
99 * @param[out] item string item to fill
100 * @param[in] length max allowed string length
101 * @param[in] description item description
102 * @param[in] example item example
104 static void readOptionalString(char* item, int length, const char* description, const char* example)
106 if (readOptional(description))
108 readString(item, length, description, example);
112 void readInteger(int* item, const char* description, const char* example)
114 printf("Enter %s (f.e. %s):\n", description, example);
116 skipSpecialCharacters();
120 * Read user input (expect array of strings)
122 * @param[out] list array of strings structure
123 * @param[in] length max allowed array item length
124 * @param[in] description whole array description
125 * @param[in] example array item example
127 static void readStringArray(stringArray_t *list, int length, const char* description, const char* example)
131 char hint[MAX_STRING_LENGTH] = { 0 };
133 snprintf(hint, sizeof(hint), "%s items count", description);
134 readInteger(&count, hint, "2");
143 item = OICCalloc(count, sizeof(char*));
150 for (i = 0; i < count; i++)
152 item[i] = OICCalloc(length, sizeof(char));
159 snprintf(hint, sizeof(hint), "%s %d item", description, i + 1);
160 readString(item[i], length, hint, example);
163 list->length = count;
167 //free already allocated memory here
168 for (int k = 0; k < i; k++)
176 * Read user input (expect array of strings)
177 * It is optional and can be skipped by user.
179 * @param[out] list array of strings structure
180 * @param[in] length max allowed array item length
181 * @param[in] description whole array description
182 * @param[in] example array item example
184 static void readOptionalStringArray(stringArray_t *list, int length, const char* description, const char* example)
186 if (readOptional(description))
188 readStringArray(list, length, description, example);
192 void printStringArray(stringArray_t *list)
196 OIC_LOG(INFO, TAG, "Received NULL list");
200 OIC_LOG_V(INFO, TAG, "List contains %zu items", list->length);
202 for (size_t i = 0; i < list->length; i++)
204 OIC_LOG_V(INFO, TAG, "item[%zu] = %s", i, list->array[i]);
208 void printInviteResponse(inviteResponse_t *in)
212 OIC_LOG(INFO, TAG, "Received NULL invitation response");
216 OIC_LOG(INFO, TAG, "Received next invite gid list:");
217 printStringArray(&in->invite.gidlist);
219 OIC_LOG(INFO, TAG, "Received next invite mid list:");
220 printStringArray(&in->invite.midlist);
222 OIC_LOG(INFO, TAG, "Received next invited gid list:");
223 printStringArray(&in->invited.gidlist);
225 OIC_LOG(INFO, TAG, "Received next invited mid list:");
226 printStringArray(&in->invited.midlist);
229 void clearInviteResponse(inviteResponse_t *in)
236 clearStringArray(&in->invite.gidlist);
237 clearStringArray(&in->invite.midlist);
239 clearStringArray(&in->invited.gidlist);
240 clearStringArray(&in->invited.midlist);
243 bool readFile(const char *name, OCByteString *out)
247 uint8_t *buffer = NULL;
251 file = fopen(name, "rb");
254 OIC_LOG_V(ERROR, TAG, "Unable to open file %s", name);
259 if (fseek(file, 0, SEEK_END))
261 OIC_LOG(ERROR, TAG, "Failed to SEEK_END");
265 length = ftell(file);
268 OIC_LOG(ERROR, TAG, "Failed to ftell");
272 if (fseek(file, 0, SEEK_SET))
274 OIC_LOG(ERROR, TAG, "Failed to SEEK_SET");
279 buffer = (uint8_t *)malloc(length);
282 OIC_LOG(ERROR, TAG, "Failed to allocate buffer");
286 //Read file contents into buffer
288 size_t realCount = fread(buffer, length, count, file);
289 if (realCount != count)
291 OIC_LOG_V(ERROR, TAG, "Read %d bytes %zu times instead of %zu", length, realCount, count);
305 * Frees particular cloudAce object
307 * @param[in] ace ace object to free
309 static void freeCloudAce(cloudAce_t *ace)
314 OicSecRsrc_t* rsrc = NULL;
315 OicSecRsrc_t* tmpRsrc = NULL;
316 LL_FOREACH_SAFE(ace->resources, rsrc, tmpRsrc)
318 LL_DELETE(ace->resources, rsrc);
326 * Deletes cloudAce list
328 * @param[in] ace aces list to delete
330 static void deleteCloudAceList(cloudAce_t *aces)
332 cloudAce_t *ace = NULL;
333 cloudAce_t *tmpAce = NULL;
334 LL_FOREACH_SAFE(aces, ace, tmpAce)
336 LL_DELETE(aces, ace);
341 OCStackResult OCWrapperCertificateIssueRequest(const OCDevAddr *endPoint, OCCloudResponseCB callback)
343 return OCCloudCertificateIssueRequest(NULL, endPoint, callback);
346 OCStackResult OCWrapperGetCRL(const OCDevAddr *endPoint, OCCloudResponseCB callback)
348 return OCCloudGetCRL(NULL, endPoint, callback);
351 OCStackResult OCWrapperPostCRL(const OCDevAddr *endPoint, OCCloudResponseCB callback)
353 OCStackResult result = OC_STACK_ERROR;
354 OCByteString crlData = {0, 0};
355 char filename[64] = {0};
356 char thisUpdate[16] = { 0 };
357 char nextUpdate[16] = { 0 };
358 stringArray_t serialNumbers = {0, 0};
360 readString(thisUpdate, sizeof(thisUpdate), "Crl's thisUpdate value", "20160727000000");
361 readString(nextUpdate, sizeof(nextUpdate), "Crl's nextUpdate value", "20161027000000");
362 readOptionalStringArray(&serialNumbers, 16, "Revoked serial numbers", "1234");
364 if (NULL == serialNumbers.array)
366 readString(filename, sizeof(filename),
367 "filename from which binary Crl in DER format will be read", "crl");
369 if (!readFile(filename, &crlData))
371 printf("Can't read crl from file %s\n", filename);
375 stringArray_t *rcsn = serialNumbers.array? &serialNumbers : NULL;
376 OCByteString *crl = crlData.bytes? &crlData : NULL;
378 result = OCCloudPostCRL(NULL, thisUpdate, nextUpdate, crl, rcsn,
381 clearStringArray(&serialNumbers);
382 OICFree(crlData.bytes);
387 OCStackResult OCWrapperAclIdGetByDevice(const OCDevAddr *endPoint, OCCloudResponseCB callback)
389 char di[MAX_ID_LENGTH] = { 0 };
391 readString(di, sizeof(di), "device id", UUID_EXAMPLE_1);
393 return OCCloudGetAclIdByDevice(NULL, di, endPoint, callback);
396 OCStackResult OCWrapperAclIdCreate(const OCDevAddr *endPoint, OCCloudResponseCB callback)
398 char oid[MAX_ID_LENGTH] = { 0 };
399 char di[MAX_ID_LENGTH] = { 0 };
401 readString(oid, sizeof(oid), "owner id", UUID_EXAMPLE_2);
402 readString(di, sizeof(di), "device id", UUID_EXAMPLE_1);
404 return OCCloudAclIdCreate(NULL, oid, di, endPoint, callback);
407 OCStackResult OCWrapperAclIdDelete(const OCDevAddr *endPoint, OCCloudResponseCB callback)
409 char aclid[MAX_ID_LENGTH] = { 0 };
411 readString(aclid, sizeof(aclid), "acl id", ACL_ID_EXAMPLE);
413 return OCCloudAclIdDelete(NULL, aclid, endPoint, callback);
416 OCStackResult OCWrapperAclIndividualGetInfo(const OCDevAddr *endPoint, OCCloudResponseCB callback)
418 char aclid[MAX_ID_LENGTH] = { 0 };
420 readString(aclid, sizeof(aclid), "acl id", ACL_ID_EXAMPLE);
422 return OCCloudAclIndividualGetInfo(NULL, aclid, endPoint, callback);
425 OCStackResult OCWrapperAclIndividualUpdateAce(const OCDevAddr *endPoint, OCCloudResponseCB callback)
427 OCStackResult result = OC_STACK_NO_MEMORY;
429 char aclid[MAX_ID_LENGTH] = { 0 };
430 readString(aclid, sizeof(aclid), "acl id", ACL_ID_EXAMPLE);
432 int acllist_count = 0;
433 readInteger(&acllist_count, "acl list count", "1");
435 cloudAce_t *aces = NULL;
437 for (int i = 0; i < acllist_count; i++)
439 cloudAce_t *ace = OICCalloc(1, sizeof(cloudAce_t));
442 OIC_LOG(ERROR, TAG, "Can't allocate memory for ace");
445 LL_APPEND(aces, ace);
447 char aceid[MAX_ID_LENGTH] = { 0 };
448 char subjectuuid[MAX_ID_LENGTH] = { 0 };
454 readString(subjectuuid, sizeof(subjectuuid), "subjectuuid", SUBJECT_ID_EXAMPLE);
455 } while (OC_STACK_OK != ConvertStrToUuid(subjectuuid, &ace->subjectuuid));
457 readInteger(&stype, "subject type", "0 – Device, 1 – User, 2 - Group");
458 readInteger(&permission, "permission", "6");
460 ace->aceId = OICStrdup(aceid);
462 ace->permission = permission;
464 int reslist_count = 0;
465 readInteger(&reslist_count, "resources list count", "1");
467 for (int i = 0; i < reslist_count; i++)
469 OicSecRsrc_t *res = OICCalloc(1, sizeof(OicSecRsrc_t));
472 OIC_LOG(ERROR, TAG, "Can't allocate memory for res");
475 LL_APPEND(ace->resources, res);
477 char href[32] = { 0 };
478 readString(href, sizeof(href), "href", RESOURCE_URI_EXAMPLE);
480 stringArray_t rt = {0, 0};
481 readStringArray(&rt, MAX_ID_LENGTH, "resource type", RESOURCE_TYPE_EXAMPLE);
483 stringArray_t _if = {0, 0};
484 readStringArray(&_if, MAX_ID_LENGTH, "interface", INTERFACE_EXAMPLE);
486 res->href = OICStrdup(href);
487 res->types = rt.array;
488 res->typeLen = rt.length;
489 res->interfaces = _if.array;
490 res->interfaceLen = _if.length;
494 result = OCCloudAclIndividualUpdateAce(NULL, aclid, aces, endPoint, callback);
496 deleteCloudAceList(aces);
500 OCStackResult OCWrapperAclIndividualUpdate(const OCDevAddr *endPoint, OCCloudResponseCB callback)
502 OCStackResult result = OC_STACK_NO_MEMORY;
504 char aclid[MAX_ID_LENGTH] = { 0 };
505 readString(aclid, sizeof(aclid), "acl id", ACL_ID_EXAMPLE);
507 cloudAce_t *ace = OICCalloc(1, sizeof(cloudAce_t));
510 OIC_LOG(ERROR, TAG, "Can't allocate memory for ace");
514 char aceid[MAX_ID_LENGTH] = { 0 };
515 char subjectuuid[MAX_ID_LENGTH] = { 0 };
519 readString(aceid, sizeof(aceid), "ace id", ACE_ID_EXAMPLE);
522 readString(subjectuuid, sizeof(subjectuuid), "subjectuuid", SUBJECT_ID_EXAMPLE);
523 } while (OC_STACK_OK != ConvertStrToUuid(subjectuuid, &ace->subjectuuid));
525 readInteger(&stype, "subject type", "0 – Device, 1 – User, 2 - Group");
526 readInteger(&permission, "permission", "6");
529 ace->permission = permission;
531 int reslist_count = 0;
532 readInteger(&reslist_count, "resources list count", "1");
534 for (int i = 0; i < reslist_count; i++)
536 OicSecRsrc_t *res = OICCalloc(1, sizeof(OicSecRsrc_t));
539 OIC_LOG(ERROR, TAG, "Can't allocate memory for res");
542 LL_APPEND(ace->resources, res);
544 char href[32] = { 0 };
545 readString(href, sizeof(href), "href", RESOURCE_URI_EXAMPLE);
547 stringArray_t rt = {0, 0};
548 readStringArray(&rt, MAX_ID_LENGTH, "resource type", RESOURCE_TYPE_EXAMPLE);
550 stringArray_t _if = {0, 0};
551 readStringArray(&_if, MAX_ID_LENGTH, "interface", INTERFACE_EXAMPLE);
553 res->href = OICStrdup(href);
554 res->types = rt.array;
555 res->typeLen = rt.length;
556 res->interfaces = _if.array;
557 res->interfaceLen = _if.length;
561 result = OCCloudAclIndividualUpdate(NULL, aclid,aceid, ace, endPoint, callback);
566 OCStackResult OCWrapperAclIndividualDelete(const OCDevAddr *endPoint, OCCloudResponseCB callback)
568 char aclid[MAX_ID_LENGTH] = { 0 };
570 readString(aclid, sizeof(aclid), "acl id", ACL_ID_EXAMPLE);
572 return OCCloudAclIndividualDelete(NULL, aclid, endPoint, callback);
575 OCStackResult OCWrapperAclIndividualDeleteAce(const OCDevAddr *endPoint, OCCloudResponseCB callback)
577 char aclid[MAX_ID_LENGTH] = { 0 };
578 char aceid[MAX_ID_LENGTH] = { 0 };
580 readString(aclid, sizeof(aclid), "acl id", ACL_ID_EXAMPLE);
581 readString(aceid, sizeof(aceid), "ace id", ACE_ID_EXAMPLE);
583 return OCCloudAclIndividualDeleteAce(NULL, aclid, aceid, endPoint, callback);
586 OCStackResult OCWrapperAclCreateGroup(const OCDevAddr *endPoint, OCCloudResponseCB callback)
588 char gtype[16] = { 0 };
589 char gmid[MAX_ID_LENGTH] = { 0 };
591 readString(gtype, sizeof(gtype), "Group type value", "Public");
592 readOptionalString(gmid, sizeof(gmid), "group member id value", UUID_EXAMPLE_2);
594 return OCCloudAclCreateGroup(NULL, gtype, OPTIONAL(gmid), endPoint, callback);
597 OCStackResult OCWrapperAclFindMyGroup(const OCDevAddr *endPoint, OCCloudResponseCB callback)
599 char mid[MAX_ID_LENGTH] = { 0 };
601 readOptionalString(mid, sizeof(mid), "member id value", UUID_EXAMPLE_2);
603 return OCCloudAclFindMyGroup(NULL, OPTIONAL(mid), endPoint, callback);
606 OCStackResult OCWrapperAclDeleteGroup(const OCDevAddr *endPoint, OCCloudResponseCB callback)
608 char gid[MAX_ID_LENGTH] = { 0 };
609 char gmid[MAX_ID_LENGTH] = { 0 };
611 readString(gid, sizeof(gid), "Group id value", ID_EXAMPLE_1);
613 readOptionalString(gmid, sizeof(gmid), "group member id value", UUID_EXAMPLE_2);
615 return OCCloudAclDeleteGroup(NULL, gid, OPTIONAL(gmid), endPoint, callback);
618 OCStackResult OCWrapperAclJoinToInvitedGroup(const OCDevAddr *endPoint, OCCloudResponseCB callback)
620 char gid[MAX_ID_LENGTH] = { 0 };
622 readString(gid, sizeof(gid), "Group id value", ID_EXAMPLE_1);
624 return OCCloudAclJoinToInvitedGroup(NULL, gid, endPoint, callback);
627 OCStackResult OCWrapperAclObserveGroup(const OCDevAddr *endPoint, OCCloudResponseCB callback)
629 char gid[MAX_ID_LENGTH] = { 0 };
631 readString(gid, sizeof(gid), "Group id value", ID_EXAMPLE_1);
633 return OCCloudAclObserveGroup(NULL, gid, endPoint, callback);
636 OCStackResult OCWrapperAclShareDeviceIntoGroup(const OCDevAddr *endPoint, OCCloudResponseCB callback)
638 OCStackResult result = OC_STACK_NO_MEMORY;
639 char gid[MAX_ID_LENGTH] = { 0 };
640 stringArray_t midlist = {0,0};
641 stringArray_t dilist = {0,0};
643 readString(gid, sizeof(gid), "Group id value", ID_EXAMPLE_1);
645 readStringArray(&midlist, MAX_ID_LENGTH, "member id list", UUID_EXAMPLE_2);
647 readStringArray(&dilist, MAX_ID_LENGTH, "device list", UUID_EXAMPLE_1);
649 result = OCCloudAclShareDeviceIntoGroup(NULL, gid, &midlist, &dilist, endPoint, callback);
651 clearStringArray(&midlist);
652 clearStringArray(&dilist);
657 OCStackResult OCWrapperAclDeleteDeviceFromGroup(const OCDevAddr *endPoint, OCCloudResponseCB callback)
659 OCStackResult result = OC_STACK_NO_MEMORY;
660 char gid[MAX_ID_LENGTH] = { 0 };
661 stringArray_t midlist = {0,0};
662 stringArray_t dilist = {0,0};
664 readString(gid, sizeof(gid), "Group id value", ID_EXAMPLE_1);
666 readStringArray(&midlist, MAX_ID_LENGTH, "member id list", UUID_EXAMPLE_2);
668 readStringArray(&dilist, MAX_ID_LENGTH, "device list", UUID_EXAMPLE_1);
670 result = OCCloudAclDeleteDeviceFromGroup(NULL, gid, &midlist, &dilist, endPoint, callback);
672 clearStringArray(&midlist);
673 clearStringArray(&dilist);
678 OCStackResult OCWrapperAclGroupGetInfo(const OCDevAddr *endPoint, OCCloudResponseCB callback)
680 char gid[MAX_ID_LENGTH] = { 0 };
681 char mid[MAX_ID_LENGTH] = { 0 };
683 readString(gid, sizeof(gid), "Group id value", ID_EXAMPLE_1);
685 readOptionalString(mid, sizeof(mid), "member id value", UUID_EXAMPLE_2);
687 return OCCloudAclGroupGetInfo(NULL, gid, OPTIONAL(mid), endPoint, callback);
690 OCStackResult OCWrapperAclInviteUser(const OCDevAddr *endPoint, OCCloudResponseCB callback)
692 OCStackResult result = OC_STACK_NO_MEMORY;
693 char uid[MAX_ID_LENGTH] = { 0 };
694 stringArray_t midlist = {0,0};
695 stringArray_t gidlist = {0,0};
697 readOptionalString(uid, sizeof(uid), "user id value", UUID_EXAMPLE_2);
699 readStringArray(&gidlist, MAX_ID_LENGTH, "group id list", UUID_EXAMPLE_1);
701 readStringArray(&midlist, MAX_ID_LENGTH, "member id list", UUID_EXAMPLE_2);
703 result = OCCloudAclInviteUser(NULL, OPTIONAL(uid), &gidlist, &midlist, endPoint, callback);
705 clearStringArray(&midlist);
706 clearStringArray(&gidlist);
711 OCStackResult OCWrapperAclGetInvitation(const OCDevAddr *endPoint, OCCloudResponseCB callback)
713 char uid[MAX_ID_LENGTH] = { 0 };
715 readOptionalString(uid, sizeof(uid), "user uuid value", UUID_EXAMPLE_2);
717 return OCCloudAclGetInvitation(NULL, OPTIONAL(uid), endPoint, callback);
720 OCStackResult OCWrapperAclDeleteInvitation(const OCDevAddr *endPoint, OCCloudResponseCB callback)
722 char uid[MAX_ID_LENGTH] = { 0 };
723 char gid[MAX_ID_LENGTH] = { 0 };
725 readOptionalString(uid, sizeof(uid), "user uuid value", UUID_EXAMPLE_2);
726 readString(gid, sizeof(gid), "Group id value", ID_EXAMPLE_1);
728 return OCCloudAclDeleteInvitation(NULL, OPTIONAL(uid), gid, endPoint, callback);
731 OCStackResult OCWrapperAclCancelInvitation(const OCDevAddr *endPoint, OCCloudResponseCB callback)
733 char uid[MAX_ID_LENGTH] = { 0 };
734 char gid[MAX_ID_LENGTH] = { 0 };
735 char mid[MAX_ID_LENGTH] = { 0 };
737 readOptionalString(uid, sizeof(uid), "user uuid value", UUID_EXAMPLE_2);
739 readString(gid, sizeof(gid), "Group id value", ID_EXAMPLE_1);
740 readString(mid, sizeof(mid), "member id value", ID_EXAMPLE_1);
742 return OCCloudAclCancelInvitation(NULL, OPTIONAL(uid), gid, mid, endPoint, callback);
745 OCStackResult OCWrapperAclPolicyCheck(const OCDevAddr *endPoint, OCCloudResponseCB callback)
747 char sid[MAX_ID_LENGTH] = { 0 };
748 char di[MAX_ID_LENGTH] = { 0 };
750 char user_uri[32] = { 0 };
752 readString(sid, sizeof(sid), "subject id", UUID_EXAMPLE_1);
753 readString(di, sizeof(di), "device id", UUID_EXAMPLE_2);
754 readString(rm, sizeof(rm), "request method", "GET or POST or DELETE");
755 readString(user_uri, sizeof(user_uri), "request uri", RESOURCE_URI_EXAMPLE);
757 return OCCloudAclPolicyCheck(NULL, sid, di, rm, user_uri, endPoint, callback);