Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 1023c749 authored by Grace Cheng's avatar Grace Cheng
Browse files

Adding auth messages into BiometricStatusRepository and Auth clients 

Adding additional parameters to AuthenticationState and
AuthenticationStateListeners to match auth messages in
KeyguardUpdateMonitor, and adding listener invocations to
Authentication/Detect/Enroll clients

Flag: NONE
Bug: 322555228
Test: atest BiometricStatusRepositoryTest
Test: atest AdaptiveAuthServiceTest
Test: atest FaceAuthenticationClientTest
Test: atest FaceEnrollClientTest
Test: atest FaceDetectClientTest
Test: atest FingerprintAuthenticationClientTest
Test: atest FingerprintEnrollClientTest
Test: atest FingerprintDetectClientTest
Change-Id: Ie3393426b3f04ec4e7fad8a7c35a2d6b827e4db0
parent 726607cc

core/java/android/hardware/biometrics/AuthenticationStateListener.aidl

+34 −25
Original line number Diff line number Diff line
@@ -15,7 +15,13 @@ 
 */

package android.hardware.biometrics;



import android.hardware.biometrics.BiometricSourceType;

import android.hardware.biometrics.events.AuthenticationAcquiredInfo;

import android.hardware.biometrics.events.AuthenticationErrorInfo;

import android.hardware.biometrics.events.AuthenticationFailedInfo;

import android.hardware.biometrics.events.AuthenticationHelpInfo;

import android.hardware.biometrics.events.AuthenticationStartedInfo;

import android.hardware.biometrics.events.AuthenticationStoppedInfo;

import android.hardware.biometrics.events.AuthenticationSucceededInfo;



/**

 * Low-level callback interface between <Biometric>Manager and <Auth>Service. Allows core system
@@ -25,41 +31,44 @@ import android.hardware.biometrics.BiometricSourceType; 
 */

oneway interface AuthenticationStateListener {

    /**

     * Defines behavior in response to authentication starting

     * @param requestReason reason from [BiometricRequestConstants.RequestReason] for requesting

     * authentication starting

     * Defines behavior in response to biometric authentication being acquired.

     * @param authInfo information related to the biometric authentication acquired.

     */

    void onAuthenticationStarted(int requestReason);

    void onAuthenticationAcquired(in AuthenticationAcquiredInfo authInfo);



    /**

     * Defines behavior in response to authentication stopping

     * Defines behavior in response to an unrecoverable error encountered during authentication.

     * @param authInfo information related to the unrecoverable auth error encountered

     */

    void onAuthenticationStopped();

    void onAuthenticationError(in AuthenticationErrorInfo authInfo);



    /**

     * Defines behavior in response to a successful authentication

     * @param requestReason Reason from [BiometricRequestConstants.RequestReason] for the requested

     *                      authentication

     * @param userId The user Id for the requested authentication

     * Defines behavior in response to a failed authentication

     * @param authInfo information related to the failed authentication

     */

    void onAuthenticationSucceeded(int requestReason, int userId);

    void onAuthenticationFailed(in AuthenticationFailedInfo authInfo);



    /**

     * Defines behavior in response to a failed authentication

     * @param requestReason Reason from [BiometricRequestConstants.RequestReason] for the requested

     *                      authentication

     * @param userId The user Id for the requested authentication

     * Defines behavior in response to a recoverable error encountered during authentication.

     * @param authInfo information related to the recoverable auth error encountered

     */

    void onAuthenticationHelp(in AuthenticationHelpInfo authInfo);



    /**

     * Defines behavior in response to authentication starting

     * @param authInfo information related to the authentication starting

     */

    void onAuthenticationFailed(int requestReason, int userId);

    void onAuthenticationStarted(in AuthenticationStartedInfo authInfo);



    /**

     * Defines behavior in response to biometric being acquired.

     * @param biometricSourceType identifies [BiometricSourceType] biometric was acquired for

     * @param requestReason reason from [BiometricRequestConstants.RequestReason] for authentication

     * @param acquiredInfo [BiometricFingerprintConstants.FingerprintAcquired] int corresponding to

     *                     a known acquired message.

     * Defines behavior in response to authentication stopping

     * @param authInfo information related to the authentication stopping

     */

    void onAuthenticationStopped(in AuthenticationStoppedInfo authInfo);



    /**

     * Defines behavior in response to a successful authentication

     * @param authInfo information related to the successful authentication

     */

    void onAuthenticationAcquired(

        in BiometricSourceType biometricSourceType, int requestReason, int acquiredInfo

    );

    void onAuthenticationSucceeded(in AuthenticationSucceededInfo authInfo);

}

core/java/android/hardware/biometrics/events/AuthenticationAcquiredInfo.aidl

0 → 100644
+19 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 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.events;



parcelable AuthenticationAcquiredInfo;

core/java/android/hardware/biometrics/events/AuthenticationAcquiredInfo.java

0 → 100644
+305 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 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.events;



import android.annotation.NonNull;

import android.annotation.Nullable;

import android.hardware.biometrics.BiometricFaceConstants;

import android.hardware.biometrics.BiometricFingerprintConstants;

import android.hardware.biometrics.BiometricRequestConstants;

import android.hardware.biometrics.BiometricSourceType;

import android.os.Parcel;

import android.os.Parcelable;



import com.android.internal.util.DataClass;



/**

 * Information related to biometric authentication being acquired.

 * @hide

 */

@DataClass(

        genParcelable = true,

        genAidl = true,

        genBuilder = true,

        genSetters = true,

        genEqualsHashCode = true

)

public final class AuthenticationAcquiredInfo implements Parcelable {

    /** Identifies {@link BiometricSourceType} of authentication. */

    @NonNull

    private final BiometricSourceType mBiometricSourceType;



    /** Indicates reason from {@link BiometricRequestConstants.RequestReason} for

     * requesting authentication. */

    @BiometricRequestConstants.RequestReason

    private final int mRequestReason;



    /**

     * {@link BiometricFaceConstants.FaceAcquired} or

     * {@link BiometricFingerprintConstants.FingerprintAcquired} int corresponding to

     * a known acquired message.

     */

    private final int mAcquiredInfo;







    // Code below generated by codegen v1.0.23.

    //

    // DO NOT MODIFY!

    // CHECKSTYLE:OFF Generated code

    //

    // To regenerate run:

    // $ codegen $ANDROID_BUILD_TOP/frameworks/base/core/java/android/hardware/biometrics/events/AuthenticationAcquiredInfo.java

    //

    // To exclude the generated code from IntelliJ auto-formatting enable (one-time):

    //   Settings > Editor > Code Style > Formatter Control

    //@formatter:off





    @DataClass.Generated.Member

    /* package-private */ AuthenticationAcquiredInfo(

            @NonNull BiometricSourceType biometricSourceType,

            @BiometricRequestConstants.RequestReason int requestReason,

            int acquiredInfo) {

        this.mBiometricSourceType = biometricSourceType;

        com.android.internal.util.AnnotationValidations.validate(

                NonNull.class, null, mBiometricSourceType);

        this.mRequestReason = requestReason;

        com.android.internal.util.AnnotationValidations.validate(

                BiometricRequestConstants.RequestReason.class, null, mRequestReason);

        this.mAcquiredInfo = acquiredInfo;



        // onConstructed(); // You can define this method to get a callback

    }



    /**

     * Identifies {@link BiometricSourceType} of authentication.

     */

    @DataClass.Generated.Member

    public @NonNull BiometricSourceType getBiometricSourceType() {

        return mBiometricSourceType;

    }



    /**

     * Indicates reason from {@link BiometricRequestConstants.RequestReason} for

     * requesting authentication.

     */

    @DataClass.Generated.Member

    public @BiometricRequestConstants.RequestReason int getRequestReason() {

        return mRequestReason;

    }



    /**

     * {@link BiometricFaceConstants.FaceAcquired} or

     * {@link BiometricFingerprintConstants.FingerprintAcquired} int corresponding to

     * a known acquired message.

     */

    @DataClass.Generated.Member

    public int getAcquiredInfo() {

        return mAcquiredInfo;

    }



    @Override

    @DataClass.Generated.Member

    public boolean equals(@Nullable Object o) {

        // You can override field equality logic by defining either of the methods like:

        // boolean fieldNameEquals(AuthenticationAcquiredInfo other) { ... }

        // boolean fieldNameEquals(FieldType otherValue) { ... }



        if (this == o) return true;

        if (o == null || getClass() != o.getClass()) return false;

        @SuppressWarnings("unchecked")

        AuthenticationAcquiredInfo that = (AuthenticationAcquiredInfo) o;

        //noinspection PointlessBooleanExpression

        return true

                && java.util.Objects.equals(mBiometricSourceType, that.mBiometricSourceType)

                && mRequestReason == that.mRequestReason

                && mAcquiredInfo == that.mAcquiredInfo;

    }



    @Override

    @DataClass.Generated.Member

    public int hashCode() {

        // You can override field hashCode logic by defining methods like:

        // int fieldNameHashCode() { ... }



        int _hash = 1;

        _hash = 31 * _hash + java.util.Objects.hashCode(mBiometricSourceType);

        _hash = 31 * _hash + mRequestReason;

        _hash = 31 * _hash + mAcquiredInfo;

        return _hash;

    }



    @Override

    @DataClass.Generated.Member

    public void writeToParcel(@NonNull Parcel dest, int flags) {

        // You can override field parcelling by defining methods like:

        // void parcelFieldName(Parcel dest, int flags) { ... }



        dest.writeTypedObject(mBiometricSourceType, flags);

        dest.writeInt(mRequestReason);

        dest.writeInt(mAcquiredInfo);

    }



    @Override

    @DataClass.Generated.Member

    public int describeContents() { return 0; }



    /** @hide */

    @SuppressWarnings({"unchecked", "RedundantCast"})

    @DataClass.Generated.Member

    /* package-private */ AuthenticationAcquiredInfo(@NonNull Parcel in) {

        // You can override field unparcelling by defining methods like:

        // static FieldType unparcelFieldName(Parcel in) { ... }



        BiometricSourceType biometricSourceType = (BiometricSourceType) in.readTypedObject(BiometricSourceType.CREATOR);

        int requestReason = in.readInt();

        int acquiredInfo = in.readInt();



        this.mBiometricSourceType = biometricSourceType;

        com.android.internal.util.AnnotationValidations.validate(

                NonNull.class, null, mBiometricSourceType);

        this.mRequestReason = requestReason;

        com.android.internal.util.AnnotationValidations.validate(

                BiometricRequestConstants.RequestReason.class, null, mRequestReason);

        this.mAcquiredInfo = acquiredInfo;



        // onConstructed(); // You can define this method to get a callback

    }



    @DataClass.Generated.Member

    public static final @NonNull Parcelable.Creator<AuthenticationAcquiredInfo> CREATOR

            = new Parcelable.Creator<AuthenticationAcquiredInfo>() {

        @Override

        public AuthenticationAcquiredInfo[] newArray(int size) {

            return new AuthenticationAcquiredInfo[size];

        }



        @Override

        public AuthenticationAcquiredInfo createFromParcel(@NonNull Parcel in) {

            return new AuthenticationAcquiredInfo(in);

        }

    };



    /**

     * A builder for {@link AuthenticationAcquiredInfo}

     */

    @SuppressWarnings("WeakerAccess")

    @DataClass.Generated.Member

    public static final class Builder {



        private @NonNull BiometricSourceType mBiometricSourceType;

        private @BiometricRequestConstants.RequestReason int mRequestReason;

        private int mAcquiredInfo;



        private long mBuilderFieldsSet = 0L;



        /**

         * Creates a new Builder.

         *

         * @param biometricSourceType

         *   Identifies {@link BiometricSourceType} of authentication.

         * @param requestReason

         *   Indicates reason from {@link BiometricRequestConstants.RequestReason} for

         *   requesting authentication.

         * @param acquiredInfo

         *   {@link BiometricFaceConstants.FaceAcquired} or

         *   {@link BiometricFingerprintConstants.FingerprintAcquired} int corresponding to

         *   a known acquired message.

         */

        public Builder(

                @NonNull BiometricSourceType biometricSourceType,

                @BiometricRequestConstants.RequestReason int requestReason,

                int acquiredInfo) {

            mBiometricSourceType = biometricSourceType;

            com.android.internal.util.AnnotationValidations.validate(

                    NonNull.class, null, mBiometricSourceType);

            mRequestReason = requestReason;

            com.android.internal.util.AnnotationValidations.validate(

                    BiometricRequestConstants.RequestReason.class, null, mRequestReason);

            mAcquiredInfo = acquiredInfo;

        }



        /**

         * Identifies {@link BiometricSourceType} of authentication.

         */

        @DataClass.Generated.Member

        public @NonNull Builder setBiometricSourceType(@NonNull BiometricSourceType value) {

            checkNotUsed();

            mBuilderFieldsSet |= 0x1;

            mBiometricSourceType = value;

            return this;

        }



        /**

         * Indicates reason from {@link BiometricRequestConstants.RequestReason} for

         * requesting authentication.

         */

        @DataClass.Generated.Member

        public @NonNull Builder setRequestReason(@BiometricRequestConstants.RequestReason int value) {

            checkNotUsed();

            mBuilderFieldsSet |= 0x2;

            mRequestReason = value;

            return this;

        }



        /**

         * {@link BiometricFaceConstants.FaceAcquired} or

         * {@link BiometricFingerprintConstants.FingerprintAcquired} int corresponding to

         * a known acquired message.

         */

        @DataClass.Generated.Member

        public @NonNull Builder setAcquiredInfo(int value) {

            checkNotUsed();

            mBuilderFieldsSet |= 0x4;

            mAcquiredInfo = value;

            return this;

        }



        /** Builds the instance. This builder should not be touched after calling this! */

        public @NonNull AuthenticationAcquiredInfo build() {

            checkNotUsed();

            mBuilderFieldsSet |= 0x8; // Mark builder used



            AuthenticationAcquiredInfo o = new AuthenticationAcquiredInfo(

                    mBiometricSourceType,

                    mRequestReason,

                    mAcquiredInfo);

            return o;

        }



        private void checkNotUsed() {

            if ((mBuilderFieldsSet & 0x8) != 0) {

                throw new IllegalStateException(

                        "This Builder should not be reused. Use a new Builder instance instead");

            }

        }

    }



    @DataClass.Generated(

            time = 1713305187861L,

            codegenVersion = "1.0.23",

            sourceFile = "frameworks/base/core/java/android/hardware/biometrics/events/AuthenticationAcquiredInfo.java",

            inputSignatures = "private final @android.annotation.NonNull android.hardware.biometrics.BiometricSourceType mBiometricSourceType\nprivate final @android.hardware.biometrics.BiometricRequestConstants.RequestReason int mRequestReason\nprivate final  int mAcquiredInfo\nclass AuthenticationAcquiredInfo extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genParcelable=true, genAidl=true, genBuilder=true, genSetters=true, genEqualsHashCode=true)")

    @Deprecated

    private void __metadata() {}





    //@formatter:on

    // End of generated code



}

core/java/android/hardware/biometrics/events/AuthenticationErrorInfo.aidl

0 → 100644
+19 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 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.events;



parcelable AuthenticationErrorInfo;

core/java/android/hardware/biometrics/events/AuthenticationErrorInfo.java

0 → 100644
+347 −0

File added.

Preview size limit exceeded, changes collapsed.