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

   1 /* *****************************************************************
   2  *
   3  * Copyright 2015 Samsung Electronics All Rights Reserved.
   4  *
   5  *
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * *****************************************************************/
  20
  21 #ifndef SRP_SECURERESOURCEPROVIDER_H
  22 #define SRP_SECURERESOURCEPROVIDER_H
  23
  24 #include "ocstack.h"
  25 #include "securevirtualresourcetypes.h"
  26 #include "pmtypes.h"
  27
  28 #ifdef __cplusplus
  29 extern "C"
  30 {
  31 #endif
  32
  33 /**
  34  * API to send ACL information to resource.
  35  *
  36  * @param[in] selectedDeviceInfo Selected target device.
  37  * @param[in] acl ACL to provision.
  38  * @param[in] resultCallback callback provided by API user, callback will be called when
  39  *            provisioning request recieves a response from resource server.
  40  * @return OC_STACK_OK in case of success and other value otherwise.
  41  */
  42 OCStackResult SRPProvisionACL(void *ctx, const OCProvisionDev_t *selectedDeviceInfo,
  43                                         OicSecAcl_t *acl, OCProvisionResultCB resultCallback);
  44
  45 #ifdef __WITH_X509__
  46 /**
  47  * API to send CRL information to resource.
  48  *
  49  * @param[in] selectedDeviceInfo Selected target device.
  50  * @param[in] crl CRL to provision.
  51  * @param[in] resultCallback callback provided by API user, callback will be called when
  52  *            provisioning request recieves a response from resource server.
  53  * @return OC_STACK_OK in case of success and other value otherwise.
  54  */
  55 OCStackResult SRPProvisionCRL(void *ctx, const OCProvisionDev_t *selectedDeviceInfo,
  56         OicSecCrl_t *crl, OCProvisionResultCB resultCallback);
  57 #endif // __WITH_X509__
  58 /**
  59  * API to send Direct-Pairing Configuration to a device.
  60  *
  61  * @param[in] selectedDeviceInfo Selected target device.
  62  * @param[in] pconf PCONF pointer.
  63  * @param[in] resultCallback callback provided by API user, callback will be called when
  64  *            provisioning request recieves a response from resource server.
  65  * @return OC_STACK_OK in case of success and other value otherwise.
  66  */
  67 OCStackResult SRPProvisionDirectPairing(void *ctx, const OCProvisionDev_t *selectedDeviceInfo,
  68                                         OicSecPconf_t *pconf, OCProvisionResultCB resultCallback);
  69
  70 /**
  71  * API to send Direct-Pairing Configuration to a device.
  72  *
  73  * @param[in] selectedDeviceInfo Selected target device.
  74  * @param[in] pconf PCONF pointer.
  75  * @param[in] resultCallback callback provided by API user, callback will be called when
  76  *            provisioning request recieves a response from resource server.
  77  * @return OC_STACK_OK in case of success and other value otherwise.
  78  */
  79 OCStackResult SRPProvisionDirectPairing(void *ctx, const OCProvisionDev_t *selectedDeviceInfo,
  80                                         OicSecPconf_t *pconf, OCProvisionResultCB resultCallback);
  81
  82 /**
  83  * API to provision credential to devices.
  84  *
  85  * @param[in] type Type of credentials to be provisioned to the device.
  86  * @param[in] pDev1 Pointer to PMOwnedDeviceInfo_t instance,respresenting resource to be provsioned.
  87    @param[in] pDev2 Pointer to PMOwnedDeviceInfo_t instance,respresenting resource to be provsioned.
  88  * @param[in] resultCallback callback provided by API user, callback will be called when
  89  *            provisioning request recieves a response from first resource server.
  90  * @return OC_STACK_OK in case of success and other value otherwise.
  91  */
  92 OCStackResult SRPProvisionCredentials(void *ctx,OicSecCredType_t type, size_t keySize,
  93                                       const OCProvisionDev_t *pDev1,
  94                                       const OCProvisionDev_t *pDev2,
  95                                       OCProvisionResultCB resultCallback);
  96
  97 /**
  98  * Function to unlink devices.
  99  * This function will remove the credential & relationship between the two devices.
 100  *
 101  * @param[in] ctx Application context would be returned in result callback
 102  * @param[in] pTargetDev1 first device information to be unlinked.
 103  * @param[in] pTargetDev2 second device information to be unlinked.
 104  * @param[in] resultCallback callback provided by API user, callback will be called when
 105  *            device unlink is finished.
 106  *            when there is an error, this user callback is called immediately.
 107  * @return OC_STACK_OK in case of success and other value otherwise.
 108  */
 109 OCStackResult SRPUnlinkDevices(void* ctx,
 110                               const OCProvisionDev_t* pTargetDev1,
 111                               const OCProvisionDev_t* pTargetDev2,
 112                               OCProvisionResultCB resultCallback);
 113
 114 /*
 115  * Function to device revocation.
 116  * This function will remove credential of target device from all devices in subnet.
 117  *
 118  * @param[in] ctx Application context would be returned in result callback
 119  * @param[in] waitTimeForOwnedDeviceDiscovery Maximum wait time for owned device discovery.(seconds)
 120  * @param[in] pTargetDev Device information to be revoked.
 121  * @param[in] resultCallback callback provided by API user, callback will be called when
 122  *            credential revocation is finished.
 123  *            when there is an error, this user callback is called immediately.
 124  * @return OC_STACK_OK in case of success and other value otherwise.
 125  *         If OC_STACK_OK is returned, the caller of this API should wait for callback.
 126  *         OC_STACK_CONTINUE means operation is success but no request is need to be initiated.
 127  */
 128 OCStackResult SRPRemoveDevice(void* ctx,
 129                               unsigned short waitTimeForOwnedDeviceDiscovery,
 130                               const OCProvisionDev_t* pTargetDev,
 131                               OCProvisionResultCB resultCallback);
 132
 133 #ifdef __cplusplus
 134 }
 135 #endif
 136 #endif //SRP_SECURERESOURCEPROVIDER_H