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 1\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  * API to set a allow status of OxM\r
  52  *\r
  53  * @param[in] oxm Owership transfer method (ref. OicSecOxm_t)\r
  54  * @param[in] allowStatus allow status (true = allow, false = not allow)\r
  55  *\r
  56  * @return OC_STACK_OK in case of success and other value otherwise.\r
  57  */\r
  58 OCStackResult OTMSetOxmAllowStatus(const OicSecOxm_t oxm, const bool allowStatus);\r
  59 \r
  60 \r
  61 /*\r
  62  *Callback for load secret for temporal secure session\r
  63  *\r
  64  * e.g) in case of PIN based, input the pin through this callback\r
  65  *       in case of X.509 based, input the certificate through this callback\r
  66  */\r
  67 typedef OCStackResult (*OTMLoadSecret)(OTMContext_t* otmCtx);\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 OCStackResult (*OTMCreatePayloadCallback)(OTMContext_t* otmCtx, uint8_t **payload,\r
  78                                                   size_t *size);\r
  79 \r
  80 /**\r
  81  * Required callback for performing ownership transfer\r
  82  */\r
  83 struct OTMCallbackData\r
  84 {\r
  85     OTMLoadSecret loadSecretCB;\r
  86     OTMCreateSecureSession createSecureSessionCB;\r
  87     OTMCreatePayloadCallback createSelectOxmPayloadCB;\r
  88     OTMCreatePayloadCallback createOwnerTransferPayloadCB;\r
  89 };\r
  90 \r
  91 /**\r
  92  * Context for ownership transfer(OT)\r
  93  */\r
  94 struct OTMContext{\r
  95     void* userCtx;                            /**< Context for user.*/\r
  96     OCProvisionDev_t* selectedDeviceInfo;     /**< Selected device info for OT. */\r
  97     OicUuid_t subIdForPinOxm;                 /**< Subject Id which uses PIN based OTM. */\r
  98     OCProvisionResultCB ctxResultCallback;    /**< Function pointer to store result callback. */\r
  99     OCProvisionResult_t* ctxResultArray;      /**< Result array having result of all device. */\r
 100     size_t ctxResultArraySize;                /**< No of elements in result array. */\r
 101     bool ctxHasError;                         /**< Does OT process have any error. */\r
 102     OCDoHandle ocDoHandle;                    /** <A handle for latest request message*/\r
 103     OTMCallbackData_t otmCallback; /**< OTM callbacks to perform the OT/MOT. **/\r
 104     int attemptCnt;\r
 105 };\r
 106 \r
 107 // TODO: Remove this OTMSetOwnershipTransferCallbackData, Please see the jira ticket IOT-1484\r
 108 /**\r
 109  * Set the callbacks for ownership transfer\r
 110  *\r
 111  * @param[in] oxm Ownership transfer method\r
 112  * @param[in] callbackData the implementation of the ownership transfer function for each step.\r
 113  * @return OC_STACK_OK in case of success and other value otherwise.\r
 114  */\r
 115 OCStackResult OTMSetOwnershipTransferCallbackData(OicSecOxm_t oxm, OTMCallbackData_t* callbackData);\r
 116 \r
 117 /**\r
 118  * API to assign the OTMCallback for each OxM.\r
 119  *\r
 120  * @param[out] callbacks Instance of OTMCallback_t\r
 121  * @param[in] oxm Ownership transfer method\r
 122  * @return  OC_STACK_OK on success\r
 123  */\r
 124 OCStackResult OTMSetOTCallback(OicSecOxm_t oxm, OTMCallbackData_t* callbacks);\r
 125 \r
 126 /**\r
 127  * Function to save the result of provisioning.\r
 128  *\r
 129  * @param[in,out] otmCtx   Context value of ownership transfer.\r
 130  * @param[in] res   result of provisioning\r
 131  */\r
 132 void SetResult(OTMContext_t* otmCtx, const OCStackResult res);\r
 133 \r
 134 /**\r
 135  * Function to select appropriate security provisioning method.\r
 136  *\r
 137  * @param[in] supportedMethods   Array of supported methods\r
 138  * @param[in] numberOfMethods   number of supported methods\r
 139  * @param[out]  selectedMethod         Selected methods\r
 140  * @param[in] ownerType type of owner device (SUPER_OWNER or SUB_OWNER)\r
 141  * @return  OC_STACK_OK on success\r
 142  */\r
 143 OCStackResult OTMSelectOwnershipTransferMethod(const OicSecOxm_t *supportedMethods,\r
 144         size_t numberOfMethods, OicSecOxm_t *selectedMethod, OwnerType_t ownerType);\r
 145 \r
 146 /**\r
 147  * This function configures SVR DB as self-ownership.\r
 148  *\r
 149  *@return OC_STACK_OK in case of successful configue and other value otherwise.\r
 150  */\r
 151 OCStackResult ConfigSelfOwnership(void);\r
 152 \r
 153 /**\r
 154  * API to terminate the OTM process when terminating OCStack\r
 155  */\r
 156 void OTMTerminate();\r
 157 \r
 158 #ifdef __cplusplus\r
 159 }\r
 160 #endif\r
 161 #endif //OTM_OWNERSHIPTRANSFERMANAGER_H_\r