asset_type.h

Overview

Defines the enums, structs, and error codes used in the asset store service.

File to include: <asset/asset_type.h>

Library: libasset_ndk.z.so

System capability: SystemCapability.Security.Asset

Since: 11

Related module: AssetType

Summary

Structs

Name	typedef Keyword	Description
Asset_Blob	Asset_Blob	Defines a binary array, that is, an array of bytes with variable length.
Asset_Value	Asset_Value	Defines the value of the asset attribute.
Asset_Attr	Asset_Attr	Represents an asset attribute in the form of a key-value (KV) pair.
Asset_Result	Asset_Result	Represents the query result of an asset.
Asset_ResultSet	Asset_ResultSet	Represents the query result of multiple assets.
Asset_SyncResult	Asset_SyncResult	Represents the sync result of an asset.

Enums

Name	typedef Keyword	Description
Asset_TagType	Asset_TagType	Enumerates the types of the keys of asset attributes.
Asset_Tag	Asset_Tag	Enumerates the keys of asset attributes.
Asset_ResultCode	Asset_ResultCode	Enumerates the result codes used in the ASSET APIs.
Asset_Accessibility	Asset_Accessibility	Enumerates the types of the access control based on the lock screen status.
Asset_AuthType	Asset_AuthType	Enumerates the user authentication types supported by assets.
Asset_SyncType	Asset_SyncType	Enumerates the asset sync types.
Asset_WrapType	Asset_WrapType	Encrypted import/export type supported by the asset.
Asset_ConflictResolution	Asset_ConflictResolution	Enumerates the policies for resolving the conflict (for example, a duplicate alias).
Asset_ReturnType	Asset_ReturnType	Enumerates the types of the asset query result to return.
Asset_OperationType	Asset_OperationType	Enumerates the additional asset operation types.

Macros

Name	Description
ASSET_TAG_TYPE_MASK (0xF << 28)	Defines the mask used to obtain the key type of an asset attribute. Since: 11

Enum Description

Asset_TagType

enum Asset_TagType

Description

Enumerates the types of the keys of asset attributes.

Since: 11

Enum	Description
ASSET_TYPE_BOOL = 0x1 << 28	Boolean.
ASSET_TYPE_NUMBER = 0x2 << 28	uint32_t.
ASSET_TYPE_BYTES = 0x3 << 28	Bytes.

Asset_Tag

enum Asset_Tag

Description

Enumerates the keys of asset attributes.

Since: 11

Enum	Description
ASSET_TAG_SECRET = ASSET_TYPE_BYTES \|0x01	Sensitive user data in the form of bytes, such as passwords and tokens.
ASSET_TAG_ALIAS = ASSET_TYPE_BYTES \|0x02	Asset alias (identifier) in the form of bytes.
ASSET_TAG_ACCESSIBILITY = ASSET_TYPE_NUMBER \|0x03	Access control based on the lock screen status. The value is of the uint32_t type.
ASSET_TAG_REQUIRE_PASSWORD_SET = ASSET_TYPE_BOOL \|0x04	A Boolean value indicating whether the asset is available only with a lock screen password.
ASSET_TAG_AUTH_TYPE = ASSET_TYPE_NUMBER \|0x05	User authentication type for the asset. The value is of the uint32_t type.
ASSET_TAG_AUTH_VALIDITY_PERIOD = ASSET_TYPE_NUMBER \|0x06	Validity period of the user authentication, in seconds. The value is of the uint32_t type, in seconds.
ASSET_TAG_AUTH_CHALLENGE = ASSET_TYPE_BYTES \|0x07	Challenge value, in the form of bytes, used for anti-replay during the authentication.
ASSET_TAG_AUTH_TOKEN = ASSET_TYPE_BYTES \|0x08	Authentication token, in the form of bytes, obtained after a successful user authentication.
ASSET_TAG_SYNC_TYPE = ASSET_TYPE_NUMBER \|0x10	Asset sync type. The value is of the uint32_t type.
ASSET_TAG_IS_PERSISTENT = ASSET_TYPE_BOOL \|0x11	Whether the asset needs to be stored persistently. Verification of ohos.permission.STORE_PERSISTENT_DATA is required if OH_Asset_Add is called with this tag passed in.
ASSET_TAG_DATA_LABEL_CRITICAL_1 = ASSET_TYPE_BYTES \|0x20	Custom data, which is of the bytes type and cannot be changed.
ASSET_TAG_DATA_LABEL_CRITICAL_2 = ASSET_TYPE_BYTES \|0x21	Custom data, which is of the bytes type and cannot be changed.
ASSET_TAG_DATA_LABEL_CRITICAL_3 = ASSET_TYPE_BYTES \|0x22	Custom data, which is of the bytes type and cannot be changed.
ASSET_TAG_DATA_LABEL_CRITICAL_4 = ASSET_TYPE_BYTES \|0x23	Custom data, which is of the bytes type and cannot be changed.
ASSET_TAG_DATA_LABEL_NORMAL_1 = ASSET_TYPE_BYTES \|0x30	Custom data, which is of the bytes type and can be changed.
ASSET_TAG_DATA_LABEL_NORMAL_2 = ASSET_TYPE_BYTES \|0x31	Custom data, which is of the bytes type and can be changed.
ASSET_TAG_DATA_LABEL_NORMAL_3 = ASSET_TYPE_BYTES \|0x32	Custom data, which is of the bytes type and can be changed.
ASSET_TAG_DATA_LABEL_NORMAL_4 = ASSET_TYPE_BYTES \|0x33	Custom data, which is of the bytes type and can be changed.
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_1 = ASSET_TYPE_BYTES \|0x34	Custom data, which is of the bytes type, can be changed, but cannot be synced. Since: 12
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_2 = ASSET_TYPE_BYTES \|0x35	Custom data, which is of the bytes type, can be changed, but cannot be synced. Since: 12
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_3 = ASSET_TYPE_BYTES \|0x36	Custom data, which is of the bytes type, can be changed, but cannot be synced. Since: 12
ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_4 = ASSET_TYPE_BYTES \|0x37	Custom data, which is of the bytes type, can be changed, but cannot be synced. Since: 12
ASSET_TAG_RETURN_TYPE = ASSET_TYPE_NUMBER \|0x40	Type of asset information to return. The value is of the uint32_t type.
ASSET_TAG_RETURN_LIMIT = ASSET_TYPE_NUMBER \|0x41	Maximum number of assets that can be returned in a query operation. The value is of the uint32_t type.
ASSET_TAG_RETURN_OFFSET = ASSET_TYPE_NUMBER \|0x42	Offset of the returned assets in a batch query. The value is of the uint32_t type.
ASSET_TAG_RETURN_ORDERED_BY = ASSET_TYPE_NUMBER \|0x43	Sorting order of the assets in the query result. The value is of the uint32_t type.
ASSET_TAG_CONFLICT_RESOLUTION = ASSET_TYPE_NUMBER \|0x44	Policy for resolving the conflict when an asset is added. The value is of the uint32_t type.
ASSET_TAG_UPDATE_TIME = ASSET_TYPE_BYTES \|0x45	Asset update time, in timestamp format. The value is of the bytes type. Since: 12
ASSET_TAG_OPERATION_TYPE = ASSET_TYPE_NUMBER \|0x46	Additional operation type. The value is of the uint32_t type. Since: 12
ASSET_TAG_REQUIRE_ATTR_ENCRYPTED = ASSET_TYPE_BOOL \|0x47	Whether to encrypt the additional information customized by the service. The value is of the Boolean type. Since: 14
ASSET_TAG_GROUP_ID = ASSET_TYPE_BYTES \|0x48	Group to which the asset belongs. The value is of the bytes type. Since: 18
ASSET_TAG_WRAP_TYPE = ASSET_TYPE_NUMBER \|0x49	Encrypted import/export type supported by the asset. The value is of the uint32_t type. Since: 18

Asset_ResultCode

enum Asset_ResultCode

Description

Enumerates the result codes used in the ASSET APIs.

Since: 11

Enum	Description
ASSET_SUCCESS = 0	The operation is successful.
ASSET_PERMISSION_DENIED = 201	The caller does not have the required permission.
ASSET_INVALID_ARGUMENT = 401	The parameter is invalid.
ASSET_SERVICE_UNAVAILABLE = 24000001	The asset store service is unavailable.
ASSET_NOT_FOUND = 24000002	The asset is not found.
ASSET_DUPLICATED = 24000003	The asset already exists.
ASSET_ACCESS_DENIED = 24000004	The access to the asset is denied.
ASSET_STATUS_MISMATCH = 24000005	The lock screen status does not match.
ASSET_OUT_OF_MEMORY = 24000006	The system memory is insufficient.
ASSET_DATA_CORRUPTED = 24000007	The asset is corrupted.
ASSET_DATABASE_ERROR = 24000008	The database operation failed.
ASSET_CRYPTO_ERROR = 24000009	The cryptographic operation failed.
ASSET_IPC_ERROR = 24000010	The IPC failed.
ASSET_BMS_ERROR = 24000011	The Bundle Manager service is abnormal.
ASSET_ACCOUNT_ERROR = 24000012	The Account service is abnormal.
ASSET_ACCESS_TOKEN_ERROR = 24000013	The Access Token service is abnormal.
ASSET_FILE_OPERATION_ERROR = 24000014	The file operation failed.
ASSET_GET_SYSTEM_TIME_ERROR = 24000015	Failed to obtain the system time.
ASSET_LIMIT_EXCEEDED = 24000016	The number of cached assets exceeds the limit.
ASSET_UNSUPPORTED = 24000017	The function is not supported.
ASSET_PARAM_VERIFICATION_FAILED = 24000018	The parameter verification fails. Since: 20

Asset_Accessibility

enum Asset_Accessibility

Description

Enumerates the types of the access control based on the lock screen status.

Since: 11

Enum	Description
ASSET_ACCESSIBILITY_DEVICE_POWERED_ON = 0	The asset can be accessed after the device is powered on.
ASSET_ACCESSIBILITY_DEVICE_FIRST_UNLOCKED = 1	The asset can be accessed only after the device is unlocked for the first time.
ASSET_ACCESSIBILITY_DEVICE_UNLOCKED = 2	The asset can be accessed only after the device is unlocked.

Asset_AuthType

enum Asset_AuthType

Description

Enumerates the user authentication types supported by assets.

Since: 11

Enum	Description
ASSET_AUTH_TYPE_NONE = 0x00	No user authentication is required before the asset is accessed.
ASSET_AUTH_TYPE_ANY = 0xFF	The asset can be accessed if any user authentication (such as PIN, facial, or fingerprint authentication) is successful.

Asset_SyncType

enum Asset_SyncType

Description

Asset sync type.

Since: 11

Enum	Description
ASSET_SYNC_TYPE_NEVER = 0	Asset sync is not allowed.
ASSET_SYNC_TYPE_THIS_DEVICE = 1 << 0	Asset sync is allowed only on the local device, for example, in data restore on the local device.
ASSET_SYNC_TYPE_TRUSTED_DEVICE = 1 << 1	Asset sync is allowed only between trusted devices, for example, in the case of cloning.
ASSET_SYNC_TYPE_TRUSTED_ACCOUNT = 1 << 2	Asset sync is allowed only between the devices that are logged in with trusted accounts, for example, in cloud sync scenarios. Since: 12

Asset_WrapType

enum Asset_WrapType

Description

Encrypted import/export type supported by the asset.

Since: 18

Enum	Description
ASSET_WRAP_TYPE_NEVER = 0	Encrypted import/export is not allowed for the asset.
ASSET_WRAP_TYPE_TRUSTED_ACCOUNT = 1	Encrypted import/export is allowed for the asset only on devices where a trusted account is logged in.

Asset_ConflictResolution

enum Asset_ConflictResolution

Description

Policy for resolving the conflict (for example, a duplicate alias).

Since: 11

Enum	Description
ASSET_CONFLICT_OVERWRITE = 0	Overwrite the original asset.
ASSET_CONFLICT_THROW_ERROR = 1	Throw an exception for the service to perform subsequent processing.

Asset_ReturnType

enum Asset_ReturnType

Description

Type of the asset query result to return.

Since: 11

Enum	Description
ASSET_RETURN_ALL = 0	The query result contains the asset plaintext and its attributes.
ASSET_RETURN_ATTRIBUTES = 1	The query result contains only the asset attributes.