1# 查询关键资产(C/C++) 2 3## 接口介绍 4 5可通过API文档查看查询关键资产的接口[OH_Asset_Query](../../reference/apis-asset-store-kit/_asset_api.md#oh_asset_query) 6的详细介绍。 7 8在查询关键资产时，关键资产属性的内容参数如下表所示： 9 10>**注意：** 11> 12>下表中名称包含“ASSET_TAG_DATA_LABEL”的关键资产属性，用于存储业务自定义信息，其内容不会被加密，请勿存放个人数据。 13 14| 属性名称（Asset_Tag） | 属性内容（Asset_Value） | 是否必选 | 说明 | 15| ------------------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | 16| ASSET_TAG_ALIAS | 类型为uint8[]，长度为1-256字节。 | 可选 | 关键资产别名，每条关键资产的唯一索引。 | 17| ASSET_TAG_ACCESSIBILITY | 类型为uint32_t，取值范围详见[Asset_Accessibility](../../reference/apis-asset-store-kit/_asset_type.md#asset_accessibility)。 | 可选 | 基于锁屏状态的访问控制。 | 18| ASSET_TAG_REQUIRE_PASSWORD_SET | 类型为bool。 | 可选 | 是否仅在设置了锁屏密码的情况下，可访问关键资产。 | 19| ASSET_TAG_AUTH_TYPE | 类型为uint32_t，取值范围详见[Asset_AuthType](../../reference/apis-asset-store-kit/_asset_type.md#asset_authtype)。 | 可选 | 访问关键资产所需的用户认证类型。 | 20| ASSET_TAG_SYNC_TYPE | 类型为uint32_t，取值范围详见[Asset_SyncType](../../reference/apis-asset-store-kit/_asset_type.md#asset_synctype)。 | 可选 | 关键资产支持的同步类型。 | 21| ASSET_TAG_IS_PERSISTENT | 类型为bool。 | 可选 | 在应用卸载时是否需要保留关键资产。 | 22| ASSET_TAG_DATA_LABEL_CRITICAL_1 | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 23| ASSET_TAG_DATA_LABEL_CRITICAL_2 | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 24| ASSET_TAG_DATA_LABEL_CRITICAL_3 | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 25| ASSET_TAG_DATA_LABEL_CRITICAL_4 | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 26| ASSET_TAG_DATA_LABEL_NORMAL_1 | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 27| ASSET_TAG_DATA_LABEL_NORMAL_2 | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 28| ASSET_TAG_DATA_LABEL_NORMAL_3 | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 29| ASSET_TAG_DATA_LABEL_NORMAL_4 | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 30| ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_1<sup>12+</sup> | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 31| ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_2<sup>12+</sup> | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 32| ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_3<sup>12+</sup> | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 33| ASSET_TAG_DATA_LABEL_NORMAL_LOCAL_4<sup>12+</sup> | 类型为uint8[]，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 34| ASSET_TAG_RETURN_TYPE | 类型为uint32_t，取值范围详见[Asset_ReturnType](../../reference/apis-asset-store-kit/_asset_type.md#asset_returntype)。 | 可选 | 关键资产查询返回的结果类型。 | 35| ASSET_TAG_RETURN_LIMIT | 类型为uint32_t。 | 可选 | 关键资产查询返回的结果数量。 | 36| ASSET_TAG_RETURN_OFFSET | 类型为uint32_t，取值范围：1-65536。 | 可选 | 关键资产查询返回的结果偏移量。<br>**说明：** 用于分批查询场景，指定从第几个开始返回。 | 37| ASSET_TAG_RETURN_ORDERED_BY | 类型为uint32_t，取值范围：ASSET_TAG_DATA_LABEL_xxx。 | 可选 | 关键资产查询返回的结果排序依据，仅支持按照附属信息排序。<br>**说明：** 默认按照关键资产新增的顺序返回。 | 38| ASSET_TAG_REQUIRE_ATTR_ENCRYPTED<sup>14+</sup> | 类型为bool。 | 可选 | 是否查询业务自定义附属信息被加密的数据，默认值为false，即查询业务附属信息不加密的数据。| 39| ASSET_TAG_GROUP_ID<sup>18+</sup> | 类型为uint8[]，长度为7-127字节。 | 可选 | 待查询的关键资产所属群组，默认查询不属于任何群组的关键资产。| 40 41## 约束和限制 42 43批量查询出的关键资产需要通过IPC通道传输给业务，受IPC缓冲区大小限制，建议对查询超过40条关键资产时，进行分批查询，且每次查询数量不超过40条。 44 45## 代码示例 46 47### 查询单条关键资产明文 48 49查询别名是demo_alias的关键资产明文。 50 51在指定群组中查询一条关键资产明文的示例代码详见[查询单条群组关键资产明文](asset-native-group-access-control.md#查询单条群组关键资产明文)。 52 531. 在CMake脚本中链接相关动态库。 54 ```txt 55 target_link_libraries(entry PUBLIC libasset_ndk.z.so) 56 ``` 57 582. 参考如下示例代码，进行业务功能开发。 59 ```c 60 #include <string.h> 61 62 #include "asset/asset_api.h" 63 64 void QueryAsset() { 65 static const char *ALIAS = "demo_alias"; 66 Asset_Blob alias = { (uint32_t)(strlen(ALIAS)), (uint8_t *)ALIAS }; 67 Asset_Attr attr[] = { 68 { .tag = ASSET_TAG_ALIAS, .value.blob = alias }, // 指定了关键资产别名，最多查询到一条满足条件的关键资产 69 { .tag = ASSET_TAG_RETURN_TYPE, .value.u32 = ASSET_RETURN_ALL }, // 此处表示需要返回关键资产的所有信息，即属性+明文 70 }; 71 72 Asset_ResultSet resultSet = {0}; 73 int32_t ret = OH_Asset_Query(attr, sizeof(attr) / sizeof(attr[0]), &resultSet); 74 if (ret == ASSET_SUCCESS) { 75 // Parse the resultSet. 76 for (uint32_t i = 0; i < resultSet.count; i++) { 77 // Parse the secret: the data is secret->blob.data, the size is secret->blob.size. 78 Asset_Attr *secret = OH_Asset_ParseAttr(resultSet.results + i, ASSET_TAG_SECRET); 79 } 80 } 81 OH_Asset_FreeResultSet(&resultSet); 82 } 83 ``` 84 85### 查询单条关键资产属性 86 87查询别名是demo_alias的关键资产属性。 88 89在指定群组中查询一条关键资产属性的示例代码详见[查询单条群组关键资产属性](asset-native-group-access-control.md#查询单条群组关键资产属性)。 90 911. 在CMake脚本中链接相关动态库。 92 ```txt 93 target_link_libraries(entry PUBLIC libasset_ndk.z.so) 94 ``` 95 962. 参考如下示例代码，进行业务功能开发。 97 ```c 98 #include <string.h> 99 100 #include "asset/asset_api.h" 101 102 void QueryAttributes() { 103 static const char *ALIAS = "demo_alias"; 104 Asset_Blob alias = { (uint32_t)(strlen(ALIAS)), (uint8_t *)ALIAS }; 105 Asset_Attr attr[] = { 106 { .tag = ASSET_TAG_ALIAS, .value.blob = alias }, // 指定了关键资产别名，最多查询到一条满足条件的关键资产 107 { .tag = ASSET_TAG_RETURN_TYPE, .value.u32 = ASSET_RETURN_ATTRIBUTES }, // 此处表示仅返回关键资产属性，不包含关键资产明文 108 }; 109 110 Asset_ResultSet resultSet = {0}; 111 int32_t ret = OH_Asset_Query(attr, sizeof(attr) / sizeof(attr[0]), &resultSet); 112 if (ret == ASSET_SUCCESS) { 113 // Parse the result. 114 for (uint32_t i = 0; i < resultSet.count; i++) { 115 // Parse the data label: the data is label->blob.data, the size is label->blob.size. 116 Asset_Attr *label = OH_Asset_ParseAttr(resultSet.results + i, ASSET_TAG_DATA_LABEL_NORMAL_1); 117 } 118 } 119 OH_Asset_FreeResultSet(&resultSet); 120 } 121 ``` 122 123### 批量查询关键资产属性 124 125批量查询附属信息是demo_label的关键资产属性，从第5条满足条件的结果开始返回，一共返回10条，且返回结果以DATA_LABEL_NORMAL_1属性内容排序。 126 1271. 在CMake脚本中链接相关动态库。 128 ```txt 129 target_link_libraries(entry PUBLIC libasset_ndk.z.so) 130 ``` 131 1322. 参考如下示例代码，进行业务功能开发。 133 ```c 134 #include <string.h> 135 136 #include "asset/asset_api.h" 137 138 void BatchQuery() { 139 static const char *LABEL = "demo_label"; 140 Asset_Blob label = { (uint32_t)(strlen(LABEL)), (uint8_t *)LABEL }; 141 142 Asset_Attr attr[] = { 143 { .tag = ASSET_TAG_RETURN_TYPE, .value.u32 = ASSET_RETURN_ATTRIBUTES }, 144 { .tag = ASSET_TAG_DATA_LABEL_NORMAL_1, .value.blob = label }, 145 { .tag = ASSET_TAG_RETURN_OFFSET, .value.u32 = 5 }, 146 { .tag = ASSET_TAG_RETURN_LIMIT, .value.u32 = 10 }, 147 { .tag = ASSET_TAG_RETURN_ORDERED_BY, .value.u32 = ASSET_TAG_DATA_LABEL_NORMAL_1 }, 148 }; 149 150 Asset_ResultSet resultSet = { 0 }; 151 int32_t ret = OH_Asset_Query(attr, sizeof(attr) / sizeof(attr[0]), &resultSet); 152 if (ret == ASSET_SUCCESS) { 153 // Parse the result. 154 for (uint32_t i = 0; i < resultSet.count; i++) { 155 // Parse the data alias: the data is alias->blob.data, the size is alias->blob.size.. 156 Asset_Attr *alias = OH_Asset_ParseAttr(resultSet.results + i, ASSET_TAG_ALIAS); 157 } 158 } 159 OH_Asset_FreeResultSet(&resultSet); 160 } 161 ``` 162