*
* @file ckmc-manager.h
* @version 1.0
- * @brief provides management functions(storing, retrieving, and removing) for keys, certificates and data of a user and additional crypto functions.
+ * @brief Provides management functions(storing, retrieving, and removing) for keys, certificates and data of a user and additional crypto functions.
*/
#include <stddef.h>
#include <sys/types.h>
+#include <tizen.h>
#include <ckmc/ckmc-type.h>
#include <ckmc/ckmc-error.h>
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks Currently only four types of keys are supported for this API. These are RSA public/private key and ECDSA /private key.
+ * @remarks Currently only six types of keys are supported for this API. These are RSA public/private key, DSA public/private key and ECDSA public/private key.
* @remarks key_type in key may be set to #CKMC_KEY_NONE as an input. key_type is determined inside key manager during storing keys.
- * @remarks Some private key files are protected by a password. if raw_key in key read from those encrypted files is encrypted with a password, the password should be provided in the #ckmc_key structure.
- * @remarks if password in policy is provided, the key is additionally encrypted with the password in policy.
+ * @remarks Some private key files are protected by a password. If raw_key in key read from those encrypted files is encrypted with a password, the password should be provided in the #ckmc_key_s structure.
+ * @remarks If password in policy is provided, the key is additionally encrypted with the password in policy.
*
- * @param[in] alias is the name of a key to be stored
- * @param[in] key has a key's binary value to be stored.
- * @param[in] policy is about how to store a key securely.
+ * @param[in] alias The name of a key to be stored
+ * @param[in] key The key's binary value to be stored
+ * @param[in] policy The policy about how to store a key securely
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ALIAS_EXISTS alias already exists.
- * @exception #CKMC_API_ERROR_INVALID_FORMAT the format of raw_key is not valid.
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to other DB transaction unexpectedly.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ALIAS_EXISTS Alias already exists
+ * @retval #CKMC_ERROR_INVALID_FORMAT The format of raw_key is not valid
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to other DB transaction unexpectedly
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
+ *
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_remove_key()
* @see ckmc_get_key()
* @see ckmc_get_key_alias_list()
- * @see #ckmc_key
- * @see #ckmc_policy
+ * @see #ckmc_key_s
+ * @see #ckmc_policy_s
*/
-int ckmc_save_key(const char *alias, const ckmc_key key, const ckmc_policy policy);
+int ckmc_save_key(const char *alias, const ckmc_key_s key, const ckmc_policy_s policy);
/**
- * @brief Removes a key from key manager
+ * @brief Removes a key from key manager.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks a client can remove only keys stored by the client.
+ * @remarks A client can remove only keys stored by the client.
+ *
+ * @param[in] alias The name of a key to be removed
*
- * @param[in] alias is the name of a key to be removed
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to the error with unknown reason
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to the error with unknown reason
+ * @retval #CKMC_ERROR_DB_ALIAS_UNKNOWN Alias does not exist
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_save_key()
* @see ckmc_get_key()
int ckmc_remove_key(const char *alias);
/**
- * @brief Get a key from key manager
+ * @brief Gets a key from key manager.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks a client can access only data stored by the client and non-restricted data stored by other clients.
- * @remarks A newly created ppkey should be destroyed by calling ckmc_key_free() if it is no longer needed.
+ * @remarks A client can access only data stored by the client.
+ * @remarks You must destroy the newly created @a ppkey by calling ckmc_key_free() if it is no longer needed.
+ *
+ * @param[in] alias The name of a key to retrieve
+ * @param[in] password The password used in decrypting a key value \n
+ * If password of policy is provided in ckmc_save_key(), the same password should be provided.
+ * @param[out] ppkey The pointer to a newly created ckmc_key_s handle
*
- * @param[in] alias is the name of a key to retrieve
- * @param[in] password is used in decrypting a key value. If password of policy is provided in ckmc_save_key(), the same password should be provided.
- * @param[out] ppkey is a pointer to a newly created ckmc_key handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to the error with unknown reason
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to the error with unknown reason
+ * @retval #CKMC_ERROR_DB_ALIAS_UNKNOWN Alias does not exist
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_save_key()
* @see ckmc_remove_key()
* @see ckmc_get_key_alias_list()
*/
-int ckmc_get_key(const char *alias, const char *password, ckmc_key **ppkey);
+int ckmc_get_key(const char *alias, const char *password, ckmc_key_s **ppkey);
/**
- * @brief Get a all alias of keys to which the client can access
+ * @brief Gets all the alias of keys that the client can access.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks a client can access only data stored by the client and non-restricted data stored by other clients.
- * @remarks A newly created ppalias_list should be destroyed by calling ckmc_alias_list_all_free() if it is no longer needed.
+ * @remarks A client can access only data stored by the client.
+ * @remarks You must destroy the newly created @a ppalias_list by calling ckmc_alias_list_all_free() if it is no longer needed.
*
- * @param[out] ppalias_list is a pointer to a newly created ckmc_alias_list handle containing all available alias of keys. If there is no available key alias, *ppalias_list will be null.
+ * @param[out] ppalias_list The pointer to a newly created ckmc_alias_list_s handle containing all available alias of keys \n
+ * If there is no available key alias, *ppalias_list will be null.
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to the error with unknown reason
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to the error with unknown reason
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
+ *
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_save_key()
* @see ckmc_remove_key()
* @see ckmc_get_key()
*/
-int ckmc_get_key_alias_list(ckmc_alias_list** ppalias_list);
+int ckmc_get_key_alias_list(ckmc_alias_list_s** ppalias_list);
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @param[in] alias is the name of a certificate to be stored
- * @param[in] cert has a certificate's binary value to be stored.
- * @param[in] policy is about how to store a certificate securely.
+ * @param[in] alias The name of a certificate to be stored
+ * @param[in] cert The certificate's binary value to be stored
+ * @param[in] policy The policy about how to store a certificate securely
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ALIAS_EXISTS alias already exists.
- * @exception #CKMC_API_ERROR_INVALID_FORMAT the format of raw_cert is not valid.
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to other DB transaction unexpectedly.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ALIAS_EXISTS Alias already exists
+ * @retval #CKMC_ERROR_INVALID_FORMAT The format of raw_cert is not valid
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to other DB transaction unexpectedly
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_remove_cert()
* @see ckmc_get_cert()
* @see ckmc_get_cert_alias_list()
- * @see #ckmc_cert
- * @see #ckmc_policy
+ * @see #ckmc_cert_s
+ * @see #ckmc_policy_s
*/
-int ckmc_save_cert(const char *alias, const ckmc_cert cert, const ckmc_policy policy);
+int ckmc_save_cert(const char *alias, const ckmc_cert_s cert, const ckmc_policy_s policy);
/**
- * @brief Removes a certificate from key manager
+ * @brief Removes a certificate from key manager.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks a client can remove only certificates stored by the client.
+ * @remarks A client can remove only certificates stored by the client.
*
- * @param[in] alias is the name of a certificate to be removed
+ * @param[in] alias The name of a certificate to be removed
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to the error with unknown reason
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to the error with unknown reason
+ * @retval #CKMC_ERROR_DB_ALIAS_UNKNOWN Alias does not exist
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
+ *
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_save_cert()
* @see ckmc_get_cert()
int ckmc_remove_cert(const char *alias);
/**
- * @brief Get a certificate from key manager
+ * @brief Gets a certificate from key manager.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks a client can access only certificate stored by the client and non-restricted certificate stored by other clients.
- * @remarks A newly created ppcert should be destroyed by calling ckmc_cert_free() if it is no longer needed.
+ * @remarks A client can access only certificate stored by the client.
+ * @remarks You must destroy the newly created @a ppcert by calling ckmc_cert_free() if it is no longer needed.
+ *
+ * @param[in] alias The name of a certificate to retrieve
+ * @param[in] password The password used in decrypting a certificate value \n
+ * If password of policy is provided in ckmc_save_cert(), the same password should be provided.
+ * @param[out] ppcert The pointer to a newly created ckmc_cert_s handle
*
- * @param[in] alias is the name of a certificate to retrieve
- * @param[in] password is used in decrypting a certificate value. If password of policy is provided in ckmc_save_cert(), the same password should be provided.
- * @param[out] ppcert is a pointer to a newly created ckmc_cert handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to the error with unknown reason
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to the error with unknown reason
+ * @retval #CKMC_ERROR_DB_ALIAS_UNKNOWN Alias does not exists
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_save_cert()
* @see ckmc_remove_cert()
* @see ckmc_get_cert_alias_list()
*/
-int ckmc_get_cert(const char *alias, const char *password, ckmc_cert **ppcert);
+int ckmc_get_cert(const char *alias, const char *password, ckmc_cert_s **ppcert);
/**
- * @brief Get a all alias of certificates to which the client can access
+ * @brief Gets all alias of certificates which the client can access.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks a client can access only data stored by the client and non-restricted data stored by other clients.
- * @remarks A newly created ppalias_list should be destroyed by calling ckmc_alias_list_all_free() if it is no longer needed.
+ * @remarks A client can access only data stored by the client.
+ * @remarks You must destroy the newly created @a ppalias_list by calling ckmc_alias_list_all_free() if it is no longer needed.
*
- * @param[out] ppalias_list is a pointer to a newly created ckmc_alias_list handle containing all available alias of keys. If there is no available key alias, *ppalias_list will be null.
+ * @param[out] ppalias_list The pointer to a newly created ckmc_alias_list_s handle containing all available alias of keys \n
+ * If there is no available key alias, *ppalias_list will be null.
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to the error with unknown reason
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to the error with unknown reason
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
+ *
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_save_cert()
* @see ckmc_remove_cert()
* @see ckmc_get_cert()
*/
-int ckmc_get_cert_alias_list(ckmc_alias_list** ppalias_list);
+int ckmc_get_cert_alias_list(ckmc_alias_list_s** ppalias_list);
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @param[in] alias is the name of a data to be stored
- * @param[in] data has a binary value to be stored.
- * @param[in] policy is about how to store a data securely.
+ * @param[in] alias The name of a data to be stored
+ * @param[in] data The binary value to be stored
+ * @param[in] policy The policy about how to store a data securely
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ALIAS_EXISTS alias already exists.
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to other DB transaction unexpectedly.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ALIAS_EXISTS Alias already exists
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to other DB transaction unexpectedly
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_remove_data()
* @see ckmc_get_data()
* @see ckmc_get_data_alias_list()
- * @see #ckmc_raw_buffer
- * @see #ckmc_policy
+ * @see #ckmc_raw_buffer_s
+ * @see #ckmc_policy_s
*/
-int ckmc_save_data(const char *alias, ckmc_raw_buffer data, const ckmc_policy policy);
+int ckmc_save_data(const char *alias, ckmc_raw_buffer_s data, const ckmc_policy_s policy);
/**
- * @brief Removes a data from key manager
+ * @brief Removes a data from key manager.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks a client can remove only data stored by the client.
+ * @remarks A client can remove only data stored by the client.
*
- * @param[in] alias is the name of a data to be removed
+ * @param[in] alias The name of a data to be removed
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to the error with unknown reason
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to the error with unknown reason
+ * @retval #CKMC_ERROR_DB_ALIAS_UNKNOWN Alias does not exist
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
+ *
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_save_data()
* @see ckmc_get_data()
int ckmc_remove_data(const char *alias);
/**
- * @brief Get a data from key manager
+ * @brief Gets a data from key manager.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks a client can access only data stored by the client and non-restricted data stored by other clients.
- * @remarks A newly created ppdata should be destroyed by calling ckmc_buffer_free() if it is no longer needed.
+ * @remarks A client can access only data stored by the client.
+ * @remarks You must destroy the newly created @a ppdata by calling ckmc_buffer_free() if it is no longer needed.
+ *
+ * @param[in] alias The name of a data to retrieve
+ * @param[in] password The password used in decrypting a data value \n
+ * If password of policy is provided in ckmc_save_data(), the same password should be provided.
+ * @param[out] ppdata The pointer to a newly created ckmc_raw_buffer_s handle
*
- * @param[in] alias is the name of a data to retrieve
- * @param[in] password is used in decrypting a data value. If password of policy is provided in ckmc_save_data(), the same password should be provided.
- * @param[out] ppdata is a pointer to a newly created ckmc_raw_buffer handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to the error with unknown reason
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to the error with unknown reason
+ * @retval #CKMC_ERROR_DB_ALIAS_UNKNOWN Alias does not exist
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_save_data()
* @see ckmc_remove_data()
* @see ckmc_get_data_alias_list()
*/
-int ckmc_get_data(const char *alias, const char *password, ckmc_raw_buffer **ppdata);
+int ckmc_get_data(const char *alias, const char *password, ckmc_raw_buffer_s **ppdata);
/**
- * @brief Get a all alias of data to which the client can access
+ * @brief Gets all alias of data which the client can access.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks a client can access only data stored by the client and non-restricted data stored by other clients.
- * @remarks A newly created ppalias_list should be destroyed by calling ckmc_alias_list_all_free() if it is no longer needed.
+ * @remarks A client can access only data stored by the client.
+ * @remarks You must destroy the newly created @a ppalias_list by calling ckmc_alias_list_all_free() if it is no longer needed.
*
- * @param[out] ppalias_list is a pointer to a newly created ckmc_alias_list handle containing all available alias of keys. If there is no available key alias, *ppalias_list will be null.
+ * @param[out] ppalias_list The pointer to a newly created ckmc_alias_list_s handle containing all available alias of keys \n
+ * If there is no available key alias, *ppalias_list will be null.
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to the error with unknown reason
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to the error with unknown reason
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
+ *
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_save_data()
* @see ckmc_remove_data()
* @see ckmc_get_data()
*/
-int ckmc_get_data_alias_list(ckmc_alias_list** ppalias_list);
+int ckmc_get_data_alias_list(ckmc_alias_list_s** ppalias_list);
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks if password in policy is provided, the key is additionally encrypted with the password in policy.
+ * @remarks If password in policy is provided, the key is additionally encrypted with the password in policy.
+ *
+ * @param[in] size The size of key strength to be created \n
+ * @c 1024, @c 2048, and @c 4096 are supported.
+ * @param[in] private_key_alias The name of private key to be stored
+ * @param[in] public_key_alias The name of public key to be stored
+ * @param[in] policy_private_key The policy about how to store a private key securely
+ * @param[in] policy_public_key The policy about how to store a public key securely
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ALIAS_EXISTS Alias already exists
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to other DB transaction unexpectedly
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
+ *
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
+ *
+ * @see ckmc_create_key_pair_dsa()
+ * @see ckmc_create_key_pair_ecdsa()
+ * @see ckmc_create_signature()
+ * @see ckmc_verify_signature()
+ */
+int ckmc_create_key_pair_rsa(const size_t size, const char *private_key_alias, const char *public_key_alias, const ckmc_policy_s policy_private_key, const ckmc_policy_s policy_public_key);
+
+/**
+ * @brief Creates DSA private/public key pair and stores them inside key manager based on each policy.
+ *
+ * @since_tizen 2.3
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/keymanager
+ *
+ * @remarks If password in policy is provided, the key is additionally encrypted with the password in policy.
*
- * @param[in] size is the size of key strength to be created. 1024, 2048, and 4096 are supported.
- * @param[in] private_key_alias is the name of private key to be stored.
- * @param[in] public_key_alias is the name of public key to be stored.
- * @param[in] policy_private_key is about how to store a private key securely.
- * @param[in] policy_public_key is about how to store a public key securely.
+ * @param[in] size The size of key strength to be created \n
+ * @c 1024, @c 2048, @c 3072 and @c 4096 are supported.
+ * @param[in] private_key_alias The name of private key to be stored
+ * @param[in] public_key_alias The name of public key to be stored
+ * @param[in] policy_private_key The policy about how to store a private key securely
+ * @param[in] policy_public_key The policy about how to store a public key securely
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ALIAS_EXISTS alias already exists.
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to other DB transaction unexpectedly.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ALIAS_EXISTS Alias already exists
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to other DB transaction unexpectedly
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
+ *
+ * @see ckmc_create_key_pair_rsa()
* @see ckmc_create_key_pair_ecdsa()
* @see ckmc_create_signature()
* @see ckmc_verify_signature()
*/
-int ckmc_create_key_pair_rsa(const size_t size, const char *private_key_alias, const char *public_key_alias, const ckmc_policy policy_private_key, const ckmc_policy policy_public_key);
+int ckmc_create_key_pair_dsa(const size_t size, const char *private_key_alias, const char *public_key_alias, const ckmc_policy_s policy_private_key, const ckmc_policy_s policy_public_key);
/**
* @brief Creates ECDSA private/public key pair and stores them inside key manager based on each policy.
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
- * @remarks if password in policy is provided, the key is additionally encrypted with the password in policy.
+ * @remarks If password in policy is provided, the key is additionally encrypted with the password in policy.
*
- * @param[in] type is the type of eliptic curve of ECDSA.
- * @param[in] private_key_alias is the name of private key to be stored.
- * @param[in] public_key_alias is the name of public key to be stored.
- * @param[in] policy_private_key is about how to store a private key securely.
- * @param[in] policy_public_key is about how to store a public key securely.
+ * @param[in] type The type of elliptic curve of ECDSA
+ * @param[in] private_key_alias The name of private key to be stored
+ * @param[in] public_key_alias The name of public key to be stored
+ * @param[in] policy_private_key The policy about how to store a private key securely
+ * @param[in] policy_public_key The policy about how to store a public key securely
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ALIAS_EXISTS alias already exists.
- * @exception #CKMC_API_ERROR_DB_ERROR failed due to other DB transaction unexpectedly.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ALIAS_EXISTS Alias already exists
+ * @retval #CKMC_ERROR_DB_ERROR Failed due to other DB transaction unexpectedly
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
+ *
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_create_key_pair_rsa()
+ * @see ckmc_create_key_pair_dsa()
* @see ckmc_create_signature()
* @see ckmc_verify_signature()
- * @see #ckmc_ec_type
+ * @see #ckmc_ec_type_e
*/
-int ckmc_create_key_pair_ecdsa(const ckmc_ec_type type, const char *private_key_alias, const char *public_key_alias, const ckmc_policy policy_private_key, const ckmc_policy policy_public_key);
+int ckmc_create_key_pair_ecdsa(const ckmc_ec_type_e type, const char *private_key_alias, const char *public_key_alias, const ckmc_policy_s policy_private_key, const ckmc_policy_s policy_public_key);
/**
- * @brief Creates a signature on a given message using a private key and returns the signature
+ * @brief Creates a signature on a given message using a private key and returns the signature.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
* @remarks If password of policy is provided during storing a key, the same password should be provided.
- * @remarks A newly created ppsignature should be destroyed by calling ckmc_buffer_free() if it is no longer needed.
+ * @remarks You must destroy the newly created @a ppsignature by calling ckmc_buffer_free() if it is no longer needed.
*
+ * @param[in] private_key_alias The name of private key
+ * @param[in] password The password used in decrypting a private key value
+ * @param[in] message The message that is signed with a private key
+ * @param[in] hash The hash algorithm used in creating signature
+ * @param[in] padding The RSA padding algorithm used in creating signature \n
+ * It is used only when the signature algorithm is RSA.
+ * @param[out] ppsignature The pointer to a newly created signature \n
+ * If an error occurs, @a *ppsignature will be null.
*
- * @param[in] private_key_alias is the name of private key.
- * @param[in] password is used in decrypting a private key value.
- * @param[in] message is signed with a private key .
- * @param[in] hash is the hash algorithm used in creating signature.
- * @param[in] padding is the RSA padding algorithm used in creating signature. It is used only when the signature algorithm is RSA.
- * @param[out] ppsignature is a pointer to a newly created signature's. If an error occurs, *ppsignature will be null.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @return 0 on success, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ALIAS_UNKNOWN Alias does not exist
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_create_key_pair_rsa()
* @see ckmc_create_key_pair_ecdsa()
* @see ckmc_verify_signature()
* @see ckmc_buffer_free()
- * @see #ckmc_hash_algo
- * @see #ckmc_rsa_padding_algo
+ * @see #ckmc_hash_algo_e
+ * @see #ckmc_rsa_padding_algo_e
*/
-int ckmc_create_signature(const char *private_key_alias, const char *password, const ckmc_raw_buffer message, const ckmc_hash_algo hash, const ckmc_rsa_padding_algo padding, ckmc_raw_buffer **ppsignature);
+int ckmc_create_signature(const char *private_key_alias, const char *password, const ckmc_raw_buffer_s message, const ckmc_hash_algo_e hash, const ckmc_rsa_padding_algo_e padding, ckmc_raw_buffer_s **ppsignature);
/**
- * @brief Verify a given signature on a given message using a public key and returns the signature status.
+ * @brief Verifies a given signature on a given message using a public key and returns the signature status.
*
* @since_tizen 2.3
* @privlevel public
*
* @remarks If password of policy is provided during storing a key, the same password should be provided.
*
- * @param[in] public_key_alias is the name of public key.
- * @param[in] password is used in decrypting a public key value.
- * @param[in] message is a input on which the signature is created.
- * @param[in] signature is verified with public key.
- * @param[in] hash is the hash algorithm used in verifying signature.
- * @param[in] padding is the RSA padding algorithm used in verifying signature. It is used only when the signature algorithm is RSA.
+ * @param[in] public_key_alias The name of public key
+ * @param[in] password The password used in decrypting a public key value
+ * @param[in] message The input on which the signature is created
+ * @param[in] signature The signature that is verified with public key
+ * @param[in] hash The hash algorithm used in verifying signature
+ * @param[in] padding The RSA padding algorithm used in verifying signature \n
+ * It is used only when the signature algorithm is RSA.
+ *
+ * @return @c 0 on success and the signature is valid,
+ * otherwise a negative error value
*
- * @return 0 on success and the signature is valid, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_VERIFICATION_FAILED the signature is invalid
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_VERIFICATION_FAILED The signature is invalid
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ALIAS_UNKNOWN Alias does not exist
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_create_key_pair_rsa()
* @see ckmc_create_key_pair_ecdsa()
* @see ckmc_verify_signature()
- * @see #ckmc_hash_algo
- * @see #ckmc_rsa_padding_algo
+ * @see #ckmc_hash_algo_e
+ * @see #ckmc_rsa_padding_algo_e
*/
-int ckmc_verify_signature(const char *public_key_alias, const char *password, const ckmc_raw_buffer message, const ckmc_raw_buffer signature, const ckmc_hash_algo hash, const ckmc_rsa_padding_algo padding);
+int ckmc_verify_signature(const char *public_key_alias, const char *password, const ckmc_raw_buffer_s message, const ckmc_raw_buffer_s signature, const ckmc_hash_algo_e hash, const ckmc_rsa_padding_algo_e padding);
/**
- * @brief Verify a certificate chain and return that chain.
+ * @brief Verifies a certificate chain and returns that chain.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
* @remarks The trusted root certificate of the chain should exist in the system's certificate storage.
- * @remarks A newly created ppcert_chain_list should be destroyed by calling ckmc_cert_list_all_free() if it is no longer needed.
+ * @remarks You must destroy the newly created @a ppcert_chain_list by calling ckmc_cert_list_all_free() if it is no longer needed.
*
- * @param[in] cert is the certificate to be verified
- * @param[in] untrustedcerts is the untrusted CA certificates to be used in verifying a certificate chain.
- * @param[out] ppcert_chain_list is a pointer to a newly created certificate chain's handle. If an error occurs, *ppcert_chain_list will be null.
+ * @param[in] cert The certificate to be verified
+ * @param[in] untrustedcerts The untrusted CA certificates to be used in verifying a certificate chain
+ * @param[out] ppcert_chain_list The pointer to a newly created certificate chain's handle \n
+ * If an error occurs, @a *ppcert_chain_list will be null.
*
- * @return 0 on success and the signature is valid, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_VERIFICATION_FAILED the certificate chain is not valid
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_INVALID_FORMAT the format of certificate is not valid.
+ * @return @c 0 on success and the signature is valid,
+ * otherwise a negative error value
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_VERIFICATION_FAILED The certificate chain is not valid
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_INVALID_FORMAT The format of certificate is not valid
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
+ *
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_get_cert_chain_with_alias())
* @see ckmc_cert_list_all_free()
*/
-int ckmc_get_cert_chain(const ckmc_cert *cert, const ckmc_cert_list *untrustedcerts, ckmc_cert_list **ppcert_chain_list);
+int ckmc_get_cert_chain(const ckmc_cert_s *cert, const ckmc_cert_list_s *untrustedcerts, ckmc_cert_list_s **ppcert_chain_list);
/**
- * @brief Verify a certificate chain using a alias list of untrusted certificates and return that chain.
+ * @brief Verifies a certificate chain using an alias list of untrusted certificates and return that chain.
*
* @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/keymanager
*
* @remarks The trusted root certificate of the chain should exist in the system's certificate storage.
- * @remarks A newly created ppcert_chain_list should be destroyed by calling ckmc_cert_list_all_free() if it is no longer needed.
+ * @remarks You must destroy the newly created @a ppcert_chain_list by calling ckmc_cert_list_all_free() if it is no longer needed.
+ *
+ * @param[in] cert The certificate to be verified
+ * @param[in] untrustedcerts The alias list of untrusted CA certificates stored in key manager to be used in verifying a certificate chain
+ * @param[out] ppcert_chain_list The pointer to a newly created certificate chain's handle \n
+ * If an error occurs, @a *ppcert_chain_list will be null.
*
- * @param[in] cert is the certificate to be verified
- * @param[in] untrustedcerts is an alias list of untrusted CA certificates stored in key manager to be used in verifying a certificate chain.
- * @param[out] ppcert_chain_list is a pointer to a newly created certificate chain's handle. If an error occurs, *ppcert_chain_list will be null.
+ * @return @c 0 on success and the signature is valid,
+ * otherwise a negative error value
*
- * @return 0 on success and the signature is valid, otherwise a negative error value
- * @exception #CKMC_API_SUCCESS Successful
- * @exception #CKMC_API_ERROR_VERIFICATION_FAILED the certificate chain is not valid
- * @exception #CKMC_API_ERROR_INPUT_PARAM input parameter is invalid
- * @exception #CKMC_API_ERROR_DB_LOCKED a user key is not loaded in memory(a user is not logged in)
- * @exception #CKMC_API_ERROR_DB_ALIAS_UNKNOWN alias doesn't exists.
- * @exception #CKMC_API_ERROR_INVALID_FORMAT the format of certificate is not valid.
+ * @retval #CKMC_ERROR_NONE Successful
+ * @retval #CKMC_ERROR_VERIFICATION_FAILED The certificate chain is not valid
+ * @retval #CKMC_ERROR_INVALID_PARAMETER Input parameter is invalid
+ * @retval #CKMC_ERROR_DB_LOCKED A user key is not loaded in memory (a user is not logged in)
+ * @retval #CKMC_ERROR_DB_ALIAS_UNKNOWN Alias does not exist
+ * @retval #CKMC_ERROR_INVALID_FORMAT The format of certificate is not valid
+ * @retval #CKMC_ERROR_PERMISSION_DENIED Failed to access key manager
*
- * @pre User must be already logged in and his user key is already loaded into memory in plain text form.
+ * @pre User is already logged in and the user key is already loaded into memory in plain text form.
*
* @see ckmc_get_cert_chain())
* @see ckmc_cert_list_all_free()
*/
-int ckmc_get_cert_chain_with_alias(const ckmc_cert *cert, const ckmc_alias_list *untrustedcerts, ckmc_cert_list **ppcert_chain_list);
+int ckmc_get_cert_chain_with_alias(const ckmc_cert_s *cert, const ckmc_alias_list_s *untrustedcerts, ckmc_cert_list_s **ppcert_chain_list);
#ifdef __cplusplus
projects / platform / core / security / key-manager.git / blobdiff