From: Sungbae Yoo Date: Thu, 30 Mar 2017 07:27:09 +0000 (+0900) Subject: Fix wrong comments about tizen version to start including X-Git-Tag: submit/tizen/20170411.020854~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6b78910f8c8ffe555b9338df2001848d593d45c5;p=platform%2Fcore%2Fsecurity%2Fode.git Fix wrong comments about tizen version to start including Signed-off-by: Sungbae Yoo Change-Id: If1e2554772b4ecd609469332cfccd7cff50e2a63 --- diff --git a/lib/ode/common.h b/lib/ode/common.h index 20ad83b..683b7ce 100644 --- a/lib/ode/common.h +++ b/lib/ode/common.h @@ -47,7 +47,7 @@ extern "C" { /** * @brief Enumeration of device encryption API errors - * @since_tizen 3.0 + * @since_tizen 4.0 */ typedef enum { ODE_ERROR_NONE = TIZEN_ERROR_NONE, /**< The operation was successful */ @@ -66,17 +66,17 @@ typedef enum { /* * @brief Enumeration for encryption state - * @since_tizen 3.0 + * @since_tizen 4.0 */ typedef enum { ODE_STATE_UNENCRYPTED = 0x00, /**< Device is not encrypted */ ODE_STATE_ENCRYPTED = 0x01, /**< Device is encrypted */ - ODE_STATE_CORRUPTED = 0x02 /**< Devoce is corrupted because of encryption error */ + ODE_STATE_CORRUPTED = 0x02 /**< Device is corrupted because of encryption error */ } ode_state_e; /** * @brief Called when internal storage is mounted with encryption - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] user_data The user data passed from * ode_internal_encryption_set_mount_event_cb() or * ode_external_encryption_set_mount_event_cb(). diff --git a/lib/ode/external-encryption.h b/lib/ode/external-encryption.h index e56902e..28a8548 100644 --- a/lib/ode/external-encryption.h +++ b/lib/ode/external-encryption.h @@ -33,7 +33,7 @@ extern "C" { * @brief Set a password to be used by mount of encrypted external storage * @details Administrator can use this API to set a password for external * mount external storage with encryption. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to mount external storage * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -53,7 +53,7 @@ ODE_API int ode_external_encryption_set_mount_password(const char* password); * @brief Mount external storage with encryption * @details Administrator can use this API to mount encrypted external * storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful * @retval #ODE_ERROR_INVALID_PARAMETER Invalid parameter @@ -72,7 +72,7 @@ ODE_API int ode_external_encryption_mount(); /** * @brief Umount external storage * @details Administrator can use this API to unmount external storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful * @retval #ODE_ERROR_INVALID_PARAMETER Invalid parameter @@ -87,7 +87,7 @@ ODE_API int ode_external_encryption_umount(); /** * @brief Encrypt external storage by given password. * @details Administrator can use this API to encrypt external storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to encrypt external storage * @param[in] options Encryption options * @return #ODE_ERROR_NONE on success, otherwise a negative value @@ -108,7 +108,7 @@ ODE_API int ode_external_encryption_encrypt(const char* password, unsigned int o /** * @brief Decrypt external storage by given password. * @details Administrator can use this API to decrypt external storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to decrypt external storage * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -130,7 +130,7 @@ ODE_API int ode_external_encryption_decrypt(const char* password); * storage when the password is missing or the encryption is * corrupted. Note that this API will be erase all the contents * in external storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful * @retval #ODE_ERROR_INVALID_PARAMETER Invalid parameter @@ -147,7 +147,7 @@ ODE_API int ode_external_encryption_recovery(); * @details Administrator can use this API to check if the password that will be used for external storage encryption/decryption exists. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[out] result Whether encryption password was created * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -165,7 +165,7 @@ ODE_API int ode_external_encryption_is_password_initialized(bool* result); * @brief Initialize external encryption password to given password * @details Administrator can use this API to set new password that will be used for external storage encryption/decryption. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to set * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -186,7 +186,7 @@ ODE_API int ode_external_encryption_init_password(const char* password); * @brief Remove external encryption password * @details Administrator can use this API to delete password that was set by ode_external_encryption_init_password(). - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to delete * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -206,7 +206,7 @@ ODE_API int ode_external_encryption_clean_password(const char* password); * @brief Change the password for external storage. * @details Administrator can use this API to change password for external * storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] old_password Current password of external storage * @param[in] new_password The password to use newly for external storage * @return #ODE_ERROR_NONE on success, otherwise a negative value @@ -228,7 +228,7 @@ ODE_API int ode_external_encryption_change_password(const char* old_password, * @brief Verify if given password is external encryption password. * @details Administrator can use this API to find if a password is used by external encryption - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[int] password The password to be verified * @param[out] result The result of verification * @return #ODE_ERROR_NONE on success, otherwise a negative value @@ -247,7 +247,7 @@ ODE_API int ode_external_encryption_verify_password(const char* password, bool* * @brief Get current encryption state of external storage. * @details Administrator can use this API to get current encryption state * of external storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[out] state The encryption state of external storage * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -262,7 +262,7 @@ ODE_API int ode_external_encryption_get_state(int* state); /* * @brief Enumeration for external encryption options - * @since_tizen 3.0 + * @since_tizen 4.0 */ typedef enum { ODE_OPTION_EXTERNAL_ONLY_NEW_FILE = 1 << 0, /**< Encrypt new files only */ @@ -273,7 +273,7 @@ typedef enum { * @brief Get supported options for encryption of external storage. * @details Administrator can use this API to get which options are supported for encryption of external storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[out] option The logical OR of supported options in external storage * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -289,7 +289,7 @@ ODE_API int ode_external_encryption_get_supported_options(unsigned int* options) * @brief Register a callback to get mount event of internal storage * @details Services can use this API to attach a callback to be called * by mount event of internal storage with encryption. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] callback The mount event callback function * @param[in] user_data The user data passed to the callback function * @return #ODE_ERROR_NONE on success, otherwise a negative value @@ -308,7 +308,7 @@ ODE_API int ode_external_encryption_set_mount_event_cb(ode_mount_event_cb callba * @brief Unregister a callback to get mount event of internal storage * @details Services can use this API to detach a callback to be called * by mount event of internal storage with encryption. - * @since_tizen 3.0 + * @since_tizen 4.0 * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful * @retval #ODE_ERROR_TIMED_OUT Time out diff --git a/lib/ode/internal-encryption.h b/lib/ode/internal-encryption.h index e5f1cdb..8fe1843 100644 --- a/lib/ode/internal-encryption.h +++ b/lib/ode/internal-encryption.h @@ -32,7 +32,7 @@ extern "C" { * @brief Set a password to be used by mount of encrypted internal storage * @details Administrator can use this API to set a password for internal * mount internal storage with encryption. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to mount internal storage * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -52,7 +52,7 @@ ODE_API int ode_internal_encryption_set_mount_password(const char* password); * @brief Mount internal storage with encryption * @details Administrator can use this API to mount encrypted internal * storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful * @retval #ODE_ERROR_INVALID_PARAMETER Invalid parameter @@ -71,7 +71,7 @@ ODE_API int ode_internal_encryption_mount(); /** * @brief Umount internal storage * @details Administrator can use this API to unmount internal storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful * @retval #ODE_ERROR_INVALID_PARAMETER Invalid parameter @@ -86,7 +86,7 @@ ODE_API int ode_internal_encryption_umount(); /** * @brief Encrypt internal storage by given password. * @details Administrator can use this API to encrypt internal storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to encrypt internal storage * @param[in] options Encryption options * @return #ODE_ERROR_NONE on success, otherwise a negative value @@ -109,7 +109,7 @@ ODE_API int ode_internal_encryption_encrypt(const char* password, unsigned int o /** * @brief Decrypt internal storage by given password. * @details Administrator can use this API to decrypt internal storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to decrypt internal storage * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -131,7 +131,7 @@ ODE_API int ode_internal_encryption_decrypt(const char* password); * storage when the password is missing or the encryption is * corrupted. Note that this API will be erase all the contents * in internal storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful * @retval #ODE_ERROR_INVALID_PARAMETER Invalid parameter @@ -148,7 +148,7 @@ ODE_API int ode_intternal_encryption_recovery(); * @details Administrator can use this API to check if the password that will be used for internal storage encryption/decryption exists. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[out] result Whether encryption password was created * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -166,7 +166,7 @@ ODE_API int ode_internal_encryption_is_password_initialized(bool* result); * @brief Initialize internal encryption password to given password * @details Administrator can use this API to set new password that will be used for internal storage encryption/decryption. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to set * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -187,7 +187,7 @@ ODE_API int ode_internal_encryption_init_password(const char* password); * @brief Remove internal encryption password * @details Administrator can use this API to delete password that was set by ode_internal_encryption_init_password(). - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to delete * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -207,7 +207,7 @@ ODE_API int ode_internal_encryption_clean_password(const char* password); * @brief Change the password for internal storage. * @details Administrator can use this API to change password for internal * storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] old_password Current password of internal storage * @param[in] new_password The password to use newly for internal storage * @return #ODE_ERROR_NONE on success, otherwise a negative value @@ -229,7 +229,7 @@ ODE_API int ode_internal_encryption_change_password(const char* old_password, * @brief Verify if given password is internal encryption password. * @details Administrator can use this API to find if a password is used by internal encryption - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] password The password to be verified * @param[out] result The result of verification * @return #ODE_ERROR_NONE on success, otherwise a negative value @@ -249,7 +249,7 @@ ODE_API int ode_internal_encryption_verify_password(const char* password, bool* * @brief Get current encryption state of internal storage. * @details Administrator can use this API to get current encryption state * of internal storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[out] state The encryption state of internal storage * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -264,7 +264,7 @@ ODE_API int ode_internal_encryption_get_state(int* state); /* * @brief Enumeration for internal encryption options - * @since_tizen 3.0 + * @since_tizen 4.0 */ typedef enum { ODE_OPTION_INTERNAL_INCLUDE_UNUSED_REGION = 1 << 0, /**< Encrypt all include unused region */ @@ -274,7 +274,7 @@ typedef enum { * @brief Get supported options for encryption of internal storage. * @details Administrator can use this API to get which options are supported for encryption of internal storage. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[out] option The logical OR of supported options in internal storage * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -290,7 +290,7 @@ ODE_API int ode_internal_encryption_get_supported_options(unsigned int* options) * @brief Register a callback to get mount event of internal storage * @details Services can use this API to attach a callback to be called * by mount event of internal storage with encryption. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] callback The mount event callback function * @param[in] user_data The user data passed to the callback function * @return #ODE_ERROR_NONE on success, otherwise a negative value @@ -308,7 +308,7 @@ ODE_API int ode_internal_encryption_set_mount_event_cb(ode_mount_event_cb callba * @brief Unregister a callback to get mount event of internal storage * @details Services can use this API to detach a callback to be called * by mount event of internal storage with encryption. - * @since_tizen 3.0 + * @since_tizen 4.0 * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful * @retval #ODE_ERROR_TIMED_OUT Time out diff --git a/lib/ode/secure-erase.h b/lib/ode/secure-erase.h index 3e6b4b7..8fb8c6d 100644 --- a/lib/ode/secure-erase.h +++ b/lib/ode/secure-erase.h @@ -31,7 +31,7 @@ extern "C" { /** * @brief Erase the file or device with given name securely. * @details Administrator can use this API to secure-erase the files. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] name The file/directory or device name * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful @@ -49,7 +49,7 @@ ODE_API int ode_secure_erase(const char* name); /** * @brief Clean garbage in the device with given name securely. * @details Administrator can use this API to collect garbage in the device. - * @since_tizen 3.0 + * @since_tizen 4.0 * @param[in] name The device name * @return #ODE_ERROR_NONE on success, otherwise a negative value * @retval #ODE_ERROR_NONE Successful