MasterKey
class MasterKey
Wrapper for a master key used in the library.
On Android M (API 23) and above, this is class references a key that's stored in the Android Keystore. On Android L (API 21, 22), there isn't a master key.
Summary
Nested types |
|---|
class MasterKey.BuilderBuilder for generating a |
enum MasterKey.KeySchemeAlgorithm/Cipher choices used for the master key. |
Constants |
|
|---|---|
const Int |
The default and recommended size for the master key. |
const String! |
DEFAULT_MASTER_KEY_ALIAS = "_androidx_security_master_key_"The default master key alias. |
Public functions |
|
|---|---|
java-static Int |
The default validity period for authentication in seconds. |
Int |
Gets the duration in seconds that the key is unlocked for following user authentication. |
Boolean |
Checks if this key is backed by the Android Keystore. |
Boolean |
Gets whether the key is backed by strong box. |
Boolean |
Gets whether user authentication is required to use this key. |
String |
toString() |
Constants
DEFAULT_AES_GCM_MASTER_KEY_SIZE
const val DEFAULT_AES_GCM_MASTER_KEY_SIZE = 256: Int
The default and recommended size for the master key.
DEFAULT_MASTER_KEY_ALIAS
const val DEFAULT_MASTER_KEY_ALIAS = "_androidx_security_master_key_": String!
The default master key alias.
Public functions
getDefaultAuthenticationValidityDurationSeconds
java-static fun getDefaultAuthenticationValidityDurationSeconds(): Int
The default validity period for authentication in seconds.
getUserAuthenticationValidityDurationSeconds
fun getUserAuthenticationValidityDurationSeconds(): Int
Gets the duration in seconds that the key is unlocked for following user authentication.
The value returned for this method is only meaningful on Android M+ (API 23) when isUserAuthenticationRequired returns true.
| Returns | |
|---|---|
Int |
The duration the key is unlocked for in seconds. |
isKeyStoreBacked
fun isKeyStoreBacked(): Boolean
Checks if this key is backed by the Android Keystore.
| Returns | |
|---|---|
Boolean |
|
isStrongBoxBacked
fun isStrongBoxBacked(): Boolean
Gets whether the key is backed by strong box.
isUserAuthenticationRequired
fun isUserAuthenticationRequired(): Boolean
Gets whether user authentication is required to use this key.
This method always returns false on Android L (API 21 + 22).