新增关键资产(C/C++)
接口介绍
接口文档链接:
int32_t OH_Asset_Add(const Asset_Attr *attributes, uint32_t attrCnt)
参数列表:
属性名称(Asset_Tag) | 属性内容(Asset_Value) | 是否必选 | 说明 |
---|---|---|---|
ASSET_TAG_SECRET | 类型为uint8[],长度为1-1024字节 | 必选 | 关键资产明文 |
ASSET_TAG_ALIAS | 类型为uint8[],长度为1-256字节 | 必选 | 关键资产别名,每条关键资产的唯一索引 |
ASSET_TAG_ACCESSIBILITY | 类型为uint32_t,取值范围详见Asset_Accessibility | 可选 | 基于锁屏状态的访问控制 |
ASSET_TAG_REQUIRE_PASSWORD_SET | 类型为bool | 可选 | 是否仅在设置了锁屏密码的情况下,可访问关键资产 |
ASSET_TAG_AUTH_TYPE | 类型为uint32_t,取值范围详见Asset_AuthType | 可选 | 访问关键资产所需的用户认证类型 |
ASSET_TAG_SYNC_TYPE | 类型为uint32_t,取值范围详见Asset_SyncType | 可选 | 关键资产支持的同步类型 |
ASSET_TAG_IS_PERSISTENT | 类型为bool | 可选 | 在应用卸载时是否需要保留关键资产 需要权限: ohos.permission.STORE_PERSISTENT_DATA |
ASSET_TAG_DATA_LABEL_CRITICAL_1 | 类型为uint8[],长度为1-512字节 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护 |
ASSET_TAG_DATA_LABEL_CRITICAL_2 | 类型为uint8[],长度为1-512字节 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护 |
ASSET_TAG_DATA_LABEL_CRITICAL_3 | 类型为uint8[],长度为1-512字节 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护 |
ASSET_TAG_DATA_LABEL_CRITICAL_4 | 类型为uint8[],长度为1-512字节 | 可选 | 关键资产附属信息,内容由业务自定义且有完整性保护 |
ASSET_TAG_DATA_LABEL_NORMAL_1 | 类型为uint8[],长度为1-512字节 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护 |
ASSET_TAG_DATA_LABEL_NORMAL_2 | 类型为uint8[],长度为1-512字节 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护 |
ASSET_TAG_DATA_LABEL_NORMAL_3 | 类型为uint8[],长度为1-512字节 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护 |
ASSET_TAG_DATA_LABEL_NORMAL_4 | 类型为uint8[],长度为1-512字节 | 可选 | 关键资产附属信息,内容由业务自定义且无完整性保护 |
ASSET_TAG_CONFLICT_RESOLUTION | 类型为uint32_t,取值范围详见Asset_ConflictResolution | 可选 | 新增关键资产时的冲突(如:别名相同)处理策略 |
代码示例
新增一条密码是demo_pwd,别名是demo_alias,附属信息是demo_label的数据,该数据在用户首次解锁设备后可被访问。
-
在CMake脚本中链接相关动态库
target_link_libraries(entry PUBLIC libasset_ndk.z.so)
-
参考如下示例代码,进行业务功能开发
#include <string.h> #include "asset/asset_api.h" void AddAsset() { static const char *SECRET = "demo_pwd"; static const char *ALIAS = "demo_alias"; static const char *LABEL = "demo_label"; Asset_Blob secret = { (uint32_t)(strlen(SECRET)), (uint8_t *)SECRET }; Asset_Blob alias = { (uint32_t)(strlen(ALIAS)), (uint8_t *)ALIAS }; Asset_Blob label = { (uint32_t)(strlen(LABEL)), (uint8_t *)LABEL }; Asset_Attr attr[] = { { .tag = ASSET_TAG_ACCESSIBILITY, .value.u32 = ASSET_ACCESSIBILITY_DEVICE_FIRST_UNLOCKED }, { .tag = ASSET_TAG_SECRET, .value.blob = secret }, { .tag = ASSET_TAG_ALIAS, .value.blob = alias }, { .tag = ASSET_TAG_DATA_LABEL_NORMAL_1, .value.blob = label }, }; int32_t ret = OH_Asset_Add(attr, sizeof(attr) / sizeof(attr[0])); if (ret == ASSET_SUCCESS) { // Asset added successfully. } else { // Failed to add Asset. } }
约束和限制
- 基于别名的访问
关键资产以密文的形式存储在ASSET数据库中,以业务身份 + 别名作为唯一索引。故业务需要保证每条关键资产的别名唯一。
- 业务自定义数据存储
ASSET为业务预留了8个关键资产自定义属性,名称以"ASSET_TAG_DATA_LABEL"开头。对于超过8个自定义属性的情况,业务可以将多段数据按照一定的格式(如JSON)拼接到同一个ASSET属性中。
ASSET对部分属性会进行完整性保护,这部分属性名称以"ASSET_TAG_DATA_LABEL_CRITICAL"开头,且写入后不支持更新。