Merge "keystore: Add documentation for user presence required." into pi-dev (e9a66536) · Commits · e / os / android_frameworks_base

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

+16 −0

Original line number	Diff line number	Diff line
		@@ -595,6 +595,14 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec, UserAu
		/**
		* Returns {@code true} if the key is authorized to be used only if a test of user presence has
		* been performed between the {@code Signature.initSign()} and {@code Signature.sign()} calls.
		* It requires that the KeyStore implementation have a direct way to validate the user presence
		* for example a KeyStore hardware backed strongbox can use a button press that is observable
		* in hardware. A test for user presence is tangential to authentication. The test can be part
		* of an authentication step as long as this step can be validated by the hardware protecting
		* the key and cannot be spoofed. For example, a physical button press can be used as a test of
		* user presence if the other pins connected to the button are not able to simulate a button
		* press. There must be no way for the primary processor to fake a button press, or that
		* button must not be used as a test of user presence.
		*/
		public boolean isUserPresenceRequired() {
		return mUserPresenceRequired;
		@@ -1181,6 +1189,14 @@ public final class KeyGenParameterSpec implements AlgorithmParameterSpec, UserAu
		/**
		* Sets whether a test of user presence is required to be performed between the
		* {@code Signature.initSign()} and {@code Signature.sign()} method calls.
		* It requires that the KeyStore implementation have a direct way to validate the user
		* presence for example a KeyStore hardware backed strongbox can use a button press that
		* is observable in hardware. A test for user presence is tangential to authentication. The
		* test can be part of an authentication step as long as this step can be validated by the
		* hardware protecting the key and cannot be spoofed. For example, a physical button press
		* can be used as a test of user presence if the other pins connected to the button are not
		* able to simulate a button press.There must be no way for the primary processor to fake a
		* button press, or that button must not be used as a test of user presence.
		*/
		@NonNull
		public Builder setUserPresenceRequired(boolean required) {

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

+15 −2

Original line number	Diff line number	Diff line
		@@ -448,7 +448,12 @@ public final class KeyProtection implements ProtectionParameter, UserAuthArgs {
		* been performed between the {@code Signature.initSign()} and {@code Signature.sign()} calls.
		* It requires that the KeyStore implementation have a direct way to validate the user presence
		* for example a KeyStore hardware backed strongbox can use a button press that is observable
		* in hardware.
		* in hardware. A test for user presence is tangential to authentication. The test can be part
		* of an authentication step as long as this step can be validated by the hardware protecting
		* the key and cannot be spoofed. For example, a physical button press can be used as a test of
		* user presence if the other pins connected to the button are not able to simulate a button
		* press. There must be no way for the primary processor to fake a button press, or that
		* button must not be used as a test of user presence.
		*/
		public boolean isUserPresenceRequired() {
		return mUserPresenceRequred;
		@@ -845,7 +850,15 @@ public final class KeyProtection implements ProtectionParameter, UserAuthArgs {

		/**
		* Sets whether a test of user presence is required to be performed between the
		* {@code Signature.initSign()} and {@code Signature.sign()} method calls.
		* {@code Signature.initSign()} and {@code Signature.sign()} method calls. It requires that
		* the KeyStore implementation have a direct way to validate the user presence for example
		* a KeyStore hardware backed strongbox can use a button press that is observable in
		* hardware. A test for user presence is tangential to authentication. The test can be part
		* of an authentication step as long as this step can be validated by the hardware
		* protecting the key and cannot be spoofed. For example, a physical button press can be
		* used as a test of user presence if the other pins connected to the button are not able
		* to simulate a button press. There must be no way for the primary processor to fake a
		* button press, or that button must not be used as a test of user presence.
		*/
		@NonNull
		public Builder setUserPresenceRequired(boolean required) {