1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
/*
* Copyright (C) 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.hardware.biometrics;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.os.Parcel;
import android.os.Parcelable;
import java.util.ArrayList;
import java.util.List;
/**
* Contains the information set/requested by the caller of the {@link BiometricPrompt}
* @hide
*/
public class PromptInfo implements Parcelable {
@NonNull private CharSequence mTitle;
private boolean mUseDefaultTitle;
@Nullable private CharSequence mSubtitle;
@Nullable private CharSequence mDescription;
@Nullable private CharSequence mDeviceCredentialTitle;
@Nullable private CharSequence mDeviceCredentialSubtitle;
@Nullable private CharSequence mDeviceCredentialDescription;
@Nullable private CharSequence mNegativeButtonText;
private boolean mConfirmationRequested = true; // default to true
private boolean mDeviceCredentialAllowed;
private @BiometricManager.Authenticators.Types int mAuthenticators;
private boolean mDisallowBiometricsIfPolicyExists;
private boolean mReceiveSystemEvents;
@NonNull private List<Integer> mAllowedSensorIds = new ArrayList<>();
private boolean mAllowBackgroundAuthentication;
private boolean mIgnoreEnrollmentState;
private boolean mIsForLegacyFingerprintManager = false;
public PromptInfo() {
}
PromptInfo(Parcel in) {
mTitle = in.readCharSequence();
mUseDefaultTitle = in.readBoolean();
mSubtitle = in.readCharSequence();
mDescription = in.readCharSequence();
mDeviceCredentialTitle = in.readCharSequence();
mDeviceCredentialSubtitle = in.readCharSequence();
mDeviceCredentialDescription = in.readCharSequence();
mNegativeButtonText = in.readCharSequence();
mConfirmationRequested = in.readBoolean();
mDeviceCredentialAllowed = in.readBoolean();
mAuthenticators = in.readInt();
mDisallowBiometricsIfPolicyExists = in.readBoolean();
mReceiveSystemEvents = in.readBoolean();
mAllowedSensorIds = in.readArrayList(Integer.class.getClassLoader(), java.lang.Integer.class);
mAllowBackgroundAuthentication = in.readBoolean();
mIgnoreEnrollmentState = in.readBoolean();
mIsForLegacyFingerprintManager = in.readBoolean();
}
public static final Creator<PromptInfo> CREATOR = new Creator<PromptInfo>() {
@Override
public PromptInfo createFromParcel(Parcel in) {
return new PromptInfo(in);
}
@Override
public PromptInfo[] newArray(int size) {
return new PromptInfo[size];
}
};
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeCharSequence(mTitle);
dest.writeBoolean(mUseDefaultTitle);
dest.writeCharSequence(mSubtitle);
dest.writeCharSequence(mDescription);
dest.writeCharSequence(mDeviceCredentialTitle);
dest.writeCharSequence(mDeviceCredentialSubtitle);
dest.writeCharSequence(mDeviceCredentialDescription);
dest.writeCharSequence(mNegativeButtonText);
dest.writeBoolean(mConfirmationRequested);
dest.writeBoolean(mDeviceCredentialAllowed);
dest.writeInt(mAuthenticators);
dest.writeBoolean(mDisallowBiometricsIfPolicyExists);
dest.writeBoolean(mReceiveSystemEvents);
dest.writeList(mAllowedSensorIds);
dest.writeBoolean(mAllowBackgroundAuthentication);
dest.writeBoolean(mIgnoreEnrollmentState);
dest.writeBoolean(mIsForLegacyFingerprintManager);
}
public boolean containsTestConfigurations() {
if (mIsForLegacyFingerprintManager
&& mAllowedSensorIds.size() == 1
&& !mAllowBackgroundAuthentication) {
return false;
} else if (!mAllowedSensorIds.isEmpty()) {
return true;
} else if (mAllowBackgroundAuthentication) {
return true;
}
return false;
}
public boolean containsPrivateApiConfigurations() {
if (mDisallowBiometricsIfPolicyExists) {
return true;
} else if (mUseDefaultTitle) {
return true;
} else if (mDeviceCredentialTitle != null) {
return true;
} else if (mDeviceCredentialSubtitle != null) {
return true;
} else if (mDeviceCredentialDescription != null) {
return true;
} else if (mReceiveSystemEvents) {
return true;
}
return false;
}
// Setters
public void setTitle(CharSequence title) {
mTitle = title;
}
public void setUseDefaultTitle(boolean useDefaultTitle) {
mUseDefaultTitle = useDefaultTitle;
}
public void setSubtitle(CharSequence subtitle) {
mSubtitle = subtitle;
}
public void setDescription(CharSequence description) {
mDescription = description;
}
public void setDeviceCredentialTitle(CharSequence deviceCredentialTitle) {
mDeviceCredentialTitle = deviceCredentialTitle;
}
public void setDeviceCredentialSubtitle(CharSequence deviceCredentialSubtitle) {
mDeviceCredentialSubtitle = deviceCredentialSubtitle;
}
public void setDeviceCredentialDescription(CharSequence deviceCredentialDescription) {
mDeviceCredentialDescription = deviceCredentialDescription;
}
public void setNegativeButtonText(CharSequence negativeButtonText) {
mNegativeButtonText = negativeButtonText;
}
public void setConfirmationRequested(boolean confirmationRequested) {
mConfirmationRequested = confirmationRequested;
}
public void setDeviceCredentialAllowed(boolean deviceCredentialAllowed) {
mDeviceCredentialAllowed = deviceCredentialAllowed;
}
public void setAuthenticators(int authenticators) {
mAuthenticators = authenticators;
}
public void setDisallowBiometricsIfPolicyExists(boolean disallowBiometricsIfPolicyExists) {
mDisallowBiometricsIfPolicyExists = disallowBiometricsIfPolicyExists;
}
public void setReceiveSystemEvents(boolean receiveSystemEvents) {
mReceiveSystemEvents = receiveSystemEvents;
}
public void setAllowedSensorIds(@NonNull List<Integer> sensorIds) {
mAllowedSensorIds.clear();
mAllowedSensorIds.addAll(sensorIds);
}
public void setAllowBackgroundAuthentication(boolean allow) {
mAllowBackgroundAuthentication = allow;
}
public void setIgnoreEnrollmentState(boolean ignoreEnrollmentState) {
mIgnoreEnrollmentState = ignoreEnrollmentState;
}
public void setIsForLegacyFingerprintManager(int sensorId) {
mIsForLegacyFingerprintManager = true;
mAllowedSensorIds.clear();
mAllowedSensorIds.add(sensorId);
}
// Getters
public CharSequence getTitle() {
return mTitle;
}
public boolean isUseDefaultTitle() {
return mUseDefaultTitle;
}
public CharSequence getSubtitle() {
return mSubtitle;
}
public CharSequence getDescription() {
return mDescription;
}
public CharSequence getDeviceCredentialTitle() {
return mDeviceCredentialTitle;
}
public CharSequence getDeviceCredentialSubtitle() {
return mDeviceCredentialSubtitle;
}
public CharSequence getDeviceCredentialDescription() {
return mDeviceCredentialDescription;
}
public CharSequence getNegativeButtonText() {
return mNegativeButtonText;
}
public boolean isConfirmationRequested() {
return mConfirmationRequested;
}
/**
* This value is read once by {@link com.android.server.biometrics.BiometricService} and
* combined into {@link #getAuthenticators()}.
* @deprecated
* @return
*/
@Deprecated
public boolean isDeviceCredentialAllowed() {
return mDeviceCredentialAllowed;
}
public int getAuthenticators() {
return mAuthenticators;
}
public boolean isDisallowBiometricsIfPolicyExists() {
return mDisallowBiometricsIfPolicyExists;
}
public boolean isReceiveSystemEvents() {
return mReceiveSystemEvents;
}
@NonNull
public List<Integer> getAllowedSensorIds() {
return mAllowedSensorIds;
}
public boolean isAllowBackgroundAuthentication() {
return mAllowBackgroundAuthentication;
}
public boolean isIgnoreEnrollmentState() {
return mIgnoreEnrollmentState;
}
public boolean isForLegacyFingerprintManager() {
return mIsForLegacyFingerprintManager;
}
}
|