From: Shivam Verma <s01.verma@samsung.com>
Date: Wed, 12 Jul 2023 14:44:17 +0000 (+0530)
Subject: FIDO_Client deprecation
X-Git-Tag: accepted/tizen/8.0/unified/20231005.092557^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fheads%2Ftizen_8.0;p=platform%2Fcore%2Faccount%2Ffido-client.git

FIDO_Client deprecation

Change-Id: I00594baba19a95c51ab5af8b2152562e5129a62e
---

diff --git a/common/fido_uaf_types.h b/common/fido_uaf_types.h
index e5661b8..9c46118 100755
--- a/common/fido_uaf_types.h
+++ b/common/fido_uaf_types.h
@@ -36,6 +36,7 @@
  */
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief  The structure type for the Authenticator handle.
  * @since_tizen  3.0
  */
@@ -43,6 +44,7 @@ typedef struct fido_authenticator_s* fido_authenticator_h;
 
 
 /**
+ *  @deprecated Deprecated since 8.0.
  *  @brief    Enumerations of error codes for FIDO APIs.
  *  @since_tizen 3.0
  */
@@ -63,6 +65,7 @@ typedef enum {
 } fido_error_e;
 
 /**
+ *  @deprecated Deprecated since 8.0.
  *  @brief  Authenticator's supported algorithm and encoding.
  *  @remarks Refer to FIDO UAF Registry document for more details.
  *  @since_tizen 3.0
@@ -77,6 +80,7 @@ typedef enum {
 } fido_auth_algo_e;
 
 /**
+ *  @deprecated Deprecated since 8.0.
  *  @brief  Authenticator's supported Attestation type.
  *  @remarks Refer to FIDO UAF Registry document for more details.
  *  @since_tizen 3.0
@@ -87,6 +91,7 @@ typedef enum {
 } fido_auth_attestation_type_e;
 
 /**
+ *  @deprecated Deprecated since 8.0.
  *  @brief  Authenticator's supported user verification method type.
  *  @remarks Refer to FIDO UAF Registry document for more details.
  *  @since_tizen 3.0
@@ -111,6 +116,7 @@ typedef enum {
 } fido_auth_user_verify_type_e;
 
 /**
+ *  @deprecated Deprecated since 8.0.
  *  @brief  Authenticator's supported key protection method type.
  *  @remarks Refer to FIDO UAF Registry document for more details.
  *  @since_tizen 3.0
@@ -126,6 +132,7 @@ typedef enum {
 } fido_auth_key_protection_type_e;
 
 /**
+ *  @deprecated Deprecated since 8.0.
  *  @brief  Authenticator's supported matcher protection type.
  *  @remarks Refer to FIDO UAF Registry document for more details.
  *  @since_tizen 3.0
@@ -137,6 +144,7 @@ typedef enum {
 } fido_auth_matcher_protection_type_e;
 
 /**
+ *  @deprecated Deprecated since 8.0.
  *  @brief  Authenticator's supported method to communicate to FIDO user device.
  *  @remarks Refer to FIDO UAF Registry document for more details.
  *  @since_tizen 3.0
@@ -159,6 +167,7 @@ typedef enum {
 } fido_auth_attachment_hint_e;
 
 /**
+ *  @deprecated Deprecated since 8.0.
  *  @brief  Transaction confirmation display capability type.
  *  @remarks Refer to FIDO UAF Registry document for more details.
  *  @since_tizen 3.0
diff --git a/doc/fido_doc.h b/doc/fido_doc.h
index f7fbdcb..3a1d8ad 100755
--- a/doc/fido_doc.h
+++ b/doc/fido_doc.h
@@ -19,7 +19,7 @@
 #define __FIDO_DOC_H__
 
 /**
- * @defgroup  CAPI_FIDO_MODULE FIDO Client
+ * @defgroup  CAPI_FIDO_MODULE FIDO Client (Deprecated)
  * @ingroup   CAPI_ACCOUNT_FRAMEWORK
  * @brief     The FIDO Client APIs provide Fast IDentity Online UAF Client specification APIs.
  *
@@ -43,7 +43,7 @@
  *
  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature List</b>.</a>
  *
- * @defgroup  CAPI_FIDO_UAF_MESSAGES_MODULE FIDO UAF MESSAGES
+ * @defgroup  CAPI_FIDO_UAF_MESSAGES_MODULE FIDO UAF MESSAGES (Deprecated)
  * @ingroup   CAPI_FIDO_MODULE
  * @brief     Fido UAF Messages
  *
@@ -54,7 +54,7 @@
  * The FIDO UAF Client APIs which process UAF messages from fido server.
  * More details about the FIDO specification can be found in https://fidoalliance.org/specifications/download
  *
- * @defgroup  CAPI_FIDO_AUTHENTICATOR_MODULE FIDO AUTHENTICATOR
+ * @defgroup  CAPI_FIDO_AUTHENTICATOR_MODULE FIDO AUTHENTICATOR (Deprecated)
  * @ingroup   CAPI_FIDO_MODULE
  * @brief     Fido Authenticator
  *
diff --git a/include/fido_uaf_authenticator.h b/include/fido_uaf_authenticator.h
index 02a35af..df6b6d8 100755
--- a/include/fido_uaf_authenticator.h
+++ b/include/fido_uaf_authenticator.h
@@ -37,6 +37,7 @@ extern "C"
  */
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Called once for each result of calling fido_foreach_authenticator()
  * @since_tizen 3.0
  *
@@ -47,6 +48,7 @@ extern "C"
 typedef void (*fido_authenticator_cb)(const fido_authenticator_h auth_info, void *user_data);
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves  all the available FIDO authenticators supported by this Device.
  * @details fido_authenticator_cb() callback is called synchronously once for each authenticator.
  * @since_tizen 3.0
@@ -64,9 +66,10 @@ typedef void (*fido_authenticator_cb)(const fido_authenticator_h auth_info, void
  * @retval     #FIDO_ERROR_PERMISSION_DENIED The application does not have permission to call this function.
  * @retval     #FIDO_ERROR_NOT_SUPPORTED FIDO is not supported on this device.
  */
-int fido_foreach_authenticator(fido_authenticator_cb cb, void *user_data);
+int fido_foreach_authenticator(fido_authenticator_cb cb, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets the Authenticator title.
  * @since_tizen 3.0
  *
@@ -80,9 +83,10 @@ int fido_foreach_authenticator(fido_authenticator_cb cb, void *user_data);
  * @retval     #FIDO_ERROR_OUT_OF_MEMORY      Out of Memory
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
-int fido_authenticator_get_title(const fido_authenticator_h auth, char **title);
+int fido_authenticator_get_title(const fido_authenticator_h auth, char **title) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the Authenticator AAID (Authenticator Attestation ID).
  * @since_tizen 3.0
  *
@@ -96,9 +100,10 @@ int fido_authenticator_get_title(const fido_authenticator_h auth, char **title);
  * @retval     #FIDO_ERROR_OUT_OF_MEMORY      Out of Memory
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
-int fido_authenticator_get_aaid(const fido_authenticator_h auth, char **aaid);
+int fido_authenticator_get_aaid(const fido_authenticator_h auth, char **aaid) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the Authenticator description
  * @since_tizen 3.0
  *
@@ -112,9 +117,10 @@ int fido_authenticator_get_aaid(const fido_authenticator_h auth, char **aaid);
  * @retval     #FIDO_ERROR_OUT_OF_MEMORY      Out of Memory
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
-int fido_authenticator_get_description(const fido_authenticator_h auth, char **desc);
+int fido_authenticator_get_description(const fido_authenticator_h auth, char **desc) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the Authenticator assertion scheme.
  * @since_tizen 3.0
  *
@@ -128,9 +134,10 @@ int fido_authenticator_get_description(const fido_authenticator_h auth, char **d
  * @retval     #FIDO_ERROR_OUT_OF_MEMORY      Out of Memory
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
-int fido_authenticator_get_assertion_scheme(const fido_authenticator_h auth, char **scheme);
+int fido_authenticator_get_assertion_scheme(const fido_authenticator_h auth, char **scheme) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the Authenticator algorithm.
  * @since_tizen 3.0
  *
@@ -142,9 +149,10 @@ int fido_authenticator_get_assertion_scheme(const fido_authenticator_h auth, cha
  * @retval     #FIDO_ERROR_NONE               Successful
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
-int fido_authenticator_get_algorithm(const fido_authenticator_h auth, fido_auth_algo_e *algo);
+int fido_authenticator_get_algorithm(const fido_authenticator_h auth, fido_auth_algo_e *algo) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Called once for each result of calling fido_authenticator_foreach_attestation_type().
  * @since_tizen 3.0
  *
@@ -154,6 +162,7 @@ int fido_authenticator_get_algorithm(const fido_authenticator_h auth, fido_auth_
 typedef void (*fido_attestation_type_cb)(fido_auth_attestation_type_e att_type, void *user_data);
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves all the available attestation types for this Authenticator.
  * @since_tizen 3.0
  *
@@ -167,9 +176,10 @@ typedef void (*fido_attestation_type_cb)(fido_auth_attestation_type_e att_type,
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
 int fido_authenticator_foreach_attestation_type(const fido_authenticator_h auth,
-	fido_attestation_type_cb cb, void *user_data);
+	fido_attestation_type_cb cb, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the user verification method of this Authenticator.
  * @since_tizen 3.0
  *
@@ -182,9 +192,10 @@ int fido_authenticator_foreach_attestation_type(const fido_authenticator_h auth,
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
 int fido_authenticator_get_verification_method(const fido_authenticator_h auth,
-	fido_auth_user_verify_type_e *user_verification);
+	fido_auth_user_verify_type_e *user_verification) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the key protection method of this Authenticator.
  * @since_tizen 3.0
  *
@@ -197,9 +208,10 @@ int fido_authenticator_get_verification_method(const fido_authenticator_h auth,
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
 int fido_authenticator_get_key_protection_method(const fido_authenticator_h auth,
-	fido_auth_key_protection_type_e *key_protection);
+	fido_auth_key_protection_type_e *key_protection) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the matcher protection method of this Authenticator.
  * @since_tizen 3.0
  *
@@ -212,9 +224,10 @@ int fido_authenticator_get_key_protection_method(const fido_authenticator_h auth
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
 int fido_authenticator_get_matcher_protection_method(const fido_authenticator_h auth,
-	fido_auth_matcher_protection_type_e *matcher_protection);
+	fido_auth_matcher_protection_type_e *matcher_protection) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the attachment hint of this Authenticator.
  * @since_tizen 3.0
  *
@@ -227,9 +240,10 @@ int fido_authenticator_get_matcher_protection_method(const fido_authenticator_h
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
 int fido_authenticator_get_attachment_hint(const fido_authenticator_h auth,
-	fido_auth_attachment_hint_e *attachment_hint);
+	fido_auth_attachment_hint_e *attachment_hint) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Checks if the Authenticator is Second factor only which is supported by U2F standards.
  * @since_tizen 3.0
  *
@@ -238,9 +252,10 @@ int fido_authenticator_get_attachment_hint(const fido_authenticator_h auth,
  * @return     @c true if its only second factor,
  *             otherwise false.
  */
-bool fido_authenticator_get_is_second_factor_only(const fido_authenticator_h auth);
+bool fido_authenticator_get_is_second_factor_only(const fido_authenticator_h auth) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the Transaction Confirmation display type of this Authenticator.
  * @since_tizen 3.0
  *
@@ -253,9 +268,10 @@ bool fido_authenticator_get_is_second_factor_only(const fido_authenticator_h aut
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
 int fido_authenticator_get_tc_discplay(const fido_authenticator_h auth,
-	fido_auth_tc_display_type_e *tc_display);
+	fido_auth_tc_display_type_e *tc_display) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the Transaction Confirmation display content type of this Authenticator.
  * @since_tizen 3.0
  *
@@ -269,9 +285,10 @@ int fido_authenticator_get_tc_discplay(const fido_authenticator_h auth,
  * @retval     #FIDO_ERROR_OUT_OF_MEMORY      Out of Memory
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
-int fido_authenticator_get_tc_display_type(const fido_authenticator_h auth, char **tc_display_content_type);
+int fido_authenticator_get_tc_display_type(const fido_authenticator_h auth, char **tc_display_content_type) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Retrieves the icon of this Authenticator.
  * @since_tizen 3.0
  *
@@ -285,7 +302,7 @@ int fido_authenticator_get_tc_display_type(const fido_authenticator_h auth, char
  * @retval     #FIDO_ERROR_OUT_OF_MEMORY      Out of Memory
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
-int fido_authenticator_get_icon(const fido_authenticator_h auth, char **icon);
+int fido_authenticator_get_icon(const fido_authenticator_h auth, char **icon) TIZEN_DEPRECATED_API;
 
 /**
  * @}
diff --git a/include/fido_uaf_client.h b/include/fido_uaf_client.h
index d3c0e2a..da536ab 100755
--- a/include/fido_uaf_client.h
+++ b/include/fido_uaf_client.h
@@ -36,6 +36,7 @@ extern "C"
  */
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets the FIDO client vendor name.
  * @since_tizen 3.0
  *
@@ -48,9 +49,10 @@ extern "C"
  * @retval     #FIDO_ERROR_OUT_OF_MEMORY      Out of Memory
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
-int fido_get_client_vendor(char **vendor_name);
+int fido_get_client_vendor(char **vendor_name) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets the FIDO client vendor version information.
  * @since_tizen 3.0
  *
@@ -63,7 +65,7 @@ int fido_get_client_vendor(char **vendor_name);
  * @retval     #FIDO_ERROR_OUT_OF_MEMORY      Out of Memory
  * @retval     #FIDO_ERROR_INVALID_PARAMETER  Invalid parameter
  */
-int fido_get_client_version(int *client_major_version, int *client_minor_version);
+int fido_get_client_version(int *client_major_version, int *client_minor_version) TIZEN_DEPRECATED_API;
 
 /**
  * @}
@@ -75,6 +77,7 @@ int fido_get_client_version(int *client_major_version, int *client_minor_version
  */
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Checks whether the FIDO message can be processed.
  * @since_tizen 3.0
  * @privlevel  public
@@ -96,9 +99,10 @@ int fido_get_client_version(int *client_major_version, int *client_minor_version
  * @retval     #FIDO_ERROR_UNTRUSTED_FACET_ID     The caller's id is not allowed to use this operation.
  *
  */
-int fido_uaf_is_supported(const char *uaf_message_json, bool *is_supported);
+int fido_uaf_is_supported(const char *uaf_message_json, bool *is_supported) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Called when fido_uaf_get_response_message() response comes.
  * @details The following error codes can be delivered:
  * <pre>
@@ -127,6 +131,7 @@ int fido_uaf_is_supported(const char *uaf_message_json, bool *is_supported);
 typedef void (*fido_uaf_response_message_cb) (fido_error_e tizen_error_code, const char *uaf_response_json, void *user_data);
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Processes the given FIDO UAF message.
  * @details This function is asynchronous. The response is delivered via fido_uaf_response_message_cb().
  * Depending on the FIDO message type, this may involve user interactions.
@@ -149,9 +154,10 @@ typedef void (*fido_uaf_response_message_cb) (fido_error_e tizen_error_code, con
  * @see fido_uaf_response_message_cb()
  */
 int fido_uaf_get_response_message(const char *uaf_request_json, const char *channel_binding,
-	fido_uaf_response_message_cb callback, void *user_data);
+	fido_uaf_response_message_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Notifies the FIDO client about the server result. FIDO Server sends the result of processing a UAF message to FIDO client.
  * @remarks This is especially important for cases when a new registration may be considered by the client to be in a pending state
  * until it is communicated that the server accepted it.
@@ -177,7 +183,7 @@ int fido_uaf_get_response_message(const char *uaf_request_json, const char *chan
  *
  * @see fido_uaf_response_message_cb()
  */
-int fido_uaf_set_server_result(int response_code, const char *uaf_response_json);
+int fido_uaf_set_server_result(int response_code, const char *uaf_response_json) TIZEN_DEPRECATED_API;
 
 /**
  * @}