Language

KeyGenParameterSpec.Builder.SetDevicePropertiesAttestationIncluded Method

Definition

Sets whether to include the base device properties in the attestation certificate.

[Android.Runtime.Register("setDevicePropertiesAttestationIncluded", "(Z)Landroid/security/keystore/KeyGenParameterSpec$Builder;", "", ApiSince=31)]
public Android.Security.Keystore.KeyGenParameterSpec.Builder SetDevicePropertiesAttestationIncluded(bool devicePropertiesAttestationIncluded);
[<Android.Runtime.Register("setDevicePropertiesAttestationIncluded", "(Z)Landroid/security/keystore/KeyGenParameterSpec$Builder;", "", ApiSince=31)>]
member this.SetDevicePropertiesAttestationIncluded : bool -> Android.Security.Keystore.KeyGenParameterSpec.Builder

Parameters

devicePropertiesAttestationIncluded
Boolean

Returns

Attributes

Remarks

Sets whether to include the base device properties in the attestation certificate.

If attestationChallenge is not null, the public key certificate for this key pair will contain an extension that describes the details of the key's configuration and authorizations, including the device properties values (brand, device, manufacturer, model, product). These should be the same as in (Build.BRAND, Build.DEVICE, Build.MANUFACTURER, Build.MODEL, Build.PRODUCT). The attestation certificate chain can be retrieved with java.security.KeyStore.getCertificateChain(String).

If attestationChallenge is null, the public key certificate for this key pair will not contain the extension with the requested attested values.

KeyPairGenerator.generateKeyPair() will throw ProviderException if device properties attestation fails or is not supported.

Android reference for android.security.keystore.KeyGenParameterSpec.Builder.setDevicePropertiesAttestationIncluded.

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