summaryrefslogtreecommitdiffstats
path: root/keystore/java/android/security/keystore/KeyPermanentlyInvalidatedException.java
diff options
context:
space:
mode:
authorAlex Klyubin <klyubin@google.com>2015-06-16 10:44:11 -0700
committerAlex Klyubin <klyubin@google.com>2015-06-17 11:08:29 -0700
commit83cc7a347f4775821ebeed04a2244b8b847be516 (patch)
treeeb679ee090881d363c901bf4e14a3b280dbd1612 /keystore/java/android/security/keystore/KeyPermanentlyInvalidatedException.java
parente826515469274b4675a5ae6948dd04855ff0b786 (diff)
downloadframeworks_base-83cc7a347f4775821ebeed04a2244b8b847be516.zip
frameworks_base-83cc7a347f4775821ebeed04a2244b8b847be516.tar.gz
frameworks_base-83cc7a347f4775821ebeed04a2244b8b847be516.tar.bz2
Improve documentation for keys requiring user auth.
Bug: 18088752 Change-Id: I24eeb33790a74d8d81d10fcdb1eb058d47144c44
Diffstat (limited to 'keystore/java/android/security/keystore/KeyPermanentlyInvalidatedException.java')
-rw-r--r--keystore/java/android/security/keystore/KeyPermanentlyInvalidatedException.java13
1 files changed, 7 insertions, 6 deletions
diff --git a/keystore/java/android/security/keystore/KeyPermanentlyInvalidatedException.java b/keystore/java/android/security/keystore/KeyPermanentlyInvalidatedException.java
index e320c9c..9e82fc0 100644
--- a/keystore/java/android/security/keystore/KeyPermanentlyInvalidatedException.java
+++ b/keystore/java/android/security/keystore/KeyPermanentlyInvalidatedException.java
@@ -21,12 +21,13 @@ import java.security.InvalidKeyException;
/**
* Indicates that the key can no longer be used because it has been permanently invalidated.
*
- * <p>This can currently occur only for keys that require user authentication. Such keys are
- * permanently invalidated once the secure lock screen is disabled (i.e., reconfigured to None,
- * Swipe or other mode which does not authenticate the user) or when the secure lock screen is
- * forcibly reset (e.g., by Device Admin). Additionally, keys configured to require user
- * authentication for every use of the key are also permanently invalidated once a new fingerprint
- * is enrolled or once no more fingerprints are enrolled.
+ * <p>This only occurs for keys which are authorized to be used only if the user has been
+ * authenticated. Such keys are permanently and irreversibly invalidated once the secure lock screen
+ * is disabled (i.e., reconfigured to None, Swipe or other mode which does not authenticate the
+ * user) or when the secure lock screen is forcibly reset (e.g., by Device Admin). Additionally,
+ * keys configured to require user authentication to take place for every of the keys, are also
+ * permanently invalidated once a new fingerprint is enrolled or once no more fingerprints are
+ * enrolled.
*/
public class KeyPermanentlyInvalidatedException extends InvalidKeyException {