Merge branch 'master' into extended-easysetup
[platform/upstream/iotivity.git] / resource / csdk / security / src / pstatresource.c
1 //******************************************************************
2 //
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
4 //
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
6 //
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
10 //
11 //      http://www.apache.org/licenses/LICENSE-2.0
12 //
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.
18 //
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
20
21 #include <stdlib.h>
22 #include <string.h>
23
24 #include "ocstack.h"
25 #include "oic_malloc.h"
26 #include "ocpayload.h"
27 #include "payload_logging.h"
28 #include "resourcemanager.h"
29 #include "pstatresource.h"
30 #include "doxmresource.h"
31 #include "psinterface.h"
32 #include "srmresourcestrings.h"
33 #include "srmutility.h"
34
35 #define TAG  "SRM-PSTAT"
36
37 /** Default cbor payload size. This value is increased in case of CborErrorOutOfMemory.
38  * The value of payload size is increased until reaching below max cbor size. */
39 static const uint16_t CBOR_SIZE = 512;
40
41 // Max cbor size payload.
42 static const uint16_t CBOR_MAX_SIZE = 4400;
43
44 // PSTAT Map size - Number of mandatory items
45 static const uint8_t PSTAT_MAP_SIZE = 9;
46
47 static OicSecDpom_t gSm = SINGLE_SERVICE_CLIENT_DRIVEN;
48 static OicSecPstat_t gDefaultPstat =
49 {
50     false,                                    // bool isop
51     (OicSecDpm_t)(BOOTSTRAP_SERVICE | SECURITY_MANAGEMENT_SERVICES |
52     PROVISION_CREDENTIALS | PROVISION_ACLS),   // OicSecDpm_t cm
53     (OicSecDpm_t)(TAKE_OWNER | BOOTSTRAP_SERVICE | SECURITY_MANAGEMENT_SERVICES |
54     PROVISION_CREDENTIALS | PROVISION_ACLS),   // OicSecDpm_t tm
55     {.id = {0}},                              // OicUuid_t deviceID
56     SINGLE_SERVICE_CLIENT_DRIVEN,             // OicSecDpom_t om */
57     1,                                        // the number of elts in Sms
58     &gSm,                                     // OicSecDpom_t *sm
59     0,                                        // uint16_t commitHash
60     {.id = {0}},                              // OicUuid_t rownerID
61 };
62
63 static OicSecPstat_t    *gPstat = NULL;
64
65 static OCResourceHandle gPstatHandle = NULL;
66
67 void DeletePstatBinData(OicSecPstat_t* pstat)
68 {
69     if (pstat)
70     {
71         //Clean 'supported modes' field
72         OICFree(pstat->sm);
73
74         //Clean pstat itself
75         OICFree(pstat);
76     }
77 }
78
79 OCStackResult PstatToCBORPayload(const OicSecPstat_t *pstat, uint8_t **payload, size_t *size)
80 {
81     if (NULL == pstat || NULL == payload || NULL != *payload || NULL == size)
82     {
83         return OC_STACK_INVALID_PARAM;
84     }
85
86     size_t cborLen = *size;
87     if (0 == cborLen)
88     {
89         cborLen = CBOR_SIZE;
90     }
91
92     *payload = NULL;
93     *size = 0;
94
95     OCStackResult ret = OC_STACK_ERROR;
96
97     CborEncoder encoder;
98     CborEncoder pstatMap;
99     char* strUuid = NULL;
100
101     int64_t cborEncoderResult = CborNoError;
102
103     uint8_t *outPayload = (uint8_t *)OICCalloc(1, cborLen);
104     VERIFY_NON_NULL(TAG, outPayload, ERROR);
105     cbor_encoder_init(&encoder, outPayload, cborLen, 0);
106
107     cborEncoderResult = cbor_encoder_create_map(&encoder, &pstatMap, PSTAT_MAP_SIZE);
108     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Pstat Map.");
109
110     cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_ISOP_NAME,
111         strlen(OIC_JSON_ISOP_NAME));
112     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ISOP Name Tag.");
113     cborEncoderResult = cbor_encode_boolean(&pstatMap, pstat->isOp);
114     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ISOP Name Value.");
115
116     cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_DEVICE_ID_NAME,
117         strlen(OIC_JSON_DEVICE_ID_NAME));
118     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Tag.");
119     ret = ConvertUuidToStr(&pstat->deviceID, &strUuid);
120     VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
121     cborEncoderResult = cbor_encode_text_string(&pstatMap, strUuid, strlen(strUuid));
122     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Device Id Value.");
123     OICFree(strUuid);
124     strUuid = NULL;
125
126     cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_CM_NAME,
127         strlen(OIC_JSON_CM_NAME));
128     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding CM Name Tag.");
129     cborEncoderResult = cbor_encode_int(&pstatMap, pstat->cm);
130     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding CM Name Value.");
131
132     cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_TM_NAME,
133         strlen(OIC_JSON_TM_NAME));
134     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding TM Name Tag.");
135     cborEncoderResult = cbor_encode_int(&pstatMap, pstat->tm);
136     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding TM Name Value.");
137
138     cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_OM_NAME,
139         strlen(OIC_JSON_OM_NAME));
140     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding OM Name Tag.");
141     cborEncoderResult = cbor_encode_int(&pstatMap, pstat->om);
142     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding OM Name Value.");
143
144     cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_SM_NAME,
145         strlen(OIC_JSON_SM_NAME));
146     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding SM Name Tag.");
147     cborEncoderResult = cbor_encode_int(&pstatMap, pstat->sm[0]);
148     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding SM Name Value.");
149
150     cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_ROWNERID_NAME,
151         strlen(OIC_JSON_ROWNERID_NAME));
152     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Tag.");
153     ret = ConvertUuidToStr(&pstat->rownerID, &strUuid);
154     VERIFY_SUCCESS(TAG, OC_STACK_OK == ret , ERROR);
155     cborEncoderResult = cbor_encode_text_string(&pstatMap, strUuid, strlen(strUuid));
156     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding ROwner Id Value.");
157     OICFree(strUuid);
158     strUuid = NULL;
159
160     //RT -- Mandatory
161     CborEncoder rtArray;
162     cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_RT_NAME,
163             strlen(OIC_JSON_RT_NAME));
164     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Name Tag.");
165     cborEncoderResult = cbor_encoder_create_array(&pstatMap, &rtArray, 1);
166     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding RT Value.");
167     for (size_t i = 0; i < 1; i++)
168     {
169         cborEncoderResult = cbor_encode_text_string(&rtArray, OIC_RSRC_TYPE_SEC_PSTAT,
170                 strlen(OIC_RSRC_TYPE_SEC_PSTAT));
171         VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding RT Value.");
172     }
173     cborEncoderResult = cbor_encoder_close_container(&pstatMap, &rtArray);
174     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing RT.");
175
176     //IF-- Mandatory
177      CborEncoder ifArray;
178      cborEncoderResult = cbor_encode_text_string(&pstatMap, OIC_JSON_IF_NAME,
179              strlen(OIC_JSON_IF_NAME));
180      VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Name Tag.");
181      cborEncoderResult = cbor_encoder_create_array(&pstatMap, &ifArray, 1);
182      VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Addding IF Value.");
183     for (size_t i = 0; i < 1; i++)
184     {
185         cborEncoderResult = cbor_encode_text_string(&ifArray, OC_RSRVD_INTERFACE_DEFAULT,
186                 strlen(OC_RSRVD_INTERFACE_DEFAULT));
187         VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding IF Value.");
188     }
189     cborEncoderResult = cbor_encoder_close_container(&pstatMap, &ifArray);
190     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Closing IF.");
191
192     cborEncoderResult = cbor_encoder_close_container(&encoder, &pstatMap);
193     VERIFY_CBOR_SUCCESS(TAG, cborEncoderResult, "Failed Adding Closing PSTAT Map.");
194
195     if (CborNoError == cborEncoderResult)
196     {
197         *size = encoder.ptr - outPayload;
198         *payload = outPayload;
199         ret = OC_STACK_OK;
200     }
201 exit:
202     if ((CborErrorOutOfMemory == cborEncoderResult) && (cborLen < CBOR_MAX_SIZE))
203     {
204         // reallocate and try again!
205         OICFree(outPayload);
206         // Since the allocated initial memory failed, double the memory.
207         cborLen += encoder.ptr - encoder.end;
208         cborEncoderResult = CborNoError;
209         ret = PstatToCBORPayload(pstat, payload, &cborLen);
210         if (OC_STACK_OK == ret)
211         {
212             *size = cborLen;
213         }
214     }
215
216     if ((CborNoError != cborEncoderResult) || (OC_STACK_OK != ret))
217     {
218         OICFree(outPayload);
219         outPayload = NULL;
220         *payload = NULL;
221         *size = 0;
222         ret = OC_STACK_ERROR;
223     }
224
225     return ret;
226 }
227
228 OCStackResult CBORPayloadToPstat(const uint8_t *cborPayload, const size_t size,
229                                  OicSecPstat_t **secPstat)
230 {
231     if (NULL == cborPayload || NULL == secPstat || NULL != *secPstat || 0 == size)
232     {
233         return OC_STACK_INVALID_PARAM;
234     }
235
236     OCStackResult ret = OC_STACK_ERROR;
237     *secPstat = NULL;
238
239     CborValue pstatCbor;
240     CborParser parser;
241     CborError cborFindResult = CborNoError;
242     char *strUuid = NULL;
243     size_t len = 0;
244
245     cbor_parser_init(cborPayload, size, 0, &parser, &pstatCbor);
246     CborValue pstatMap = { .parser = NULL };
247
248     OicSecPstat_t *pstat = NULL;
249     cborFindResult = cbor_value_enter_container(&pstatCbor, &pstatMap);
250     VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding PSTAT Map.");
251
252     pstat = (OicSecPstat_t *)OICCalloc(1, sizeof(OicSecPstat_t));
253     VERIFY_NON_NULL(TAG, pstat, ERROR);
254
255     cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_ISOP_NAME, &pstatMap);
256     if (CborNoError == cborFindResult && cbor_value_is_boolean(&pstatMap))
257     {
258         cborFindResult = cbor_value_get_boolean(&pstatMap, &pstat->isOp);
259         VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding isOp Value.");
260     }
261
262     cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_DEVICE_ID_NAME, &pstatMap);
263     if (CborNoError == cborFindResult && cbor_value_is_text_string(&pstatMap))
264     {
265         cborFindResult = cbor_value_dup_text_string(&pstatMap, &strUuid , &len, NULL);
266         VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding Device Id Value.");
267         ret = ConvertStrToUuid(strUuid , &pstat->deviceID);
268         VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
269         OICFree(strUuid );
270         strUuid  = NULL;
271     }
272
273     cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_CM_NAME, &pstatMap);
274     if (CborNoError == cborFindResult && cbor_value_is_integer(&pstatMap))
275     {
276         cborFindResult = cbor_value_get_int(&pstatMap, (int *) &pstat->cm);
277         VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding CM.");
278     }
279
280     cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_TM_NAME, &pstatMap);
281     if (CborNoError == cborFindResult && cbor_value_is_integer(&pstatMap))
282     {
283         cborFindResult = cbor_value_get_int(&pstatMap, (int *) &pstat->tm);
284         VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding TM.");
285     }
286
287     cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_OM_NAME, &pstatMap);
288     if (CborNoError == cborFindResult && cbor_value_is_integer(&pstatMap))
289     {
290         cborFindResult = cbor_value_get_int(&pstatMap, (int *) &pstat->om);
291         VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding OM.");
292     }
293
294     cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_SM_NAME, &pstatMap);
295     if (CborNoError == cborFindResult && cbor_value_is_integer(&pstatMap))
296     {
297         pstat->smLen = 1;
298         pstat->sm = (OicSecDpom_t*)OICCalloc(pstat->smLen, sizeof(OicSecDpom_t));
299         cborFindResult = cbor_value_get_int(&pstatMap, (int *) &pstat->sm[0]);
300         VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding SM.");
301
302     }
303
304     cborFindResult = cbor_value_map_find_value(&pstatCbor, OIC_JSON_ROWNERID_NAME, &pstatMap);
305     if (CborNoError == cborFindResult && cbor_value_is_text_string(&pstatMap))
306     {
307         cborFindResult = cbor_value_dup_text_string(&pstatMap, &strUuid , &len, NULL);
308         VERIFY_CBOR_SUCCESS(TAG, cborFindResult, "Failed Finding ROwner Id Value.");
309         ret = ConvertStrToUuid(strUuid , &pstat->rownerID);
310         VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
311         OICFree(strUuid );
312         strUuid  = NULL;
313     }
314
315     *secPstat = pstat;
316     ret = OC_STACK_OK;
317
318 exit:
319     if (CborNoError != cborFindResult)
320     {
321         OIC_LOG(ERROR, TAG, "CBORPayloadToPstat failed");
322         DeletePstatBinData(pstat);
323         pstat = NULL;
324         *secPstat = NULL;
325         ret = OC_STACK_ERROR;
326     }
327
328     return ret;
329 }
330
331 /**
332  * Function to update persistent storage
333  */
334 static bool UpdatePersistentStorage(OicSecPstat_t *pstat)
335 {
336     bool bRet = false;
337
338     size_t size = 0;
339     uint8_t *cborPayload = NULL;
340     OCStackResult ret = PstatToCBORPayload(pstat, &cborPayload, &size);
341     if (OC_STACK_OK == ret)
342     {
343         if (OC_STACK_OK == UpdateSecureResourceInPS(OIC_JSON_PSTAT_NAME, cborPayload, size))
344         {
345             bRet = true;
346         }
347         OICFree(cborPayload);
348     }
349
350     return bRet;
351 }
352
353 static bool ValidateQuery(const char * query)
354 {
355     OIC_LOG (DEBUG, TAG, "In ValidateQuery");
356     if(NULL == gPstat)
357     {
358         return false;
359     }
360
361     bool bInterfaceQry = false;      // does querystring contains 'if' query ?
362     bool bInterfaceMatch = false;    // does 'if' query matches with oic.if.baseline ?
363
364     OicParseQueryIter_t parseIter = {.attrPos = NULL};
365
366     ParseQueryIterInit((unsigned char*)query, &parseIter);
367
368     while (GetNextQuery(&parseIter))
369     {
370         if (strncasecmp((char *)parseIter.attrPos, OC_RSRVD_INTERFACE, parseIter.attrLen) == 0)
371         {
372             bInterfaceQry = true;
373             if ((strncasecmp((char *)parseIter.valPos, OC_RSRVD_INTERFACE_DEFAULT, parseIter.valLen) == 0))
374             {
375                 bInterfaceMatch = true;
376             }
377         }
378     }
379     return (bInterfaceQry ? bInterfaceMatch: true);
380 }
381
382 /**
383  * The entity handler determines how to process a GET request.
384  */
385 static OCEntityHandlerResult HandlePstatGetRequest (const OCEntityHandlerRequest * ehRequest)
386 {
387     OCEntityHandlerResult ehRet = OC_EH_OK;
388
389     OIC_LOG(INFO, TAG, "HandlePstatGetRequest  processing GET request");
390
391     //Checking if Get request is a query.
392     if (ehRequest->query)
393     {
394         OIC_LOG_V(DEBUG,TAG,"query:%s",ehRequest->query);
395         OIC_LOG(DEBUG, TAG, "HandlePstatGetRequest processing query");
396         if (!ValidateQuery(ehRequest->query))
397         {
398             ehRet = OC_EH_ERROR;
399         }
400     }
401
402     /*
403      * For GET or Valid Query request return doxm resource CBOR payload.
404      * For non-valid query return NULL json payload.
405      * A device will 'always' have a default Pstat, so PstatToCBORPayload will
406      * return valid pstat resource json.
407      */
408     size_t size = 0;
409     uint8_t *payload = NULL;
410     if (ehRet == OC_EH_OK)
411     {
412         if(OC_STACK_OK != PstatToCBORPayload(gPstat, &payload, &size))
413         {
414             OIC_LOG(WARNING, TAG, "PstatToCBORPayload failed in HandlePstatGetRequest");
415         }
416     }
417
418     // Send response payload to request originator
419     ehRet = ((SendSRMResponse(ehRequest, ehRet, payload, size)) == OC_STACK_OK) ?
420                    OC_EH_OK : OC_EH_ERROR;
421     OICFree(payload);
422     return ehRet;
423 }
424
425 /**
426  * The entity handler determines how to process a POST request.
427  * Per the REST paradigm, POST can also be used to update representation of existing
428  * resource or create a new resource.
429  * For pstat, it updates only tm and om.
430  */
431 static OCEntityHandlerResult HandlePstatPostRequest(const OCEntityHandlerRequest *ehRequest)
432 {
433     OCEntityHandlerResult ehRet = OC_EH_ERROR;
434     OIC_LOG(INFO, TAG, "HandlePstatPostRequest  processing POST request");
435     OicSecPstat_t *pstat = NULL;
436     static uint16_t prevMsgId = 0;
437
438     if (ehRequest->payload)
439     {
440         uint8_t *payload = ((OCSecurityPayload *) ehRequest->payload)->securityData;
441         size_t size = ((OCSecurityPayload *) ehRequest->payload)->payloadSize;
442         VERIFY_NON_NULL(TAG, payload, ERROR);
443
444         OCStackResult ret = CBORPayloadToPstat(payload, size, &pstat);
445         VERIFY_NON_NULL(TAG, pstat, ERROR);
446         if (OC_STACK_OK == ret)
447         {
448             if (true == (pstat->cm & RESET) && false == pstat->isOp)
449             {
450                 gPstat->cm = pstat->cm;
451                 OIC_LOG(INFO, TAG, "State changed to Ready for Reset");
452             }
453             else if (false == (pstat->cm & TAKE_OWNER) && false == pstat->isOp)
454             {
455                 gPstat->cm = pstat->cm;
456                 OIC_LOG (INFO, TAG, "State changed to Ready for Provisioning");
457             }
458             else if (false == (pstat->cm & TAKE_OWNER) && true == pstat->isOp)
459             {
460                 gPstat->isOp =pstat->isOp;
461                 OIC_LOG (INFO, TAG, "State changed to Ready for Normal Operation");
462             }
463             else
464             {
465                 OIC_LOG(DEBUG, TAG, "Invalid Device provisionig state");
466             }
467             if (pstat->om != MULTIPLE_SERVICE_SERVER_DRIVEN && gPstat)
468             {
469                 /*
470                  * Check if the operation mode is in the supported provisioning services
471                  * operation mode list.
472                  */
473                 for (size_t i=0; i< gPstat->smLen; i++)
474                 {
475                     if(gPstat->sm[i] == pstat->om)
476                     {
477                         gPstat->om = pstat->om;
478                         break;
479                     }
480                 }
481             }
482             // Convert pstat data into CBOR for update to persistent storage
483             if (UpdatePersistentStorage(gPstat))
484             {
485                 ehRet = OC_EH_OK;
486             }
487             if (true == (pstat->cm & RESET))
488             {
489                 if (OC_STACK_OK != SendSRMResponse(ehRequest, ehRet, NULL, 0))
490                 {
491                     ehRet = OC_EH_ERROR;
492                     OIC_LOG(ERROR, TAG, "SendSRMResponse failed in HandlePstatPostRequest");
493                     DeletePstatBinData(pstat);
494                     return ehRet;
495                 }
496                 ret = ResetSecureResourceInPS();
497                 if (OC_STACK_OK == ret)
498                 {
499                     ehRet = OC_EH_OK;
500                 }
501                 DeletePstatBinData(pstat);
502                 return ehRet;
503             }
504         }
505     }
506  exit:
507      if(OC_EH_OK != ehRet)
508      {
509          /*
510            * If some error is occured while ownership transfer,
511            * ownership transfer related resource should be revert back to initial status.
512            */
513          const OicSecDoxm_t* doxm = GetDoxmResourceData();
514          if(doxm)
515          {
516              if(!doxm->owned && prevMsgId !=  ehRequest->messageID)
517              {
518                  RestoreDoxmToInitState();
519                  RestorePstatToInitState();
520              }
521          }
522          else
523          {
524              OIC_LOG(ERROR, TAG, "Invalid DOXM resource.");
525          }
526      }
527      else
528      {
529          prevMsgId = ehRequest->messageID;
530      }
531
532     // Send response payload to request originator
533     ehRet = ((SendSRMResponse(ehRequest, ehRet, NULL, 0)) == OC_STACK_OK) ?
534                    OC_EH_OK : OC_EH_ERROR;
535
536     DeletePstatBinData(pstat);
537     return ehRet;
538 }
539
540 /**
541  * This internal method is the entity handler for pstat resources.
542  */
543  OCEntityHandlerResult PstatEntityHandler(OCEntityHandlerFlag flag,
544                                           OCEntityHandlerRequest * ehRequest,
545                                           void *callbackParam)
546 {
547     (void)callbackParam;
548     OCEntityHandlerResult ehRet = OC_EH_ERROR;
549     // This method will handle REST request (GET/POST) for /oic/sec/pstat
550     if (flag & OC_REQUEST_FLAG)
551     {
552         OIC_LOG(INFO, TAG, "Flag includes OC_REQUEST_FLAG");
553         switch (ehRequest->method)
554         {
555             case OC_REST_GET:
556                 ehRet = HandlePstatGetRequest(ehRequest);
557                 break;
558             case OC_REST_POST:
559                 ehRet = HandlePstatPostRequest(ehRequest);
560                 break;
561             default:
562                 ehRet = ((SendSRMResponse(ehRequest, ehRet, NULL, 0)) == OC_STACK_OK) ?
563                                OC_EH_OK : OC_EH_ERROR;
564                 break;
565         }
566     }
567     return ehRet;
568 }
569
570 /**
571  * This internal method is used to create '/oic/sec/pstat' resource.
572  */
573  OCStackResult CreatePstatResource()
574 {
575     OCStackResult ret = OCCreateResource(&gPstatHandle,
576                                          OIC_RSRC_TYPE_SEC_PSTAT,
577                                          OC_RSRVD_INTERFACE_DEFAULT,
578                                          OIC_RSRC_PSTAT_URI,
579                                          PstatEntityHandler,
580                                          NULL,
581                                          OC_SECURE |
582                                          OC_DISCOVERABLE);
583
584     if (OC_STACK_OK != ret)
585     {
586         OIC_LOG(FATAL, TAG, "Unable to instantiate pstat resource");
587         DeInitPstatResource();
588     }
589     return ret;
590 }
591
592 /**
593  * Get the default value.
594  *
595  * @return the gDefaultPstat pointer.
596  */
597 static OicSecPstat_t* GetPstatDefault()
598 {
599     return &gDefaultPstat;
600 }
601
602 OCStackResult InitPstatResource()
603 {
604     OCStackResult ret = OC_STACK_ERROR;
605
606     // Read Pstat resource from PS
607     uint8_t *data = NULL;
608     size_t size = 0;
609     OicUuid_t emptyUuid = {.id={0}};
610     ret = GetSecureVirtualDatabaseFromPS(OIC_JSON_PSTAT_NAME, &data, &size);
611     // If database read failed
612     if (OC_STACK_OK != ret)
613     {
614         OIC_LOG (DEBUG, TAG, "ReadSVDataFromPS failed");
615     }
616     if (data)
617     {
618         // Read ACL resource from PS
619         ret = CBORPayloadToPstat(data, size, &gPstat);
620         OICFree(data);
621     }
622     /*
623      * If SVR database in persistent storage got corrupted or
624      * is not available for some reason, a default pstat is created
625      * which allows user to initiate pstat provisioning again.
626      */
627     if ((OC_STACK_OK != ret) || !gPstat)
628     {
629         gPstat = GetPstatDefault();
630     }
631     VERIFY_NON_NULL(TAG, gPstat, FATAL);
632
633     //In case of Pstat's device id is empty, fill the device id as doxm's device id.
634     if(0 == memcmp(&gPstat->deviceID, &emptyUuid, sizeof(OicUuid_t)))
635     {
636         OicUuid_t doxmUuid = {.id={0}};
637         if(OC_STACK_OK == GetDoxmDeviceID(&doxmUuid))
638         {
639             memcpy(&gPstat->deviceID, &doxmUuid, sizeof(OicUuid_t));
640         }
641     }
642
643     // Instantiate 'oic.sec.pstat'
644     ret = CreatePstatResource();
645
646 exit:
647     if (OC_STACK_OK != ret)
648     {
649         DeInitPstatResource();
650     }
651     return ret;
652 }
653
654 OCStackResult DeInitPstatResource()
655 {
656     if (gPstat != &gDefaultPstat)
657     {
658         DeletePstatBinData(gPstat);
659         gPstat = NULL;
660     }
661     return OCDeleteResource(gPstatHandle);
662 }
663
664 /**
665  * Function to restore pstat resurce to initial status.
666  * This function will use in case of error while ownership transfer
667  */
668 void RestorePstatToInitState()
669 {
670     if(gPstat)
671     {
672         OIC_LOG(INFO, TAG, "PSTAT resource will revert back to initial status.");
673
674         gPstat->cm = (OicSecDpm_t)(gPstat->cm | TAKE_OWNER);
675         gPstat->tm = (OicSecDpm_t)(gPstat->tm & (~TAKE_OWNER));
676         gPstat->om = SINGLE_SERVICE_CLIENT_DRIVEN;
677         if(gPstat->sm && 0 < gPstat->smLen)
678         {
679             gPstat->sm[0] = SINGLE_SERVICE_CLIENT_DRIVEN;
680         }
681
682         if (!UpdatePersistentStorage(gPstat))
683         {
684             OIC_LOG(ERROR, TAG, "Failed to revert PSTAT in persistent storage");
685         }
686     }
687 }
688
689 OCStackResult SetPstatRownerId(const OicUuid_t* newROwner)
690 {
691     OCStackResult ret = OC_STACK_ERROR;
692     uint8_t *cborPayload = NULL;
693     size_t size = 0;
694     OicUuid_t prevId = {.id={0}};
695
696     if(NULL == newROwner)
697     {
698         ret = OC_STACK_INVALID_PARAM;
699     }
700     if(NULL == gPstat)
701     {
702         ret = OC_STACK_NO_RESOURCE;
703     }
704
705     if(newROwner && gPstat)
706     {
707         memcpy(prevId.id, gPstat->rownerID.id, sizeof(prevId.id));
708         memcpy(gPstat->rownerID.id, newROwner->id, sizeof(newROwner->id));
709
710         ret = PstatToCBORPayload(gPstat, &cborPayload, &size);
711         VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
712
713         ret = UpdateSecureResourceInPS(OIC_JSON_PSTAT_NAME, cborPayload, size);
714         VERIFY_SUCCESS(TAG, OC_STACK_OK == ret, ERROR);
715
716         OICFree(cborPayload);
717     }
718
719     return ret;
720
721 exit:
722     OICFree(cborPayload);
723     memcpy(gPstat->rownerID.id, prevId.id, sizeof(prevId.id));
724     return ret;
725 }
726
727 /**
728  * This function returns the "isop" status of the device.
729  *
730  * @return true iff pstat.isop == 1, else false
731  */
732 bool GetPstatIsop()
733 {
734     return gPstat->isOp;
735 }
736
737 OCStackResult GetPstatRownerId(OicUuid_t *rowneruuid)
738 {
739     OCStackResult retVal = OC_STACK_ERROR;
740     if (gPstat)
741     {
742         *rowneruuid = gPstat->rownerID;
743         retVal = OC_STACK_OK;
744     }
745     return retVal;
746 }