Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge ""Unlocked device required" javadoc clarification" into pi-dev

Browse Source
This commit is contained in:
TreeHugger Robot
2018-04-02 21:40:34 +00:00
committed by Android (Google) Code Review
parent 6d24a1c8be 6f8fa9ac83
commit 084f9aee9a
2 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
keystore/java/android/security/keystore/KeyGenParameterSpec.java
View File

@@ -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) {

11
keystore/java/android/security/keystore/KeyProtection.java
View File

@@ -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) {