• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 新增关键资产(C/C++)
2
3<!--Kit: Asset Store Kit-->
4<!--Subsystem: Security-->
5<!--Owner: @JeremyXu-->
6<!--Designer: @skye_you-->
7<!--Tester: @nacyli-->
8<!--Adviser: @zengyawen-->
9
10## 接口介绍
11
12可通过API文档查看新增关键资产的接口[OH_Asset_Add](../../reference/apis-asset-store-kit/capi-asset-api-h.md#oh_asset_add)的详细介绍。
13
14在新增关键资产时,关键资产属性的内容参数如下表所示:
15
16>**注意:**
17>
18>下表中“ASSET_TAG_ALIAS”和名称包含“ASSET_TAG_DATA_LABEL”的关键资产属性,用于存储业务自定义信息,其内容不会被加密,请勿存放敏感个人数据。
19
20| 属性名称(Asset_Tag)            | 属性内容(Asset_Value)                                       | 是否必选 | 说明                                                         |
21| ------------------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ |
22| ASSET_TAG_SECRET                | 类型为uint8[],长度为1-1024字节。                              | 必选     | 关键资产明文。                                                 |
23| ASSET_TAG_ALIAS                 | 类型为uint8[],长度为1-256字节。                               | 必选     | 关键资产别名,每条关键资产的唯一索引。                         |
24| ASSET_TAG_ACCESSIBILITY         | 类型为uint32_t,取值范围详见[Asset_Accessibility](../../reference/apis-asset-store-kit/capi-asset-type-h.md#asset_accessibility)。 | 可选     | 基于锁屏状态的访问控制,默认值为ASSET_ACCESSIBILITY_DEVICE_FIRST_UNLOCKED,即首次解锁后可访问。                       |
25| ASSET_TAG_REQUIRE_PASSWORD_SET  | 类型为bool。                                                   | 可选     | 是否仅在设置了锁屏密码的情况下,可访问关键资产。为true时,表示仅在用户设置了锁屏密码的情况下,关键资产才允许被访问;为false时,表示无论用户是否设置锁屏密码,关键资产均允许被访问。默认值为false。                 |
26| ASSET_TAG_AUTH_TYPE             | 类型为uint32_t,取值范围详见[Asset_AuthType](../../reference/apis-asset-store-kit/capi-asset-type-h.md#asset_authtype)。 | 可选     | 访问关键资产所需的用户认证类型,默认值为ASSET_AUTH_TYPE_NONE,即访问关键资产前无需用户认证。   |
27| ASSET_TAG_SYNC_TYPE             | 类型为uint32_t,取值范围详见[Asset_SyncType](../../reference/apis-asset-store-kit/capi-asset-type-h.md#asset_synctype)。 | 可选     | 关键资产支持的同步类型,默认值为ASSET_SYNC_TYPE_NEVER,即不允许同步该关键资产。            |
28| ASSET_TAG_IS_PERSISTENT         | 类型为bool。                                                   | 可选     | 在应用卸载时是否需要保留关键资产。为true时表示应用卸载后,应用存储的关键资产将被保留;为false时表示应用卸载后,应用存储的关键资产将被删除。默认值为false。<br>**注意:** 设置此属性时,需[申请权限](../AccessToken/declare-permissions.md)ohos.permission.STORE_PERSISTENT_DATA。|
29| ASSET_TAG_DATA_LABEL_CRITICAL_1 | 类型为uint8[],长度为1-2048字节。                           | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
30| ASSET_TAG_DATA_LABEL_CRITICAL_2 | 类型为uint8[],长度为1-2048字节。                           | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
31| ASSET_TAG_DATA_LABEL_CRITICAL_3 | 类型为uint8[],长度为1-2048字节。                           | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
32| ASSET_TAG_DATA_LABEL_CRITICAL_4 | 类型为uint8[],长度为1-2048字节。                           | 可选     | 关键资产附属信息,内容由业务自定义且有完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
33| ASSET_TAG_DATA_LABEL_NORMAL_1   | 类型为uint8[],长度为1-2048字节。                           | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
34| ASSET_TAG_DATA_LABEL_NORMAL_2   | 类型为uint8[],长度为1-2048字节。                           | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
35| ASSET_TAG_DATA_LABEL_NORMAL_3   | 类型为uint8[],长度为1-2048字节。                           | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
36| ASSET_TAG_DATA_LABEL_NORMAL_4   | 类型为uint8[],长度为1-2048字节。                           | 可选     | 关键资产附属信息,内容由业务自定义且无完整性保护。<br/>**说明:** API12前长度为1-512字节。 |
37| ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_1<sup>12+</sup> | 类型为uint8[],长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
38| ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_2<sup>12+</sup> | 类型为uint8[],长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
39| ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_3<sup>12+</sup> | 类型为uint8[],长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
40| ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_4<sup>12+</sup> | 类型为uint8[],长度为1-2048字节。 | 可选 | 关键资产附属的本地信息,内容由业务自定义且无完整性保护,该项信息不会进行同步。 |
41| ASSET_TAG_CONFLICT_RESOLUTION   | 类型为uint32_t,取值范围详见[Asset_ConflictResolution](../../reference/apis-asset-store-kit/capi-asset-type-h.md#asset_conflictresolution)。 | 可选     | 新增关键资产时的冲突(如:别名相同)处理策略,默认值为ASSET_CONFLICT_THROW_ERROR,即抛出异常,由业务进行后续处理。             |
42| ASSET_TAG_REQUIRE_ATTR_ENCRYPTED<sup>14+</sup> | 类型为bool。 | 可选 | 是否加密业务自定义附属信息。为true时表示业务自定义附属信息加密存储,为false时表示业务自定义附属信息不加密存储。默认值为false。|
43| ASSET_TAG_GROUP_ID<sup>18+</sup> | 类型为uint8[],长度为7-127字节。 | 可选 | 待新增的关键资产所属群组,默认新增不属于任何群组的关键资产。|
44| ASSET_TAG_WRAP_TYPE<sup>18+</sup> |类型为uint32_t,取值范围详见[Asset_WrapType](../../reference/apis-asset-store-kit/capi-asset-type-h.md#asset_wraptype)。 | 可选 | 关键资产支持的加密导入导出类型,默认值为ASSET_WRAP_TYPE_NEVER,即不允许加密导入导出关键资产。|
45
46## 约束和限制
47
48- 基于别名的访问
49
50  关键资产以密文的形式存储在ASSET数据库中,以业务身份和别名作为索引。业务需保证每条关键资产的别名唯一。
51
52- 业务自定义数据存储
53
54  - ASSET为业务预留了12个关键资产自定义属性,名称以"ASSET_TAG_DATA_LABEL"开头。对于超过12个自定义属性的情况,业务可以将多段数据按照一定的格式(如JSON)拼接到同一个ASSET属性中。
55
56  - ASSET对部分属性会进行完整性保护,这部分属性名称以"ASSET_TAG_DATA_LABEL_CRITICAL"开头,且写入后不支持更新。
57
58## 代码示例
59
60新增密码为demo_pwd、别名为demo_alias、附属信息为demo_label的关键资产。用户首次解锁设备后,该关键资产可被访问。
61
62在指定群组中新增一条关键资产的示例代码详见[新增群组关键资产](asset-native-group-access-control.md#新增群组关键资产)。
63
641. 在CMake脚本中链接相关动态库。
65   ```txt
66   target_link_libraries(entry PUBLIC libasset_ndk.z.so)
67   ```
68
692. 参考如下示例代码,进行业务功能开发。
70   ```c
71   #include <string.h>
72
73   #include "asset/asset_api.h"
74
75   static napi_value AddAsset(napi_env env, napi_callback_info info)
76   {
77       static const char *SECRET = "demo_pwd";
78       static const char *ALIAS = "demo_alias";
79       static const char *LABEL = "demo_label";
80
81       Asset_Blob secret = {(uint32_t)(strlen(SECRET)), (uint8_t *)SECRET};
82       Asset_Blob alias = {(uint32_t)(strlen(ALIAS)), (uint8_t *)ALIAS};
83       Asset_Blob label = {(uint32_t)(strlen(LABEL)), (uint8_t *)LABEL};
84       Asset_Attr attr[] = {
85           {.tag = ASSET_TAG_ACCESSIBILITY, .value.u32 = ASSET_ACCESSIBILITY_DEVICE_FIRST_UNLOCKED},
86           {.tag = ASSET_TAG_SECRET, .value.blob = secret},
87           {.tag = ASSET_TAG_ALIAS, .value.blob = alias},
88           {.tag = ASSET_TAG_DATA_LABEL_NORMAL_1, .value.blob = label},
89       };
90
91       int32_t addResult = OH_Asset_Add(attr, sizeof(attr) / sizeof(attr[0]));
92       napi_value ret;
93       napi_create_int32(env, addResult, &ret);
94       return ret;
95   }
96   ```
97