X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=src%2Finclude%2Fprivilege_information.h;h=429100f3f6ca78c599106dabf9b415c058467152;hb=89500046a7424ffe0c52c3a511199437f86ab437;hp=923be748340ed124e20c9630e9e0f0df8c0d8345;hpb=ec5e522778fc8ba9af14481f181efb988c3567fe;p=platform%2Fcore%2Fsecurity%2Fprivilege-info.git diff --git a/src/include/privilege_information.h b/src/include/privilege_information.h old mode 100755 new mode 100644 index 923be74..429100f --- a/src/include/privilege_information.h +++ b/src/include/privilege_information.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2013 Samsung Electronics Co., Ltd All Rights Reserved + * Copyright (c) 2014-2023 Samsung Electronics Co., Ltd All Rights Reserved * * Licensed under the Apache License, Version 2.0 (the License); * you may not use this file except in compliance with the License. @@ -14,102 +14,209 @@ * limitations under the License. */ -#ifndef __TIZEN_SECURITY_PRIVILEGE_INFO_H -#define __TIZEN_SECURITY_PRIVILEGE_INFO_H + +#ifndef __TIZEN_SECURITY_PRIVILEGE_INFORMATION_H +#define __TIZEN_SECURITY_PRIVILEGE_INFORMATION_H + #include +#include + +#ifndef TIZEN_DEPRECATED_API +#define TIZEN_DEPRECATED_API __attribute__ ((__visibility__("default"), deprecated)) +#endif #ifdef __cplusplus extern "C" { #endif + /** * @addtogroup CAPI_SECURITY_FRAMEWORK_PRIVILEGE_INFO_MODULE * @{ */ + /** - * @brief Enumerations of error code for Privilege Information. - * @since_tizen 2.3 + * @brief Enumeration for error code for Privilege Information. + * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif */ -typedef enum -{ - PRVINFO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ - PRVINFO_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid function parameter */ - PRVINFO_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ - PRVINFO_ERROR_INTERNAL_ERROR = TIZEN_ERROR_UNKNOWN, /**< Unknown error */ +typedef enum { + PRVINFO_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + PRVINFO_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid function parameter */ + PRVINFO_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ + PRVINFO_ERROR_INTERNAL_ERROR = TIZEN_ERROR_UNKNOWN, /**< Unknown error */ + PRVINFO_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< @deprecated Not supported (Deprecated since 7.5) */ + PRVINFO_ERROR_NO_MATCHING_PRIVILEGE = TIZEN_ERROR_PRIVILEGE_INFORMATION | 0x01 /**< No matched privilege (Since 6.0) */ } privilege_info_error_e; /** * @brief Gets the display name of the given privilege. - * @since_tizen 2.3 - * @remarks @a display_name must be released with free() by you. - * @param [in] api_version The version of API - * @param [in] privilege The privilege - * @param [out] display_name The display name of the privilege - * @return 0 on success, otherwise a negative error value. + * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif + * @remarks @a display_name must be released using free(). + * @remarks Since 6.0, this function returns #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege doesn't exist. + * @param[in] api_version The API version of the application to get privilege information + * @param[in] privilege The privilege + * @param[out] display_name The display name of the privilege + * @return @c 0 on success, + * otherwise a negative error value * @retval #PRVINFO_ERROR_NONE Successful + * @retval #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE No matched privilege * @retval #PRVINFO_ERROR_OUT_OF_MEMORY Out of memory * @retval #PRVINFO_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #PRVINFO_ERROR_INTERNAL_ERROR Unknown error */ -int privilege_info_get_display_name(const char* api_version, const char* privilege, char **display_name); +int privilege_info_get_display_name(const char *api_version, const char *privilege, char **display_name); + /** * @brief Gets the display name of the given privilege. - * @since_tizen 2.3 - * @remarks @a display_name must be released with free() by you. - * @remarks package_type must be one of followings: PRVINFO_PACKAGE_TYPE_NATIVE, PRVINFO_PACKAGE_TYPE_WEB - * @param [in] package_type The type of application package - * @param [in] api_version The version of API - * @param [in] privilege The privilege - * @param [out] display_name The display name of the privilege - * @return 0 on success, otherwise a negative error value. + * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif + * @remarks @a display_name must be released using free(). + * @remarks @a package_type must be one of followings: "PRVINFO_PACKAGE_TYPE_NATIVE", "PRVINFO_PACKAGE_TYPE_WEB" + * @remarks Since 6.0, this function returns #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege doesn't exist. + * @param[in] package_type The type of application package + * @param[in] api_version The API version of the application to get privilege information + * @param[in] privilege The privilege + * @param[out] display_name The display name of the privilege + * @return @c 0 on success, + * otherwise a negative error value * @retval #PRVINFO_ERROR_NONE Successful + * @retval #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE No matched privilege * @retval #PRVINFO_ERROR_OUT_OF_MEMORY Out of memory * @retval #PRVINFO_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #PRVINFO_ERROR_INTERNAL_ERROR Unknown error */ -int privilege_info_get_display_name_by_pkgtype(const char* package_type, const char* api_version, const char* privilege, char **display_name); +int privilege_info_get_display_name_by_pkgtype(const char *package_type, const char *api_version, const char *privilege, char **display_name); + /** * @brief Gets the description of the given privilege. - * @since_tizen 2.3 - * @remarks @a description must be released with free() by you. - * @param [in] api_version The version of API - * @param [in] privilege The privilege - * @param [out] description The description of the privilege - * @return 0 on success, otherwise a negative error value. + * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif + * @remarks @a description must be released using free(). + * @remarks Since 6.0, this function returns #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege doesn't exist. + * @param[in] api_version The API version of the application to get privilege information + * @param[in] privilege The privilege + * @param[out] description The description of the privilege + * @return @c 0 on success, + * otherwise a negative error value * @retval #PRVINFO_ERROR_NONE Successful + * @retval #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE No matched privilege * @retval #PRVINFO_ERROR_OUT_OF_MEMORY Out of memory * @retval #PRVINFO_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #PRVINFO_ERROR_INTERNAL_ERROR Unknown error */ -int privilege_info_get_description(const char* api_version, const char *privilege, char **description); +int privilege_info_get_description(const char *api_version, const char *privilege, char **description); + /** * @brief Gets the description of the given privilege. - * @since_tizen 2.3 - * @remarks @a description must be released with free() by you. - * @remarks package_type must be one of followings: PRVINFO_PACKAGE_TYPE_NATIVE, PRVINFO_PACKAGE_TYPE_WEB - * @param [in] package_type The type of application package - * @param [in] api_version The version of API - * @param [in] privilege The privilege - * @param [out] description The description of the privilege + * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif + * @remarks @a description must be released using free(). + * @remarks @a package_type must be one of followings: "PRVINFO_PACKAGE_TYPE_NATIVE", "PRVINFO_PACKAGE_TYPE_WEB" + * @remarks Since 6.0, this function returns #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE if the given @a privilege doesn't exist. + * @param[in] package_type The type of application package + * @param[in] api_version The API version of the application to get privilege information + * @param[in] privilege The privilege + * @param[out] description The description of the privilege + * @return @c 0 on success, + * otherwise a negative error value + * @retval #PRVINFO_ERROR_NONE Successful + * @retval #PRVINFO_ERROR_NO_MATCHING_PRIVILEGE No matched privilege + * @retval #PRVINFO_ERROR_OUT_OF_MEMORY Out of memory + * @retval #PRVINFO_ERROR_INVALID_PARAMETER Invalid function parameter + * @retval #PRVINFO_ERROR_INTERNAL_ERROR Unknown error + */ +int privilege_info_get_description_by_pkgtype(const char *package_type, const char *api_version, const char *privilege, char **description); + + +/** + * @deprecated Deprecated since 7.5. + * @brief Gets the display name of the privacy group in which the given privilege is included. + * @since_tizen 3.0 + * @remarks @a privacy_name must be released using free(). + * @remarks @a privilege must be privacy related, otherwise #PRVINFO_ERROR_INVALID_PARAMETER is returned. + * @param[in] privilege The privilege + * @param[out] privacy_name The privacy group's display name that the given privilege is included in + * @return @c 0 on success, + * otherwise a negative error value + * @retval #PRVINFO_ERROR_NONE Successful + * @retval #PRVINFO_ERROR_OUT_OF_MEMORY Out of memory + * @retval #PRVINFO_ERROR_INVALID_PARAMETER Invalid function parameter + * @retval #PRVINFO_ERROR_INTERNAL_ERROR Unknown error + * @retval #PRVINFO_ERROR_NOT_SUPPORTED Not supported + */ +int privilege_info_get_privacy_display_name(const char *privilege, char **privacy_name) TIZEN_DEPRECATED_API; + + +/** + * @brief The structure for privilege information. + * @since_tizen 5.5 + */ +typedef struct _privilege_info_s { + char* privilege_name; /**< The privilege name */ + char* display_name; /**< The display name of the privilege */ + char* description; /**< The description of the privilege */ +} privilege_info_s; + +/** + * @brief Enumeration for return code to be sent to consumer. + * @since_tizen 5.5 + */ +typedef enum { + PRIVILEGE_CONSUMER_RETURN_CODE_SUCCESS = 0, /**< Successful */ + PRIVILEGE_CONSUMER_RETURN_CODE_UNKNOWN_LOCALE_CODE, /**< Unknown locale code. */ + PRIVILEGE_CONSUMER_RETURN_CODE_INVALID_PARAMETER, /**< Invalid parameter. */ +} privilege_consumer_return_code_e; + +/** + * @brief Gets the privilege information list of the given locale and privileges. + * @details If the given @a locale is not recognized, @a return_result is set to #PRIVILEGE_CONSUMER_RETURN_CODE_UNKNOWN_LOCALE_CODE and the result in the @a privilege_info_list is provided according to the current locale. If all of the privileges in @a privilege_name_list are invalid then @a return_result is set to #PRIVILEGE_CONSUMER_RETURN_CODE_INVALID_PARAMETER. Otherwise, @a return_result is set to #PRIVILEGE_CONSUMER_RETURN_CODE_SUCCESS. If some of the privileges in @a privilege_name_list are invalid then corresponding elements in the @a privilege_info_list will have the display_name and the description set to an empty string. + * @since_tizen 5.5 + * + * @remarks You must destroy the newly created privilege_info_list by calling privilege_info_free_privilege_info_list() if it is no longer needed. + * + * @param[in] locale The locale information + * @param[in] privilege_name_list The privilege name list + * @param[out] privilege_info_list The privilege information list of the given locale and privileges + * @param[out] return_result The return code to be sent to consumer. + * * @return 0 on success, otherwise a negative error value. - * @retval #PRVINFO_ERROR_NONE Successful + * + * @retval #PRVINFO_ERROR_NONE Successful * @retval #PRVINFO_ERROR_OUT_OF_MEMORY Out of memory * @retval #PRVINFO_ERROR_INVALID_PARAMETER Invalid function parameter * @retval #PRVINFO_ERROR_INTERNAL_ERROR Unknown error + * @see privilege_info_free_privilege_info_list() + * @see privilege_consumer_return_code_e + */ +int privilege_info_get_privilege_info_list(const char* locale, GList* privilege_name_list, GList** privilege_info_list, privilege_consumer_return_code_e* return_result); + +/** + * @brief Destroys the privilege information list. + * @since_tizen 5.5 + * + * @remarks If @a privilege_info_list is NULL, no operation is performed and #PRVINFO_ERROR_INVALID_PARAMETER will be returned. + * + * @param[in] privilege_info_list The privilege information list to destroy + * + * @return 0 on success, otherwise a negative error value. + * + * @retval #PRVINFO_ERROR_NONE Successful + * @retval #PRVINFO_ERROR_INVALID_PARAMETER Invalid function parameter */ -int privilege_info_get_description_by_pkgtype(const char* package_type, const char* api_version, const char *privilege, char **description); +int privilege_info_free_privilege_info_list(GList* privilege_info_list); + + /** * @} */ + #ifdef __cplusplus } #endif -#endif // __TIZEN_SECURITY_PRIVILEGE_INFO_H + +#endif /* __TIZEN_SECURITY_PRIVILEGE_INFORMATION_H */