• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 新增关键资产(C/C++)
2
3## 接口介绍
4
5接口文档链接:
6
7[int32_t OH_Asset_Add(const Asset_Attr *attributes, uint32_t attrCnt)](../../reference/apis-asset-store-kit/_asset_api.md#oh_asset_add)
8
9参数列表:
10
11| 属性名称(Asset_Tag)            | 属性内容(Asset_Value)                                       | 是否必选 | 说明                                                         |
12| ------------------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
13| ASSET_TAG_SECRET                | 类型为uint8[],长度为1-1024字节                              | 必选     | 关键资产明文                                                 |
14| ASSET_TAG_ALIAS                 | 类型为uint8[],长度为1-256字节                               | 必选     | 关键资产别名,每条关键资产的唯一索引                         |
15| ASSET_TAG_ACCESSIBILITY         | 类型为uint32_t,取值范围详见[Asset_Accessibility](../../reference/apis-asset-store-kit/_asset_type.md#asset_accessibility) | 可选     | 基于锁屏状态的访问控制                                                 |
16| ASSET_TAG_REQUIRE_PASSWORD_SET  | 类型为bool                                                   | 可选     | 是否仅在设置了锁屏密码的情况下,可访问关键资产                 |
17| ASSET_TAG_AUTH_TYPE             | 类型为uint32_t,取值范围详见[Asset_AuthType](../../reference/apis-asset-store-kit/_asset_type.md#asset_authtype) | 可选     | 访问关键资产所需的用户认证类型                               |
18| ASSET_TAG_SYNC_TYPE             | 类型为uint32_t,取值范围详见[Asset_SyncType](../../reference/apis-asset-store-kit/_asset_type.md#asset_synctype) | 可选     | 关键资产支持的同步类型                                       |
19| ASSET_TAG_IS_PERSISTENT         | 类型为bool                                                   | 可选     | 在应用卸载时是否需要保留关键资产<br>**需要权限:** ohos.permission.STORE_PERSISTENT_DATA |
20| ASSET_TAG_DATA_LABEL_CRITICAL_1 | 类型为uint8[],长度为1-512字节                               | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护             |
21| ASSET_TAG_DATA_LABEL_CRITICAL_2 | 类型为uint8[],长度为1-512字节                               | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护             |
22| ASSET_TAG_DATA_LABEL_CRITICAL_3 | 类型为uint8[],长度为1-512字节                               | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护             |
23| ASSET_TAG_DATA_LABEL_CRITICAL_4 | 类型为uint8[],长度为1-512字节                               | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护             |
24| ASSET_TAG_DATA_LABEL_NORMAL_1   | 类型为uint8[],长度为1-512字节                               | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护             |
25| ASSET_TAG_DATA_LABEL_NORMAL_2   | 类型为uint8[],长度为1-512字节                               | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护             |
26| ASSET_TAG_DATA_LABEL_NORMAL_3   | 类型为uint8[],长度为1-512字节                               | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护             |
27| ASSET_TAG_DATA_LABEL_NORMAL_4   | 类型为uint8[],长度为1-512字节                               | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护             |
28| ASSET_TAG_CONFLICT_RESOLUTION   | 类型为uint32_t,取值范围详见[Asset_ConflictResolution](../../reference/apis-asset-store-kit/_asset_type.md#asset_conflictresolution) | 可选     | 新增关键资产时的冲突(如:别名相同)处理策略                             |
29
30## 代码示例
31
32新增一条密码是demo_pwd,别名是demo_alias,附属信息是demo_label的数据,该数据在用户首次解锁设备后可被访问。
33
341. 在CMake脚本中链接相关动态库
35   ```txt
36   target_link_libraries(entry PUBLIC libasset_ndk.z.so)
37   ```
38
392. 参考如下示例代码,进行业务功能开发
40   ```c
41   #include <string.h>
42
43   #include "asset/asset_api.h"
44
45   void AddAsset() {
46      static const char *SECRET = "demo_pwd";
47      static const char *ALIAS = "demo_alias";
48      static const char *LABEL = "demo_label";
49
50      Asset_Blob secret = { (uint32_t)(strlen(SECRET)), (uint8_t *)SECRET };
51      Asset_Blob alias = { (uint32_t)(strlen(ALIAS)), (uint8_t *)ALIAS };
52      Asset_Blob label = { (uint32_t)(strlen(LABEL)), (uint8_t *)LABEL };
53      Asset_Attr attr[] = {
54         { .tag = ASSET_TAG_ACCESSIBILITY, .value.u32 = ASSET_ACCESSIBILITY_DEVICE_FIRST_UNLOCKED },
55         { .tag = ASSET_TAG_SECRET, .value.blob = secret },
56         { .tag = ASSET_TAG_ALIAS, .value.blob = alias },
57         { .tag = ASSET_TAG_DATA_LABEL_NORMAL_1, .value.blob = label },
58      };
59
60      int32_t ret = OH_Asset_Add(attr, sizeof(attr) / sizeof(attr[0]));
61      if (ret == ASSET_SUCCESS) {
62         // Asset added successfully.
63      } else {
64         // Failed to add Asset.
65      }
66   }
67   ```
68
69## 约束和限制
70
71* 基于别名的访问
72
73关键资产以密文的形式存储在ASSET数据库中,以业务身份 + 别名作为唯一索引。故业务需要保证每条关键资产的别名唯一。
74
75* 业务自定义数据存储
76
77ASSET为业务预留了8个关键资产自定义属性,名称以"ASSET_TAG_DATA_LABEL"开头。对于超过8个自定义属性的情况,业务可以将多段数据按照一定的格式(如JSON)拼接到同一个ASSET属性中。
78
79ASSET对部分属性会进行完整性保护,这部分属性名称以"ASSET_TAG_DATA_LABEL_CRITICAL"开头,且写入后不支持更新。
80