/**
* @file yaca_crypto.h
- * @brief
*/
#ifndef YACA_CRYPTO_H
*
* @remarks In case of failure the function doesn't free the memory pointed by @a memory.
*
- * @remarks If @a *memory is NULL then the call is equivalent to yaca_malloc().
+ * @remarks If @a memory is NULL then the call is equivalent to yaca_malloc().
*
* @remarks If the function fails the contents of @a memory will be left unchanged.
*
*
* @return #YACA_ERROR_NONE when buffers are equal otherwise #YACA_ERROR_DATA_MISMATCH
* @retval #YACA_ERROR_NONE Successful
+ * @retval #YACA_ERROR_INVALID_PARAMETER Required parameters have incorrect values (NULL, 0)
* @retval #YACA_ERROR_DATA_MISMATCH Buffers are different
*/
int yaca_memcmp(const void *first, const void *second, size_t len);
/**
* @file yaca_digest.h
- * @brief
*/
#ifndef YACA_DIGEST_H
/**
* @file yaca_encrypt.h
- * @brief
*/
#ifndef YACA_ENCRYPT_H
/**
* @file yaca_error.h
- * @brief
*/
#ifndef YACA_ERROR_H
/**
* @file yaca_key.h
- * @brief
*/
#ifndef YACA_KEY_H
#define YACA_KEY_NULL ((yaca_key_h) NULL)
/**
- * @brief Get key's type.
+ * @brief Gets key's type.
*
* @since_tizen 3.0
*
int yaca_key_get_type(const yaca_key_h key, yaca_key_type_e *key_type);
/**
- * @brief Get key's length (in bits).
+ * @brief Gets key's length (in bits).
*
* @since_tizen 3.0
*
*
* @since_tizen 3.0
*
- * @remarks This function imports a key trying to match it to the key_type specified.
+ * @remarks This function imports a key trying to match it to the @a key_type specified.
* It should autodetect both the key format and the file format.
*
* @remarks For symmetric, IV and DES keys RAW binary format and BASE64 encoded
* @return #YACA_ERROR_NONE on success, negative on error
* @retval #YACA_ERROR_NONE Successful
* @retval #YACA_ERROR_INVALID_PARAMETER Required parameters have incorrect values (NULL, 0,
- * invalid key_type or data_len too big)
+ * invalid @a key_type or @a data_len too big)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
* @retval #YACA_ERROR_INVALID_PASSWORD Invalid password given or password was required
* @return #YACA_ERROR_NONE on success, negative on error
* @retval #YACA_ERROR_NONE Successful
* @retval #YACA_ERROR_INVALID_PARAMETER Required parameters have incorrect values (NULL, 0,
- * invalid key/file format or data_len too big)
+ * invalid key/file format or @ data_len too big)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @return #YACA_ERROR_NONE on success, negative on error
* @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_PARAMETER key is NULL, incorrect key_type or
- * key_bit_len is not dividable by 8
+ * @retval #YACA_ERROR_INVALID_PARAMETER key is NULL, incorrect @a key_type or
+ * @a key_bit_len is not dividable by 8
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @return #YACA_ERROR_NONE on success, negative on error
* @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_PARAMETER prv_key is of invalid type or pub_key is NULL
+ * @retval #YACA_ERROR_INVALID_PARAMETER @a prv_key is of invalid type or @a pub_key is NULL
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
/**
* @file yaca_seal.h
- * @brief
*/
#ifndef YACA_SEAL_H
/**
* @file yaca_sign.h
- * @brief
*/
#ifndef YACA_SIGN_H
/**
* @file yaca_simple.h
- * @brief
*/
#ifndef YACA_SIMPLE_H
*/
/**
- * @brief Calculate a digest of a buffer.
+ * @brief Calculates a digest of a buffer.
*
* @since_tizen 3.0
*
size_t *digest_len);
/**
- * @brief Encrypt data using a symmetric cipher.
+ * @brief Encrypts data using a symmetric cipher.
*
* @since_tizen 3.0
*
size_t *ciphertext_len);
/**
- * @brief Decrypt data using a symmetric cipher.
+ * @brief Decrypts data using a symmetric cipher.
*
* @since_tizen 3.0
*
size_t *plaintext_len);
/**
- * @brief Create a signature using asymmetric private key.
+ * @brief Creates a signature using asymmetric private key.
*
* @since_tizen 3.0
*
size_t *signature_len);
/**
- * @brief Verify a signature using asymmetric public key.
+ * @brief Verifies a signature using asymmetric public key.
*
* @since_tizen 3.0
*
size_t signature_len);
/**
- * @brief Calculate a HMAC of given message using symmetric key.
+ * @brief Calculates a HMAC of given message using symmetric key.
*
* @since_tizen 3.0
*
size_t *mac_len);
/**
- * @brief Calculate a CMAC of given message using symmetric key.
+ * @brief Calculates a CMAC of given message using symmetric key.
*
* @since_tizen 3.0
*
/**
* @file yaca_types.h
- * @brief
*/
#ifndef YACA_TYPES_H
*/
/**
- * @brief Context.
+ * @brief The context handle.
*
* @since_tizen 3.0
*/
typedef struct yaca_context_s *yaca_context_h;
/**
- * @brief Key.
+ * @brief The key handle.
*
* @since_tizen 3.0
*/
* #YACA_BCM_ECB
* - see #yaca_block_cipher_mode_e for details on additional properties (mandatory).
* - Use double DES keys to perform corresponding 2-key 3DES encryption.
-
*/
YACA_ENCRYPT_UNSAFE_3DES_2TDEA,
/**\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
- * Key mangement 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 digest and digital signature.\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
*\r
* @section CAPI_YACA_MODULE_OVERVIEW Overview\r
* </tr>\r
* </table>\r
*\r
- * The yaca provides a crypto function such as key management, integrity handling and data en/decryption.\r
- * Key mangement 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
+ * The yaca provides a crypto function such as key management, integrity handling 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 digest and digital signature.\r
+ * Data en/decryption provides Advanced/Simpled APIs for en/decrypting a data and creating a IV.\r
*\r
* @image html capi_yaca_overview_diagram.png\r
*\r
* The yaca provides 3 types of API.\r
* - 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.\r
* - data en/decryption APIs : These APIs provides Advanced/Simpled API for the data encryption.\r
- * - integrity APIs : These APIs provides creating a signature using asymmetric private key, verifing 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
+ * - 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.\r
*\r
*\r
*/\r
* \#include <yaca/yaca_digest.h>\r
*\r
* @section CAPI_YACA_INTEGRITY_MODULE_OVERVIEW Overview\r
- * It provides advanced APIs for creating a signature using asymmetric private key, verifing 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
+ * 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
*\r
*/\r
\r
projects / platform / core / security / yaca.git / commitdiff