KeyStorePurpose Enum

Definition

Namespace:: Android.Security.Keystore

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This enumeration supports a bitwise combination of its member values.

[System.Flags]
public enum KeyStorePurpose

[<System.Flags>]
type KeyStorePurpose =

Inheritance: Enum
KeyStorePurpose

Attributes: FlagsAttribute

Fields

Name	Value	Description
Encrypt	1	Purpose of key: encryption. Android reference for `android.security.keystore.KeyProperties.PURPOSE_ENCRYPT`. 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.
Decrypt	2	Purpose of key: decryption. Android reference for `android.security.keystore.KeyProperties.PURPOSE_DECRYPT`. 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.
Sign	4	Purpose of key: signing or generating a Message Authentication Code (MAC). Android reference for `android.security.keystore.KeyProperties.PURPOSE_SIGN`. 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.
Verify	8	Purpose of key: signature or Message Authentication Code (MAC) verification. Android reference for `android.security.keystore.KeyProperties.PURPOSE_VERIFY`. 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.
WrapKey	32	Purpose of key: wrapping and unwrapping wrapped keys for secure import. Android reference for `android.security.keystore.KeyProperties.PURPOSE_WRAP_KEY`. 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.
AgreeKey	64	Purpose of key: creating a shared ECDH secret through key agreement. A key having this purpose can be combined with the elliptic curve public key of another party to establish a shared secret over an insecure channel. It should be used as a parameter to `javax.crypto.KeyAgreement#init(java.security.Key)` (a complete example is available here). See this article for a more detailed explanation. Android reference for `android.security.keystore.KeyProperties.PURPOSE_AGREE_KEY`. 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.
AttestKey	128	Purpose of key: Signing attestations. This purpose is incompatible with all others, meaning that when generating a key with PURPOSE_ATTEST_KEY, no other purposes may be specified. In addition, PURPOSE_ATTEST_KEY may not be specified for imported keys. Android reference for `android.security.keystore.KeyProperties.PURPOSE_ATTEST_KEY`. 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.

Remarks

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