Tizen Native API
7.0
|
The FIDO Client APIs provide Fast IDentity Online UAF Client specification APIs.
Required Header
#include <fido.h>
Overview
The FIDO Universal Authentication Framework (UAF) Client APIs provide APIs for application developers to utilize Device's available authenticators for online service integration. The goal of this Universal Authentication Framework is to provide a unified and extensible authentication mechanism that supplants passwords while avoiding the shortcomings of current alternative authentication approaches. More details about the FIDO specification can be found in https://fidoalliance.org/specifications/download/
Related Features
This API is related with the following feature:
- http://tizen.org/feature/fido.uaf
It is recommended to design feature related codes in your application for reliability.
You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.
To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
More details on featuring your application can be found from Feature List.
Tizen FIDO UAF Client Framework. Refer to https://fidoalliance.org/specifications/download/ about FIDO UAF. Also FIDO server document needs to be referred for using end points and additional parameters.
Functions | |
int | fido_get_client_vendor (char **vendor_name) |
Gets the FIDO client vendor name. | |
int | fido_get_client_version (int *client_major_version, int *client_minor_version) |
Gets the FIDO client vendor version information. | |
Typedefs | |
typedef struct fido_authenticator_s * | fido_authenticator_h |
The structure type for the Authenticator handle. | |
Defines | |
#define | FIDO_SERVER_STATUS_CODE_OK 1200 |
The FIDO Server response for successful interaction. |
Define Documentation
#define FIDO_SERVER_STATUS_CODE_OK 1200 |
The FIDO Server response for successful interaction.
- Since :
- 3.0
Typedef Documentation
typedef struct fido_authenticator_s* fido_authenticator_h |
The structure type for the Authenticator handle.
- Since :
- 3.0
Enumeration Type Documentation
enum fido_auth_algo_e |
Authenticator's supported algorithm and encoding.
- Remarks:
- Refer to FIDO UAF Registry document for more details.
- Since :
- 3.0
- Enumerator:
Authenticator's supported method to communicate to FIDO user device.
- Remarks:
- Refer to FIDO UAF Registry document for more details.
- Since :
- 3.0
- Enumerator:
Authenticator's supported key protection method type.
- Remarks:
- Refer to FIDO UAF Registry document for more details.
- Since :
- 3.0
- Enumerator:
Authenticator's supported matcher protection type.
- Remarks:
- Refer to FIDO UAF Registry document for more details.
- Since :
- 3.0
Transaction confirmation display capability type.
- Remarks:
- Refer to FIDO UAF Registry document for more details.
- Since :
- 3.0
- Enumerator:
Authenticator's supported user verification method type.
- Remarks:
- Refer to FIDO UAF Registry document for more details.
- Since :
- 3.0
- Enumerator:
enum fido_error_e |
Enumerations of error codes for FIDO APIs.
- Since :
- 3.0
- Enumerator:
Function Documentation
int fido_get_client_vendor | ( | char ** | vendor_name | ) |
Gets the FIDO client vendor name.
- Since :
- 3.0
- Remarks:
- The vendor_name should be released using free().
- Parameters:
-
[out] vendor_name The vendor name
- 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_get_client_version | ( | int * | client_major_version, |
int * | client_minor_version | ||
) |
Gets the FIDO client vendor version information.
- Since :
- 3.0
- Parameters:
-
[out] client_major_version The FIDO client major version [out] client_minor_version The FIDO client minor version
- 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