resource/csdk/security/include/internal/doxmresource.h

   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 #ifndef IOTVT_SRM_DOXM_H
  22 #define IOTVT_SRM_DOXM_H
  23
  24 #include "octypes.h"
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /**
  31  * Initialize DOXM resource by loading data from persistent storage.
  32  *
  33  * @return ::OC_STACK_OK for Success, otherwise some error value.
  34  */
  35 OCStackResult InitDoxmResource();
  36
  37 /**
  38  * Perform cleanup for DOXM resources.
  39  *
  40  * @return ::OC_STACK_OK for Success, otherwise some error value.
  41  */
  42 OCStackResult DeInitDoxmResource();
  43
  44 /**
  45  * This method is used by SRM to retrieve DOXM resource data..
  46  *
  47  * @return reference to @ref OicSecDoxm_t, binary format of Doxm resource data.
  48  */
  49 const OicSecDoxm_t* GetDoxmResourceData();
  50
  51 /**
  52  * This method converts CBOR DOXM into binary DOXM.
  53  * The CBOR DOXM can be from persistent database or
  54  * or received as PUT/POST request.
  55  *
  56  * @param cborPayload is a doxm data in cbor.
  57  * @note Caller needs to invoke OCFree after done using the return pointer.
  58  * @param doxm is the pointer to @ref OicSecDoxm_t.
  59  * @param size of the cborPayload. In case value is 0, CBOR_SIZE value is assigned.
  60  *
  61  * @return ::OC_STACK_OK for Success, otherwise some error value.
  62  */
  63 OCStackResult CBORPayloadToDoxm(const uint8_t *cborPayload, size_t size,
  64                                 OicSecDoxm_t **doxm);
  65
  66 /**
  67  * This method converts DOXM data into CBOR format.
  68  * Caller needs to invoke 'free' when finished done using
  69  * return string.
  70  *
  71  * @param doxm Pointer to @ref OicSecDoxm_t.
  72  * @note Caller needs to invoke OCFree after done using the return pointer.
  73  * @param cborPayload is the payload of the cbor.
  74  * @param cborSize is the size of the cbor payload. Passed parameter should not be NULL.
  75  * @param rwOnly indicates whether convertingpayload has all properties or read-write properties only.
  76  *
  77  * @return ::OC_STACK_OK for Success, otherwise some error value.
  78  */
  79 OCStackResult DoxmToCBORPayload(const OicSecDoxm_t * doxm, uint8_t **cborPayload,
  80                                 size_t *cborSize, bool rwOnly);
  81
  82 /**
  83  * This method returns the SRM device ID for this device.
  84  *
  85  * @return ::OC_STACK_OK for Success, otherwise some error value.
  86  */
  87 OCStackResult GetDoxmDeviceID(OicUuid_t *deviceID);
  88
  89 /**
  90  * Gets the OicUuid_t value for the owner of this device.
  91  *
  92  * @param devownerid a pointer to be assigned to the devownerid property
  93  * @return ::OC_STACK_OK if devownerid is assigned correctly, else ::OC_STACK_ERROR.
  94  */
  95 OCStackResult GetDoxmDevOwnerId(OicUuid_t *devownerid);
  96
  97 /**
  98  * Gets the OicUuid_t value for the rowneruuid of the doxm resource.
  99  *
 100  * @param rowneruuid a pointer to be assigned to the rowneruuid property
 101  * @return ::OC_STACK_OK if rowneruuid is assigned correctly, else ::OC_STACK_ERROR.
 102  */
 103 OCStackResult GetDoxmRownerId(OicUuid_t *rowneruuid);
 104
 105 /** This function deallocates the memory for OicSecDoxm_t .
 106  *
 107  * @param doxm is the pointer to @ref OicSecDoxm_t.
 108  */
 109 void DeleteDoxmBinData(OicSecDoxm_t* doxm);
 110
 111 /**
 112  * Function to restore doxm resurce to initial status.
 113  * This function will use in case of error while ownership transfer
 114  */
 115 void RestoreDoxmToInitState();
 116
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif //IOTVT_SRM_DOXMR_H