1 /* *****************************************************************
3 * Copyright 2015 Samsung Electronics All Rights Reserved.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 * *****************************************************************/
21 #ifndef SRP_SECURERESOURCEPROVIDER_H
22 #define SRP_SECURERESOURCEPROVIDER_H
25 #include "securevirtualresourcetypes.h"
34 * API to send ACL information to resource.
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.
42 OCStackResult SRPProvisionACL(void *ctx, const OCProvisionDev_t *selectedDeviceInfo,
43 OicSecAcl_t *acl, OCProvisionResultCB resultCallback);
46 * API to send Direct-Pairing Configuration to a device.
48 * @param[in] selectedDeviceInfo Selected target device.
49 * @param[in] pconf PCONF pointer.
50 * @param[in] resultCallback callback provided by API user, callback will be called when
51 * provisioning request recieves a response from resource server.
52 * @return OC_STACK_OK in case of success and other value otherwise.
54 OCStackResult SRPProvisionDirectPairing(void *ctx, const OCProvisionDev_t *selectedDeviceInfo,
55 OicSecPconf_t *pconf, OCProvisionResultCB resultCallback);
58 * API to provision credential to devices.
60 * @param[in] type Type of credentials to be provisioned to the device.
61 * @param[in] pDev1 Pointer to PMOwnedDeviceInfo_t instance,respresenting resource to be provsioned.
62 @param[in] pDev2 Pointer to PMOwnedDeviceInfo_t instance,respresenting resource to be provsioned.
63 * @param[in] resultCallback callback provided by API user, callback will be called when
64 * provisioning request recieves a response from first resource server.
65 * @return OC_STACK_OK in case of success and other value otherwise.
67 OCStackResult SRPProvisionCredentials(void *ctx,OicSecCredType_t type, size_t keySize,
68 const OCProvisionDev_t *pDev1,
69 const OCProvisionDev_t *pDev2,
70 OCProvisionResultCB resultCallback);
73 * Function to unlink devices.
74 * This function will remove the credential & relationship between the two devices.
76 * @param[in] ctx Application context would be returned in result callback
77 * @param[in] pTargetDev1 first device information to be unlinked.
78 * @param[in] pTargetDev2 second device information to be unlinked.
79 * @param[in] resultCallback callback provided by API user, callback will be called when
80 * device unlink is finished.
81 * when there is an error, this user callback is called immediately.
82 * @return OC_STACK_OK in case of success and other value otherwise.
84 OCStackResult SRPUnlinkDevices(void* ctx,
85 const OCProvisionDev_t* pTargetDev1,
86 const OCProvisionDev_t* pTargetDev2,
87 OCProvisionResultCB resultCallback);
90 * Function to device revocation.
91 * This function will remove credential of target device from all devices in subnet.
93 * @param[in] ctx Application context would be returned in result callback
94 * @param[in] waitTimeForOwnedDeviceDiscovery Maximum wait time for owned device discovery.(seconds)
95 * @param[in] pTargetDev Device information to be revoked.
96 * @param[in] resultCallback callback provided by API user, callback will be called when
97 * credential revocation is finished.
98 * when there is an error, this user callback is called immediately.
99 * @return OC_STACK_OK in case of success and other value otherwise.
100 * If OC_STACK_OK is returned, the caller of this API should wait for callback.
101 * OC_STACK_CONTINUE means operation is success but no request is need to be initiated.
103 OCStackResult SRPRemoveDevice(void* ctx,
104 unsigned short waitTimeForOwnedDeviceDiscovery,
105 const OCProvisionDev_t* pTargetDev,
106 OCProvisionResultCB resultCallback);
111 #endif //SRP_SECURERESOURCEPROVIDER_H