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 #define WRONG_PIN_MAX_ATTEMP 5\r
  35 \r
  36 typedef struct OTMCallbackData OTMCallbackData_t;\r
  37 typedef struct OTMContext OTMContext_t;\r
  38 \r
  39 /**\r
  40  * Do ownership transfer for the unowned devices.\r
  41  *\r
  42  * @param[in] ctx Application context would be returned in result callback\r
  43  * @param[in] selectedDeviceList linked list of ownership transfer candidate devices.\r
  44  * @param[in] resultCB Result callback function to be invoked when ownership transfer finished.\r
  45  * @return OC_STACK_OK in case of success and other value otherwise.\r
  46  */\r
  47 OCStackResult OTMDoOwnershipTransfer(void* ctx,\r
  48                                      OCProvisionDev_t* selectedDeviceList, OCProvisionResultCB resultCB);\r
  49 \r
  50 /*\r
  51  *Callback for load secret for temporal secure session\r
  52  *\r
  53  * e.g) in case of PIN based, input the pin through this callback\r
  54  *       in case of X.509 based, input the certificate through this callback\r
  55  */\r
  56 typedef OCStackResult (*OTMLoadSecret)(OTMContext_t* otmCtx);\r
  57 \r
  58 /*\r
  59  * Callback for create secure channel using secret inputed from OTMLoadSecret callback\r
  60  */\r
  61 typedef OCStackResult (*OTMCreateSecureSession)(OTMContext_t* otmCtx);\r
  62 \r
  63 /*\r
  64  * Callback for creating CoAP payload.\r
  65  */\r
  66 typedef OCStackResult (*OTMCreatePayloadCallback)(OTMContext_t* otmCtx, uint8_t **payload,\r
  67                                                   size_t *size);\r
  68 \r
  69 /**\r
  70  * Required callback for performing ownership transfer\r
  71  */\r
  72 struct OTMCallbackData\r
  73 {\r
  74     OTMLoadSecret loadSecretCB;\r
  75     OTMCreateSecureSession createSecureSessionCB;\r
  76     OTMCreatePayloadCallback createSelectOxmPayloadCB;\r
  77     OTMCreatePayloadCallback createOwnerTransferPayloadCB;\r
  78 };\r
  79 \r
  80 /**\r
  81  * Context for ownership transfer(OT)\r
  82  */\r
  83 struct OTMContext{\r
  84     void* userCtx;                            /**< Context for user.*/\r
  85     OCProvisionDev_t* selectedDeviceInfo;     /**< Selected device info for OT. */\r
  86     OicUuid_t subIdForPinOxm;                 /**< Subject Id which uses PIN based OTM. */\r
  87     OCProvisionResultCB ctxResultCallback;    /**< Function pointer to store result callback. */\r
  88     OCProvisionResult_t* ctxResultArray;      /**< Result array having result of all device. */\r
  89     size_t ctxResultArraySize;                /**< No of elements in result array. */\r
  90     bool ctxHasError;                         /**< Does OT process have any error. */\r
  91     OCDoHandle ocDoHandle;                    /** <A handle for latest request message*/\r
  92     OTMCallbackData_t otmCallback; /**< OTM callbacks to perform the OT/MOT. **/\r
  93     int attemptCnt;\r
  94 };\r
  95 \r
  96 // TODO: Remove this OTMSetOwnershipTransferCallbackData, Please see the jira ticket IOT-1484\r
  97 /**\r
  98  * Set the callbacks for ownership transfer\r
  99  *\r
 100  * @param[in] oxm Ownership transfer method\r
 101  * @param[in] callbackData the implementation of the ownership transfer function for each step.\r
 102  * @return OC_STACK_OK in case of success and other value otherwise.\r
 103  */\r
 104 OCStackResult OTMSetOwnershipTransferCallbackData(OicSecOxm_t oxm, OTMCallbackData_t* callbackData);\r
 105 \r
 106 /**\r
 107  * API to assign the OTMCallback for each OxM.\r
 108  *\r
 109  * @param[out] callbacks Instance of OTMCallback_t\r
 110  * @param[in] oxm Ownership transfer method\r
 111  * @return  OC_STACK_OK on success\r
 112  */\r
 113 OCStackResult OTMSetOTCallback(OicSecOxm_t oxm, OTMCallbackData_t* callbacks);\r
 114 \r
 115 #ifdef __cplusplus\r
 116 }\r
 117 #endif\r
 118 #endif //OTM_OWNERSHIPTRANSFERMANAGER_H_\r