resource/csdk/security/include/internal/credresource.h

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Intel Mobile Communications GmbH 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 IOTVT_SRM_CREDR_H
  22 #define IOTVT_SRM_CREDR_H
  23
  24 #include "cainterface.h"
  25 #include "securevirtualresourcetypes.h"
  26 #include "octypes.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /**
  33  * Initialize credential resource by loading data from persistent storage.
  34  *
  35  * @return ::OC_STACK_OK, if initialization is successful, else ::OC_STACK_ERROR if
  36  * initialization fails.
  37  */
  38 OCStackResult InitCredResource();
  39
  40 /**
  41  * Perform cleanup for credential resources.
  42  *
  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.
  46  */
  47 OCStackResult DeInitCredResource();
  48
  49 /**
  50  * This method is used by tinydtls/SRM to retrieve credential for given subject.
  51  *
  52  * @param subjectId for which credential is required.
  53  *
  54  * @return reference to @ref OicSecCred_t, if credential is found, else NULL, if credential
  55  * not found.
  56  */
  57 OicSecCred_t* GetCredResourceData(const OicUuid_t* subjectId);
  58
  59 /**
  60  * This method is used by SRM to retrieve credential for given credId.
  61  *
  62  * @param credId for which credential is required.
  63  *
  64  * @return reference to @ref OicSecCred_t, if credential is found, else NULL, if credential
  65  * not found.
  66  */
  67 OicSecCred_t* GetCredResourceDataByCredId(const uint16_t credId);
  68
  69 /**
  70  * This function converts credential data into CBOR format.
  71  * Caller needs to invoke 'free' when done using returned string.
  72  *
  73  * @param cred is the pointer to instance of OicSecCred_t structure.
  74  * @param cborPayload is the CBOR converted value.
  75  * @param cborSize is the size of the CBOR.
  76  * @param secureFlag shows fill or not private key.
  77  *
  78  * @return ::OC_STACK_OK if conversion is successful, else ::OC_STACK_ERROR if unsuccessful.
  79  */
  80 OCStackResult CredToCBORPayload(const OicSecCred_t* cred, uint8_t **cborPayload,
  81                                 size_t *cborSize, int secureFlag);
  82
  83 /**
  84  * This function generates the bin credential data.
  85  *
  86  * @param subject pointer to subject of this credential.
  87  * @param credType credential type.
  88  * @param publicData public data such as public key.
  89  * @param privateData private data such as private key.
  90  * @param rownerID Resource owner's UUID.
  91  *
  92  * @return pointer to instance of @ref OicSecCred_t if successful. else NULL in case of error.
  93
  94  */
  95 OicSecCred_t * GenerateCredential(const OicUuid_t* subject, OicSecCredType_t credType,
  96                      const OicSecCert_t * publicData, const OicSecKey_t * privateData,
  97                      const OicUuid_t * rownerID);
  98
  99 /**
 100  * This function adds the new cred to the credential list.
 101  *
 102  * @param cred is the pointer to new credential.
 103  *
 104  * @return ::OC_STACK_OK, cred not NULL and persistent storage gets updated.
 105  * ::OC_STACK_ERROR, cred is NULL or fails to update persistent storage.
 106  */
 107 OCStackResult AddCredential(OicSecCred_t * cred);
 108
 109 /**
 110  * Function to remove the credential from SVR DB.
 111  *
 112  * @param subject is the Credential Subject to be deleted.
 113  *
 114  * @return ::OC_STACK_OK for success, or errorcode otherwise.
 115  */
 116 OCStackResult RemoveCredential(const OicUuid_t *subject);
 117
 118 /**
 119  * Function to remove the credential from SVR DB.
 120  *
 121  * @param credId is the Credential ID to be deleted.
 122  *
 123  * @return ::OC_STACK_OK for success, or errorcode otherwise.
 124  */
 125 OCStackResult RemoveCredentialByCredId(uint16_t credId);
 126
 127 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
 128 /**
 129  * This internal callback is used by lower stack (i.e. CA layer) to
 130  * retrieve PSK credentials from RI security layer.
 131  *
 132  * @param type of PSK data required by CA layer during DTLS handshake.
 133  * @param desc Additional request information.
 134  * @param desc_len is the actual length of desc.
 135  * @param result  is must be filled with the requested information.
 136  * @param result_length is the maximum size of @p result.
 137  *
 138  * @return The number of bytes written to @p result or a value
 139  *         less than zero on error.
 140  */
 141 int32_t GetDtlsPskCredentials( CADtlsPskCredType_t type,
 142               const unsigned char *desc, size_t desc_len,
 143               unsigned char *result, size_t result_length);
 144
 145 /**
 146  * Add temporal PSK to PIN based OxM.
 147  *
 148  * @param tmpSubject is the UUID of target device
 149  * @param credType is the type of credential to be added
 150  * @param pin is the numeric characters
 151  * @param pinSize is the length of 'pin'
 152  * @param rownerID Resource owner's UUID
 153  * @param tmpCredSubject is the generated credential's subject.
 154  *
 155  * @return ::OC_STACK_OK for success or else errorcode.
 156  */
 157 OCStackResult AddTmpPskWithPIN(const OicUuid_t* tmpSubject, OicSecCredType_t credType,
 158                             const char * pin, size_t pinSize,
 159                             const OicUuid_t * rownerID,
 160                             OicUuid_t* tmpCredSubject);
 161
 162 #endif // __WITH_DTLS__ or __WITH_TLS__
 163
 164 /**
 165  * Function to getting credential list
 166  *
 167  * @return ::credential list
 168  */
 169 const OicSecCred_t* GetCredList();
 170
 171 /**
 172  * Function to deallocate allocated memory to OicSecCred_t.
 173  *
 174  * @param cred pointer to cred type.
 175  *
 176  */
 177 void DeleteCredList(OicSecCred_t* cred);
 178
 179 /**
 180  * Internal function to update resource owner
 181  *
 182  * @param newROwner new owner
 183  *
 184  * @retval ::OC_STACK_OK for Success, otherwise some error value
 185  */
 186 OCStackResult SetCredRownerId(const OicUuid_t* newROwner);
 187
 188 /**
 189  * Gets the OicUuid_t value for the rownerid of the cred resource.
 190  *
 191  * @param rowneruuid a pointer to be assigned to the rowneruuid property
 192  * @return ::OC_STACK_OK if rowneruuid is assigned correctly, else ::OC_STACK_ERROR.
 193  */
 194 OCStackResult GetCredRownerId(OicUuid_t *rowneruuid);
 195
 196 #if defined(__WITH_TLS__) || defined(__WITH_DTLS__)
 197 /**
 198  * Used by mbedTLS to retrieve trusted CA certificates
 199  *
 200  * @param[out] crt certificates to be filled.
 201  */
 202 void GetDerCaCert(ByteArray_t * crt);
 203 /**
 204  * Used by mbedTLS to retrieve own certificate chain
 205  *
 206  * @param[out] crt certificate chain to be filled.
 207  */
 208 void GetDerOwnCert(ByteArray_t * crt);
 209 /**
 210  * Used by mbedTLS to retrieve owm private key
 211  *
 212  * @param[out] key key to be filled.
 213  */
 214 void GetDerKey(ByteArray_t * key);
 215 /**
 216  * Used by CA to retrieve credential types
 217  *
 218  * @param[out] key key to be filled.
 219  */
 220 void InitCipherSuiteList(bool *list);
 221 #endif // __WITH_TLS__
 222 #ifdef __cplusplus
 223 }
 224 #endif
 225
 226 #endif //IOTVT_SRM_CREDR_H