2929import java .util .concurrent .Executor ;
3030
3131/**
32- * Authenticates the user with fingerprint and sends corresponding response back to Flutter.
32+ * Authenticates the user with biometrics and sends corresponding response back to Flutter.
3333 *
3434 * <p>One instance per call is generated to ensure readable separation of executable paths across
3535 * method calls.
3636 */
3737@ SuppressWarnings ("deprecation" )
3838class AuthenticationHelper extends BiometricPrompt .AuthenticationCallback
3939 implements Application .ActivityLifecycleCallbacks , DefaultLifecycleObserver {
40-
4140 /** The callback that handles the result of this authentication process. */
4241 interface AuthCompletionHandler {
43-
4442 /** Called when authentication was successful. */
4543 void onSuccess ();
4644
@@ -75,24 +73,32 @@ interface AuthCompletionHandler {
7573 Lifecycle lifecycle ,
7674 FragmentActivity activity ,
7775 MethodCall call ,
78- AuthCompletionHandler completionHandler ) {
76+ AuthCompletionHandler completionHandler ,
77+ boolean allowCredentials ) {
7978 this .lifecycle = lifecycle ;
8079 this .activity = activity ;
8180 this .completionHandler = completionHandler ;
8281 this .call = call ;
8382 this .isAuthSticky = call .argument ("stickyAuth" );
8483 this .uiThreadExecutor = new UiThreadExecutor ();
85- this .promptInfo =
84+
85+ BiometricPrompt .PromptInfo .Builder promptBuilder =
8686 new BiometricPrompt .PromptInfo .Builder ()
8787 .setDescription ((String ) call .argument ("localizedReason" ))
8888 .setTitle ((String ) call .argument ("signInTitle" ))
89- .setSubtitle ((String ) call .argument ("fingerprintHint" ))
90- .setNegativeButtonText ((String ) call .argument ("cancelButton" ))
89+ .setSubtitle ((String ) call .argument ("biometricHint" ))
9190 .setConfirmationRequired ((Boolean ) call .argument ("sensitiveTransaction" ))
92- .build ();
91+ .setConfirmationRequired ((Boolean ) call .argument ("sensitiveTransaction" ));
92+
93+ if (allowCredentials ) {
94+ promptBuilder .setDeviceCredentialAllowed (true );
95+ } else {
96+ promptBuilder .setNegativeButtonText ((String ) call .argument ("cancelButton" ));
97+ }
98+ this .promptInfo = promptBuilder .build ();
9399 }
94100
95- /** Start the fingerprint listener. */
101+ /** Start the biometric listener. */
96102 void authenticate () {
97103 if (lifecycle != null ) {
98104 lifecycle .addObserver (this );
@@ -103,15 +109,15 @@ void authenticate() {
103109 biometricPrompt .authenticate (promptInfo );
104110 }
105111
106- /** Cancels the fingerprint authentication. */
112+ /** Cancels the biometric authentication. */
107113 void stopAuthentication () {
108114 if (biometricPrompt != null ) {
109115 biometricPrompt .cancelAuthentication ();
110116 biometricPrompt = null ;
111117 }
112118 }
113119
114- /** Stops the fingerprint listener. */
120+ /** Stops the biometric listener. */
115121 private void stop () {
116122 if (lifecycle != null ) {
117123 lifecycle .removeObserver (this );
@@ -125,21 +131,27 @@ private void stop() {
125131 public void onAuthenticationError (int errorCode , CharSequence errString ) {
126132 switch (errorCode ) {
127133 case BiometricPrompt .ERROR_NO_DEVICE_CREDENTIAL :
128- completionHandler .onError (
129- "PasscodeNotSet" ,
130- "Phone not secured by PIN, pattern or password, or SIM is currently locked." );
131- break ;
134+ if (call .argument ("useErrorDialogs" )) {
135+ showGoToSettingsDialog (
136+ (String ) call .argument ("deviceCredentialsRequired" ),
137+ (String ) call .argument ("deviceCredentialsSetupDescription" ));
138+ return ;
139+ }
140+ completionHandler .onError ("NotAvailable" , "Security credentials not available." );
132141 case BiometricPrompt .ERROR_NO_SPACE :
133142 case BiometricPrompt .ERROR_NO_BIOMETRICS :
143+ if (promptInfo .isDeviceCredentialAllowed ()) return ;
134144 if (call .argument ("useErrorDialogs" )) {
135- showGoToSettingsDialog ();
145+ showGoToSettingsDialog (
146+ (String ) call .argument ("biometricRequired" ),
147+ (String ) call .argument ("goToSettingDescription" ));
136148 return ;
137149 }
138150 completionHandler .onError ("NotEnrolled" , "No Biometrics enrolled on this device." );
139151 break ;
140152 case BiometricPrompt .ERROR_HW_UNAVAILABLE :
141153 case BiometricPrompt .ERROR_HW_NOT_PRESENT :
142- completionHandler .onError ("NotAvailable" , "Biometrics is not available on this device ." );
154+ completionHandler .onError ("NotAvailable" , "Security credentials not available." );
143155 break ;
144156 case BiometricPrompt .ERROR_LOCKOUT :
145157 completionHandler .onError (
@@ -176,7 +188,7 @@ public void onAuthenticationSucceeded(BiometricPrompt.AuthenticationResult resul
176188 public void onAuthenticationFailed () {}
177189
178190 /**
179- * If the activity is paused, we keep track because fingerprint dialog simply returns "User
191+ * If the activity is paused, we keep track because biometric dialog simply returns "User
180192 * cancelled" when the activity is paused.
181193 */
182194 @ Override
@@ -215,12 +227,12 @@ public void onResume(@NonNull LifecycleOwner owner) {
215227
216228 // Suppress inflateParams lint because dialogs do not need to attach to a parent view.
217229 @ SuppressLint ("InflateParams" )
218- private void showGoToSettingsDialog () {
230+ private void showGoToSettingsDialog (String title , String descriptionText ) {
219231 View view = LayoutInflater .from (activity ).inflate (R .layout .go_to_setting , null , false );
220232 TextView message = (TextView ) view .findViewById (R .id .fingerprint_required );
221233 TextView description = (TextView ) view .findViewById (R .id .go_to_setting_description );
222- message .setText (( String ) call . argument ( "fingerprintRequired" ) );
223- description .setText (( String ) call . argument ( "goToSettingDescription" ) );
234+ message .setText (title );
235+ description .setText (descriptionText );
224236 Context context = new ContextThemeWrapper (activity , R .style .AlertDialogCustom );
225237 OnClickListener goToSettingHandler =
226238 new OnClickListener () {
0 commit comments