Added in API level 28

ConfirmationPrompt

open class ConfirmationPrompt
kotlin.Any
   ↳ android.security.ConfirmationPrompt

Class used for displaying confirmation prompts.

Confirmation prompts are prompts shown to the user to confirm a given text and are implemented in a way that a positive response indicates with high confidence that the user has seen the given text, even if the Android framework (including the kernel) was compromised. Implementing confirmation prompts with these guarantees requires dedicated hardware-support and may not always be available.

Confirmation prompts are typically used with an external entity - the Relying Party - in the following way. The setup steps are as follows:

  • Before first use, the application generates a key-pair with the CONFIRMATION tag set. AndroidKeyStore key attestation, e.g., android.security.keystore.KeyGenParameterSpec.Builder#setAttestationChallenge(byte[]) is used to generate a certificate chain that includes the public key (Kpub in the following) of the newly generated key.
  • The application sends Kpub and the certificate chain resulting from device attestation to the Relying Party.
  • The Relying Party validates the certificate chain which involves checking the root certificate is what is expected (e.g. a certificate from Google), each certificate signs the next one in the chain, ending with Kpub, and that the attestation certificate asserts that Kpub has the CONFIRMATION tag set. Additionally the relying party stores Kpub and associates it with the device it was received from.

The Relying Party is typically an external device (for example connected via Bluetooth) or application server.

Before executing a transaction which requires a high assurance of user content, the application does the following:

  • The application gets a cryptographic nonce from the Relying Party and passes this as the extraData (via the Builder helper class) to the presentPrompt() method. The Relying Party stores the nonce locally since it'll use it in a later step.
  • If the user approves the prompt a Confirmation Response is returned in the onConfirmed(byte[]) callback as the dataThatWasConfirmed parameter. This blob contains the text that was shown to the user, the extraData parameter, and possibly other data.
  • The application signs the Confirmation Response with the previously created key and sends the blob and the signature to the Relying Party.
  • The Relying Party checks that the signature was made with Kpub and then extracts promptText matches what is expected and extraData matches the previously created nonce. If all checks passes, the transaction is executed.

Note: It is vital to check the promptText because this is the only part that the user has approved. To avoid writing parsers for all of the possible locales, it is recommended that the Relying Party uses the same string generator as used on the device and performs a simple string comparison.

Summary

Nested classes

A builder that collects arguments, to be shown on the system-provided confirmation prompt.
Public methods
open Unit

Cancels a prompt currently being displayed.
open static Boolean
isSupported(context: Context!)

Checks if the device supports confirmation prompts.
open Unit

Requests a confirmation prompt to be presented to the user.

Public methods

cancelPrompt

Added in API level 28
open fun cancelPrompt(): Unit

Cancels a prompt currently being displayed. On success, the onCanceled() method on the supplied callback object will be called asynchronously.

Exceptions
java.lang.IllegalStateException if no prompt is currently being presented.

isSupported

Added in API level 28
open static fun isSupported(context: Context!): Boolean

Checks if the device supports confirmation prompts.

Parameters
context Context!: the application context.
Return
Boolean true if confirmation prompts are supported by the device.

presentPrompt

Added in API level 28
open fun presentPrompt(
    executor: Executor, 
    callback: ConfirmationCallback
): Unit

Requests a confirmation prompt to be presented to the user. When the prompt is no longer being presented, one of the methods in ConfirmationCallback is called on the supplied callback object. Confirmation prompts may not be available when accessibility services are running so this may fail with a ConfirmationNotAvailableException exception even if isSupported returns true.

Parameters
executor Executor: the executor identifying the thread that will receive the callback. This value cannot be null.
callback ConfirmationCallback: the callback to use when the prompt is done showing. This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the prompt text is too long or malfomed.
android.security.ConfirmationAlreadyPresentingException if another prompt is being presented.
android.security.ConfirmationNotAvailableException if confirmation prompts are not supported.