- don't include source/example directories, they only cause confusion.
- don't add empty doxygen comment before a regular one. Move those
comments to @file.
- minor changes in the doc/ directory.
Change-Id: Ie1e5e8b01cacc6a74c7201cd2652b0752091e455
*/
/**
- * @file yaca_crypto.h
+ * @file yaca_crypto.h
+ * @brief Non crypto related functions.
*/
#ifndef YACA_CRYPTO_H
*/
/**
- * Note: Non-Crypto Yet Another Crypto API - non crypto related functions.
- *
- *
- */
-
-/**
* @brief NULL value for the crypto context.
*
* @since_tizen 3.0
*/
/**
- * @file yaca_digest.h
+ * @file yaca_digest.h
+ * @brief Advanced API for the message digests.
*/
#ifndef YACA_DIGEST_H
*/
/**
- * Note: Advanced-Digest Advanced API for the message digests.
- *
- *
- */
-
-/**
* @brief Initializes a digest context.
*
* @since_tizen 3.0
*/
/**
- * @file yaca_encrypt.h
+ * @file yaca_encrypt.h
+ * @brief Advanced API for the symmetric encryption.
*/
#ifndef YACA_ENCRYPT_H
*/
/**
- * Note: Advanced-Encryption-Symmetric Advanced API for the symmetric encryption.
- *
- *
- */
-
-/**
* @brief Returns the recommended/default length of the IV for a given encryption configuration.
*
* @since_tizen 3.0
*/
/**
- * @file yaca_error.h
+ * @file yaca_error.h
+ * @brief Error enums and defines.
*/
#ifndef YACA_ERROR_H
extern "C" {
#endif
-
/**
* @addtogroup CAPI_YACA_ENCRYPTION_MODULE
* @{
*/
-/**
- * Note: Error Yet another Crypto API - error enums.
- *
- */
-
-/* define it temporary until this code goes into capi-base-common package */
+/* @cond Define it temporarily until this code goes into capi-base-common package */
#ifndef TIZEN_ERROR_YACA
#define TIZEN_ERROR_YACA -0x01E30000
#endif
+/* @endcond */
/**
* @brief Enumeration of YACA error values.
*/
/**
- * @file yaca_key.h
+ * @file yaca_key.h
+ * @brief Advanced API for the key and IV handling.
*/
#ifndef YACA_KEY_H
*/
/**
- * Note: Key Advanced API for the key and IV handling.
- *
- *
- */
-
-/**
* @brief NULL value for yaca_key_h type.
*
* @since_tizen 3.0
*/
void yaca_key_destroy(yaca_key_h key);
-
-/**
- * Note: Key-Derivation Advanced API for the key derivation.
- *
- *
- */
-
/**
* @brief Derives a key from user password (PKCS #5 a.k.a. pbkdf2 algorithm).
*
*/
/**
- * @file yaca_seal.h
+ * @file yaca_seal.h
+ * @brief Advanced API for the asymmetric encryption.
+ *
+ * @details Seal does more than just encrypt. It first generates the encryption key and IV,
+ * then encrypts whole message using this key (and selected symmetric algorithm).
+ * Finally it encrypts symmetric key with public key.
*/
#ifndef YACA_SEAL_H
*/
/**
- * Note Advanced-Encryption-Asymmetric Advanced API for the asymmetric encryption.
- *
- *
- * @remarks Seal does more than just encrypt. It first generates the encryption key and IV,
- * then encrypts whole message using this key (and selected symmetric algorithm).
- * Finally it encrypts symmetric key with public key.
- *
- */
-
-/**
* @brief Initializes an asymmetric encryption context and generates symmetric key and IV.
*
* @remarks Generated symmetric key is encrypted with public key,
*/
/**
- * @file yaca_sign.h
+ * @file yaca_sign.h
+ * @brief Advanced API for the integrity handling - HMAC, CMAC and digital signature.
*/
#ifndef YACA_SIGN_H
*/
/**
- * Note: Advanced-Integrity Advanced API for the integrity handling - HMAC, CMAC and digital signature.
- *
- *
- */
-
-/**
* @brief Initializes a signature context for asymmetric signatures.
*
* @since_tizen 3.0
*/
/**
- * @file yaca_simple.h
+ * @file yaca_simple.h
+ * @brief Simple API.
+ *
+ * @details This is simple API.
+ * Design constraints:
+ * - All operations are single-shot (no streaming possible)
+ * - Context is not used
+ * - For now only digest and symmetric ciphers are supported
+ * - GCM and CCM chaining is not supported
+ * - All outputs are allocated by the library
*/
#ifndef YACA_SIMPLE_H
*/
/**
- * Note: Simple-API Simple API.
- *
- * @remarks This is simple API.
- * Design constraints:
- * - All operations are single-shot (no streaming possible)
- * - Context is not used
- * - For now only digest and symmetric ciphers are supported
- * - GCM and CCM chaining is not supported
- * - All outputs are allocated by the library
- *
- */
-
-/**
* @brief Calculates a digest of a buffer.
*
* @since_tizen 3.0
*/
/**
- * @file yaca_types.h
+ * @file yaca_types.h
+ * @brief Types enums and defines.
*/
#ifndef YACA_TYPES_H
*/
/**
- * Note: Crypto-Types Yet Another Crypto API - types.
- *
- *
- */
-
-/**
* @brief The context handle.
*
* @since_tizen 3.0
# Note: If this tag is empty the current directory is searched.
INPUT = ../api \
- ../examples \
- ../src
+ ../doc
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
/**\r
* @ingroup CAPI_SECURITY_FRAMEWORK\r
* @defgroup CAPI_YACA_MODULE yaca crypto module\r
- * @brief The yaca(yet another crypto api) provides a crypto function such as key management, data integrity and data en/decryption.\r
+ * @brief The YACA (Yet Another Crypto Api) provides a crypto function such as key management, data integrity and data en/decryption.\r
* 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.\r
* Data Integrity provides Advanced/Simpled API for the integrity handling - HMAC, CMAC, message digests and digital signature.\r
* Data en/decryption provides Advanced/Simpled APIs for en/decrypting and sealing/opening a data.\r
* @brief Provides APIs for encryption and decryption operations.\r
*\r
* @section CAPI_YACA_ENCRYPTION_MODULE_HEADER Required Header\r
- * \#include <yaca/yaca_crypto.h>\r
- * \#include <yaca/yaca_encrypt.h>\r
- * \#include <yaca/yaca_seal.h>\r
- * \#include <yaca/yaca_types.h>\r
- * \#include <yaca/yaca_error.h>\r
+ * \#include <yaca/yaca_crypto.h>\n\r
+ * \#include <yaca/yaca_encrypt.h>\n\r
+ * \#include <yaca/yaca_seal.h>\n\r
+ * \#include <yaca/yaca_types.h>\n\r
+ * \#include <yaca/yaca_error.h>\n\r
*\r
* @section CAPI_YACA_ENCRYPTION_MODULE_OVERVIEW Overview\r
* It provides advanced APIs for encryption/decryption operations with symmetric keys and sealing/opening operations with asymmetric keys.\r
* @brief Provides APIs for creating/verifying a signature and digesting a message.\r
*\r
* @section CAPI_YACA_INTEGRITY_MODULE_HEADER Required Header\r
- * \#include <yaca/yaca_sign.h>\r
- * \#include <yaca/yaca_digest.h>\r
+ * \#include <yaca/yaca_sign.h>\n\r
+ * \#include <yaca/yaca_digest.h>\n\r
*\r
* @section CAPI_YACA_INTEGRITY_MODULE_OVERVIEW Overview\r
* It provides advanced APIs for 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.\r
* @brief Provides APIs for key handling operations such as generating and importing a key.\r
*\r
* @section CAPI_YACA_KEY_MODULE_HEADER Required Header\r
- * \#include <yaca/yaca_key.h>\r
+ * \#include <yaca/yaca_key.h>\n\r
*\r
* @section CAPI_YACA_KEY_MODULE_OVERVIEW Overview\r
* It provides APIs for 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.\r
* @brief Provides simple APIs for cryptographic operations.\r
*\r
* @section CAPI_YACA_SIMPLE_MODULE_HEADER Required Header\r
- * \#include <yaca/yaca_simple.h>\r
+ * \#include <yaca/yaca_simple.h>\n\r
*\r
* @section CAPI_YACA_SIMPLE_MODULE_OVERVIEW Overview\r
* It provides simple APIs for encryption/decryption, signing/verification, and message digestion.\r