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 device is current subnet. It will list\r
  46  * all the device in subnet which are not yet owned. Please call OCInit with OC_CLIENT_SERVER as\r
  47  * OCMode.\r
  48  *\r
  49  * @param[in] timeout Timeout in seconds, value till which function will listen to responses from\r
  50  *                    client before returning the list of devices.\r
  51  * @param[out] ppList List of candidate devices to be provisioned\r
  52  * @return OTM_SUCCESS in case of success and other value otherwise.\r
  53  */\r
  54 OCStackResult OCDiscoverUnownedDevices(unsigned short waittime, OCProvisionDev_t **ppList);\r
  55 \r
  56 /**\r
  57  * Do ownership transfer for un-owned device.\r
  58  *\r
  59  * @param[in] ctx Application context would be returned in result callback\r
  60  * @param[in] targetDevices List of devices to perform ownership transfer.\r
  61  * @param[in] resultCallback Result callback function to be invoked when ownership transfer finished.\r
  62  * @return OC_STACK_OK in case of success and other value otherwise.\r
  63  */\r
  64 OCStackResult OCDoOwnershipTransfer(void* ctx,\r
  65                                     OCProvisionDev_t *targetDevices,\r
  66                                     OCProvisionResultCB resultCallback);\r
  67 \r
  68 /**\r
  69  * API to register for particular OxM.\r
  70  *\r
  71  * @param[in] Ownership transfer method.\r
  72  * @param[in] Implementation of callback functions for owership transfer.\r
  73  * @return OC_STACK_OK in case of success and other value otherwise.\r
  74  */\r
  75 OCStackResult OCSetOwnerTransferCallbackData(OicSecOxm_t oxm, OTMCallbackData_t* callbackData);\r
  76 \r
  77 /**\r
  78  * The function is responsible for discovery of owned device is current subnet. It will list\r
  79  * all the device in subnet which are owned by calling provisioning client.\r
  80  *\r
  81  * @param[in] timeout Timeout in seconds, value till which function will listen to responses from\r
  82  *                    client before returning the list of devices.\r
  83  * @param[out] ppList List of device owned by provisioning tool.\r
  84  * @return OTM_SUCCESS in case of success and other value otherwise.\r
  85  */\r
  86 OCStackResult OCDiscoverOwnedDevices(unsigned short timeout, OCProvisionDev_t **ppList);\r
  87 \r
  88 /**\r
  89  * API to provision credentials between two devices and ACLs for the devices who act as a server.\r
  90  *\r
  91  * @param[in] ctx Application context would be returned in result callback.\r
  92  * @param[in] type Type of credentials to be provisioned to the device.\r
  93  * @param[in] pDev1 Pointer to OCProvisionDev_t instance,respresenting device to be provisioned.\r
  94  * @param[in] acl ACL for device 1. If this is not required set NULL.\r
  95  * @param[in] pDev2 Pointer to OCProvisionDev_t instance,respresenting device to be provisioned.\r
  96  * @param[in] acl ACL for device 2. If this is not required set NULL.\r
  97  * @param[in] resultCallback callback provided by API user, callback will be called when\r
  98  *            provisioning request recieves a response from first resource server.\r
  99  * @return OC_STACK_OK in case of success and other value otherwise.\r
 100  */\r
 101 OCStackResult OCProvisionPairwiseDevices(void* ctx, OicSecCredType_t type, size_t keySize,\r
 102                                          const OCProvisionDev_t *pDev1, OicSecAcl_t *pDev1Acl,\r
 103                                          const OCProvisionDev_t *pDev2, OicSecAcl_t *pDev2Acl,\r
 104                                          OCProvisionResultCB resultCallback);\r
 105 \r
 106 /**\r
 107  * API to send ACL information to device.\r
 108  *\r
 109  * @param[in] ctx Application context would be returned in result callback.\r
 110  * @param[in] selectedDeviceInfo Selected target device.\r
 111  * @param[in] acl ACL to provision.\r
 112  * @param[in] resultCallback callback provided by API user, callback will be called when provisioning\r
 113               request recieves a response from resource server.\r
 114  * @return OC_STACK_OK in case of success and other value otherwise.\r
 115  */\r
 116 OCStackResult OCProvisionACL(void *ctx, const OCProvisionDev_t *selectedDeviceInfo, OicSecAcl_t *acl,\r
 117                              OCProvisionResultCB resultCallback);\r
 118 \r
 119 /**\r
 120  * this function sends Direct-Pairing Configuration to a 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] pconf PCONF pointer.\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 OCProvisionDirectPairing(void* ctx, const OCProvisionDev_t *selectedDeviceInfo, OicSecPconf_t *pconf,\r
 130                              OCProvisionResultCB resultCallback);\r
 131 \r
 132 /**\r
 133  * API to provision credential to devices.\r
 134  *\r
 135  * @param[in] ctx Application context would be returned in result callback.\r
 136  * @param[in] type Type of credentials to be provisioned to the device.\r
 137  * @param[in] pDev1 Pointer to OCProvisionDev_t instance,respresenting resource to be provsioned.\r
 138    @param[in] pDev2 Pointer to OCProvisionDev_t instance,respresenting resource to be provsioned.\r
 139  * @param[in] resultCallback callback provided by API user, callback will be called when\r
 140  *            provisioning request recieves a response from first resource server.\r
 141  * @return OC_STACK_OK in case of success and other value otherwise.\r
 142  */\r
 143 OCStackResult OCProvisionCredentials(void *ctx, OicSecCredType_t type, size_t keySize,\r
 144                                       const OCProvisionDev_t *pDev1,\r
 145                                       const OCProvisionDev_t *pDev2,\r
 146                                       OCProvisionResultCB resultCallback);\r
 147 \r
 148 /**\r
 149  * Function to unlink devices.\r
 150  * This function will remove the credential & relasionship between the two devices.\r
 151  *\r
 152  * @param[in] ctx Application context would be returned in result callback\r
 153  * @param[in] pTargetDev1 fitst device information to be unlinked.\r
 154  * @param[in] pTargetDev2 second device information to be unlinked.\r
 155  * @param[in] resultCallback callback provided by API user, callback will be called when\r
 156  *            device unlink is finished.\r
 157  * @return OC_STACK_OK in case of success and other value otherwise.\r
 158  */\r
 159 OCStackResult OCUnlinkDevices(void* ctx,\r
 160                               const OCProvisionDev_t* pTargetDev1,\r
 161                               const OCProvisionDev_t* pTargetDev2,\r
 162                               OCProvisionResultCB resultCallback);\r
 163 \r
 164 /**\r
 165  * Function for device revocation\r
 166  * This function will remove credential of target device from all devices in subnet.\r
 167  *\r
 168  * @param[in] ctx Application context would be returned in result callback\r
 169  * @param[in] waitTimeForOwnedDeviceDiscovery Maximum wait time for owned device discovery.(seconds)\r
 170  * @param[in] pTargetDev Device information to be revoked.\r
 171  * @param[in] resultCallback callback provided by API user, callback will be called when\r
 172  *            credential revocation is finished.\r
 173  * @return OC_STACK_OK in case of success and other value otherwise.\r
 174  *         if OC_STACK_OK is returned, the caller of this API should wait for callback.\r
 175  *         OC_STACK_CONTINUE means operation is success but no need to wait for callback.\r
 176  */\r
 177 OCStackResult OCRemoveDevice(void* ctx,\r
 178                              unsigned short waitTimeForOwnedDeviceDiscovery,\r
 179                              const OCProvisionDev_t* pTargetDev,\r
 180                              OCProvisionResultCB resultCallback);\r
 181 /**
 182  * API to get status of all the devices in current subnet. The status include endpoint information\r
 183  * and doxm information which can be extracted duing owned and unowned discovery. Along with this\r
 184  * information. The API will provide information about devices' status\r
 185  * Device can have following states\r
 186  *  - ON/OFF: Device is switched on or off.\r
 187  *\r
 188  * NOTE: Caller need to call OCDeleteDiscoveredDevices to delete memory allocated by this API for out\r
 189  * variables pOwnedDevList and pUnownedDevList.\r
 190  *\r
 191  * @param[in] waitime Wait time for the API. The wait time will be divided by 2, and half of wait time\r
 192  * will be used for unowned discovery and remaining half for owned discovery.\r
 193  * @param[out] pOwnedDevList  list of owned devices.\r
 194  * @param[out] pUnownedDevList  list of unowned devices.\r
 195  * @return OC_STACK_OK in case of success and other value otherwise.\r
 196  */\r
 197 OCStackResult OCGetDevInfoFromNetwork(unsigned short waittime,\r
 198                                        OCProvisionDev_t** pOwnedDevList,\r
 199                                        OCProvisionDev_t** pUnownedDevList);\r
 200 /**\r
 201  * This method is used to get linked devices' IDs.\r
 202  *\r
 203  * @param[in] uuidOfDevice a target device's uuid.\r
 204  * @param[out] uuidList information about the list of linked devices' uuids.\r
 205  * @param[out] numOfDevices total number of linked devices.\r
 206  * @return OC_STACK_OK in case of success and other value otherwise.\r
 207  */\r
 208 OCStackResult OCGetLinkedStatus(const OicUuid_t* uuidOfDevice,\r
 209                                   OCUuidList_t** uuidList,\r
 210                                   size_t* numOfDevices);\r
 211 \r
 212 /**\r
 213  * API to delete memory allocated to linked list created by OCDiscover_XXX_Devices API.\r
 214  *\r
 215  * @param[in] pList Pointer to OCProvisionDev_t which should be deleted.\r
 216  */\r
 217 void OCDeleteDiscoveredDevices(OCProvisionDev_t *pList);\r
 218 \r
 219 /**\r
 220  * API to delete memory allocated to OicUuid_t list.\r
 221  *\r
 222  * @param[in] pList Pointer to OicUuid_t list which should be deleted.\r
 223  */\r
 224 void OCDeleteUuidList(OCUuidList_t* pList);\r
 225 \r
 226 /**\r
 227  * This function deletes ACL data.\r
 228  *\r
 229  * @param pAcl Pointer to OicSecAcl_t structure.\r
 230  */\r
 231 void OCDeleteACLList(OicSecAcl_t* pAcl);
 232 \r
 233 /**\r
 234  * This function deletes PDACL data.\r
 235  *\r
 236  * @param pPdAcl Pointer to OicSecPdAcl_t structure.\r
 237  */\r
 238 void OCDeletePdAclList(OicSecPdAcl_t* pPdAcl);\r
 239
 240 #ifdef __WITH_X509__
 241 /**
 242  * this function sends CRL information to resource.
 243  *
 244  * @param[in] ctx Application context would be returned in result callback.
 245  * @param[in] selectedDeviceInfo Selected target device.
 246  * @param[in] crl CRL to provision.
 247  * @param[in] resultCallback callback provided by API user, callback will be called when provisioning
 248               request recieves a response from resource server.
 249  * @return  OC_STACK_OK in case of success and other value otherwise.
 250  */
 251 OCStackResult OCProvisionCRL(void* ctx, const OCProvisionDev_t *selectedDeviceInfo, OicSecCrl_t *crl,
 252                              OCProvisionResultCB resultCallback);
 253 #endif // __WITH_X509__
 254 \r
 255 \r
 256 #ifdef __cplusplus\r
 257 }\r
 258 #endif // __cplusplus\r
 259 \r
 260 #endif /* OCPROVISIONINGMANAGER_H_ */\r