Share via


KeyProtection.IsUserPresenceRequired Property

Definition

Returns true if the key is authorized to be used only if a test of user presence has been performed between the Signature.initSign() and Signature.sign() calls.

public bool IsUserPresenceRequired { [Android.Runtime.Register("isUserPresenceRequired", "()Z", "", ApiSince=28)] get; }
[<get: Android.Runtime.Register("isUserPresenceRequired", "()Z", "", ApiSince=28)>]
member this.IsUserPresenceRequired : bool

Property Value

Attributes

Remarks

Returns true if the key is authorized to be used only if a test of user presence has been performed between the Signature.initSign() and 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.

Java documentation for android.security.keystore.KeyProtection.isUserPresenceRequired().

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to