1 //******************************************************************
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
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 IOTVT_SRM_CREDR_H
22 #define IOTVT_SRM_CREDR_H
24 #include "cainterface.h"
25 #include "securevirtualresourcetypes.h"
33 * Initialize credential resource by loading data from persistent storage.
35 * @return ::OC_STACK_OK, if initialization is successful, else ::OC_STACK_ERROR if
36 * initialization fails.
38 OCStackResult InitCredResource();
41 * Perform cleanup for credential resources.
43 * @return ::OC_STACK_OK, if no errors. ::OC_STACK_ERROR, if stack process error.
44 * ::OC_STACK_NO_RESOURCE, if resource not found.
45 * ::OC_STACK_INVALID_PARAM, if invalid param.
47 OCStackResult DeInitCredResource();
50 * This method is used by tinydtls/SRM to retrieve credential for given subject.
52 * @param subjectId for which credential is required.
54 * @return reference to @ref OicSecCred_t, if credential is found, else NULL, if credential
57 const OicSecCred_t* GetCredResourceData(const OicUuid_t* subjectId);
60 * This function converts credential data into CBOR format.
61 * Caller needs to invoke 'free' when done using returned string.
63 * @param cred is the pointer to instance of OicSecCred_t structure.
64 * @param cborPayload is the CBOR converted value.
65 * @param cborSize is the size of the CBOR.
67 * @return ::OC_STACK_OK if conversion is successful, else ::OC_STACK_ERROR if unsuccessful.
69 OCStackResult CredToCBORPayload(const OicSecCred_t* cred, uint8_t **cborPayload,
73 * This function generates the bin credential data.
75 * @param subject pointer to subject of this credential.
76 * @param credType credential type.
77 * @param publicData public data such as public key.
78 * @param privateData private data such as private key.
79 * @param rownerID Resource owner's UUID.
81 * @return pointer to instance of @ref OicSecCred_t if successful. else NULL in case of error.
84 OicSecCred_t * GenerateCredential(const OicUuid_t* subject, OicSecCredType_t credType,
85 const OicSecCert_t * publicData, const OicSecKey_t * privateData,
86 const OicUuid_t * rownerID);
89 * This function adds the new cred to the credential list.
91 * @param cred is the pointer to new credential.
93 * @return ::OC_STACK_OK, cred not NULL and persistent storage gets updated.
94 * ::OC_STACK_ERROR, cred is NULL or fails to update persistent storage.
96 OCStackResult AddCredential(OicSecCred_t * cred);
99 * Function to remove the credential from SVR DB.
101 * @param credId is the Credential ID to be deleted.
103 * @return ::OC_STACK_OK for success, or errorcode otherwise.
105 OCStackResult RemoveCredential(const OicUuid_t *credId);
107 #if defined(__WITH_DTLS__)
109 * This internal callback is used by lower stack (i.e. CA layer) to
110 * retrieve PSK credentials from RI security layer.
112 * @param type of PSK data required by CA layer during DTLS handshake.
113 * @param desc Additional request information.
114 * @param desc_len is the actual length of desc.
115 * @param result is must be filled with the requested information.
116 * @param result_length is the maximum size of @p result.
118 * @return The number of bytes written to @p result or a value
119 * less than zero on error.
121 int32_t GetDtlsPskCredentials( CADtlsPskCredType_t type,
122 const unsigned char *desc, size_t desc_len,
123 unsigned char *result, size_t result_length);
126 * Add temporal PSK to PIN based OxM.
128 * @param tmpSubject is the UUID of target device
129 * @param credType is the type of credential to be added
130 * @param pin is the numeric characters
131 * @param pinSize is the length of 'pin'
132 * @param rownerID Resource owner's UUID
133 * @param tmpCredSubject is the generated credential's subject.
135 * @return ::OC_STACK_OK for success or else errorcode.
137 OCStackResult AddTmpPskWithPIN(const OicUuid_t* tmpSubject, OicSecCredType_t credType,
138 const char * pin, size_t pinSize,
139 const OicUuid_t * rownerID,
140 OicUuid_t* tmpCredSubject);
142 #endif /* __WITH_DTLS__ */
146 * This function is used toretrieve certificate credentials from RI security layer.
148 * @param credInfo is the binary structure containing certificate credentials
150 * @return 0 on success.
152 int GetDtlsX509Credentials(CADtlsX509Creds_t *credInfo);
153 #endif /*__WITH_X509__*/
156 * Function to deallocate allocated memory to OicSecCred_t.
158 * @param cred pointer to cred type.
161 void DeleteCredList(OicSecCred_t* cred);
164 * Internal function to update resource owner
166 * @param newROwner new owner
168 * @retval ::OC_STACK_OK for Success, otherwise some error value
170 OCStackResult SetCredRownerId(const OicUuid_t* newROwner);
173 * Gets the OicUuid_t value for the rownerid of the cred resource.
175 * @param rowneruuid a pointer to be assigned to the rowneruuid property
176 * @return ::OC_STACK_OK if rowneruuid is assigned correctly, else ::OC_STACK_ERROR.
178 OCStackResult GetCredRownerId(OicUuid_t *rowneruuid);
184 #endif //IOTVT_SRM_CREDR_H