Remove conditional statements from Native API headers 51/302551/1
authorKrzysztof Malysa <k.malysa@samsung.com>
Thu, 7 Dec 2023 15:03:09 +0000 (16:03 +0100)
committerKrzysztof Malysa <k.malysa@samsung.com>
Fri, 8 Dec 2023 08:44:02 +0000 (09:44 +0100)
Part of 9.0 Native API Public Header.

Change-Id: I960fc582ec9ccfa141a975054cb80911d2959294

src/include/ckmc/ckmc-manager.h
src/include/ckmc/ckmc-type.h

index a0f3267..7e68199 100644 (file)
@@ -80,7 +80,7 @@ int ckmc_save_key(const char *alias, const ckmc_key_s key, const ckmc_policy_s p
 
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4. @elseif WEARABLE 3.0. @endif
+ * @deprecated Deprecated since 2.4
  *             [Use ckmc_remove_alias() instead]
  * @brief Removes a key from key manager.
  * @since_tizen 2.3
@@ -218,7 +218,7 @@ int ckmc_save_cert(const char *alias, const ckmc_cert_s cert, const ckmc_policy_
 
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4. @elseif WEARABLE 3.0. @endif
+ * @deprecated Deprecated since 2.4
  *             [Use ckmc_remove_alias() instead]
  * @brief Removes a certificate from key manager.
  * @since_tizen 2.3
@@ -331,7 +331,7 @@ int ckmc_get_cert_alias_info_list(ckmc_alias_info_list_s **ppalias_list);
 /**
  * @brief Stores PKCS12's contents inside key manager based on the provided policies. All items from
  *        the PKCS12 will use the same alias.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @remarks %http://tizen.org/privilege/keymanager (public level privilege) is no longer required to
  *          use this function since 3.0.
  * @param[in] alias The name of a data to be stored
@@ -362,7 +362,7 @@ int ckmc_save_pkcs12(const char *alias,
 
 /**
  * @brief Gets a pkcs12 from key manager.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @remarks %http://tizen.org/privilege/keymanager (public level privilege) is no longer required to
  *          use this function since 3.0.
  * @remarks A client can access only data stored by the client.
@@ -419,7 +419,7 @@ int ckmc_save_data(const char *alias, ckmc_raw_buffer_s data, const ckmc_policy_
 
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4. @elseif WEARABLE 3.0. @endif
+ * @deprecated Deprecated since 2.4
  *             [Use ckmc_remove_alias() instead]
  * @brief Removes a data from key manager.
  * @since_tizen 2.3
@@ -776,7 +776,7 @@ int ckmc_get_cert_chain(const ckmc_cert_s *cert,
 
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4. @elseif WEARABLE 3.0. @endif
+ * @deprecated Deprecated since 2.4
  *             [Use ckmc_get_cert_chain() instead]
  * @brief Verifies a certificate chain using an alias list of untrusted certificates and return that
  *        chain.
@@ -817,7 +817,7 @@ int ckmc_get_cert_chain_with_alias(const ckmc_cert_s *cert,
 /**
  * @brief Verifies a certificate chain and returns that chain using user-entered, trusted, and
  *        untrusted CA certificates.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @remarks %http://tizen.org/privilege/keymanager (public level privilege) is no longer required to
  *          use this function since 3.0.
  * @remarks If the trusted root certificates are provided as a user input, these certificates do not
@@ -854,7 +854,7 @@ int ckmc_get_cert_chain_with_trustedcert(const ckmc_cert_s *cert,
 /**
  * @deprecated Deprecated since 6.5. Use raw OpenSSL instead.
  * @brief Performs OCSP that checks certificate is whether revoked or not.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
  * @remarks %http://tizen.org/privilege/internet (public level privilege) is required to use this
@@ -879,7 +879,7 @@ int ckmc_ocsp_check(const ckmc_cert_list_s *pcert_chain_list,
 
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4. @elseif WEARABLE 3.0. @endif
+ * @deprecated Deprecated since 2.4
  *             [Use ckmc_set_permission() instead]
  * @brief Allows another application to access client's application data.
  * @since_tizen 2.3
@@ -907,7 +907,7 @@ int ckmc_allow_access(const char *alias,
 
 /**
  * @brief Allows another application to access client's application data.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @remarks %http://tizen.org/privilege/keymanager (public level privilege) is no longer required to
  *          use this function since 3.0.
  * @remarks Data identified by @a alias should exist.
@@ -930,7 +930,7 @@ int ckmc_set_permission(const char *alias, const char *accessor, int permissions
 
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4. @elseif WEARABLE 3.0. @endif
+ * @deprecated Deprecated since 2.4
  *             [Use ckmc_set_permission() instead]
  * @brief Revokes another application's access to client's application data.
  * @since_tizen 2.3
@@ -958,7 +958,7 @@ int ckmc_deny_access(const char *alias, const char *accessor) TIZEN_DEPRECATED_A
 
 /**
  * @brief Removes an entry (no matter of type) from the key manager.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @remarks %http://tizen.org/privilege/keymanager (public level privilege) is no longer required to
  *          use this function since 3.0.
  * @remarks To remove item, client must have remove permission to the specified item.
index 3de4c1a..a1b8ba3 100644 (file)
@@ -151,7 +151,7 @@ typedef enum __ckmc_rsa_padding_algo {
 
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4. @elseif WEARABLE 3.0. @endif
+ * @deprecated Deprecated since 2.4
  *             [Use #ckmc_permission_e instead]
  * @brief Enumeration for database access rights.
  * @since_tizen 2.3
@@ -164,7 +164,7 @@ typedef enum __ckmc_access_right {
 
 /**
  * @brief Enumeration for permissions to access/modify alias.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  */
 typedef enum __ckmc_permission {
        CKMC_PERMISSION_NONE = 0x00, /**< Clear permissions */
@@ -259,7 +259,7 @@ typedef struct __ckmc_cert_list {
 
 /**
  * @brief Enumeration for OCSP status.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  */
 typedef enum __ckmc_ocsp_status {
        CKMC_OCSP_STATUS_GOOD = 0, /**< OCSP status is good */
@@ -276,7 +276,7 @@ typedef enum __ckmc_ocsp_status {
 
 /**
  * @brief The structure for PKCS12 used in key manager CAPI.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  */
 typedef struct __ckmc_pkcs12 {
        ckmc_key_s *priv_key; /**< The private key, may be NULL */
@@ -581,7 +581,7 @@ int ckmc_alias_new(const char *owner_id, const char *alias, char **full_alias);
 
 /**
  * @brief Creates a new #ckmc_key_s handle and returns it.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @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. The @a raw_key may be encrypted with password.
@@ -615,7 +615,7 @@ void ckmc_key_free(ckmc_key_s *key);
 
 /**
  * @brief Creates a new #ckmc_raw_buffer_s handle and returns it.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @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
@@ -642,7 +642,7 @@ void ckmc_buffer_free(ckmc_raw_buffer_s *buffer);
 
 /**
  * @brief Creates a new #ckmc_cert_s handle and returns it.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @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
@@ -695,7 +695,7 @@ int ckmc_load_cert_from_file(const char *file_path, ckmc_cert_s **cert);
 
 /**
  * @brief Creates a new #ckmc_pkcs12_s handle and returns it.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @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
@@ -724,7 +724,7 @@ int ckmc_pkcs12_new(ckmc_key_s *private_key,
 
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4. @elseif WEARABLE 3.0. @endif
+ * @deprecated Deprecated since 2.4
  *             [Use ckmc_pkcs12_load() instead]
  * @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.
@@ -765,7 +765,7 @@ int ckmc_load_from_pkcs12_file(const char *file_path,
 
 /**
  * @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
+ * @since_tizen 2.4
  * @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
@@ -789,7 +789,7 @@ int ckmc_pkcs12_load(const char *file_path, const char *passphrase, ckmc_pkcs12_
 
 /**
  * @brief Destroys the #ckmc_pkcs12_s handle and releases all its resources.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  * @param[in] pkcs12 The #ckmc_pkcs12_s handle to destroy
  * @see ckmc_pkcs12_new()
  * @see ckmc_pkcs12_load()
@@ -800,7 +800,7 @@ void ckmc_pkcs12_free(ckmc_pkcs12_s *pkcs12);
 /**
  * @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
+ * @since_tizen 2.4
  * @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 #ckmc_alias_list_s
@@ -820,7 +820,7 @@ int ckmc_alias_list_new(char *alias, ckmc_alias_list_s **ppalias_list);
  * @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
+ * @since_tizen 2.4
  * @remarks You must destroy the newly created @a pplast using ckmc_alias_list_free()
  * @param[in] previous The last #ckmc_alias_list_s handle to which a newly created
  *                     #ckmc_alias_list_s is added
@@ -840,7 +840,7 @@ int ckmc_alias_list_add(ckmc_alias_list_s *previous, char *alias, ckmc_alias_lis
 /**
  * @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
+ * @since_tizen 2.4
  * @remarks It does not destroy an alias itself in #ckmc_alias_list_s.
  * @param[in] first The first #ckmc_alias_list_s handle to destroy
  * @see ckmc_alias_list_all_free()
@@ -852,7 +852,7 @@ void ckmc_alias_list_free(ckmc_alias_list_s *first);
 /**
  * @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
+ * @since_tizen 2.4
  * @remarks It also destroys the alias in #ckmc_alias_list_s.
  * @param[in] first The first #ckmc_alias_list_s handle to destroy
  * @see #ckmc_alias_list_s
@@ -863,7 +863,7 @@ void ckmc_alias_list_all_free(ckmc_alias_list_s *first);
 /**
  * @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
+ * @since_tizen 2.4
  * @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 #ckmc_cert_list_s
@@ -883,7 +883,7 @@ int ckmc_cert_list_new(ckmc_cert_s *cert, ckmc_cert_list_s **ppalias_list);
  * @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
+ * @since_tizen 2.4
  * @remarks You must destroy the newly created @a pplast using ckmc_cert_list_free()
  * @param[in] previous The last #ckmc_cert_list_s handle to which a newly created #ckmc_cert_list_s
  *                     is added
@@ -903,7 +903,7 @@ int ckmc_cert_list_add(ckmc_cert_list_s *previous, ckmc_cert_s *cert, ckmc_cert_
 /**
  * @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
+ * @since_tizen 2.4
  * @remarks It does not destroy #ckmc_cert_s itself in #ckmc_cert_list_s.
  * @param[in] first The first #ckmc_cert_list_s handle to destroy
  * @see ckmc_cert_list_all_free()