diff options
author | Sangwan Kwon <sangwan.kwon@samsung.com> | 2019-10-14 15:55:13 +0900 |
---|---|---|
committer | sangwan kwon <sangwan.kwon@samsung.com> | 2019-11-29 04:31:54 +0000 |
commit | cff4f25e70466788cdcea8fbbb322902af7048e5 (patch) | |
tree | 34a9b5ce7cd67922109fa61c792cdd9e3437b953 /src | |
parent | a6b6517c9d512c627e30f3f7ed2d446135f48f23 (diff) | |
download | csr-framework-tizen_5.5.tar.gz csr-framework-tizen_5.5.tar.bz2 csr-framework-tizen_5.5.zip |
Add privilege information to api headerstizen_5.5
Change-Id: I354789b6e38d5f7db575bfa7fa22b585f9289d41
Signed-off-by: Sangwan Kwon <sangwan.kwon@samsung.com>
(cherry picked from commit 9ec7bfea0cebe3eb4fd00bdc01ea9f1200086be2)
Diffstat (limited to 'src')
-rw-r--r-- | src/include/csr/csr-content-screening.h | 42 | ||||
-rw-r--r-- | src/include/csr/csr-web-protection.h | 14 |
2 files changed, 56 insertions, 0 deletions
diff --git a/src/include/csr/csr-content-screening.h b/src/include/csr/csr-content-screening.h index d345806..344a2fe 100644 --- a/src/include/csr/csr-content-screening.h +++ b/src/include/csr/csr-content-screening.h @@ -50,6 +50,8 @@ extern "C" { * @details A Content Screening API handle (or CSR CS handle) is obtained by this method. * The handle is required for subsequent CSR CS API calls. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks @a handle should be released using csr_cs_context_destroy(). * @remarks Multiple handles can be obtained. * @param[out] handle A pointer of CSR CS context handle @@ -68,6 +70,8 @@ int csr_cs_context_create(csr_cs_context_h *handle); * @partner * @brief Releases all system resources associated with a Content Screening API handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @param[in] handle CSR CS context handle returned by csr_cs_context_create() * @return #CSR_ERROR_NONE on success, * otherwise a negative error value @@ -88,6 +92,8 @@ int csr_cs_context_destroy(csr_cs_context_h handle); * User can allow, disallow, and remove detected malware by popup. * Selection can be different between malware's severity. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks This option is disabled(#CSR_CS_ASK_USER_NO) as a default. * @param[in] handle CSR CS context handle returned by csr_cs_context_create() * @param[in] ask_user Popup option to set or unset @@ -108,6 +114,8 @@ int csr_cs_set_ask_user(csr_cs_context_h handle, csr_cs_ask_user_e ask_user); * @brief Sets a popup message of a client in case that a malware is detected. * @details Default message is "Malware which may harm your device is detected." * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks Meaningful only when ask user option is set by csr_cs_set_ask_user(). * @remarks The message will be printed on popup for user. * @remarks Default popup message will be used if it isn't set. @@ -129,6 +137,8 @@ int csr_cs_set_popup_message(csr_cs_context_h handle, const char *message); * @partner * @brief Sets a maximum core usage during scanning. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks If a core usage is not set, #CSR_CS_CORE_USAGE_DEFAULT will be used. * @param[in] handle CSR CS context handle returned by csr_cs_context_create() * @param[in] usage A maximum core usage during scanning @@ -148,6 +158,8 @@ int csr_cs_set_core_usage(csr_cs_context_h handle, csr_cs_core_usage_e usage); * @partner * @brief Sets a scan on cloud option. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks Scan on cloud option is turned off as a default. * @remarks If an engine does not support "scanning on cloud", this option is silently ignored. * @param[in] handle CSR CS context handle returned by csr_cs_context_create() @@ -245,6 +257,8 @@ int csr_cs_scan_file(csr_cs_context_h handle, const char *file_path, csr_cs_malw * @partner * @brief Sets a callback function for the case that a file scan is completed. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks Callback for asynchronous scan functions. * @param[in] handle CSR CS context handle returned by csr_cs_context_create() * @param[in] callback A callback function for each file or application scanning done without any malware. @@ -265,6 +279,8 @@ int csr_cs_set_file_scanned_cb(csr_cs_context_h handle, csr_cs_file_scanned_cb c * @partner * @brief Sets a callback function for detection of a malware. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks Callback for asynchronous scan functions. * @param[in] handle CSR CS context handle returned by csr_cs_context_create() * @param[in] callback A callback function for each file or application scanning done with malware detected @@ -285,6 +301,8 @@ int csr_cs_set_detected_cb(csr_cs_context_h handle, csr_cs_detected_cb callback) * @partner * @brief Sets a callback function for scanning completed without an error. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks Callback for asynchronous scan functions. * @param[in] handle CSR CS context handle returned by csr_cs_context_create() * @param[in] callback A callback function for scanning completed successfully @@ -305,6 +323,8 @@ int csr_cs_set_completed_cb(csr_cs_context_h handle, csr_cs_completed_cb callbac * @partner * @brief Sets a callback function for scanning cancelled. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks Callback for asynchronous scan functions. * @remarks Client can cancel asynchronous scanning by csr_cs_cancel_scanning(). * @param[in] handle CSR CS context handle returned by csr_cs_context_create() @@ -327,6 +347,8 @@ int csr_cs_set_cancelled_cb(csr_cs_context_h handle, csr_cs_cancelled_cb callbac * @partner * @brief Sets a callback function for scanning stopped with an error. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks Callback for asynchronous scan functions. * @param[in] handle CSR CS context handle returned by csr_cs_context_create() * @param[in] callback A callback function for scanning stopped due to an error @@ -513,6 +535,8 @@ int csr_cs_scan_dirs_async(csr_cs_context_h handle, const char *dir_paths[], siz * @partner * @brief Cancels a running scanning task, asynchronously. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks Only for asynchronous scan functions. * @param[in] handle CSR CS context handle returned by csr_cs_context_create() * @return #CSR_ERROR_NONE on success, @@ -532,6 +556,8 @@ int csr_cs_cancel_scanning(csr_cs_context_h handle); * @partner * @brief Extracts the severity of a detected malware from the detected malware handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @param[in] malware A detected malware handle returned by csr_cs_scan_data(), * csr_cs_scan_file() or csr_cs_malware_list_get_malware() * @param[out] severity A pointer of the severity of a detected malware @@ -549,6 +575,8 @@ int csr_cs_malware_get_severity(csr_cs_malware_h malware, csr_cs_severity_level_ * @partner * @brief Extracts the name of a detected malware from the detected malware handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks @a name must be released using free(). * @param[in] malware A detected malware handle * @param[out] name A pointer of the name of a detected malware @@ -566,6 +594,8 @@ int csr_cs_malware_get_name(csr_cs_malware_h malware, char **name); * @partner * @brief Extracts an url that contains detailed information on vendor's web site from the detected malware handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks @a detailed_url must be released using free(). * @param[in] malware A detected malware handle * @param[out] detailed_url A pointer of an url that contains detailed information on @@ -584,6 +614,8 @@ int csr_cs_malware_get_detailed_url(csr_cs_malware_h malware, char **detailed_ur * @partner * @brief Extracts the time stamp when a malware is detected from the detected malware handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @param[in] malware A detected malware handle * @param[out] timestamp A pointer of the time stamp in milli second when a malware is detected * @return #CSR_ERROR_NONE on success, @@ -600,6 +632,8 @@ int csr_cs_malware_get_timestamp(csr_cs_malware_h malware, time_t *timestamp); * @partner * @brief Extracts the file name where a malware is detected from the detected malware handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks @a file_name must be released using free(). * @param[in] malware A detected malware handle * @param[out] file_name A pointer of the file name where a malware is detected. The file name is null for csr_cs_scan_data() @@ -617,6 +651,8 @@ int csr_cs_malware_get_file_name(csr_cs_malware_h malware, char **file_name); * @partner * @brief Extracts a user response of a popup from the detected malware handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @param[in] malware A detected malware handle * @param[out] response A pointer of the user response * @return #CSR_ERROR_NONE on success, @@ -633,6 +669,8 @@ int csr_cs_malware_get_user_response(csr_cs_malware_h malware, csr_cs_user_respo * @partner * @brief Checks if a malware was detected in an application or in a file. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @param[in] malware A detected malware handle * @param[out] is_app A pointer of a flag indicating the position where a malware was detected. * @return #CSR_ERROR_NONE on success, @@ -649,6 +687,8 @@ int csr_cs_malware_is_app(csr_cs_malware_h malware, bool *is_app); * @partner * @brief Extracts the package id of an application where a malware is detected from detected malware handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks @a pkg_id must be released using free(). * @param[in] malware A detected malware handle * @param[out] pkg_id A pointer of the package id where a malware is detected. @@ -812,6 +852,8 @@ int csr_cs_get_ignored_malwares(csr_cs_context_h handle, const char *dir_paths[] * @partner * @brief Extracts the detected malware handle from the detected malware list handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.scan * @remarks @a malware will be released when a context is released using csr_cs_context_destroy(). * @param[in] list A detected malware list handle returned by csr_cs_get_detected_malwares() or csr_cs_get_ignored_malwares() * @param[in] index An index of a target detected malware handle to get diff --git a/src/include/csr/csr-web-protection.h b/src/include/csr/csr-web-protection.h index 7fcb8ce..5666e95 100644 --- a/src/include/csr/csr-web-protection.h +++ b/src/include/csr/csr-web-protection.h @@ -46,6 +46,8 @@ extern "C" { * @details A Web Protection API handle (or CSR WP handle) is obtained by this method. * The handle is required for subsequent CSR WP API calls. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.webprotect * @remarks @a handle should be released using csr_wp_context_destroy(). * @remarks Multiple handles can be obtained. * @param[out] handle A pointer of CSR WP context handle @@ -64,6 +66,8 @@ int csr_wp_context_create(csr_wp_context_h *handle); * @partner * @brief Releases all system resources associated with a Web Protection API handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.webprotect * @param[in] handle CSR WP context handle returned by csr_wp_context_create() * @return #CSR_ERROR_NONE on success, * otherwise a negative error value @@ -84,6 +88,8 @@ int csr_wp_context_destroy(csr_wp_context_h handle); * @details If #CSR_WP_ASK_USER_YES is set, a popup will be prompted to a user when a URL turns out risky. * If #CSR_WP_ASK_USER_NO is set, no popup will be prompted even when a URL turns out risky. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.webprotect * @remarks This option is disabled(#CSR_WP_ASK_USER_NO) as a default. * @param[in] handle CSR WP context handle returned by csr_wp_context_create() * @param[in] ask_user A popup option in case for a risky URL @@ -103,6 +109,8 @@ int csr_wp_set_ask_user(csr_wp_context_h handle, csr_wp_ask_user_e ask_user); * @brief Sets a popup message of a client in case for a risky URL. * @details Default message is "Risky URL which may harm your device is detected". * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.webprotect * @remarks Meaningful only when ask user option is set by csr_wp_set_ask_user(). * @remarks The message will be printed on popup for user. * @remarks Default popup message will be used if it isn't set. @@ -158,6 +166,8 @@ int csr_wp_check_url(csr_wp_context_h handle, const char *url, csr_wp_check_resu * @partner * @brief Extracts a risk level of the url from the result handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.webprotect * @param[in] result A result handle returned by csr_wp_check_url() * @param[out] level A pointer of the risk level for the given URL * @return #CSR_ERROR_NONE on success, @@ -175,6 +185,8 @@ int csr_wp_result_get_risk_level(csr_wp_check_result_h result, csr_wp_risk_level * @partner * @brief Extracts an url of vendor's web site that contains detailed information about the risk from the result handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.webprotect * @remarks @a detailed_url must be released using free(). * @param[in] result A result handle returned by csr_wp_check_url() * @param[out] detailed_url A pointer of an url that contains detailed information about the risk @@ -195,6 +207,8 @@ int csr_wp_result_get_detailed_url(csr_wp_check_result_h result, char **detailed * @partner * @brief Extracts a user response of a popup from the result handle. * @since_tizen 3.0 + * @privlevel partner + * @privilege %http://tizen.org/privilege/antivirus.webprotect * @param[in] result A result handle returned by csr_wp_check_url() * @param[out] response A pointer of the user response * @return #CSR_ERROR_NONE on success, |