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

Commit f137e334 authored by Eric Biggers's avatar Eric Biggers
Browse files

Document that setUserAuthenticationValidWhileOnBody() doesn't actually work 

Bug: 289849354
Test: Build
Change-Id: I8e61eb8c9b0ef94c70ce797497b472e2985973d6
parent ff8a5a36

keystore/java/android/security/keystore/KeyGenParameterSpec.java

+10 −10
Original line number Diff line number Diff line
@@ -1672,16 +1672,16 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec, UserAu 
         * {@link #setUserAuthenticationValidityDurationSeconds} and

         * {@link #setUserAuthenticationRequired}). Once the device has been removed from the

         * user's body, the key will be considered unauthorized and the user will need to

         * re-authenticate to use it. For keys without an authentication validity period this

         * parameter has no effect.

         *

         * <p>Similarly, on devices that do not have an on-body sensor, this parameter will have no

         * effect; the device will always be considered to be "on-body" and the key will therefore

         * remain authorized until the validity period ends.

         *

         * @param remainsValid if {@code true}, and if the device supports on-body detection, key

         * will be invalidated when the device is removed from the user's body or when the

         * authentication validity expires, whichever occurs first.

         * re-authenticate to use it. If the device does not have an on-body sensor or the key does

         * not have an authentication validity period, this parameter has no effect.

         * <p>

         * Since Android 12 (API level 31), this parameter has no effect even on devices that have

         * an on-body sensor. A future version of Android may restore enforcement of this parameter.

         * Meanwhile, it is recommended to not use it.

         *

         * @param remainsValid if {@code true}, and if the device supports enforcement of this

         * parameter, the key will be invalidated when the device is removed from the user's body or

         * when the authentication validity expires, whichever occurs first.

         */

        @NonNull

        public Builder setUserAuthenticationValidWhileOnBody(boolean remainsValid) {

keystore/java/android/security/keystore/KeyProtection.java

+9 −9
Original line number Diff line number Diff line
@@ -1039,16 +1039,16 @@ public final class KeyProtection implements ProtectionParameter, UserAuthArgs { 
         * {@link #setUserAuthenticationValidityDurationSeconds} and

         * {@link #setUserAuthenticationRequired}). Once the device has been removed from the

         * user's body, the key will be considered unauthorized and the user will need to

         * re-authenticate to use it. For keys without an authentication validity period this

         * parameter has no effect.

         *

         * <p>Similarly, on devices that do not have an on-body sensor, this parameter will have no

         * effect; the device will always be considered to be "on-body" and the key will therefore

         * remain authorized until the validity period ends.

         *

         * @param remainsValid if {@code true}, and if the device supports on-body detection, key

         * will be invalidated when the device is removed from the user's body or when the

         * authentication validity expires, whichever occurs first.

         * re-authenticate to use it. If the device does not have an on-body sensor or the key does

         * not have an authentication validity period, this parameter has no effect.

         * <p>

         * Since Android 12 (API level 31), this parameter has no effect even on devices that have

         * an on-body sensor. A future version of Android may restore enforcement of this parameter.

         * Meanwhile, it is recommended to not use it.

         *

         * @param remainsValid if {@code true}, and if the device supports enforcement of this

         * parameter, the key will be invalidated when the device is removed from the user's body or

         * when the authentication validity expires, whichever occurs first.

         */

        @NonNull

        public Builder setUserAuthenticationValidWhileOnBody(boolean remainsValid) {