*
* @since_tizen 3.0
*
- * @remarks The @a memory should be freed using yaca_free()
+ * @remarks The @a memory should be freed using yaca_free().
*
* @param[in] size Size of the allocation (bytes)
* @param[out] memory Allocated memory
*
* @since_tizen 3.0
*
- * @remarks The @a memory should be freed using yaca_free()
+ * @remarks The @a memory should be freed using yaca_free().
*
* @param[in] size Size of the allocation (bytes)
* @param[out] memory Allocated memory
*
* @remarks If the function fails the contents of @a memory will be left unchanged.
*
- * @remarks The @a memory should be freed using yaca_free()
+ * @remarks The @a memory should be freed using yaca_free().
*
* @param[in] size Size of the new allocation (bytes)
* @param[in,out] memory Memory to be reallocated
* @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 ctx or property)
+ * invalid @a ctx or @a property)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see #yaca_property_e
*
* @since_tizen 3.0
*
- * @remarks The @a value should be freed using yaca_free()
+ * @remarks The @a value should be freed using yaca_free().
*
* @remarks The @a value has to be of type appropriate for given property. See #yaca_property_e
* for details on corresponding types.
*
- * @remarks @a value_len can be NULL if returned @a value is a single object
- * (i.e. not an array/buffer)
+ * @remarks The @a value_len can be NULL if returned @a value is a single object
+ * (i.e. not an array/buffer).
*
* @param[in] ctx Previously initialized crypto context
* @param[in] property Property to be read
* @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,
- * invalid ctx or property)
+ * invalid @a ctx or @a property)
* @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 Required parameters have incorrect values (NULL,
- * invalid context or too big input_len)
+ * invalid @a ctx or too big @a input_len)
* @retval #YACA_ERROR_INTERNAL Internal error
*/
int yaca_context_get_output_length(const yaca_context_h ctx,
void yaca_context_destroy(yaca_context_h ctx);
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
*
* @since_tizen 3.0
*
- * @remarks The @a ctx should be released using yaca_context_destroy()
+ * @remarks The @a ctx should be released using yaca_context_destroy().
*
* @param[out] ctx Newly created context
* @param[in] algo Digest algorithm that will be used
* @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,
- * invalid algo)
+ * invalid @a algo)
* @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 Required parameters have incorrect values (NULL, 0,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see yaca_digest_initialize()
* @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,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see yaca_digest_initialize()
int yaca_digest_finalize(yaca_context_h ctx, char *digest, size_t *digest_len);
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
*
* @since_tizen 3.0
*
- * @remarks If returned iv_bit_len equals 0 that means that for this
+ * @remarks If returned @a iv_bit_len equals 0 that means that for this
* specific algorithm and its parameters Initialization Vector is not used.
*
* @param[in] algo Encryption algorithm
* @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,
- * invalid algo, bcm or key_bit_len)
+ * invalid @a algo, @a bcm or @a key_bit_len)
* @retval #YACA_ERROR_INTERNAL Internal error
*
*/
*
* @since_tizen 3.0
*
- * @remarks The @a ctx should be released using yaca_context_destroy()
+ * @remarks The @a ctx should be released using yaca_context_destroy().
*
* @param[out] ctx Newly created context
* @param[in] algo Encryption algorithm that will be used
* @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,
- * invalid algo, bcm, sym_key or iv)
+ * invalid @a algo, @a bcm, @a sym_key or @a iv)
* @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 Required parameters have incorrect values (NULL, 0,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see yaca_encrypt_initialize()
* @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,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see yaca_encrypt_initialize()
*
* @since_tizen 3.0
*
- * @remarks The @a ctx should be released using yaca_context_destroy()
+ * @remarks The @a ctx should be released using yaca_context_destroy().
*
* @param[out] ctx Newly created context
* @param[in] algo Encryption algorithm that was used to encrypt the data
* @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,
- * invalid algo, bcm, sym_key or iv)
+ * invalid @a algo, @a bcm, @a sym_key or @a iv)
* @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 Required parameters have incorrect values (NULL, 0,
- * invalid context), wrong #YACA_PROPERTY_CCM_AAD or
+ * invalid @a ctx), wrong #YACA_PROPERTY_CCM_AAD or
* wrong #YACA_PROPERTY_CCM_TAG was used
* @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 Required parameters have incorrect values (NULL,
- * invalid context), wrong #YACA_PROPERTY_GCM_AAD or
+ * invalid @a ctx), wrong #YACA_PROPERTY_GCM_AAD or
* wrong #YACA_PROPERTY_GCM_TAG was used
* @retval #YACA_ERROR_INTERNAL Internal error
*
size_t *plaintext_len);
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
} yaca_error_e;
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
*
* @since_tizen 3.0
*
- * @remarks @a key can be any symmetric (including an Initialization Vector) or
+ * @remarks The @a key can be any symmetric (including an Initialization Vector) or
* asymmetric key (including key generation parameters).
*
* @remarks For Diffie-Helmann @a key_bit_len returns prime length in bits. Values
* be returned. For a list of keys and formats that do support encryption
* see yaca_key_export() documentation.
*
- * @remarks The @a key should be released using yaca_key_destroy()
+ * @remarks The @a key should be released using yaca_key_destroy().
*
* @param[in] key_type Type of the key
- * @param[in] password null terminated password for the key (can be NULL)
+ * @param[in] password Null-terminated password for the key (can be NULL)
* @param[in] data Blob containing the key
* @param[in] data_len Size of the blob
* @param[out] key Returned key
* 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
+ * @retval #YACA_ERROR_INVALID_PASSWORD Invalid @a password given or @a password was required
* and none was given
*
* @see #yaca_key_type_e
* @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 @a key_fmt, @a key_file_fmt or @a data_len too big)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
* where prime_length_in_bits can be any positive number
* - EC: a value taken from #yaca_key_bit_length_ec_e
*
- * @remarks The @a key should be released using yaca_key_destroy()
+ * @remarks The @a key should be released using yaca_key_destroy().
*
* @param[in] key_type Type of the key to be generated
* @param[in] key_bit_len Length of the key (in bits) to be generated
*
* @return #YACA_ERROR_NONE on success, negative on error
* @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_PARAMETER key is NULL, incorrect @a key_type or
+ * @retval #YACA_ERROR_INVALID_PARAMETER @a 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
* @remarks This function is used to generate private asymmetric keys
* based on pre-generated parameters.
*
- * @remarks The @a key should be released using yaca_key_destroy()
+ * @remarks The @a key should be released using yaca_key_destroy().
*
* @param[in] params Pre-generated parameters
* @param[out] prv_key Newly generated private key
*
* @return #YACA_ERROR_NONE on success, negative on error
* @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_PARAMETER key is NULL or incorrect @a params
+ * @retval #YACA_ERROR_INVALID_PARAMETER @a prv_key is NULL or incorrect @a params
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @since_tizen 3.0
*
- * @remarks The @a pub_key should be released using yaca_key_destroy()
+ * @remarks The @a pub_key should be released using yaca_key_destroy().
*
* @param[in] prv_key Private key to extract the public one from
* @param[out] pub_key Extracted public key
*
* @since_tizen 3.0
*
- * @remarks The @a params_key should be released using yaca_key_destroy()
+ * @remarks The @a params should be released using yaca_key_destroy().
*
* @param[in] key A key to extract the parameters from
* @param[out] params Extracted parameters
*
* @remarks The @a secret should not be used as a symmetric key,
* to produce a symmetric key pass the secret to a key derivation function (KDF)
- * or a message digest function
+ * or a message digest function.
*
- * @remarks The @a secret should be freed with yaca_free()
+ * @remarks The @a secret should be freed with yaca_free().
*
* @param[in] prv_key Our private key
* @param[in] pub_key Peer public key
*
* @return #YACA_ERROR_NONE on success, negative on error
* @retval #YACA_ERROR_NONE Successful
- * @retval #YACA_ERROR_INVALID_PARAMETER Required parameters have incorrect values (invalid key)
+ * @retval #YACA_ERROR_INVALID_PARAMETER Required parameters have incorrect values
+ * (invalid @a prv_key or @a pub_key)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @since_tizen 3.0
*
* @remarks The @a info parameter is ANSI X9.42 OtherInfo or ANSI X9.62 SharedInfo structure,
- * more information can be found in ANSI X9.42/62 standard specification
+ * more information can be found in ANSI X9.42/62 standard specification.
*
* @remarks The @a key_material or separate parts of it can be used to import a symmetric key
- * with yaca_key_import()
+ * with yaca_key_import().
*
- * @remarks The @a key_material should be freed using yaca_free()
+ * @remarks The @a key_material should be freed using yaca_free().
*
* @param[in] kdf Key derivation function
* @param[in] algo Digest algorithm that should be used in key derivation
* @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 algo or kdf)
+ * invalid @a algo or @a kdf)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @since_tizen 3.0
*
- * @remarks The @a key should be released using yaca_key_destroy()
+ * @remarks The @a key should be released using yaca_key_destroy().
*
- * @param[in] password User password as a NULL-terminated string
+ * @param[in] password User password as a null-terminated string
* @param[in] salt Salt, should be a non-empty string
* @param[in] salt_len Length of the salt
* @param[in] iterations Number of iterations
* @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 algo or key_bit_len not dividable by 8)
+ * invalid @a algo or @a key_bit_len not dividable by 8)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
void yaca_key_destroy(yaca_key_h key);
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
*
* @since_tizen 3.0
*
- * @remarks The @a ciphertext should be freed using yaca_free()
+ * @remarks The @a ciphertext should be freed using yaca_free().
*
- * @remarks The key used has to be of a #YACA_KEY_TYPE_RSA_PUB type
+ * @remarks The @a pub_key used has to be of a #YACA_KEY_TYPE_RSA_PUB type.
*
- * @remarks The maximum length of plaintext depends on the key length and padding method,
- * see #yaca_padding_e for details
+ * @remarks The maximum length of plaintext depends on the key length and padding method.
+ * See #yaca_padding_e for details.
*
- * @remarks The @a plaintext can be NULL but then the @a plaintext_len must be 0
+ * @remarks The @a plaintext can be NULL but then the @a plaintext_len must be 0.
*
* @param[in] padding Padding method
* @param[in] pub_key Public RSA key (see yaca_key.h for key generation functions)
* @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 padding, pub_key or plaintext_len)
+ * invalid @a padding, @a pub_key or @a plaintext_len)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @since_tizen 3.0
*
- * @remarks The @a plaintext should be freed using yaca_free()
+ * @remarks The @a plaintext should be freed using yaca_free().
*
- * @remarks The key used has to be of a #YACA_KEY_TYPE_RSA_PRIV type
+ * @remarks The @a prv_key used has to be of a #YACA_KEY_TYPE_RSA_PRIV type.
*
* @param[in] padding Padding method
* @param[in] prv_key Private RSA key matching the public one used to encrypt the data
* @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 padding or prv_key), padding check failed
+ * invalid @a padding or @a prv_key), padding check failed
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @since_tizen 3.0
*
- * @remarks The @a ciphertext should be freed using yaca_free()
+ * @remarks The @a ciphertext should be freed using yaca_free().
*
- * @remarks The key used has to be of a #YACA_KEY_TYPE_RSA_PRIV type
+ * @remarks The @a prv_key used has to be of a #YACA_KEY_TYPE_RSA_PRIV type.
*
* @remarks The maximum length of plaintext depends on the key length and padding method,
- * see #yaca_padding_e for details
+ * see #yaca_padding_e for details.
*
- * @remarks The @a plaintext can be NULL but then the @a plaintext_len must be 0
+ * @remarks The @a plaintext can be NULL but then the @a plaintext_len must be 0.
*
* @param[in] padding Padding method
* @param[in] prv_key Private RSA key (see yaca_key.h for key generation functions)
* @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 padding, prv_key or message_len)
+ * invalid @a padding, @a prv_key or @a plaintext_len)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @since_tizen 3.0
*
- * @remarks The @a plaintext should be freed using yaca_free()
+ * @remarks The @a plaintext should be freed using yaca_free().
*
- * @remarks The key used has to be of a #YACA_KEY_TYPE_RSA_PUB type
+ * @remarks The @a pub_key used has to be of a #YACA_KEY_TYPE_RSA_PUB type.
*
* @param[in] padding Padding method
* @param[in] pub_key Public RSA key matching the private one used to encrypt the data
* @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 padding or pub_key), padding check failed
+ * invalid @a padding or @a pub_key), padding check failed
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
size_t *plaintext_len);
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
* symmetric key and Initialization Vector.
*
* @remarks Generated symmetric key is encrypted with public key,
- * so can be ONLY used with yaca_open_initialize(). It can be exported,
- * but after import it can be ONLY used with yaca_open_initialize() as well.
+ * so can be only used with yaca_open_initialize(). It can be exported,
+ * but after import it can be only used with yaca_open_initialize() as well.
*
- * @remarks The @a ctx should be released using yaca_context_destroy()
+ * @remarks The @a ctx should be released using yaca_context_destroy().
*
- * @remarks The @a pub_key must be #YACA_KEY_TYPE_RSA_PUB
+ * @remarks The @a pub_key must be #YACA_KEY_TYPE_RSA_PUB.
*
- * @remarks The @a sym_key_bit_len must be at least 88 bits shorter than the @a pub_key bit length
+ * @remarks The @a sym_key_bit_len must be at least 88 bits shorter than the @a pub_key bit length.
*
- * @remarks The @a sym_key should be released using yaca_key_destroy()
+ * @remarks The @a sym_key should be released using yaca_key_destroy().
*
- * @remarks The @a iv should be released using yaca_key_destroy()
+ * @remarks The @a iv should be released using yaca_key_destroy().
*
* @since_tizen 3.0
*
* @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,
- * invalid algo, bcm, sym_key_bit_len or pub_key)
+ * invalid @a algo, @a bcm, @a sym_key_bit_len or @a pub_key)
* @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 Required parameters have incorrect values (NULL, 0,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see yaca_seal_initialize()
* @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,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see yaca_seal_initialize()
*
* @since_tizen 3.0
*
- * @remarks The @a ctx should be released using yaca_context_destroy()
+ * @remarks The @a ctx should be released using yaca_context_destroy().
*
- * @remarks The @a prv_key must be #YACA_KEY_TYPE_RSA_PRIV
+ * @remarks The @a prv_key must be #YACA_KEY_TYPE_RSA_PRIV.
*
* @param[out] ctx Newly created context
* @param[in] prv_key Private key, part of the pair that was used for the encryption
* @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, invalid
- * algo, bcm, sym_key_bit_len, prv_key, sym_key or iv)
+ * @a algo, @a bcm, @a sym_key_bit_len, @a prv_key,
+ * @a sym_key or @a iv)
* @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 Required parameters have incorrect values (NULL, 0,
- * invalid context), wrong #YACA_PROPERTY_CCM_AAD or
+ * invalid @a ctx), wrong #YACA_PROPERTY_CCM_AAD or
* wrong #YACA_PROPERTY_CCM_TAG was used
* @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 Required parameters have incorrect values (NULL,
- * invalid context), wrong #YACA_PROPERTY_GCM_AAD or
+ * invalid @a ctx), wrong #YACA_PROPERTY_GCM_AAD or
* wrong #YACA_PROPERTY_GCM_TAG was used
* @retval #YACA_ERROR_INTERNAL Internal error
*
size_t *plaintext_len);
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
*
* @remarks Using of #YACA_DIGEST_MD5 or #YACA_DIGEST_SHA224 with #YACA_PADDING_X931 is prohibited.
*
- * @remarks The @a ctx should be released using yaca_context_destroy()
+ * @remarks The @a ctx should be released using yaca_context_destroy().
*
* @param[out] ctx Newly created context
* @param[in] algo Digest algorithm that will be used
* @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,
- * invalid algo or key)
+ * invalid @a algo or @a prv_key)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @remarks For verification, calculate message HMAC and compare with received MAC using
* yaca_memcmp().
*
- * @remarks The @a ctx should be released using yaca_context_destroy()
+ * @remarks The @a ctx should be released using yaca_context_destroy().
*
* @param[out] ctx Newly created context
* @param[in] algo Digest algorithm that will be used
* @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,
- * invalid algo or key)
+ * invalid @a algo or @a sym_key)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @remarks For verification, calculate message CMAC and compare with received MAC using
* yaca_memcmp().
*
- * @remarks The @a ctx should be released using yaca_context_destroy()
+ * @remarks The @a ctx should be released using yaca_context_destroy().
*
* @param[out] ctx Newly created context
* @param[in] algo Encryption algorithm that will be used
* @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,
- * invalid algo or key)
+ * invalid @a algo or @a sym_key)
* @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 Required parameters have incorrect values (NULL, 0,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see yaca_sign_initialize()
* @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,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see yaca_sign_initialize()
size_t *signature_len);
/**
- * @brief Initializes a signature verification context for asymmetric signatures
+ * @brief Initializes a signature verification context for asymmetric signatures.
*
* @since_tizen 3.0
*
* changed using yaca_context_set_property() with #YACA_PROPERTY_PADDING.
* For verify to succeed it has to be set to the same value it was signed with.
*
- * @remarks The @a ctx should be released using yaca_context_destroy()
+ * @remarks The @a ctx should be released using yaca_context_destroy().
*
* @param[out] ctx Newly created context
* @param[in] algo Digest algorithm that will be used
* @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,
- * invalid algo or key)
+ * invalid @a algo or @a pub_key)
* @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 Required parameters have incorrect values (NULL, 0,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @see yaca_verify_initialize()
* @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,
- * invalid context)
+ * invalid @a ctx)
* @retval #YACA_ERROR_INTERNAL Internal error
* @retval #YACA_ERROR_DATA_MISMATCH The verification failed
*
size_t signature_len);
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
*
* @since_tizen 3.0
*
- * @remarks yaca_simple_encrypt() doesn't support #YACA_BCM_GCM and #YACA_BCM_CCM
+ * @remarks yaca_simple_encrypt() doesn't support #YACA_BCM_GCM and #YACA_BCM_CCM.
*
- * @remarks The @a ciphertext should be freed using yaca_free()
+ * @remarks The @a ciphertext should be freed using yaca_free().
*
- * @remarks The @a plaintext can be NULL but then @a plaintext_len must be 0
+ * @remarks The @a plaintext can be NULL but then @a plaintext_len must be 0.
*
* @param[in] algo Encryption algorithm (select #YACA_ENCRYPT_AES if unsure)
* @param[in] bcm Chaining mode (select #YACA_BCM_CBC if unsure)
* @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 algo, bcm, sym_key or iv)
+ * invalid @a algo, @a bcm, @a sym_key or @a iv)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @since_tizen 3.0
*
- * @remarks yaca_simple_decrypt() doesn't support #YACA_BCM_GCM and #YACA_BCM_CCM
+ * @remarks yaca_simple_decrypt() doesn't support #YACA_BCM_GCM and #YACA_BCM_CCM.
*
- * @remarks The @a plaintext should be freed using yaca_free()
+ * @remarks The @a plaintext should be freed using yaca_free().
*
- * @remarks The @a ciphertext can be NULL but then @a ciphertext_len must be 0
+ * @remarks The @a ciphertext can be NULL but then @a ciphertext_len must be 0.
*
* @param[in] algo Decryption algorithm that was used to encrypt the data
* @param[in] bcm Chaining mode that was used to encrypt the data
* @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 algo, bcm, sym_key or iv)
+ * invalid @a algo, @a bcm, @a sym_key or @a iv)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @since_tizen 3.0
*
- * @remarks The @a digest should be freed using yaca_free()
+ * @remarks The @a digest should be freed using yaca_free().
*
- * @remarks The @a message can be NULL but then @a message_len must be 0
+ * @remarks The @a message can be NULL but then @a message_len must be 0.
*
* @param[in] algo Digest algorithm (select #YACA_DIGEST_SHA256 if unsure)
* @param[in] message Message from which the digest is to be calculated
* @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,
- * invalid algo)
+ * invalid @a algo)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @remarks Using of #YACA_DIGEST_MD5 algorithm for DSA and ECDSA operations is prohibited.
*
- * @remarks The @a signature should be freed using yaca_free()
+ * @remarks The @a signature should be freed using yaca_free().
*
- * @remarks The @a message can be NULL but then @a message_len must be 0
+ * @remarks The @a message can be NULL but then @a message_len must be 0.
*
* @param[in] algo Digest algorithm that will be used
* @param[in] prv_key Private key that will be used, algorithm is
* @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 algo or key)
+ * invalid @a algo or @a prv_key)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
*
* @since_tizen 3.0
*
- * @remarks The @a message can be NULL but then @a message_len must be 0
+ * @remarks The @a message can be NULL but then @a message_len must be 0.
*
* @param[in] algo Digest algorithm that will be used
* @param[in] pub_key Public key that will be used, algorithm is
* @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 algo or key)
+ * invalid @a algo or @a pub_key)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
* @retval #YACA_ERROR_DATA_MISMATCH The verification failed
* @remarks For verification, calculate message HMAC and compare with received MAC using
* yaca_memcmp().
*
- * @remarks The @a mac should be freed using yaca_free()
+ * @remarks The @a mac should be freed using yaca_free().
*
- * @remarks The @a message can be NULL but then @a message_len must be 0
+ * @remarks The @a message can be NULL but then @a message_len must be 0.
*
* @param[in] algo Digest algorithm that will be used
* @param[in] sym_key Key that will be used, supported key types:
* @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 algo or key)
+ * invalid @a algo or @a sym_key)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
* @remarks For verification, calculate message CMAC and compare with received MAC using
* yaca_memcmp().
*
- * @remarks The @a mac should be freed using yaca_free()
+ * @remarks The @a mac should be freed using yaca_free().
*
- * @remarks The @a message can be NULL but then @a message_len must be 0
+ * @remarks The @a message can be NULL but then @a message_len must be 0.
*
* @param[in] algo Encryption algorithm that will be used
* @param[in] sym_key Key that will be used, supported key types:
* @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 algo or key)
+ * invalid @a algo or @a sym_key)
* @retval #YACA_ERROR_OUT_OF_MEMORY Out of memory error
* @retval #YACA_ERROR_INTERNAL Internal error
*
size_t *mac_len);
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
*/
YACA_PADDING_PKCS1_SSLV23,
- /** PKCS #7 padding. Suitable for symmetric encrypt/decrypt operation. */
+ /**
+ * PKCS #7 padding. Suitable for symmetric encrypt/decrypt operation.
+ */
YACA_PADDING_PKCS7
} yaca_padding_e;
} yaca_kdf_e;
/**
- * @}
- */
+ * @}
+ */
#ifdef __cplusplus
} /* extern */
projects / platform / core / security / yaca.git / commitdiff