doc/yaca_doc.h

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #ifndef __TIZEN_CORE_YACA_DOC_H__
  17 #define __TIZEN_CORE_YACA_DOC_H__
  18 /**
  19   * @ingroup CAPI_SECURITY_FRAMEWORK
  20   * @defgroup CAPI_YACA_MODULE YACA
  21   * @brief    The YACA (Yet Another Crypto Api) provides a crypto function such as key management, data integrity and data en/decryption.
  22   *           Key management provides APIs for generating secured key,importing a key trying to match it to the key_type specified and exporting a key to arbitrary format.
  23   *           Data Integrity provides Advanced/Simpled API for the integrity handling - HMAC, CMAC, message digests and digital signature.
  24   *           Data en/decryption provides Advanced/Simpled APIs for en/decrypting and sealing/opening a data.
  25   *
  26   * @section CAPI_YACA_MODULE_OVERVIEW Overview
  27   * <table>
  28   *   <tr><th>API</th><th>Description</th></tr>
  29   *   <tr>
  30   *     <td> @ref CAPI_YACA_ENCRYPTION_MODULE</td>
  31   *     <td> Provides APIs for encryption/decryption operations with symmetric keys and sealing/opening operations with asymmetric keys.</td>
  32   *   </tr>
  33   *   <tr>
  34   *     <td> @ref CAPI_YACA_INTEGRITY_MODULE</td>
  35   *     <td> Provides APIs for creating/verifying a signature, calculating HMAC/CMAC and calculating a message digest.</td>
  36   *   </tr>
  37   *   <tr>
  38   *     <td> @ref CAPI_YACA_KEY_MODULE</td>
  39   *     <td> Provides APIs for key handling operations such as generating, importing, and exporting a key and deriving a key from password.</td>
  40   *   </tr>
  41   *   <tr>
  42   *     <td> @ref CAPI_YACA_SIMPLE_MODULE</td>
  43   *     <td> Provides simple APIs for cryptographic operations.</td>
  44   *   </tr>
  45   * </table>
  46   *
  47   * The yaca provides a crypto function such as key management, integrity handling and data en/decryption.
  48   * Key management provides APIs for generating secured key, importing a key trying to match it to the key type specified and exporting a key to arbitrary format.
  49   * Data Integrity provides Advanced/Simpled API for the integrity handling - HMAC, CMAC, message digest and digital signature.
  50   * Data en/decryption provides Advanced/Simpled APIs for en/decrypting a data and creating a IV.
  51   *
  52   * The yaca provides 3 types of API.
  53   * - key management APIs : These APIs provides generating key using random number or password, importing a key trying to match it to the key_type specified and exporting a key to arbitrary format.
  54   * - data en/decryption APIs : These APIs provides Advanced/Simpled API for the data encryption.
  55   * - integrity APIs : These APIs provides creating a signature using asymmetric private key, verifying a signature using asymmetric public key, calculating a HMAC/CMAC of given message using symmetric key and calculating message digests of given message without key.
  56   *
  57   *
  58   */
  59
  60 #endif /* __TIZEN_CORE_YACA_DOC_H__ */