resource/csdk/security/include/internal/svcresource.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_SVCR_H
  22 #define IOTVT_SRM_SVCR_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /**
  29  * Initialize SVC resource by loading data from persistent storage.
  30  *
  31  * @retval  OC_STACK_OK for Success, otherwise some error value
  32  */
  33 OCStackResult InitSVCResource();
  34
  35 /**
  36  * Perform cleanup for SVC resources.
  37  *
  38  * @retval  none
  39  */
  40 void DeInitSVCResource();
  41
  42 /**
  43  * This function converts SVC data into CBOR format.
  44  * Caller needs to invoke 'free' when done using returned string.
  45  *
  46  * @param svc is the instance of @ref OicSecSvc_t structure. In case of NULL it
  47  * will return ::OC_STACK_INVALID_PARAM.
  48  * @param cborPayload is the converted cbor value of SVC structure.
  49  * @param cborSize is the size of the cbor payload. This value is the size of the
  50  * cborPayload. It should not be NON-NULL value.
  51  *
  52  * @return ::OC_STACK_OK for Success. ::OC_STACK_INVALID in case of invalid parameters.
  53  * ::OC_STACK_ERROR in case of error in converting to cbor.
  54  */
  55  OCStackResult SVCToCBORPayload(const OicSecSvc_t *svc, uint8_t **cborPayload,
  56                                 size_t *cborSize);
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif
  61
  62 #endif //IOTVT_SRM_SVCR_H