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

Commit 6f8fa9ac authored by Brian C. Young's avatar Brian C. Young
Browse files

"Unlocked device required" javadoc clarification 

Wording changes on the public API functions for these keys.

Test: CTS
Bug: 67752510
Change-Id: Iaf620e8c0e06d436d09f50d308268653bec196ce
parent 50228a64

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

+7 −4
Original line number Original line Diff line number Diff line
@@ -673,7 +673,9 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec, UserAu 
    }

    }





    /**

    /**

     * Returns {@code true} if the key cannot be used unless the device screen is unlocked.

     * Returns {@code true} if the screen must be unlocked for this key to be used for encryption or

     * signing. Decryption and signature verification will still be available when the screen is

     * locked.

     *

     *

     * @see Builder#setUnlockedDeviceRequired(boolean)

     * @see Builder#setUnlockedDeviceRequired(boolean)

     */

     */
@@ -1289,9 +1291,10 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec, UserAu 




        /**

        /**

         * Sets whether the keystore requires the screen to be unlocked before allowing decryption

         * Sets whether the keystore requires the screen to be unlocked before allowing decryption

         * using this key. If this is set to {@code true}, any attempt to decrypt using this key

         * using this key. If this is set to {@code true}, any attempt to decrypt or sign using this

         * while the screen is locked will fail. A locked device requires a PIN, password,

         * key while the screen is locked will fail. A locked device requires a PIN, password,

         * fingerprint, or other trusted factor to access.

         * fingerprint, or other trusted factor to access. While the screen is locked, the key can

         * still be used for encryption or signature verification.

         */

         */

        @NonNull

        @NonNull

        public Builder setUnlockedDeviceRequired(boolean unlockedDeviceRequired) {

        public Builder setUnlockedDeviceRequired(boolean unlockedDeviceRequired) {

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

+7 −4
Original line number Original line Diff line number Diff line
@@ -508,7 +508,9 @@ public final class KeyProtection implements ProtectionParameter, UserAuthArgs { 
    }

    }





    /**

    /**

     * Returns {@code true} if the key cannot be used unless the device screen is unlocked.

     * Returns {@code true} if the screen must be unlocked for this key to be used for encryption or

     * signing. Decryption and signature verification will still be available when the screen is

     * locked.

     *

     *

     * @see Builder#setUnlockedDeviceRequired(boolean)

     * @see Builder#setUnlockedDeviceRequired(boolean)

     */

     */
@@ -929,9 +931,10 @@ public final class KeyProtection implements ProtectionParameter, UserAuthArgs { 




        /**

        /**

         * Sets whether the keystore requires the screen to be unlocked before allowing decryption

         * Sets whether the keystore requires the screen to be unlocked before allowing decryption

         * using this key. If this is set to {@code true}, any attempt to decrypt using this key

         * using this key. If this is set to {@code true}, any attempt to decrypt or sign using this

         * while the screen is locked will fail. A locked device requires a PIN, password,

         * key while the screen is locked will fail. A locked device requires a PIN, password,

         * fingerprint, or other trusted factor to access.

         * fingerprint, or other trusted factor to access. While the screen is locked, the key can

         * still be used for encryption or signature verification.

         */

         */

        @NonNull

        @NonNull

        public Builder setUnlockedDeviceRequired(boolean unlockedDeviceRequired) {

        public Builder setUnlockedDeviceRequired(boolean unlockedDeviceRequired) {