Fido

  • The Fido class serves as the entry point for Fido APIs, which are based on the Fast IDentity Online industry standard for security keys.

  • Several constants are defined for retrieving data from Activity Intents, including JSON responses, PublicKeyCredential objects, and deprecated error/response extras.

  • There are static methods to obtain instances of Fido2ApiClient, Fido2PrivilegedApiClient, and U2fApiClient for both Context and Activity environments.

  • Some constants related to retrieving FIDO2 error and response data from Intents are deprecated, with the recommended approach being to use FIDO2_KEY_CREDENTIAL_EXTRA.
public class Fido extends Object

Entry point for Fido APIs.

FIDO (Fast IDentity Online), which is the industry alliance where Security Keys are being standardized.

See Also

Constant Summary

String FIDO2_JSON_RESPONSE_EXTRA The key used by the calling Activity to retrieve a JSON-formatted string from the Intent received by Activity.onActivityResult(int, int, Intent) after launching Fido2PendingIntent.
String FIDO2_KEY_CREDENTIAL_EXTRA The key used by the calling Activity to retrieve PublicKeyCredential from the Intent received by Activity.onActivityResult(int, int, Intent) after launching Fido2PendingIntent.
String FIDO2_KEY_ERROR_EXTRA This constant is deprecated. use FIDO2_KEY_CREDENTIAL_EXTRA to fetch PublicKeyCredential instead. PublicKeyCredential contains an AuthenticatorErrorResponse.
String FIDO2_KEY_RESPONSE_EXTRA This constant is deprecated. use FIDO2_KEY_CREDENTIAL_EXTRA to fetch PublicKeyCredential instead. PublicKeyCredential contains an AuthenticatorAttestationResponse or an AuthenticatorAssertionResponse.
String FIDO_CREDENTIAL_JSON_EXTRA The key used by the calling Activity to retrieve PublicKeyCredential from the Intent received by Activity.onActivityResult(int, int, Intent), as a JSON-formatted string after launching the Fido2 registration or Fido2 sign intent.
String KEY_RESPONSE_EXTRA The key used by the calling Activity to retrieve ResponseData from the Intent received by Activity.onActivityResult(int, int, Intent) after launching U2fPendingIntent.

Public Method Summary

static Fido2ApiClient
getFido2ApiClient(Context context)
Creates a new instance of Fido2ApiClient for use in a non-activity Context.
static Fido2ApiClient
getFido2ApiClient(Activity activity)
Creates a new instance of Fido2ApiClient for use in an Activity.
static Fido2PrivilegedApiClient
getFido2PrivilegedApiClient(Context context)
Creates a new instance of Fido2PrivilegedApiClient for use in a non-activity Context.
static Fido2PrivilegedApiClient
getFido2PrivilegedApiClient(Activity activity)
Create a new instance of Fido2PrivilegedApiClient for use in an Activity.
static U2fApiClient
getU2fApiClient(Context context)
Creates a new instance of U2fApiClient for use in a non-activity Context.
static U2fApiClient
getU2fApiClient(Activity activity)
Creates a new instance of U2fApiClient for use in an Activity.

Inherited Method Summary

Constants

public static final String FIDO2_JSON_RESPONSE_EXTRA

The key used by the calling Activity to retrieve a JSON-formatted string from the Intent received by Activity.onActivityResult(int, int, Intent) after launching Fido2PendingIntent.

Constant Value: "FIDO2_JSON_RESPONSE_EXTRA"

public static final String FIDO2_KEY_CREDENTIAL_EXTRA

The key used by the calling Activity to retrieve PublicKeyCredential from the Intent received by Activity.onActivityResult(int, int, Intent) after launching Fido2PendingIntent.

Constant Value: "FIDO2_CREDENTIAL_EXTRA"

public static final String FIDO2_KEY_ERROR_EXTRA

This constant is deprecated.
use FIDO2_KEY_CREDENTIAL_EXTRA to fetch PublicKeyCredential instead. PublicKeyCredential contains an AuthenticatorErrorResponse.

The key used by the calling Activity to retrieve AuthenticatorErrorResponse from the Intent received by Activity.onActivityResult(int, int, Intent) after launching Fido2PendingIntent.

Constant Value: "FIDO2_ERROR_EXTRA"

public static final String FIDO2_KEY_RESPONSE_EXTRA

This constant is deprecated.
use FIDO2_KEY_CREDENTIAL_EXTRA to fetch PublicKeyCredential instead. PublicKeyCredential contains an AuthenticatorAttestationResponse or an AuthenticatorAssertionResponse.

The key used by the calling Activity to retrieve AuthenticatorAttestationResponse or AuthenticatorAssertionResponse from the Intent received by Activity.onActivityResult(int, int, Intent) after launching Fido2PendingIntent.

Constant Value: "FIDO2_RESPONSE_EXTRA"

public static final String FIDO_CREDENTIAL_JSON_EXTRA

The key used by the calling Activity to retrieve PublicKeyCredential from the Intent received by Activity.onActivityResult(int, int, Intent), as a JSON-formatted string after launching the Fido2 registration or Fido2 sign intent.

Constant Value: "FIDO2_CREDENTIAL_JSON_EXTRA"

public static final String KEY_RESPONSE_EXTRA

The key used by the calling Activity to retrieve ResponseData from the Intent received by Activity.onActivityResult(int, int, Intent) after launching U2fPendingIntent.

Constant Value: "RESPONSE_EXTRA"

Public Methods

public static Fido2ApiClient getFido2ApiClient (Context context)

Creates a new instance of Fido2ApiClient for use in a non-activity Context.

public static Fido2ApiClient getFido2ApiClient (Activity activity)

Creates a new instance of Fido2ApiClient for use in an Activity.

public static Fido2PrivilegedApiClient getFido2PrivilegedApiClient (Context context)

Creates a new instance of Fido2PrivilegedApiClient for use in a non-activity Context.

public static Fido2PrivilegedApiClient getFido2PrivilegedApiClient (Activity activity)

Create a new instance of Fido2PrivilegedApiClient for use in an Activity.

public static U2fApiClient getU2fApiClient (Context context)

Creates a new instance of U2fApiClient for use in a non-activity Context.

public static U2fApiClient getU2fApiClient (Activity activity)

Creates a new instance of U2fApiClient for use in an Activity.