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 provision credential to devices.
48 * @param[in] type Type of credentials to be provisioned to the device.
49 * @param[in] pDev1 Pointer to PMOwnedDeviceInfo_t instance,respresenting resource to be provsioned.
50 @param[in] pDev2 Pointer to PMOwnedDeviceInfo_t instance,respresenting resource to be provsioned.
51 * @param[in] resultCallback callback provided by API user, callback will be called when
52 * provisioning request recieves a response from first resource server.
53 * @return OC_STACK_OK in case of success and other value otherwise.
55 OCStackResult SRPProvisionCredentials(void *ctx,OicSecCredType_t type, size_t keySize,
56 const OCProvisionDev_t *pDev1,
57 const OCProvisionDev_t *pDev2,
58 OCProvisionResultCB resultCallback);
61 * Function to unlink devices.
62 * This function will remove the credential & relationship between the two devices.
64 * @param[in] ctx Application context would be returned in result callback
65 * @param[in] pTargetDev1 first device information to be unlinked.
66 * @param[in] pTargetDev2 second device information to be unlinked.
67 * @param[in] resultCallback callback provided by API user, callback will be called when
68 * device unlink is finished.
69 * when there is an error, this user callback is called immediately.
70 * @return OC_STACK_OK in case of success and other value otherwise.
72 OCStackResult SRPUnlinkDevices(void* ctx,
73 const OCProvisionDev_t* pTargetDev1,
74 const OCProvisionDev_t* pTargetDev2,
75 OCProvisionResultCB resultCallback);
78 * Function to device revocation.
79 * This function will remove credential of target device from all devices in subnet.
81 * @param[in] ctx Application context would be returned in result callback
82 * @param[in] waitTimeForOwnedDeviceDiscovery Maximum wait time for owned device discovery.(seconds)
83 * @param[in] pTargetDev Device information to be revoked.
84 * @param[in] resultCallback callback provided by API user, callback will be called when
85 * credential revocation is finished.
86 * when there is an error, this user callback is called immediately.
87 * @return OC_STACK_OK in case of success and other value otherwise.
88 * If OC_STACK_OK is returned, the caller of this API should wait for callback.
89 * OC_STACK_CONTINUE means operation is success but no request is need to be initiated.
91 OCStackResult SRPRemoveDevice(void* ctx,
92 unsigned short waitTimeForOwnedDeviceDiscovery,
93 const OCProvisionDev_t* pTargetDev,
94 OCProvisionResultCB resultCallback);
99 #endif //SRP_SECURERESOURCEPROVIDER_H