*
* @since_tizen 3.0
*
- * @remarks @a ckmc_owner_id_system constains id connected with all system applications
+ * @remarks #ckmc_owner_id_system constains id connected with all system applications
* that run with uid less than 5000.
- * @remarks Client should use @a ckmc_owner_id_system to access data owned by system
+ * @remarks Client should use #ckmc_owner_id_system to access data owned by system
* application and stored in system database.
* @remarks Client must have permission to access proper row.
*
* @brief Handle for algorithm parameter list.
* @since_tizen 3.0
*
- * Each parameter list must have at least one CKMC_PARAM_ALGO_TYPE parameter that identifies the
- * algorithm. See #ckmc_algo_type_e for available algorithms and additional parameters they support.
+ * @remarks Each parameter list must have at least one CKMC_PARAM_ALGO_TYPE parameter that identifies the
+ * algorithm.
+ * @remarks See #ckmc_algo_type_e for available algorithms and additional parameters they support.
*
* @see ckmc_generate_new_params()
* @see ckmc_param_list_new()
*
* @param[in] owner_id Data owner's id. This should be package id if data owner is
* application. If you want to access data stored by system
- * services, it should be @a ckmc_owner_id_system
+ * services, it should be #ckmc_owner_id_system
* @param[in] alias Data alias
* @param[out] full_alias The newly created alias which is a concatenation of
- * @a owner_id, @a ckmc_owner_id_separator and @a alias.
+ * @a owner_id, #ckmc_owner_id_separator and @a alias.
* Destroy by free() after use
*
* @return #CKMC_ERROR_NONE on success, otherwise a negative error value
int ckmc_alias_new(const char *owner_id, const char *alias, char **full_alias);
/**
- * @brief Creates a new @a ckmc_key_s handle and returns it.
+ * @brief Creates a new #ckmc_key_s handle and returns it.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must destroy the newly created @a ckmc_key_s by calling ckmc_key_free() if it is no
+ * @remarks You must destroy the newly created #ckmc_key_s by calling ckmc_key_free() if it is no
* longer needed.
*
* @param[in] raw_key The byte array of key \n
* @param[in] key_type The @a raw_key's type
* @param[in] password The byte array used to decrypt @a raw_key inside key manager \n
* If @a raw_key is not encrypted, @a password can be null
- * @param[out] ppkey The pointer to a newly created @a ckmc_key_s handle
+ * @param[out] ppkey The pointer to a newly created #ckmc_key_s handle
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
char *password, ckmc_key_s **ppkey);
/**
- * @brief Destroys the @a ckmc_key_s handle and releases all its resources.
+ * @brief Destroys the #ckmc_key_s handle and releases all its resources.
*
* @since_tizen 2.3
*
- * @param[in] key The @a ckmc_key_s handle to destroy
+ * @param[in] key The #ckmc_key_s handle to destroy
*
*/
void ckmc_key_free(ckmc_key_s *key);
/**
- * @brief Creates a new @a ckmc_raw_buffer_s handle and returns it.
+ * @brief Creates a new #ckmc_raw_buffer_s handle and returns it.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must destroy the newly created @a ckmc_raw_buffer_s by calling ckmc_buffer_free() if
+ * @remarks You must destroy the newly created #ckmc_raw_buffer_s by calling ckmc_buffer_free() if
* it is no longer needed.
*
* @param[in] data The byte array of buffer
* @param[in] size The byte size of buffer
- * @param[out] ppbuffer The pointer to a newly created @a ckmc_buffer_s handle
+ * @param[out] ppbuffer The pointer to a newly created #ckmc_raw_buffer_s handle
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
ckmc_raw_buffer_s **ppbuffer);
/**
- * @brief Destroys the @a ckmc_raw_buffer_s handle and releases all its resources.
+ * @brief Destroys the #ckmc_raw_buffer_s handle and releases all its resources.
*
* @since_tizen 2.3
*
- * @param[in] buffer The @a ckmc_raw_buffer_s structure to destroy
+ * @param[in] buffer The #ckmc_raw_buffer_s structure to destroy
*
*/
void ckmc_buffer_free(ckmc_raw_buffer_s *buffer);
/**
- * @brief Creates a new @a ckmc_cert_s handle and returns it.
+ * @brief Creates a new #ckmc_cert_s handle and returns it.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must destroy the newly created @a ckmc_cert_s by calling ckmc_cert_free() if it is
+ * @remarks You must destroy the newly created #ckmc_cert_s by calling ckmc_cert_free() if it is
* no longer needed.
*
* @param[in] raw_cert The byte array of certificate
* @param[in] cert_size The byte size of raw_cert
* @param[in] data_format The encoding format of raw_cert
- * @param[out] ppcert The pointer to a newly created @a ckmc_cert_s handle
+ * @param[out] ppcert The pointer to a newly created #ckmc_cert_s handle
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
ckmc_cert_s **ppcert);
/**
- * @brief Destroys the @a ckmc_cert handle and releases all its resources.
+ * @brief Destroys the #ckmc_cert_s handle and releases all its resources.
*
* @since_tizen 2.3
*
- * @param[in] cert The @a ckmc_cert_s handle to destroy
+ * @param[in] cert The #ckmc_cert_s handle to destroy
*
* @see ckmc_load_cert_from_file()
*/
void ckmc_cert_free(ckmc_cert_s *cert);
/**
- * @brief Creates a new @a ckmc_cert_s handle from a given file and returns it.
+ * @brief Creates a new #ckmc_cert_s handle from a given file and returns it.
*
* @since_tizen 2.3
*
- * @remarks You must destroy the newly created @a ckmc_cert_s by calling ckmc_cert_free() if it is
+ * @remarks You must destroy the newly created #ckmc_cert_s by calling ckmc_cert_free() if it is
* no longer needed.
*
* @param[in] file_path The path of certificate file to be loaded \n
* The only DER or PEM encoded certificate file is supported
- * @param[out] cert The pointer of newly created @a ckmc_cert_s handle
+ * @param[out] cert The pointer of newly created #ckmc_cert_s handle
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
int ckmc_load_cert_from_file(const char *file_path, ckmc_cert_s **cert);
/**
- * @brief Creates a new @a ckmc_pkcs12_s handle and returns it.
+ * @brief Creates a new #ckmc_pkcs12_s handle and returns it.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must destroy the newly created @a ckmc_pkcs12_s by calling ckmc_pkcs12_free() if it
+ * @remarks You must destroy the newly created #ckmc_pkcs12_s by calling ckmc_pkcs12_free() if it
* is no longer needed.
* @remarks On success, private_key, cert && ca_cert_list ownership is transferred into newly
* returned ckmc_pkcs12_s.
*
- * @param[in] private_key @a ckmc_key_s handle to the private key (optional)
- * @param[in] cert @a ckmc_cert_s handle to the certificate (optional)
- * @param[in] ca_cert_list @a ckmc_cert_list_s list of chain certificate handles (optional)
- * @param[out] pkcs12_bundle The pointer to a newly created @a ckmc_pkcs12_s handle
+ * @param[in] private_key #ckmc_key_s handle to the private key (optional)
+ * @param[in] cert #ckmc_cert_s handle to the certificate (optional)
+ * @param[in] ca_cert_list #ckmc_cert_list_s list of chain certificate handles (optional)
+ * @param[out] pkcs12_bundle The pointer to a newly created #ckmc_pkcs12_s handle
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
/**
* @deprecated Deprecated since @if MOBILE 2.4. @elseif WEARABLE 3.0. @endif [Use ckmc_pkcs12_load() instead]
- * @brief Creates a new @a ckmc_key_s(private key), @a ckmc_cert_s(certificate), and
- * @a ckmc_cert_list_s(CA certificates) handle from a given PKCS#12 file and returns them.
+ * @brief Creates a new #ckmc_key_s (@a private_key), #ckmc_cert_s (@a cert), and
+ * #ckmc_cert_list_s (@a ca_cert_list) handle from a given PKCS#12 file and returns them.
*
* @since_tizen 2.3
*
- * @remarks You must destroy the newly created @a ckmc_key_s, @a ckmc_cert_s, and
- * @a ckmc_cert_list_s by calling ckmc_key_free(), ckmc_cert_free(), and
+ * @remarks You must destroy the newly created #ckmc_key_s, #ckmc_cert_s, and
+ * #ckmc_cert_list_s by calling ckmc_key_free(), ckmc_cert_free(), and
* ckmc_cert_list_all_free() if they are no longer needed.
*
* @param[in] file_path The path of PKCS12 file to be loaded
* @param[in] passphrase The passphrase used to decrypt the PCKS12 file \n
* If PKCS12 file is not encrypted, passphrase can be null
- * @param[out] private_key The pointer of newly created @a ckmc_key_s handle for a private key
- * @param[out] cert The pointer of newly created @a ckmc_cert_s handle for a certificate \n
+ * @param[out] private_key The pointer of newly created #ckmc_key_s handle for a private key
+ * @param[out] cert The pointer of newly created #ckmc_cert_s handle for a certificate \n
* It is null if the PKCS12 file does not contain a certificate
- * @param[out] ca_cert_list The pointer of newly created @a ckmc_cert_list_s handle for CA
+ * @param[out] ca_cert_list The pointer of newly created #ckmc_cert_list_s handle for CA
* certificates \n
* It is null if the PKCS12 file does not contain CA certificates
*
TIZEN_DEPRECATED_API;
/**
- * @brief Creates a new @a ckmc_pkcs12_s handle from a given PKCS#12 file and returns it.
+ * @brief Creates a new #ckmc_pkcs12_s handle from a given PKCS#12 file and returns it.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must destroy the newly created @a ckmc_pkcs12_s by calling ckmc_pkcs12_free() if
+ * @remarks You must destroy the newly created #ckmc_pkcs12_s by calling ckmc_pkcs12_free() if
* they are no longer needed.
*
- * @param[in] file_path The path of PKCS12 file to be loaded
- * @param[in] passphrase The passphrase used to decrypt the PCKS12 file \n
- * If PKCS12 file is not encrypted, passphrase can be null
- * @param[out] ca_cert_list The pointer of newly created @a ckmc_cert_list_s handle for CA
- * certificates \n
- * It is null if the PKCS12 file does not contain CA certificates
+ * @param[in] file_path The path of PKCS12 file to be loaded
+ * @param[in] passphrase The passphrase used to decrypt the PCKS12 file \n
+ * If PKCS12 file is not encrypted, passphrase can be null
+ * @param[out] pkcs12_bundle The pointer of newly created #ckmc_cert_list_s handle for CA
+ * certificates \n
+ * It is null if the PKCS12 file does not contain CA certificates
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
ckmc_pkcs12_s **pkcs12_bundle);
/**
- * @brief Destroys the @a ckmc_pkcs12_s handle and releases all its resources.
+ * @brief Destroys the #ckmc_pkcs12_s handle and releases all its resources.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] pkcs12 The @a ckmc_pkcs12_s handle to destroy
+ * @param[in] pkcs12 The #ckmc_pkcs12_s handle to destroy
*
* @see ckmc_pkcs12_new()
* @see ckmc_pkcs12_load()
void ckmc_pkcs12_free(ckmc_pkcs12_s *pkcs12);
/**
- * @brief Creates a new @a ckmc_alias_list_s handle and returns it.
- * The alias pointer in the returned @a ckmc_alias_list_s handle points to the provided
+ * @brief Creates a new #ckmc_alias_list_s handle and returns it.
+ * The alias pointer in the returned #ckmc_alias_list_s handle points to the provided
* characters and next is null.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must destroy the newly created @a ckmc_alias_list_s
+ * @remarks You must destroy the newly created #ckmc_alias_list_s
* by calling ckmc_alias_list_free() or ckmc_alias_list_all_free() if it is no longer
* needed.
*
- * @param[in] alias The first item to be set in the newly created @a ckmc_alias_list_s
- * @param[out] ppalias_list The pointer to a newly created @a ckmc_alias_list_s handle
+ * @param[in] alias The first item to be set in the newly created #ckmc_alias_list_s
+ * @param[out] ppalias_list The pointer to a newly created #ckmc_alias_list_s handle
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
int ckmc_alias_list_new(char *alias, ckmc_alias_list_s **ppalias_list);
/**
- * @brief Creates a new @a ckmc_alias_list_s handle, adds it to a previous @a ckmc_alias_list_s and
- * returns it. The alias pointer in the returned @a ckmc_alias_list_s handle points to the
+ * @brief Creates a new #ckmc_alias_list_s handle, adds it to a previous #ckmc_alias_list_s and
+ * returns it. The alias pointer in the returned #ckmc_alias_list_s handle points to the
* provided characters and next is null.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] previous The last @a ckmc_alias_list_s handle to which a newly created
- * @a ckmc_alias_list_s is added
- * @param[in] alias The item to be set in the newly created @a ckmc_alias_list_s
- * @param[out] pplast The pointer to a newly created and added @a ckmc_alias_list_s handle
+ * @param[in] previous The last #ckmc_alias_list_s handle to which a newly created
+ * #ckmc_alias_list_s is added
+ * @param[in] alias The item to be set in the newly created #ckmc_alias_list_s
+ * @param[out] pplast The pointer to a newly created and added #ckmc_alias_list_s handle
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
ckmc_alias_list_s **pplast);
/**
- * @brief Destroys the @a ckmc_alias_list_s handle and releases resources of @a ckmc_alias_list_s
+ * @brief Destroys the #ckmc_alias_list_s handle and releases resources of #ckmc_alias_list_s
* from the provided first handle cascadingly.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks It does not destroy an alias itself in @a ckmc_alias_list_s.
+ * @remarks It does not destroy an alias itself in #ckmc_alias_list_s.
*
- * @param[in] first The first @a ckmc_alias_list_s handle to destroy
+ * @param[in] first The first #ckmc_alias_list_s handle to destroy
*
* @see ckmc_alias_list_all_free()
* @see #ckmc_alias_list_s
void ckmc_alias_list_free(ckmc_alias_list_s *first);
/**
- * @brief Destroys the @a ckmc_alias_list_s handle and releases all its resources from the provided
+ * @brief Destroys the #ckmc_alias_list_s handle and releases all its resources from the provided
* first handle cascadingly.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks It also destroys the alias in @a ckmc_alias_list_s.
+ * @remarks It also destroys the alias in #ckmc_alias_list_s.
*
- * @param[in] first The first @a ckmc_alias_list_s handle to destroy
+ * @param[in] first The first #ckmc_alias_list_s handle to destroy
*
* @see #ckmc_alias_list_s
*/
void ckmc_alias_list_all_free(ckmc_alias_list_s *first);
/**
- * @brief Creates a new @a ckmc_cert_list_s handle and returns it.
- * The cert pointer in the returned @a ckmc_cert_list_s handle points to the provided
- * @a ckmc_cert_s and next is null.
+ * @brief Creates a new #ckmc_cert_list_s handle and returns it.
+ * The cert pointer in the returned #ckmc_cert_list_s handle points to the provided
+ * #ckmc_cert_s and next is null.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must destroy the newly created @a ckmc_cert_list_s by calling ckmc_cert_list_free()
+ * @remarks You must destroy the newly created #ckmc_cert_list_s by calling ckmc_cert_list_free()
* or ckmc_cert_list_all_free() if it is no longer needed.
*
- * @param[in] cert The first item to be set in the newly created @a ckmc_cert_list_s
- * @param[out] ppalias_list The pointer to a newly created @a ckmc_alias_list_s handle
+ * @param[in] cert The first item to be set in the newly created #ckmc_cert_list_s
+ * @param[out] ppalias_list The pointer to a newly created #ckmc_alias_list_s handle
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
int ckmc_cert_list_new(ckmc_cert_s *cert, ckmc_cert_list_s **ppalias_list);
/**
- * @brief Creates a new @a ckmc_cert_list_s handle, adds it to a previous @a ckmc_cert_list_s and
- * returns it. The cert pointer in the returned @a ckmc_alias_list_s handle points to the
- * provided @a ckmc_cert_s and next is null.
+ * @brief Creates a new #ckmc_cert_list_s handle, adds it to a previous #ckmc_cert_list_s and
+ * returns it. The cert pointer in the returned #ckmc_alias_list_s handle points to the
+ * provided #ckmc_cert_s and next is null.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] previous The last @a ckmc_cert_list_s handle to which a newly created
- * @a ckmc_cert_list_s is added
- * @param[in] cert The item to be set in the newly created @a ckmc_cert_list_s
- * @param[out] pplast The pointer to a newly created and added @a ckmc_alias_list_s handle
+ * @param[in] previous The last #ckmc_cert_list_s handle to which a newly created
+ * #ckmc_cert_list_s is added
+ * @param[in] cert The item to be set in the newly created #ckmc_cert_list_s
+ * @param[out] pplast The pointer to a newly created and added #ckmc_alias_list_s handle
*
* @return #CKMC_ERROR_NONE on success,
* otherwise a negative error value
ckmc_cert_list_s **pplast);
/**
- * @brief Destroys the @a ckmc_cert_list_s handle and releases resources of @a ckmc_cert_list_s
+ * @brief Destroys the #ckmc_cert_list_s handle and releases resources of #ckmc_cert_list_s
* from the provided first handle cascadingly.
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks It does not destroy @a ckmc_cert_s itself in @a ckmc_cert_list_s.
+ * @remarks It does not destroy #ckmc_cert_s itself in #ckmc_cert_list_s.
*
- * @param[in] first The first @a ckmc_cert_list_s handle to destroy
+ * @param[in] first The first #ckmc_cert_list_s handle to destroy
*
* @see ckmc_cert_list_all_free()
* @see #ckmc_cert_list_s
void ckmc_cert_list_free(ckmc_cert_list_s *first);
/**
- * @brief Destroys the @a ckmc_cert_list_s handle and releases all its resources from the provided
+ * @brief Destroys the #ckmc_cert_list_s handle and releases all its resources from the provided
* first handle cascadingly.
*
* @since_tizen 2.3
*
- * @remarks It also destroys @a ckmc_cert_s in @a ckmc_cert_list_s.
+ * @remarks It also destroys #ckmc_cert_s in #ckmc_cert_list_s.
*
- * @param[in] first The first @a ckmc_cert_list_s handle to destroy
+ * @param[in] first The first #ckmc_cert_list_s handle to destroy
*
* @see #ckmc_cert_list_s
*/
*
* @since_tizen 3.0
*
- * @remarks Caller is responsible for @a ckmc_param_list_h creation.
+ * @remarks Caller is responsible for #ckmc_param_list_h creation.
*
* @param[in] params Algorithm param list handle created with
* ckmc_param_list_new() or ckmc_generate_new_params() \n
*
* @since_tizen 3.0
*
- * @remarks Caller is responsible for @a ckmc_param_list_h creation.
+ * @remarks Caller is responsible for #ckmc_param_list_h creation.
*
* @param[in] params Algorithm param list handle created with
* ckmc_param_list_new() or ckmc_generate_new_params()
*
* @since_tizen 3.0
*
- * @remarks Caller is responsible for @a ckmc_param_list_h creation.
+ * @remarks Caller is responsible for #ckmc_param_list_h creation.
*
* @param[in] params Algorithm param list handle created with
* ckmc_param_list_new() or ckmc_generate_new_params()
*
* @since_tizen 3.0
*
- * @remarks Caller is responsible for @a ckmc_param_list_h creation.
+ * @remarks Caller is responsible for #ckmc_param_list_h creation.
*
* @param[in] params Algorithm param list handle created with
* ckmc_param_list_new() or ckmc_generate_new_params()
*
* @since_tizen 3.0
*
- * @param[in] first First element of the list to be freed
+ * @param[in] params First element of the list to be freed
*
* @see ckmc_param_list_new()
* @see ckmc_param_list_set_integer()
*
* @since_tizen 3.0
*
- * @remarks Caller is responsible for @a ckmc_param_list_h destruction.
+ * @remarks Caller is responsible for #ckmc_param_list_h destruction.
* @remarks Algorithm parameters are set to default values. Optional fields are left empty.
* Initialization vectors are left empty (they have to be set manually). Caller is
* responsible for freeing the list with ckmc_param_list_free().
projects / platform / core / security / key-manager.git / commitdiff