1 /* 2 * Copyright (C) 2022 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.keyguard 18 19 import android.annotation.StringDef 20 import android.os.PowerManager 21 import com.android.internal.logging.UiEvent 22 import com.android.internal.logging.UiEventLogger 23 import com.android.keyguard.FaceAuthApiRequestReason.Companion.NOTIFICATION_PANEL_CLICKED 24 import com.android.keyguard.FaceAuthApiRequestReason.Companion.PICK_UP_GESTURE_TRIGGERED 25 import com.android.keyguard.FaceAuthApiRequestReason.Companion.QS_EXPANDED 26 import com.android.keyguard.FaceAuthApiRequestReason.Companion.SWIPE_UP_ON_BOUNCER 27 import com.android.keyguard.FaceAuthApiRequestReason.Companion.UDFPS_POINTER_DOWN 28 import com.android.keyguard.InternalFaceAuthReasons.ALL_AUTHENTICATORS_REGISTERED 29 import com.android.keyguard.InternalFaceAuthReasons.ALTERNATE_BIOMETRIC_BOUNCER_SHOWN 30 import com.android.keyguard.InternalFaceAuthReasons.ASSISTANT_VISIBILITY_CHANGED 31 import com.android.keyguard.InternalFaceAuthReasons.AUTH_REQUEST_DURING_CANCELLATION 32 import com.android.keyguard.InternalFaceAuthReasons.BIOMETRIC_ENABLED 33 import com.android.keyguard.InternalFaceAuthReasons.CAMERA_LAUNCHED 34 import com.android.keyguard.InternalFaceAuthReasons.DEVICE_WOKEN_UP_ON_REACH_GESTURE 35 import com.android.keyguard.InternalFaceAuthReasons.DREAM_STARTED 36 import com.android.keyguard.InternalFaceAuthReasons.DREAM_STOPPED 37 import com.android.keyguard.InternalFaceAuthReasons.ENROLLMENTS_CHANGED 38 import com.android.keyguard.InternalFaceAuthReasons.FACE_AUTHENTICATED 39 import com.android.keyguard.InternalFaceAuthReasons.FACE_AUTH_STOPPED_ON_USER_INPUT 40 import com.android.keyguard.InternalFaceAuthReasons.FACE_CANCEL_NOT_RECEIVED 41 import com.android.keyguard.InternalFaceAuthReasons.FACE_LOCKOUT_RESET 42 import com.android.keyguard.InternalFaceAuthReasons.FINISHED_GOING_TO_SLEEP 43 import com.android.keyguard.InternalFaceAuthReasons.FP_AUTHENTICATED 44 import com.android.keyguard.InternalFaceAuthReasons.FP_LOCKED_OUT 45 import com.android.keyguard.InternalFaceAuthReasons.GOING_TO_SLEEP 46 import com.android.keyguard.InternalFaceAuthReasons.KEYGUARD_GOING_AWAY 47 import com.android.keyguard.InternalFaceAuthReasons.KEYGUARD_INIT 48 import com.android.keyguard.InternalFaceAuthReasons.KEYGUARD_OCCLUSION_CHANGED 49 import com.android.keyguard.InternalFaceAuthReasons.KEYGUARD_RESET 50 import com.android.keyguard.InternalFaceAuthReasons.KEYGUARD_VISIBILITY_CHANGED 51 import com.android.keyguard.InternalFaceAuthReasons.NON_STRONG_BIOMETRIC_ALLOWED_CHANGED 52 import com.android.keyguard.InternalFaceAuthReasons.OCCLUDING_APP_REQUESTED 53 import com.android.keyguard.InternalFaceAuthReasons.POSTURE_CHANGED 54 import com.android.keyguard.InternalFaceAuthReasons.PRIMARY_BOUNCER_SHOWN 55 import com.android.keyguard.InternalFaceAuthReasons.PRIMARY_BOUNCER_SHOWN_OR_WILL_BE_SHOWN 56 import com.android.keyguard.InternalFaceAuthReasons.RETRY_AFTER_HW_UNAVAILABLE 57 import com.android.keyguard.InternalFaceAuthReasons.STARTED_WAKING_UP 58 import com.android.keyguard.InternalFaceAuthReasons.STRONG_AUTH_ALLOWED_CHANGED 59 import com.android.keyguard.InternalFaceAuthReasons.TRUST_DISABLED 60 import com.android.keyguard.InternalFaceAuthReasons.TRUST_ENABLED 61 import com.android.keyguard.InternalFaceAuthReasons.USER_SWITCHING 62 63 /** 64 * List of reasons why face auth is requested by clients through 65 * [KeyguardUpdateMonitor.requestFaceAuth]. 66 */ 67 @Retention(AnnotationRetention.SOURCE) 68 @StringDef( 69 SWIPE_UP_ON_BOUNCER, 70 UDFPS_POINTER_DOWN, 71 NOTIFICATION_PANEL_CLICKED, 72 QS_EXPANDED, 73 PICK_UP_GESTURE_TRIGGERED, 74 ) 75 annotation class FaceAuthApiRequestReason { 76 companion object { 77 const val SWIPE_UP_ON_BOUNCER = "Face auth due to swipe up on bouncer" 78 const val UDFPS_POINTER_DOWN = "Face auth triggered due to finger down on UDFPS" 79 const val NOTIFICATION_PANEL_CLICKED = "Face auth due to notification panel click." 80 const val QS_EXPANDED = "Face auth due to QS expansion." 81 const val PICK_UP_GESTURE_TRIGGERED = 82 "Face auth due to pickup gesture triggered when the device is awake and not from AOD." 83 } 84 } 85 86 /** List of events why face auth could be triggered by [KeyguardUpdateMonitor]. */ 87 private object InternalFaceAuthReasons { 88 const val OCCLUDING_APP_REQUESTED = "Face auth due to request from occluding app." 89 const val RETRY_AFTER_HW_UNAVAILABLE = "Face auth due to retry after hardware unavailable." 90 const val FACE_LOCKOUT_RESET = "Face auth due to face lockout reset." 91 const val DEVICE_WOKEN_UP_ON_REACH_GESTURE = 92 "Face auth requested when user reaches for the device on AoD." 93 const val ALTERNATE_BIOMETRIC_BOUNCER_SHOWN = "Face auth due to alternate bouncer shown." 94 const val PRIMARY_BOUNCER_SHOWN = "Face auth started/stopped due to primary bouncer shown." 95 const val PRIMARY_BOUNCER_SHOWN_OR_WILL_BE_SHOWN = 96 "Face auth started/stopped due to bouncer being shown or will be shown." 97 const val TRUST_DISABLED = "Face auth started due to trust disabled." 98 const val TRUST_ENABLED = "Face auth stopped due to trust enabled." 99 const val KEYGUARD_OCCLUSION_CHANGED = 100 "Face auth started/stopped due to keyguard occlusion change." 101 const val ASSISTANT_VISIBILITY_CHANGED = 102 "Face auth started/stopped due to assistant visibility change." 103 const val STARTED_WAKING_UP = "Face auth started/stopped due to device starting to wake up." 104 const val DREAM_STOPPED = "Face auth due to dream stopped." 105 const val ALL_AUTHENTICATORS_REGISTERED = "Face auth due to all authenticators registered." 106 const val ENROLLMENTS_CHANGED = "Face auth due to enrolments changed." 107 const val KEYGUARD_VISIBILITY_CHANGED = 108 "Face auth stopped or started due to keyguard visibility changed." 109 const val FACE_CANCEL_NOT_RECEIVED = "Face auth stopped due to face cancel signal not received." 110 const val AUTH_REQUEST_DURING_CANCELLATION = 111 "Another request to start face auth received while cancelling face auth" 112 const val DREAM_STARTED = "Face auth stopped because dreaming started" 113 const val FP_LOCKED_OUT = "Face auth stopped because fp locked out" 114 const val FACE_AUTH_STOPPED_ON_USER_INPUT = 115 "Face auth stopped because user started typing password/pin" 116 const val KEYGUARD_GOING_AWAY = "Face auth stopped because keyguard going away" 117 const val CAMERA_LAUNCHED = "Face auth started/stopped because camera launched" 118 const val FP_AUTHENTICATED = "Face auth started/stopped because fingerprint launched" 119 const val GOING_TO_SLEEP = "Face auth started/stopped because going to sleep" 120 const val FINISHED_GOING_TO_SLEEP = "Face auth stopped because finished going to sleep" 121 const val KEYGUARD_INIT = "Face auth started/stopped because Keyguard is initialized" 122 const val KEYGUARD_RESET = "Face auth started/stopped because Keyguard is reset" 123 const val USER_SWITCHING = "Face auth started/stopped because user is switching" 124 const val FACE_AUTHENTICATED = "Face auth started/stopped because face is authenticated" 125 const val BIOMETRIC_ENABLED = 126 "Face auth started/stopped because biometric is enabled on keyguard" 127 const val STRONG_AUTH_ALLOWED_CHANGED = "Face auth stopped because strong auth allowed changed" 128 const val NON_STRONG_BIOMETRIC_ALLOWED_CHANGED = 129 "Face auth stopped because non strong biometric allowed changed" 130 const val POSTURE_CHANGED = "Face auth started/stopped due to device posture changed." 131 } 132 133 /** 134 * UiEvents that are logged to identify why face auth is being triggered. 135 * 136 * @param extraInfo is logged as the position. See [UiEventLogger#logWithInstanceIdAndPosition] 137 */ 138 enum class FaceAuthUiEvent 139 constructor(private val id: Int, val reason: String, var extraInfo: Int = 0) : 140 UiEventLogger.UiEventEnum { 141 @UiEvent(doc = OCCLUDING_APP_REQUESTED) 142 FACE_AUTH_TRIGGERED_OCCLUDING_APP_REQUESTED(1146, OCCLUDING_APP_REQUESTED), 143 @UiEvent(doc = UDFPS_POINTER_DOWN) 144 FACE_AUTH_TRIGGERED_UDFPS_POINTER_DOWN(1147, UDFPS_POINTER_DOWN), 145 @UiEvent(doc = SWIPE_UP_ON_BOUNCER) 146 FACE_AUTH_TRIGGERED_SWIPE_UP_ON_BOUNCER(1148, SWIPE_UP_ON_BOUNCER), 147 @UiEvent(doc = DEVICE_WOKEN_UP_ON_REACH_GESTURE) 148 FACE_AUTH_TRIGGERED_ON_REACH_GESTURE_ON_AOD(1149, DEVICE_WOKEN_UP_ON_REACH_GESTURE), 149 @UiEvent(doc = FACE_LOCKOUT_RESET) 150 FACE_AUTH_TRIGGERED_FACE_LOCKOUT_RESET(1150, FACE_LOCKOUT_RESET), 151 @UiEvent(doc = QS_EXPANDED) FACE_AUTH_TRIGGERED_QS_EXPANDED(1151, QS_EXPANDED), 152 @UiEvent(doc = NOTIFICATION_PANEL_CLICKED) 153 FACE_AUTH_TRIGGERED_NOTIFICATION_PANEL_CLICKED(1152, NOTIFICATION_PANEL_CLICKED), 154 @UiEvent(doc = PICK_UP_GESTURE_TRIGGERED) 155 FACE_AUTH_TRIGGERED_PICK_UP_GESTURE_TRIGGERED(1153, PICK_UP_GESTURE_TRIGGERED), 156 @UiEvent(doc = ALTERNATE_BIOMETRIC_BOUNCER_SHOWN) 157 FACE_AUTH_TRIGGERED_ALTERNATE_BIOMETRIC_BOUNCER_SHOWN(1154, ALTERNATE_BIOMETRIC_BOUNCER_SHOWN), 158 @UiEvent(doc = PRIMARY_BOUNCER_SHOWN) 159 FACE_AUTH_UPDATED_PRIMARY_BOUNCER_SHOWN(1155, PRIMARY_BOUNCER_SHOWN), 160 @UiEvent(doc = PRIMARY_BOUNCER_SHOWN_OR_WILL_BE_SHOWN) 161 FACE_AUTH_UPDATED_PRIMARY_BOUNCER_SHOWN_OR_WILL_BE_SHOWN( 162 1197, 163 PRIMARY_BOUNCER_SHOWN_OR_WILL_BE_SHOWN 164 ), 165 @UiEvent(doc = RETRY_AFTER_HW_UNAVAILABLE) 166 FACE_AUTH_TRIGGERED_RETRY_AFTER_HW_UNAVAILABLE(1156, RETRY_AFTER_HW_UNAVAILABLE), 167 @UiEvent(doc = TRUST_DISABLED) FACE_AUTH_TRIGGERED_TRUST_DISABLED(1158, TRUST_DISABLED), 168 @UiEvent(doc = TRUST_ENABLED) FACE_AUTH_STOPPED_TRUST_ENABLED(1173, TRUST_ENABLED), 169 @UiEvent(doc = KEYGUARD_OCCLUSION_CHANGED) 170 FACE_AUTH_UPDATED_KEYGUARD_OCCLUSION_CHANGED(1159, KEYGUARD_OCCLUSION_CHANGED), 171 @UiEvent(doc = ASSISTANT_VISIBILITY_CHANGED) 172 FACE_AUTH_UPDATED_ASSISTANT_VISIBILITY_CHANGED(1160, ASSISTANT_VISIBILITY_CHANGED), 173 @UiEvent(doc = STARTED_WAKING_UP) 174 FACE_AUTH_UPDATED_STARTED_WAKING_UP(1161, STARTED_WAKING_UP) { extraInfoToStringnull175 override fun extraInfoToString(): String { 176 return PowerManager.wakeReasonToString(extraInfo) 177 } 178 }, 179 @UiEvent(doc = POSTURE_CHANGED) FACE_AUTH_UPDATED_POSTURE_CHANGED(1265, POSTURE_CHANGED), 180 @Deprecated( 181 "Not a face auth trigger.", 182 ReplaceWith( 183 "FACE_AUTH_UPDATED_STARTED_WAKING_UP, " + 184 "extraInfo=PowerManager.WAKE_REASON_DREAM_FINISHED" 185 ) 186 ) 187 @UiEvent(doc = DREAM_STOPPED) 188 FACE_AUTH_TRIGGERED_DREAM_STOPPED(1162, DREAM_STOPPED), 189 @UiEvent(doc = ALL_AUTHENTICATORS_REGISTERED) 190 FACE_AUTH_TRIGGERED_ALL_AUTHENTICATORS_REGISTERED(1163, ALL_AUTHENTICATORS_REGISTERED), 191 @UiEvent(doc = ENROLLMENTS_CHANGED) 192 FACE_AUTH_TRIGGERED_ENROLLMENTS_CHANGED(1164, ENROLLMENTS_CHANGED), 193 @UiEvent(doc = KEYGUARD_VISIBILITY_CHANGED) 194 FACE_AUTH_UPDATED_KEYGUARD_VISIBILITY_CHANGED(1165, KEYGUARD_VISIBILITY_CHANGED), 195 @UiEvent(doc = FACE_CANCEL_NOT_RECEIVED) 196 FACE_AUTH_STOPPED_FACE_CANCEL_NOT_RECEIVED(1174, FACE_CANCEL_NOT_RECEIVED), 197 @UiEvent(doc = AUTH_REQUEST_DURING_CANCELLATION) 198 FACE_AUTH_TRIGGERED_DURING_CANCELLATION(1175, AUTH_REQUEST_DURING_CANCELLATION), 199 @UiEvent(doc = DREAM_STARTED) FACE_AUTH_STOPPED_DREAM_STARTED(1176, DREAM_STARTED), 200 @UiEvent(doc = FP_LOCKED_OUT) FACE_AUTH_STOPPED_FP_LOCKED_OUT(1177, FP_LOCKED_OUT), 201 @UiEvent(doc = FACE_AUTH_STOPPED_ON_USER_INPUT) 202 FACE_AUTH_STOPPED_USER_INPUT_ON_BOUNCER(1178, FACE_AUTH_STOPPED_ON_USER_INPUT), 203 @UiEvent(doc = KEYGUARD_GOING_AWAY) 204 FACE_AUTH_STOPPED_KEYGUARD_GOING_AWAY(1179, KEYGUARD_GOING_AWAY), 205 @UiEvent(doc = CAMERA_LAUNCHED) FACE_AUTH_UPDATED_CAMERA_LAUNCHED(1180, CAMERA_LAUNCHED), 206 @UiEvent(doc = FP_AUTHENTICATED) FACE_AUTH_UPDATED_FP_AUTHENTICATED(1181, FP_AUTHENTICATED), 207 @UiEvent(doc = GOING_TO_SLEEP) FACE_AUTH_UPDATED_GOING_TO_SLEEP(1182, GOING_TO_SLEEP), 208 @UiEvent(doc = FINISHED_GOING_TO_SLEEP) 209 FACE_AUTH_STOPPED_FINISHED_GOING_TO_SLEEP(1183, FINISHED_GOING_TO_SLEEP), 210 @UiEvent(doc = KEYGUARD_INIT) FACE_AUTH_UPDATED_ON_KEYGUARD_INIT(1189, KEYGUARD_INIT), 211 @UiEvent(doc = KEYGUARD_RESET) FACE_AUTH_UPDATED_KEYGUARD_RESET(1185, KEYGUARD_RESET), 212 @UiEvent(doc = USER_SWITCHING) FACE_AUTH_UPDATED_USER_SWITCHING(1186, USER_SWITCHING), 213 @UiEvent(doc = FACE_AUTHENTICATED) 214 FACE_AUTH_UPDATED_ON_FACE_AUTHENTICATED(1187, FACE_AUTHENTICATED), 215 @UiEvent(doc = BIOMETRIC_ENABLED) 216 FACE_AUTH_UPDATED_BIOMETRIC_ENABLED_ON_KEYGUARD(1188, BIOMETRIC_ENABLED), 217 @UiEvent(doc = STRONG_AUTH_ALLOWED_CHANGED) 218 FACE_AUTH_UPDATED_STRONG_AUTH_CHANGED(1255, STRONG_AUTH_ALLOWED_CHANGED), 219 @UiEvent(doc = NON_STRONG_BIOMETRIC_ALLOWED_CHANGED) 220 FACE_AUTH_NON_STRONG_BIOMETRIC_ALLOWED_CHANGED(1256, NON_STRONG_BIOMETRIC_ALLOWED_CHANGED); 221 getIdnull222 override fun getId(): Int = this.id 223 224 /** Convert [extraInfo] to a human-readable string. By default, this is empty. */ 225 open fun extraInfoToString(): String = "" 226 } 227 228 private val apiRequestReasonToUiEvent = 229 mapOf( 230 SWIPE_UP_ON_BOUNCER to FaceAuthUiEvent.FACE_AUTH_TRIGGERED_SWIPE_UP_ON_BOUNCER, 231 UDFPS_POINTER_DOWN to FaceAuthUiEvent.FACE_AUTH_TRIGGERED_UDFPS_POINTER_DOWN, 232 NOTIFICATION_PANEL_CLICKED to 233 FaceAuthUiEvent.FACE_AUTH_TRIGGERED_NOTIFICATION_PANEL_CLICKED, 234 QS_EXPANDED to FaceAuthUiEvent.FACE_AUTH_TRIGGERED_QS_EXPANDED, 235 PICK_UP_GESTURE_TRIGGERED to FaceAuthUiEvent.FACE_AUTH_TRIGGERED_PICK_UP_GESTURE_TRIGGERED, 236 ) 237 238 /** Converts the [reason] to the corresponding [FaceAuthUiEvent]. */ 239 fun apiRequestReasonToUiEvent(@FaceAuthApiRequestReason reason: String): FaceAuthUiEvent = 240 apiRequestReasonToUiEvent[reason]!! 241