Builder
class Builder
| kotlin.Any | |
| ↳ | android.security.keystore.KeyProtection.Builder |
Builder of KeyProtection instances.
Summary
| Public constructors | |
|---|---|
|
Creates a new instance of the |
|
| Public methods | |
|---|---|
| KeyProtection |
build()Builds an instance of |
| KeyProtection.Builder |
setBlockModes(vararg blockModes: String!)Sets the set of block modes (e.g., |
| KeyProtection.Builder |
setDigests(vararg digests: String!)Sets the set of digest algorithms (e.g., |
| KeyProtection.Builder |
setEncryptionPaddings(vararg paddings: String!)Sets the set of padding schemes (e.g., |
| KeyProtection.Builder |
setInvalidatedByBiometricEnrollment(invalidateKey: Boolean)Sets whether this key should be invalidated on biometric enrollment. |
| KeyProtection.Builder |
setIsStrongBoxBacked(isStrongBoxBacked: Boolean)Sets whether this key should be protected by a StrongBox security chip. |
| KeyProtection.Builder |
setKeyValidityEnd(endDate: Date!)Sets the time instant after which the key is no longer valid. |
| KeyProtection.Builder |
setKeyValidityForConsumptionEnd(endDate: Date!)Sets the time instant after which the key is no longer valid for decryption and verification. |
| KeyProtection.Builder |
setKeyValidityForOriginationEnd(endDate: Date!)Sets the time instant after which the key is no longer valid for encryption and signing. |
| KeyProtection.Builder |
setKeyValidityStart(startDate: Date!)Sets the time instant before which the key is not yet valid. |
| KeyProtection.Builder |
setMaxUsageCount(maxUsageCount: Int)Sets the maximum number of times the key is allowed to be used. |
| KeyProtection.Builder |
setMgf1Digests(vararg mgf1Digests: String!)Sets the set of hash functions (e.g., |
| KeyProtection.Builder |
setRandomizedEncryptionRequired(required: Boolean)Sets whether encryption using this key must be sufficiently randomized to produce different ciphertexts for the same plaintext every time. |
| KeyProtection.Builder |
setSignaturePaddings(vararg paddings: String!)Sets the set of padding schemes (e.g., |
| KeyProtection.Builder |
setUnlockedDeviceRequired(unlockedDeviceRequired: Boolean)Sets whether this key is authorized to be used only while the device is unlocked. |
| KeyProtection.Builder |
setUserAuthenticationParameters(timeout: Int, type: Int)Sets the duration of time (seconds) and authorization type for which this key is authorized to be used after the user is successfully authenticated. |
| KeyProtection.Builder |
setUserAuthenticationRequired(required: Boolean)Sets whether this key is authorized to be used only if the user has been authenticated. |
| KeyProtection.Builder |
setUserAuthenticationValidWhileOnBody(remainsValid: Boolean)Sets whether the key will remain authorized only until the device is removed from the user's body up to the limit of the authentication validity period (see |
| KeyProtection.Builder |
Sets the duration of time (seconds) for which this key is authorized to be used after the user is successfully authenticated. |
| KeyProtection.Builder |
setUserConfirmationRequired(required: Boolean)Sets whether this key is authorized to be used only for messages confirmed by the user. |
| KeyProtection.Builder |
setUserPresenceRequired(required: Boolean)Sets whether a test of user presence is required to be performed between the |
Public constructors
Builder
Builder(purposes: Int)
Creates a new instance of the Builder.
| Parameters | |
|---|---|
purposes |
Int: set of purposes (e.g., encrypt, decrypt, sign) for which the key can be used. Attempts to use the key for any other purpose will be rejected.
See |
Public methods
build
fun build(): KeyProtection
Builds an instance of KeyProtection.
| Return | |
|---|---|
KeyProtection |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if a required field is missing |
setBlockModes
fun setBlockModes(vararg blockModes: String!): KeyProtection.Builder
Sets the set of block modes (e.g., GCM, CBC) with which the key can be used when encrypting/decrypting. Attempts to use the key with any other block modes will be rejected.
This must be specified for symmetric encryption/decryption keys.
See KeyProperties.BLOCK_MODE constants.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setDigests
fun setDigests(vararg digests: String!): KeyProtection.Builder
Sets the set of digest algorithms (e.g., SHA-256, SHA-384) with which the key can be used. Attempts to use the key with any other digest algorithm will be rejected.
This must be specified for signing/verification keys and RSA encryption/decryption keys used with RSA OAEP padding scheme because these operations involve a digest. For HMAC keys, the default is the digest specified in Key.getAlgorithm() (e.g., SHA-256 for key algorithm HmacSHA256). HMAC keys cannot be authorized for more than one digest.
For private keys used for TLS/SSL client or server authentication it is usually necessary to authorize the use of no digest (KeyProperties.DIGEST_NONE). This is because TLS/SSL stacks typically generate the necessary digest(s) themselves and then use a private key to sign it.
See KeyProperties.DIGEST constants.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setEncryptionPaddings
fun setEncryptionPaddings(vararg paddings: String!): KeyProtection.Builder
Sets the set of padding schemes (e.g., OAEPPadding, PKCS7Padding, NoPadding) with which the key can be used when encrypting/decrypting. Attempts to use the key with any other padding scheme will be rejected.
This must be specified for keys which are used for encryption/decryption.
For RSA private keys used by TLS/SSL servers to authenticate themselves to clients it is usually necessary to authorize the use of no/any padding (KeyProperties.ENCRYPTION_PADDING_NONE) and/or PKCS#1 encryption padding (KeyProperties.ENCRYPTION_PADDING_RSA_PKCS1). This is because RSA decryption is required by some cipher suites, and some stacks request decryption using no padding whereas others request PKCS#1 padding.
See KeyProperties.ENCRYPTION_PADDING constants.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setInvalidatedByBiometricEnrollment
fun setInvalidatedByBiometricEnrollment(invalidateKey: Boolean): KeyProtection.Builder
Sets whether this key should be invalidated on biometric enrollment. This applies only to keys which require user authentication (see setUserAuthenticationRequired(boolean)) and if no positive validity duration has been set (see setUserAuthenticationValidityDurationSeconds(int), meaning the key is valid for biometric authentication only.
By default, invalidateKey is true, so keys that are valid for biometric authentication only are irreversibly invalidated when a new biometric is enrolled, or when all existing biometrics are deleted. That may be changed by calling this method with invalidateKey set to false.
Invalidating keys on enrollment of a new biometric or unenrollment of all biometrics improves security by ensuring that an unauthorized person who obtains the password can't gain the use of biometric-authenticated keys by enrolling their own biometric. However, invalidating keys makes key-dependent operations impossible, requiring some fallback procedure to authenticate the user and set up a new key.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setIsStrongBoxBacked
fun setIsStrongBoxBacked(isStrongBoxBacked: Boolean): KeyProtection.Builder
Sets whether this key should be protected by a StrongBox security chip.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setKeyValidityEnd
fun setKeyValidityEnd(endDate: Date!): KeyProtection.Builder
Sets the time instant after which the key is no longer valid.
By default, the key is valid at any instant.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setKeyValidityForConsumptionEnd
fun setKeyValidityForConsumptionEnd(endDate: Date!): KeyProtection.Builder
Sets the time instant after which the key is no longer valid for decryption and verification.
By default, the key is valid at any instant.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setKeyValidityForOriginationEnd
fun setKeyValidityForOriginationEnd(endDate: Date!): KeyProtection.Builder
Sets the time instant after which the key is no longer valid for encryption and signing.
By default, the key is valid at any instant.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setKeyValidityStart
fun setKeyValidityStart(startDate: Date!): KeyProtection.Builder
Sets the time instant before which the key is not yet valid.
By default, the key is valid at any instant.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
See Also
setMaxUsageCount
fun setMaxUsageCount(maxUsageCount: Int): KeyProtection.Builder
Sets the maximum number of times the key is allowed to be used. After every use of the key, the use counter will decrease. This authorization applies only to secret key and private key operations. Public key operations are not restricted. For example, after successfully encrypting and decrypting data using methods such as Cipher.doFinal(), the use counter of the secret key will decrease. After successfully signing data using methods such as Signature.sign(), the use counter of the private key will decrease. When the use counter is depleted, the key will be marked for deletion by Android Keystore and any subsequent attempt to use the key will throw KeyPermanentlyInvalidatedException. There is no key to be loaded from the Android Keystore once the exhausted key is permanently deleted, as if the key never existed before.
By default, there is no restriction on the usage of key.
Some secure hardware may not support this feature at all, in which case it will be enforced in software, some secure hardware may support it but only with maxUsageCount = 1, and some secure hardware may support it with larger value of maxUsageCount.
The PackageManger feature flags: android.content.pm.PackageManager#FEATURE_KEYSTORE_SINGLE_USE_KEY and android.content.pm.PackageManager#FEATURE_KEYSTORE_LIMITED_USE_KEY can be used to check whether the secure hardware cannot enforce this feature, can only enforce it with maxUsageCount = 1, or can enforce it with larger value of maxUsageCount.
| Parameters | |
|---|---|
maxUsageCount |
Int: maximum number of times the key is allowed to be used or KeyProperties.UNRESTRICTED_USAGE_COUNT if there is no restriction on the usage. |
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setMgf1Digests
fun setMgf1Digests(vararg mgf1Digests: String!): KeyProtection.Builder
Sets the set of hash functions (e.g., SHA-256, SHA-384) which could be used by the mask generation function MGF1 (which is used for certain operations with the key). Attempts to use the key with any other digest for the mask generation function will be rejected.
This can only be specified for signing/verification keys and RSA encryption/decryption keys used with RSA OAEP padding scheme because these operations involve a mask generation function (MGF1) with a digest. The default digest for MGF1 is SHA-1, which will be specified during key import time if no digests have been explicitly provided. When using the key, the caller may not specify any digests that were not provided during key import time. The caller may specify the default digest, SHA-1, if no digests were explicitly provided during key import (but it is not necessary to do so).
See KeyProperties.DIGEST constants.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setRandomizedEncryptionRequired
fun setRandomizedEncryptionRequired(required: Boolean): KeyProtection.Builder
Sets whether encryption using this key must be sufficiently randomized to produce different ciphertexts for the same plaintext every time. The formal cryptographic property being required is indistinguishability under chosen-plaintext attack (IND-CPA). This property is important because it mitigates several classes of weaknesses due to which ciphertext may leak information about plaintext. For example, if a given plaintext always produces the same ciphertext, an attacker may see the repeated ciphertexts and be able to deduce something about the plaintext.
By default, IND-CPA is required.
When IND-CPA is required:
- transformation which do not offer
IND-CPA, such as symmetric ciphers usingECBmode or RSA encryption without padding, are prohibited; - in transformations which use an IV, such as symmetric ciphers in
GCM,CBC, andCTRblock modes, caller-provided IVs are rejected when encrypting, to ensure that only random IVs are used. - If you are generating a random IV for encryption and then initializing a
Cipher using the IV, the solution is to let theCiphergenerate a random IV instead. This will occur if theCipheris initialized for encryption without an IV. The IV can then be queried viaCipher.getIV(). - If you are generating a non-random IV (e.g., an IV derived from something not fully random, such as the name of the file being encrypted, or transaction ID, or password, or a device identifier), consider changing your design to use a random IV which will then be provided in addition to the ciphertext to the entities which need to decrypt the ciphertext.
- If you are using RSA encryption without padding, consider switching to padding schemes which offer
IND-CPA, such as PKCS#1 or OAEP.
Before disabling this requirement, consider the following approaches instead:
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setSignaturePaddings
fun setSignaturePaddings(vararg paddings: String!): KeyProtection.Builder
Sets the set of padding schemes (e.g., PSS, PKCS#1) with which the key can be used when signing/verifying. Attempts to use the key with any other padding scheme will be rejected.
This must be specified for RSA keys which are used for signing/verification.
See KeyProperties.SIGNATURE_PADDING constants.
| Parameters | |
|---|---|
paddings |
String!: Value is android.security.keystore.KeyProperties#SIGNATURE_PADDING_RSA_PKCS1, or android.security.keystore.KeyProperties#SIGNATURE_PADDING_RSA_PSS |
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setUnlockedDeviceRequired
fun setUnlockedDeviceRequired(unlockedDeviceRequired: Boolean): KeyProtection.Builder
Sets whether this key is authorized to be used only while the device is unlocked.
The device is considered to be locked for a user when the user's apps are currently inaccessible and some form of lock screen authentication is required to regain access to them. For the full definition, see KeyguardManager.isDeviceLocked().
Public key operations aren't restricted by setUnlockedDeviceRequired(true) and may be performed even while the device is locked. In Android 11 (API level 30) and lower, encryption and verification operations with symmetric keys weren't restricted either.
Keys that use setUnlockedDeviceRequired(true) can be imported and generated even while the device is locked, as long as the device has been unlocked at least once since the last reboot. However, such keys cannot be used (except for the unrestricted operations mentioned above) until the device is unlocked. Apps that need to encrypt data while the device is locked such that it can only be decrypted while the device is unlocked can generate a key and encrypt the data in software, import the key into Keystore using setUnlockedDeviceRequired(true), and zeroize the original key.
setUnlockedDeviceRequired(true) is related to but distinct from setUserAuthenticationRequired(true). setUnlockedDeviceRequired(true) requires that the device be unlocked, whereas setUserAuthenticationRequired(true) requires that a specific type of strong authentication has happened within a specific time period. They may be used together or separately; there are cases in which one requirement can be satisfied but not the other.
Warning: Be careful using setUnlockedDeviceRequired(true) on Android 14 (API level 34) and lower, since the following bugs existed in Android 12 through 14:
- When the user didn't have a secure lock screen, unlocked-device-required keys couldn't be generated, imported, or used.
- When the user's secure lock screen was removed, all of that user's unlocked-device-required keys were automatically deleted.
- Unlocking the device with a non-strong biometric, such as face on many devices, didn't re-authorize the use of unlocked-device-required keys.
- Unlocking the device with a biometric didn't re-authorize the use of unlocked-device-required keys in profiles that share their parent user's lock.
setUnlockedDeviceRequired(true) only on Android 15 and higher. Apps that use both setUnlockedDeviceRequired(true) and setUserAuthenticationRequired(true) are unaffected by the first two issues, since the first two issues describe expected behavior for setUserAuthenticationRequired(true).
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setUserAuthenticationParameters
fun setUserAuthenticationParameters(
timeout: Int,
type: Int
): KeyProtection.Builder
Sets the duration of time (seconds) and authorization type for which this key is authorized to be used after the user is successfully authenticated. This has effect if the key requires user authentication for its use (see setUserAuthenticationRequired(boolean)).
By default, if user authentication is required, it must take place for every use of the key.
These cryptographic operations will throw UserNotAuthenticatedException during initialization if the user needs to be authenticated to proceed. This situation can be resolved by the user authenticating with the appropriate biometric or credential as required by the key. See BiometricPrompt.Builder.setAllowedAuthenticators(int) and BiometricManager.Authenticators.
Once resolved, initializing a new cryptographic operation using this key (or any other key which is authorized to be used for a fixed duration of time after user authentication) should succeed provided the user authentication flow completed successfully.
| Parameters | |
|---|---|
timeout |
Int: duration in seconds or 0 if user authentication must take place for every use of the key. Value is 0 or greater |
type |
Int: set of authentication types which can authorize use of the key. See KeyProperties.AUTH flags. Value is either 0 or a combination of android.security.keystore.KeyProperties#AUTH_BIOMETRIC_STRONG, and android.security.keystore.KeyProperties#AUTH_DEVICE_CREDENTIAL |
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setUserAuthenticationRequired
fun setUserAuthenticationRequired(required: Boolean): KeyProtection.Builder
Sets whether this key is authorized to be used only if the user has been authenticated.
By default, the key is authorized to be used regardless of whether the user has been authenticated.
When user authentication is required:
- The key can only be import if secure lock screen is set up (see
KeyguardManager.isDeviceSecure()). Additionally, if the key requires that user authentication takes place for every use of the key (seesetUserAuthenticationValidityDurationSeconds(int)), at least one biometric must be enrolled (seeBiometricManager.canAuthenticate()). - The use of the key must be authorized by the user by authenticating to this Android device using a subset of their secure lock screen credentials such as password/PIN/pattern or biometric. More information.
- The key will become irreversibly invalidated once the secure lock screen is disabled (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 a Device Administrator). Additionally, if the key requires that user authentication takes place for every use of the key, it is also irreversibly invalidated once a new biometric is enrolled or once\ no more biometrics are enrolled, unless
setInvalidatedByBiometricEnrollment(boolean)is used to allow validity after enrollment. Attempts to initialize cryptographic operations using such keys will throwKeyPermanentlyInvalidatedException.
This authorization applies only to secret key and private key operations. Public key operations are not restricted.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setUserAuthenticationValidWhileOnBody
fun setUserAuthenticationValidWhileOnBody(remainsValid: Boolean): KeyProtection.Builder
Sets whether the key will remain authorized only until the device is removed from the user's body up to the limit of the authentication validity period (see setUserAuthenticationValidityDurationSeconds and setUserAuthenticationRequired). Once the device has been removed from the user's body, the key will be considered unauthorized and the user will need to re-authenticate to use it. If the device does not have an on-body sensor or the key does not have an authentication validity period, this parameter has no effect.
Since Android 12 (API level 31), this parameter has no effect even on devices that have an on-body sensor. A future version of Android may restore enforcement of this parameter. Meanwhile, it is recommended to not use it.
| Parameters | |
|---|---|
remainsValid |
Boolean: if true, and if the device supports enforcement of this parameter, the key will be invalidated when the device is removed from the user's body or when the authentication validity expires, whichever occurs first. |
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setUserAuthenticationValidityDurationSeconds
funsetUserAuthenticationValidityDurationSeconds(seconds: Int): KeyProtection.Builder
Deprecated: See setUserAuthenticationParameters(int,int)
Sets the duration of time (seconds) for which this key is authorized to be used after the user is successfully authenticated. This has effect if the key requires user authentication for its use (see setUserAuthenticationRequired(boolean)).
By default, if user authentication is required, it must take place for every use of the key.
Cryptographic operations involving keys which require user authentication to take place for every operation can only use biometric authentication. This is achieved by initializing a cryptographic operation (Signature, Cipher, Mac) with the key, wrapping it into a BiometricPrompt.CryptoObject, invoking BiometricPrompt.authenticate with CryptoObject, and proceeding with the cryptographic operation only if the authentication flow succeeds.
Cryptographic operations involving keys which are authorized to be used for a duration of time after a successful user authentication event can only use secure lock screen authentication. These cryptographic operations will throw UserNotAuthenticatedException during initialization if the user needs to be authenticated to proceed. This situation can be resolved by the user unlocking the secure lock screen of the Android or by going through the confirm credential flow initiated by KeyguardManager.createConfirmDeviceCredentialIntent(CharSequence, CharSequence). Once resolved, initializing a new cryptographic operation using this key (or any other key which is authorized to be used for a fixed duration of time after user authentication) should succeed provided the user authentication flow completed successfully.
| Parameters | |
|---|---|
seconds |
Int: duration in seconds or -1 if user authentication must take place for every use of the key. Value is -1 or greater |
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setUserConfirmationRequired
fun setUserConfirmationRequired(required: Boolean): KeyProtection.Builder
Sets whether this key is authorized to be used only for messages confirmed by the user. Confirmation is separate from user authentication (see setUserAuthenticationRequired(boolean)). Keys can be created that require confirmation but not user authentication, or user authentication but not confirmation, or both. Confirmation verifies that some user with physical possession of the device has approved a displayed message. User authentication verifies that the correct user is present and has authenticated.
This authorization applies only to secret key and private key operations. Public key operations are not restricted. See android.security.ConfirmationPrompt class for more details about user confirmations.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |
setUserPresenceRequired
fun setUserPresenceRequired(required: Boolean): KeyProtection.Builder
Sets whether a test of user presence is required to be performed between the Signature.initSign() and 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.
| Return | |
|---|---|
KeyProtection.Builder |
This value cannot be null. |