resource/csdk/security/provisioning/include/internal/ownershiptransfermanager.h

   1 /* *****************************************************************\r
   2  *\r
   3  * Copyright 2015 Samsung Electronics All Rights Reserved.\r
   4  *\r
   5  *\r
   6  *\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  *\r
  11  *     http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  *\r
  19  * *****************************************************************/\r
  20 \r
  21 #ifndef OTM_OWNERSHIPTRANSFERMANAGER_H_\r
  22 #define OTM_OWNERSHIPTRANSFERMANAGER_H_\r
  23 \r
  24 #include "pmtypes.h"\r
  25 #include "ocstack.h"\r
  26 #include "octypes.h"\r
  27 #include "securevirtualresourcetypes.h"\r
  28 \r
  29 #ifdef __cplusplus\r
  30 extern "C" {\r
  31 #endif // __cplusplus\r
  32 \r
  33 #define OXM_STRING_MAX_LENGTH 32\r
  34 \r
  35 \r
  36 /**\r
  37  * Context for ownership transfer(OT)\r
  38  */\r
  39 typedef struct OTMContext{\r
  40     void* userCtx;                         /**< Context for user.*/\r
  41     OCProvisionDev_t* selectedDeviceInfo;  /**< Selected device info for OT. */\r
  42     OicUuid_t subIdForPinOxm;              /**< Subject Id which uses PIN based OTM. */\r
  43     OCProvisionResultCB ctxResultCallback; /**< Function pointer to store result callback. */\r
  44     OCProvisionResult_t* ctxResultArray;   /**< Result array having result of all device. */\r
  45     size_t ctxResultArraySize;             /**< No of elements in result array. */\r
  46     bool ctxHasError;                      /**< Does OT process have any error. */\r
  47 }OTMContext_t;\r
  48 \r
  49 /**\r
  50  * Do ownership transfer for the unowned devices.\r
  51  *\r
  52  * @param[in] ctx Application context would be returned in result callback\r
  53  * @param[in] selectedDeviceList linked list of ownership transfer candidate devices.\r
  54  * @param[in] resultCB Result callback function to be invoked when ownership transfer finished.\r
  55  * @return OC_STACK_OK in case of success and other value otherwise.\r
  56  */\r
  57 OCStackResult OTMDoOwnershipTransfer(void* ctx,\r
  58                                      OCProvisionDev_t* selectedDeviceList, OCProvisionResultCB resultCB);\r
  59 \r
  60 /*\r
  61  *Callback for load secret for temporal secure session\r
  62  *\r
  63  * e.g) in case of PIN based, input the pin through this callback\r
  64  *       in case of X.509 based, input the certificate through this callback\r
  65  */\r
  66 typedef OCStackResult (*OTMLoadSecret)(OTMContext_t* otmCtx);\r
  67 \r
  68 \r
  69 /*\r
  70  * Callback for create secure channel using secret inputed from OTMLoadSecret callback\r
  71  */\r
  72 typedef OCStackResult (*OTMCreateSecureSession)(OTMContext_t* otmCtx);\r
  73 \r
  74 /*\r
  75  * Callback for creating CoAP payload.\r
  76  */\r
  77 typedef char* (*OTMCreatePayloadCallback)(OTMContext_t* otmCtx);\r
  78 \r
  79 /**\r
  80  * Required callback for performing ownership transfer\r
  81  */\r
  82 typedef struct OTMCallbackData{\r
  83     OTMLoadSecret loadSecretCB;\r
  84     OTMCreateSecureSession createSecureSessionCB;\r
  85     OTMCreatePayloadCallback createSelectOxmPayloadCB;\r
  86     OTMCreatePayloadCallback createOwnerTransferPayloadCB;\r
  87 }OTMCallbackData_t;\r
  88 \r
  89 /**\r
  90  * Set the callbacks for ownership transfer\r
  91  *\r
  92  * @param[in] oxm Ownership transfer method\r
  93  * @param[in] callbackData the implementation of the ownership transfer function for each step.\r
  94  * @return OC_STACK_OK in case of success and other value otherwise.\r
  95  */\r
  96 OCStackResult OTMSetOwnershipTransferCallbackData(OicSecOxm_t oxm, OTMCallbackData_t* callbackData);\r
  97 \r
  98 \r
  99 #ifdef __cplusplus\r
 100 }\r
 101 #endif\r
 102 #endif //OTM_OWNERSHIPTRANSFERMANAGER_H_\r