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

Commit 912e35b6 authored by Eric Biggers's avatar Eric Biggers
Browse files

Improve documentation for unlockUserKeyIfUnsecured() 

Document more clearly what unlockUserKeyIfUnsecured() actually does.  It
probably should be renamed to something clearer (I'm thinking of just
changing "Key" to "Keys"), but this is a start.

Bug: 306204742
Flag: exempt, comment-only change
Test: presubmit
Change-Id: Ib35a62fb4627db5755fac57609b1fbb3a659492d
parent 132300bd

core/java/com/android/internal/widget/LockPatternUtils.java

+12 −6
Original line number Original line Diff line number Diff line
@@ -1934,15 +1934,21 @@ public class LockPatternUtils { 
    }

    }





    /**

    /**

     * Unlocks the credential-encrypted storage for the given user if the user is not secured, i.e.

     * If the user is not secured, ie doesn't have an LSKF, then decrypt the user's synthetic

     * doesn't have an LSKF.

     * password and use it to unlock various cryptographic keys associated with the user.  This

     * primarily includes unlocking the user's credential-encrypted (CE) storage.  It also includes

     * deriving or decrypting the vendor auth secret and sending it to the AuthSecret HAL.

     * <p>

     * These tasks would normally be done when the LSKF is verified.  This method is where these

     * tasks are done when the user doesn't have an LSKF.  It's called when the user is started.

     * <p>

     * Except on permission denied, this method doesn't throw an exception on failure.  However, the

     * last thing that it does is unlock CE storage, and whether CE storage has been successfully

     * unlocked can be determined by {@link StorageManager#isCeStorageUnlocked()}.

     * <p>

     * <p>

     * Whether the storage has been unlocked can be determined by

     * {@link StorageManager#isUserKeyUnlocked()}.

     *

     * Requires the {@link android.Manifest.permission#ACCESS_KEYGUARD_SECURE_STORAGE} permission.

     * Requires the {@link android.Manifest.permission#ACCESS_KEYGUARD_SECURE_STORAGE} permission.

     *

     *

     * @param userId the ID of the user whose storage to unlock

     * @param userId the ID of the user whose keys to unlock

     */

     */

    public void unlockUserKeyIfUnsecured(@UserIdInt int userId) {

    public void unlockUserKeyIfUnsecured(@UserIdInt int userId) {

        try {

        try {