Fido Authenticator.

Required Header

#include <fido_uaf_authenticator.h>

Overview

Authenticator information, received in response of fido_foreach_authenticator() call, via fido_authenticator_cb() callback. More details about the FIDO specification can be found in https://fidoalliance.org/specifications/download/

Functions
int	fido_foreach_authenticator (fido_authenticator_cb cb, void *user_data)
	Retrieves all the available FIDO authenticators supported by this Device.
int	fido_authenticator_get_title (const fido_authenticator_h auth, char **title)
	Gets the Authenticator title.
int	fido_authenticator_get_aaid (const fido_authenticator_h auth, char **aaid)
	Retrieves the Authenticator AAID (Authenticator Attestation ID).
int	fido_authenticator_get_description (const fido_authenticator_h auth, char **desc)
	Retrieves the Authenticator description.
int	fido_authenticator_get_assertion_scheme (const fido_authenticator_h auth, char **scheme)
	Retrieves the Authenticator assertion scheme.
int	fido_authenticator_get_algorithm (const fido_authenticator_h auth, fido_auth_algo_e *algo)
	Retrieves the Authenticator algorithm.
int	fido_authenticator_foreach_attestation_type (const fido_authenticator_h auth, fido_attestation_type_cb cb, void *user_data)
	Retrieves all the available attestation types for this Authenticator.
int	fido_authenticator_get_verification_method (const fido_authenticator_h auth, fido_auth_user_verify_type_e *user_verification)
	Retrieves the user verification method of this Authenticator.
int	fido_authenticator_get_key_protection_method (const fido_authenticator_h auth, fido_auth_key_protection_type_e *key_protection)
	Retrieves the key protection method of this Authenticator.
int	fido_authenticator_get_matcher_protection_method (const fido_authenticator_h auth, fido_auth_matcher_protection_type_e *matcher_protection)
	Retrieves the matcher protection method of this Authenticator.
int	fido_authenticator_get_attachment_hint (const fido_authenticator_h auth, fido_auth_attachment_hint_e *attachment_hint)
	Retrieves the attachment hint of this Authenticator.
bool	fido_authenticator_get_is_second_factor_only (const fido_authenticator_h auth)
	Checks if the Authenticator is Second factor only which is supported by U2F standards.
int	fido_authenticator_get_tc_discplay (const fido_authenticator_h auth, fido_auth_tc_display_type_e *tc_display)
	Retrieves the Transaction Confirmation display type of this Authenticator.
int	fido_authenticator_get_tc_display_type (const fido_authenticator_h auth, char **tc_display_content_type)
	Retrieves the Transaction Confirmation display content type of this Authenticator.
int	fido_authenticator_get_icon (const fido_authenticator_h auth, char **icon)
	Retrieves the icon of this Authenticator.
Typedefs
typedef void(*	fido_authenticator_cb )(const fido_authenticator_h auth_info, void *user_data)
	Called once for each result of calling fido_foreach_authenticator()
typedef void(*	fido_attestation_type_cb )(fido_auth_attestation_type_e att_type, void *user_data)
	Called once for each result of calling fido_authenticator_foreach_attestation_type().

Typedef Documentation

typedef void(* fido_attestation_type_cb)(fido_auth_attestation_type_e att_type, void *user_data)

Called once for each result of calling fido_authenticator_foreach_attestation_type().

Since :: 3.0

Parameters:

[in]	att_type	The Authenticator attestation type
[in]	user_data	The user data that was attached during fido_authenticator_foreach_attestation_type() call

typedef void(* fido_authenticator_cb)(const fido_authenticator_h auth_info, void *user_data)

Called once for each result of calling fido_foreach_authenticator()

Since :: 3.0

Parameters:

[in]	auth_info	The Authenticator info handle. This param will be freed by framework
[in]	user_data	The user data that was attached during fido_foreach_authenticator() call

See also:: fido_foreach_authenticator()

Function Documentation

int fido_authenticator_foreach_attestation_type	(	const fido_authenticator_h	auth,
		fido_attestation_type_cb	cb,
		void *	user_data
	)

Retrieves all the available attestation types for this Authenticator.

Since :: 3.0

Parameters:

[in]	auth	The Authenticator handle
[in]	cb	The iteration callback
[in]	user_data	The user data

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

int fido_authenticator_get_aaid	(	const fido_authenticator_h	auth,
		char **	aaid
	)

Retrieves the Authenticator AAID (Authenticator Attestation ID).

Since :: 3.0

Remarks:: The aaid should be released using free().

Parameters:

[in]	auth	The Authenticator handle
[out]	aaid	The AAID

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_OUT_OF_MEMORY	Out of Memory
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

int fido_authenticator_get_algorithm	(	const fido_authenticator_h	auth,
		fido_auth_algo_e *	algo
	)

Retrieves the Authenticator algorithm.

Since :: 3.0

Parameters:

[in]	auth	The Authenticator handle
[out]	algo	The authentication algorithm

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

int fido_authenticator_get_assertion_scheme	(	const fido_authenticator_h	auth,
		char **	scheme
	)

Retrieves the Authenticator assertion scheme.

Since :: 3.0

Remarks:: The scheme should be released using free(). Refer to FIDO UAF Registry document for more details.

Parameters:

[in]	auth	The Authenticator handle
[out]	scheme	The assertion scheme. UAFV1TLV is the default assertion scheme

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_OUT_OF_MEMORY	Out of Memory
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

int fido_authenticator_get_attachment_hint	(	const fido_authenticator_h	auth,
		fido_auth_attachment_hint_e *	attachment_hint
	)

Retrieves the attachment hint of this Authenticator.

Since :: 3.0

Parameters:

[in]	auth	The Authenticator handle
[out]	attachment_hint	The matcher protection method

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

int fido_authenticator_get_description	(	const fido_authenticator_h	auth,
		char **	desc
	)

Retrieves the Authenticator description.

Since :: 3.0

Remarks:: The desc should be released using free().

Parameters:

[in]	auth	The Authenticator handle
[out]	desc	The description

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_OUT_OF_MEMORY	Out of Memory
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

int fido_authenticator_get_icon	(	const fido_authenticator_h	auth,
		char **	icon
	)

Retrieves the icon of this Authenticator.

Since :: 3.0

Remarks:: The icon should be released using free().

Parameters:

[in]	auth	The Authenticator handle
[out]	icon	The icon. Portable Network Graphic (PNG) format image file representing the icon encoded as a data: url[RFC2397]

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_OUT_OF_MEMORY	Out of Memory
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

bool fido_authenticator_get_is_second_factor_only ( const fido_authenticator_h auth )

Checks if the Authenticator is Second factor only which is supported by U2F standards.

Since :: 3.0

Parameters:

[in] auth The Authenticator handle

Returns:: true if its only second factor, otherwise false.

int fido_authenticator_get_key_protection_method	(	const fido_authenticator_h	auth,
		fido_auth_key_protection_type_e *	key_protection
	)

Retrieves the key protection method of this Authenticator.

Since :: 3.0

Parameters:

[in]	auth	The Authenticator handle
[out]	key_protection	The key protection method

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
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
	)

Retrieves the matcher protection method of this Authenticator.

Since :: 3.0

Parameters:

[in]	auth	The Authenticator handle
[out]	matcher_protection	The matcher protection method

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
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
	)

Retrieves the Transaction Confirmation display type of this Authenticator.

Since :: 3.0

Parameters:

[in]	auth	The Authenticator handle
[out]	tc_display	The TC display type

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

int fido_authenticator_get_tc_display_type	(	const fido_authenticator_h	auth,
		char **	tc_display_content_type
	)

Retrieves the Transaction Confirmation display content type of this Authenticator.

Since :: 3.0

Remarks:: The tc_display_content_type should be released using free().

Parameters:

[in]	auth	The Authenticator handle
[out]	tc_display_content_type	The TC display content type which is supported MIME type [RFC2049] such as text/plain or image/png

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_OUT_OF_MEMORY	Out of Memory
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

int fido_authenticator_get_title	(	const fido_authenticator_h	auth,
		char **	title
	)

Gets the Authenticator title.

Since :: 3.0

Remarks:: The title should be released using free().

Parameters:

[in]	auth	The Authenticator handle
[out]	title	The title

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_OUT_OF_MEMORY	Out of Memory
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
	)

Retrieves the user verification method of this Authenticator.

Since :: 3.0

Parameters:

[in]	auth	The Authenticator handle
[out]	user_verification	The user verification method

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter

int fido_foreach_authenticator	(	fido_authenticator_cb	cb,
		void *	user_data
	)

Retrieves all the available FIDO authenticators supported by this Device.

fido_authenticator_cb() callback is called synchronously once for each authenticator.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/fido.client

Parameters:

[in]	cb	The iteration callback handle
[in]	user_data	The user data handle

Returns:: 0 on success, otherwise a negative error value

Return values:

FIDO_ERROR_NONE	Successful
FIDO_ERROR_OUT_OF_MEMORY	Out of Memory
FIDO_ERROR_INVALID_PARAMETER	Invalid parameter
FIDO_ERROR_PERMISSION_DENIED	The application does not have permission to call this function.
FIDO_ERROR_NOT_SUPPORTED	FIDO is not supported on this device.

Required Header

Overview

Functions

Typedefs

Typedef Documentation

Function Documentation