resource/csdk/security/provisioning/include/ocprovisioningmanager.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 OCPROVISIONINGMANAGER_H_\r
  22 #define OCPROVISIONINGMANAGER_H_\r
  23 \r
  24 #include "octypes.h"\r
  25 #include "pmtypes.h"\r
  26 #include "ownershiptransfermanager.h"\r
  27 \r
  28 #ifdef __cplusplus\r
  29 extern "C" {\r
  30 #endif // __cplusplus\r
  31 \r
  32 /**\r
  33  * The function is responsible for initializaton of the provisioning manager. It will load\r
  34  * provisioning database which have owned device's list and their linked status.\r
  35  * TODO: In addition, if there is a device(s) which has not up-to-date credentials, this function will\r
  36  * automatically try to update the deivce(s).\r
  37  *\r
  38  * @param[in] dbPath file path of the sqlite3 db\r
  39  *\r
  40  * @return OC_STACK_OK in case of success and other value otherwise.\r
  41  */\r
  42 OCStackResult OCInitPM(const char* dbPath);\r
  43 \r
  44 /**\r
  45  * The function is responsible for discovery of owned/unowned device is specified endpoint/deviceID.\r
  46  * It will return the found device even though timeout is not exceeded.\r
  47  *\r
  48  * @param[in] timeout Timeout in seconds, value till which function will listen to responses from\r
  49  *                    server before returning the device.\r
  50  * @param[in] deviceID         deviceID of target device.\r
  51  * @param[out] ppFoundDevice     OCProvisionDev_t of found device\r
  52  * @return OTM_SUCCESS in case of success and other value otherwise.\r
  53  */\r
  54 OCStackResult OCDiscoverSingleDevice(unsigned short timeout, const OicUuid_t* deviceID,\r
  55                              OCProvisionDev_t **ppFoundDevice);\r
  56 \r
  57 /**\r
  58  * The function is responsible for discovery of device is current subnet. It will list\r
  59  * all the device in subnet which are not yet owned. Please call OCInit with OC_CLIENT_SERVER as\r
  60  * OCMode.\r
  61  *\r
  62  * @param[in] timeout Timeout in seconds, value till which function will listen to responses from\r
  63  *                    server before returning the list of devices.\r
  64  * @param[out] ppList List of candidate devices to be provisioned\r
  65  * @return OTM_SUCCESS in case of success and other value otherwise.\r
  66  */\r
  67 OCStackResult OCDiscoverUnownedDevices(unsigned short waittime, OCProvisionDev_t **ppList);\r
  68 \r
  69 /**\r
  70  * Do ownership transfer for un-owned device.\r
  71  *\r
  72  * @param[in] ctx Application context would be returned in result callback\r
  73  * @param[in] targetDevices List of devices to perform ownership transfer.\r
  74  * @param[in] resultCallback Result callback function to be invoked when ownership transfer finished.\r
  75  * @return OC_STACK_OK in case of success and other value otherwise.\r
  76  */\r
  77 OCStackResult OCDoOwnershipTransfer(void* ctx,\r
  78                                     OCProvisionDev_t *targetDevices,\r
  79                                     OCProvisionResultCB resultCallback);\r
  80 \r
  81 /**\r
  82  * API to register for particular OxM.\r
  83  *\r
  84  * @param[in] Ownership transfer method.\r
  85  * @param[in] Implementation of callback functions for owership transfer.\r
  86  * @return OC_STACK_OK in case of success and other value otherwise.\r
  87  */\r
  88 OCStackResult OCSetOwnerTransferCallbackData(OicSecOxm_t oxm, OTMCallbackData_t* callbackData);\r
  89 \r
  90 /**\r
  91  * The function is responsible for discovery of owned device is current subnet. It will list\r
  92  * all the device in subnet which are owned by calling provisioning client.\r
  93  *\r
  94  * @param[in] timeout Timeout in seconds, value till which function will listen to responses from\r
  95  *                    server before returning the list of devices.\r
  96  * @param[out] ppList List of device owned by provisioning tool.\r
  97  * @return OTM_SUCCESS in case of success and other value otherwise.\r
  98  */\r
  99 OCStackResult OCDiscoverOwnedDevices(unsigned short timeout, OCProvisionDev_t **ppList);\r
 100 \r
 101 /**\r
 102  * API to provision credentials between two devices and ACLs for the devices who act as a server.\r
 103  *\r
 104  * @param[in] ctx Application context would be returned in result callback.\r
 105  * @param[in] type Type of credentials to be provisioned to the device.\r
 106  * @param[in] pDev1 Pointer to OCProvisionDev_t instance,respresenting device to be provisioned.\r
 107  * @param[in] acl ACL for device 1. If this is not required set NULL.\r
 108  * @param[in] pDev2 Pointer to OCProvisionDev_t instance,respresenting device to be provisioned.\r
 109  * @param[in] acl ACL for device 2. If this is not required set NULL.\r
 110  * @param[in] resultCallback callback provided by API user, callback will be called when\r
 111  *            provisioning request recieves a response from first resource server.\r
 112  * @return OC_STACK_OK in case of success and other value otherwise.\r
 113  */\r
 114 OCStackResult OCProvisionPairwiseDevices(void* ctx, OicSecCredType_t type, size_t keySize,\r
 115                                          const OCProvisionDev_t *pDev1, OicSecAcl_t *pDev1Acl,\r
 116                                          const OCProvisionDev_t *pDev2, OicSecAcl_t *pDev2Acl,\r
 117                                          OCProvisionResultCB resultCallback);\r
 118 \r
 119 /**\r
 120  * API to send ACL information to device.\r
 121  *\r
 122  * @param[in] ctx Application context would be returned in result callback.\r
 123  * @param[in] selectedDeviceInfo Selected target device.\r
 124  * @param[in] acl ACL to provision.\r
 125  * @param[in] resultCallback callback provided by API user, callback will be called when provisioning\r
 126               request recieves a response from resource server.\r
 127  * @return OC_STACK_OK in case of success and other value otherwise.\r
 128  */\r
 129 OCStackResult OCProvisionACL(void *ctx, const OCProvisionDev_t *selectedDeviceInfo, OicSecAcl_t *acl,\r
 130                              OCProvisionResultCB resultCallback);\r
 131 \r
 132 /**\r
 133  * this function requests CRED information to resource.\r
 134  *\r
 135  * @param[in] ctx Application context would be returned in result callback.\r
 136  * @param[in] selectedDeviceInfo Selected target device.\r
 137  * @param[in] resultCallback callback provided by API user, callback will be called when provisioning\r
 138               request recieves a response from resource server.\r
 139  * @return  OC_STACK_OK in case of success and other value otherwise.\r
 140  */\r
 141 OCStackResult OCGetCredResource(void* ctx, const OCProvisionDev_t *selectedDeviceInfo,\r
 142                              OCProvisionResultCB resultCallback);\r
 143 \r
 144 /**\r
 145  * this function requests ACL information to resource.\r
 146  *\r
 147  * @param[in] ctx Application context would be returned in result callback.\r
 148  * @param[in] selectedDeviceInfo Selected target device.\r
 149  * @param[in] resultCallback callback provided by API user, callback will be called when provisioning\r
 150               request recieves a response from resource server.\r
 151  * @return  OC_STACK_OK in case of success and other value otherwise.\r
 152  */\r
 153 OCStackResult OCGetACLResource(void* ctx, const OCProvisionDev_t *selectedDeviceInfo,\r
 154                              OCProvisionResultCB resultCallback);\r
 155 \r
 156 /**\r
 157  * this function sends Direct-Pairing Configuration to a device.\r
 158  *\r
 159  * @param[in] ctx Application context would be returned in result callback.\r
 160  * @param[in] selectedDeviceInfo Selected target device.\r
 161  * @param[in] pconf PCONF pointer.\r
 162  * @param[in] resultCallback callback provided by API user, callback will be called when provisioning\r
 163               request recieves a response from resource server.\r
 164  * @return  OC_STACK_OK in case of success and other value otherwise.\r
 165  */\r
 166 OCStackResult OCProvisionDirectPairing(void* ctx, const OCProvisionDev_t *selectedDeviceInfo, OicSecPconf_t *pconf,\r
 167                              OCProvisionResultCB resultCallback);\r
 168 \r
 169 /**\r
 170  * API to provision credential to devices.\r
 171  *\r
 172  * @param[in] ctx Application context would be returned in result callback.\r
 173  * @param[in] type Type of credentials to be provisioned to the device.\r
 174  * @param[in] pDev1 Pointer to OCProvisionDev_t instance,respresenting resource to be provsioned.\r
 175    @param[in] pDev2 Pointer to OCProvisionDev_t instance,respresenting resource to be provsioned.\r
 176  * @param[in] resultCallback callback provided by API user, callback will be called when\r
 177  *            provisioning request recieves a response from first resource server.\r
 178  * @return OC_STACK_OK in case of success and other value otherwise.\r
 179  */\r
 180 OCStackResult OCProvisionCredentials(void *ctx, OicSecCredType_t type, size_t keySize,\r
 181                                       const OCProvisionDev_t *pDev1,\r
 182                                       const OCProvisionDev_t *pDev2,\r
 183                                       OCProvisionResultCB resultCallback);\r
 184 \r
 185 /**\r
 186  * Function to unlink devices.\r
 187  * This function will remove the credential & relasionship between the two devices.\r
 188  *\r
 189  * @param[in] ctx Application context would be returned in result callback\r
 190  * @param[in] pTargetDev1 fitst device information to be unlinked.\r
 191  * @param[in] pTargetDev2 second device information to be unlinked.\r
 192  * @param[in] resultCallback callback provided by API user, callback will be called when\r
 193  *            device unlink is finished.\r
 194  * @return OC_STACK_OK in case of success and other value otherwise.\r
 195  */\r
 196 OCStackResult OCUnlinkDevices(void* ctx,\r
 197                               const OCProvisionDev_t* pTargetDev1,\r
 198                               const OCProvisionDev_t* pTargetDev2,\r
 199                               OCProvisionResultCB resultCallback);\r
 200 \r
 201 /**\r
 202  * Function for device revocation\r
 203  * This function will remove credential of target device from all devices in subnet.\r
 204  *\r
 205  * @param[in] ctx Application context would be returned in result callback\r
 206  * @param[in] waitTimeForOwnedDeviceDiscovery Maximum wait time for owned device discovery.(seconds)\r
 207  * @param[in] pTargetDev Device information to be revoked.\r
 208  * @param[in] resultCallback callback provided by API user, callback will be called when\r
 209  *            credential revocation is finished.\r
 210  * @return OC_STACK_OK in case of success and other value otherwise.\r
 211  *         if OC_STACK_OK is returned, the caller of this API should wait for callback.\r
 212  *         OC_STACK_CONTINUE means operation is success but no need to wait for callback.\r
 213  */\r
 214 OCStackResult OCRemoveDevice(void* ctx,\r
 215                              unsigned short waitTimeForOwnedDeviceDiscovery,\r
 216                              const OCProvisionDev_t* pTargetDev,\r
 217                              OCProvisionResultCB resultCallback);\r
 218 \r
 219 /*\r
 220 * Function to device revocation\r
 221 * This function will remove credential of target device from all devices in subnet.\r
 222 *\r
 223 * @param[in] ctx Application context would be returned in result callback\r
 224 * @param[in] waitTimeForOwnedDeviceDiscovery Maximum wait time for owned device discovery.(seconds)\r
 225 * @param[in] pTargetDev Device information to be revoked.\r
 226 * @param[in] resultCallback callback provided by API user, callback will be called when\r
 227 *            credential revocation is finished.\r
 228  * @return  OC_STACK_OK in case of success and other value otherwise.\r
 229 */\r
 230 OCStackResult OCRemoveDeviceWithUuid(void* ctx,\r
 231                                      unsigned short waitTimeForOwnedDeviceDiscovery,\r
 232                                      const OicUuid_t* pTargetUuid,\r
 233                                      OCProvisionResultCB resultCallback);\r
 234 \r
 235 /*\r
 236  * Function to reset the target device.\r
 237  * This function will remove credential and ACL of target device from all devices in subnet.\r
 238  *\r
 239  * @param[in] ctx Application context would be returned in result callback\r
 240  * @param[in] waitTimeForOwnedDeviceDiscovery Maximum wait time for owned device discovery.(seconds)\r
 241  * @param[in] pTargetDev Device information to be revoked.\r
 242  * @param[in] resultCallback callback provided by API user, callback will be called when\r
 243  *            credential revocation is finished.\r
 244  * @return  OC_STACK_OK in case of success and other value otherwise.\r
 245  */\r
 246 OCStackResult OCResetDevice(void* ctx, unsigned short waitTimeForOwnedDeviceDiscovery,\r
 247                             const OCProvisionDev_t* pTargetDev,\r
 248                             OCProvisionResultCB resultCallback);\r
 249 \r
 250 /**\r
 251  * API to get status of all the devices in current subnet. The status include endpoint information\r
 252  * and doxm information which can be extracted duing owned and unowned discovery. Along with this\r
 253  * information. The API will provide information about devices' status\r
 254  * Device can have following states\r
 255  *  - ON/OFF: Device is switched on or off.\r
 256  *\r
 257  * NOTE: Caller need to call OCDeleteDiscoveredDevices to delete memory allocated by this API for out\r
 258  * variables pOwnedDevList and pUnownedDevList.\r
 259  *\r
 260  * @param[in] waitime Wait time for the API. The wait time will be divided by 2, and half of wait time\r
 261  * will be used for unowned discovery and remaining half for owned discovery. So the wait time should be\r
 262  * equal to or more than 2.\r
 263  * @param[out] pOwnedDevList  list of owned devices.\r
 264  * @param[out] pUnownedDevList  list of unowned devices.\r
 265  * @return OC_STACK_OK in case of success and other value otherwise.\r
 266  */\r
 267 OCStackResult OCGetDevInfoFromNetwork(unsigned short waittime,\r
 268                                        OCProvisionDev_t** pOwnedDevList,\r
 269                                        OCProvisionDev_t** pUnownedDevList);\r
 270 /**\r
 271  * This method is used to get linked devices' IDs.\r
 272  *\r
 273  * @param[in] uuidOfDevice a target device's uuid.\r
 274  * @param[out] uuidList information about the list of linked devices' uuids.\r
 275  * @param[out] numOfDevices total number of linked devices.\r
 276  * @return OC_STACK_OK in case of success and other value otherwise.\r
 277  */\r
 278 OCStackResult OCGetLinkedStatus(const OicUuid_t* uuidOfDevice,\r
 279                                   OCUuidList_t** uuidList,\r
 280                                   size_t* numOfDevices);\r
 281 \r
 282 /**\r
 283  * API to delete memory allocated to linked list created by OCDiscover_XXX_Devices API.\r
 284  *\r
 285  * @param[in] pList Pointer to OCProvisionDev_t which should be deleted.\r
 286  */\r
 287 void OCDeleteDiscoveredDevices(OCProvisionDev_t *pList);\r
 288 \r
 289 /**\r
 290  * API to delete memory allocated to OicUuid_t list.\r
 291  *\r
 292  * @param[in] pList Pointer to OicUuid_t list which should be deleted.\r
 293  */\r
 294 void OCDeleteUuidList(OCUuidList_t* pList);\r
 295 \r
 296 /**\r
 297  * This function deletes ACL data.\r
 298  *\r
 299  * @param pAcl Pointer to OicSecAcl_t structure.\r
 300  */\r
 301 void OCDeleteACLList(OicSecAcl_t* pAcl);\r
 302 \r
 303 /**\r
 304  * This function deletes PDACL data.\r
 305  *\r
 306  * @param pPdAcl Pointer to OicSecPdAcl_t structure.\r
 307  */\r
 308 void OCDeletePdAclList(OicSecPdAcl_t* pPdAcl);\r
 309 \r
 310 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)\r
 311 /**\r
 312  * this function sends CRL information to resource.\r
 313  *\r
 314  * @param[in] ctx Application context would be returned in result callback.\r
 315  * @param[in] selectedDeviceInfo Selected target device.\r
 316  * @param[in] crl CRL to provision.\r
 317  * @param[in] resultCallback callback provided by API user, callback will be called when provisioning\r
 318               request recieves a response from resource server.\r
 319  * @return  OC_STACK_OK in case of success and other value otherwise.\r
 320  */\r
 321 OCStackResult OCProvisionCRL(void* ctx, const OCProvisionDev_t *selectedDeviceInfo, OicSecCrl_t *crl,\r
 322                              OCProvisionResultCB resultCallback);\r
 323 \r
 324 /**\r
 325  * function to provision Trust certificate chain to devices.\r
 326  *\r
 327  * @param[in] ctx Application context would be returned in result callback.\r
 328  * @param[in] type Type of credentials to be provisioned to the device.\r
 329  * @param[in] credId CredId of trust certificate chain to be provisioned to the device.\r
 330  * @param[in] selectedDeviceInfo Pointer to OCProvisionDev_t instance,respresenting resource to be provsioned.\r
 331  * @param[in] resultCallback callback provided by API user, callback will be called when\r
 332  *            provisioning request recieves a response from first resource server.\r
 333  * @return  OC_STACK_OK in case of success and other value otherwise.\r
 334  */\r
 335 OCStackResult OCProvisionTrustCertChain(void *ctx, OicSecCredType_t type, uint16_t credId,\r
 336                                       const OCProvisionDev_t *selectedDeviceInfo,\r
 337                                       OCProvisionResultCB resultCallback);\r
 338 /**\r
 339  * function to save Trust certificate chain into Cred of SVR.\r
 340  *\r
 341  * @param[in] trustCertChain Trust certificate chain to be saved in Cred of SVR.\r
 342  * @param[in] chainSize Size of trust certificate chain to be saved in Cred of SVR\r
 343  * @param[in] encodingType Encoding type of trust certificate chain to be saved in Cred of SVR\r
 344  * @param[out] credId CredId of saved trust certificate chain in Cred of SVR.\r
 345  * @return  OC_STACK_OK in case of success and other value otherwise.\r
 346  */\r
 347 OCStackResult OCSaveTrustCertChain(uint8_t *trustCertChain, size_t chainSize,\r
 348                                         OicEncodingType_t encodingType, uint16_t *credId);\r
 349 \r
 350 #endif // __WITH_DTLS__ || __WITH_TLS__\r
 351 \r
 352 \r
 353 #ifdef __cplusplus\r
 354 }\r
 355 #endif // __cplusplus\r
 356 \r
 357 #endif /* OCPROVISIONINGMANAGER_H_ */\r