1# 查询需要用户认证的关键资产(ArkTS) 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文档查看此功能的相关接口： 13 14| 异步接口 | 同步接口 | 说明 | 15| ----- | ------ | ------- | 16| [preQuery(query: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetprequery) | [preQuerySync(query: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetprequerysync12) | 查询预处理。| 17| [query(query: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetquery) | [querySync(query: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetquerysync12) | 查询关键资产。| 18| [postQuery(handle: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetpostquery) | [postQuerySync(handle: AssetMap)](../../reference/apis-asset-store-kit/js-apis-asset.md#assetpostquerysync12) | 查询后置处理。 | 19 20查询需要用户认证的关键资产时，关键资产属性的内容（AssetMap）参数如下表所示： 21 22>**注意：** 23> 24>下表中“ALIAS”和名称包含“DATA_LABEL”的关键资产属性，用于存储业务自定义信息，其内容不会被加密，请勿存放敏感个人数据。 25 26- **preQuery参数列表** 27 28 | 属性名称（Tag） | 属性内容（Value） | 是否必选 | 说明 | 29 | --------------------- | ---------------------------| -------- | -------------------------- | 30 | ALIAS | 类型为Uint8Array，长度为1-256字节。 | 可选 | 关键资产别名，每条关键资产的唯一索引。 | 31 | ACCESSIBILITY | 类型为number，取值范围详见[Accessibility](../../reference/apis-asset-store-kit/js-apis-asset.md#accessibility)。 | 可选 | 基于锁屏状态的访问控制。 | 32 | REQUIRE_PASSWORD_SET | 类型为boolean。 | 可选 | 是否仅在设置了锁屏密码的情况下，可访问关键资产。为true时表示查询仅用户设置了锁屏密码才允许访问的关键资产；为false时表示查询无论用户是否设置锁屏密码，均可访问的关键资产。 | 33 | AUTH_TYPE | 类型为number，取值范围详见[AuthType](../../reference/apis-asset-store-kit/js-apis-asset.md#authtype)。 | 可选 | 访问关键资产所需的用户认证类型。 | 34 | AUTH_VALIDITY_PERIOD | 类型为number，取值范围：1-600，单位为秒。 | 可选 | 用户认证的有效期，默认值为60。 | 35 | SYNC_TYPE | 类型为number，取值范围详见[SyncType](../../reference/apis-asset-store-kit/js-apis-asset.md#synctype)。 | 可选 | 关键资产支持的同步类型。 | 36 | IS_PERSISTENT | 类型为boolean。 | 可选 | 在应用卸载时是否需要保留关键资产。为true时表示查询应用卸载后会被保留的关键资产；为false时表示查询应用卸载后会被删除的关键资产。 | 37 | DATA_LABEL_CRITICAL_1 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 38 | DATA_LABEL_CRITICAL_2 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 39 | DATA_LABEL_CRITICAL_3 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 40 | DATA_LABEL_CRITICAL_4 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 41 | DATA_LABEL_NORMAL_1 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 42 | DATA_LABEL_NORMAL_2 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 43 | DATA_LABEL_NORMAL_3 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 44 | DATA_LABEL_NORMAL_4 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 45 | DATA_LABEL_NORMAL_LOCAL_1<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 46 | DATA_LABEL_NORMAL_LOCAL_2<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 47 | DATA_LABEL_NORMAL_LOCAL_3<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 48 | DATA_LABEL_NORMAL_LOCAL_4<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 49 | REQUIRE_ATTR_ENCRYPTED<sup>14+</sup> | 类型为boolean。 | 可选 | 是否查询业务自定义附属信息被加密的数据。为true时表示查询业务自定义附属信息加密存储的数据，为false时表示查询业务自定义附属信息不加密存储的数据。默认值为false。| 50 | GROUP_ID<sup>18+</sup> | 类型为Uint8Array，长度为7-127字节。 | 可选 | 待查询的关键资产所属群组，默认查询不属于任何群组的关键资产。| 51 52- **query参数列表** 53 54 | 属性名称（Tag） | 属性内容（Value） | 是否必选 | 说明 | 55 | --------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------ | 56 | ALIAS | 类型为Uint8Array，长度为1-256字节。 | 必选 | 关键资产别名，每条关键资产的唯一索引。 | 57 | AUTH_CHALLENGE | 类型为Uint8Array，长度为32字节。 | 必选 | 用户认证的挑战值。 | 58 | AUTH_TOKEN | 类型为Uint8Array。<br>API 20开始：长度为1-1024字节。<br>API 11-19：长度为148字节。 | 必选 | 用户认证通过的授权令牌。 | 59 | RETURN_TYPE | 类型为number，asset.ReturnType.ALL。 | 必选 | 关键资产查询返回的结果类型。 | 60 | ACCESSIBILITY | 类型为number，取值范围详见[Accessibility](../../reference/apis-asset-store-kit/js-apis-asset.md#accessibility)。 | 可选 | 基于锁屏状态的访问控制。 | 61 | REQUIRE_PASSWORD_SET | 类型为boolean。 | 可选 | 是否仅在设置了锁屏密码的情况下，可访问关键资产。为true时表示查询仅用户设置了锁屏密码才允许访问的关键资产；为false时表示查询无论用户是否设置锁屏密码，均可访问的关键资产。 | 62 | AUTH_TYPE | 类型为number，取值范围详见[AuthType](../../reference/apis-asset-store-kit/js-apis-asset.md#authtype)。 | 可选 | 访问关键资产所需的用户认证类型。 | 63 | SYNC_TYPE | 类型为number，取值范围详见[SyncType](../../reference/apis-asset-store-kit/js-apis-asset.md#synctype)。 | 可选 | 关键资产支持的同步类型。 | 64 | IS_PERSISTENT | 类型为boolean。 | 可选 | 在应用卸载时是否需要保留关键资产。为true时表示查询应用卸载后会被保留的关键资产；为false时表示查询应用卸载后会被删除的关键资产。 | 65 | DATA_LABEL_CRITICAL_1 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 66 | DATA_LABEL_CRITICAL_2 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 67 | DATA_LABEL_CRITICAL_3 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 68 | DATA_LABEL_CRITICAL_4 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 69 | DATA_LABEL_NORMAL_1 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 70 | DATA_LABEL_NORMAL_2 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 71 | DATA_LABEL_NORMAL_3 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 72 | DATA_LABEL_NORMAL_4 | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护。<br/>**说明：** API12前长度为1-512字节。 | 73 | DATA_LABEL_NORMAL_LOCAL_1<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 74 | DATA_LABEL_NORMAL_LOCAL_2<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 75 | DATA_LABEL_NORMAL_LOCAL_3<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 76 | DATA_LABEL_NORMAL_LOCAL_4<sup>12+</sup> | 类型为Uint8Array，长度为1-2048字节。 | 可选 | 关键资产附属的本地信息，内容由业务自定义且无完整性保护，该项信息不会进行同步。 | 77 | REQUIRE_ATTR_ENCRYPTED<sup>14+</sup> | 类型为boolean。 | 可选 | 是否查询业务自定义附属信息被加密的数据。为true时表示查询业务自定义附属信息加密存储的数据，为false时表示查询业务自定义附属信息不加密存储的数据。默认值为false。| 78 | GROUP_ID<sup>18+</sup> | 类型为Uint8Array，长度为7-127字节。 | 可选 | 待查询的关键资产所属群组，默认查询不属于任何群组的关键资产。| 79 80- **postQuery参数列表** 81 82 | 属性名称（Tag） | 属性内容（Value） | 是否必选 | 说明 | 83 | ------------------- | ------------------------------ | -------- | -------------------- | 84 | AUTH_CHALLENGE | 类型为Uint8Array，长度为32字节。 | 必选 | 用户认证的挑战值。 | 85 | GROUP_ID<sup>18+</sup> | 类型为Uint8Array，长度为7-127字节。 | 可选 | 待清理关键资产所属群组，默认清理内存中不属于任何群组的关键资产。| 86 87## 代码示例 88 89> **说明：** 90> 91> 本模块提供了异步和同步两套接口，以下为异步接口的使用示例，同步接口详见[API文档](../../reference/apis-asset-store-kit/js-apis-asset.md)。 92 93查询别名是demo_alias且需要用户认证的关键资产。示例中引入的@ohos.userIAM.userAuth用法详见[userAuth文档](../../reference/apis-user-authentication-kit/js-apis-useriam-userauth.md#start10)。 94 95```typescript 96import { asset } from '@kit.AssetStoreKit'; 97import { util } from '@kit.ArkTS'; 98import userAuth from '@ohos.userIAM.userAuth'; 99import { BusinessError } from '@kit.BasicServicesKit'; 100 101function stringToArray(str: string): Uint8Array { 102 let textEncoder = new util.TextEncoder(); 103 return textEncoder.encodeInto(str); 104} 105 106function arrayToString(arr: Uint8Array): string { 107 let textDecoder = util.TextDecoder.create("utf-8", { ignoreBOM: true }); 108 let str = textDecoder.decodeToString(arr, { stream: false }) 109 return str; 110} 111 112async function userAuthenticate(challenge: Uint8Array): Promise<Uint8Array> { 113 return new Promise((resolve, reject) => { 114 const authParam: userAuth.AuthParam = { 115 challenge: challenge, 116 authType: [userAuth.UserAuthType.PIN], 117 authTrustLevel: userAuth.AuthTrustLevel.ATL1, 118 }; 119 const widgetParam: userAuth.WidgetParam = { title: '请输入锁屏密码' }; 120 try { 121 let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam); 122 userAuthInstance.on('result', { 123 onResult(result) { 124 if (result.result == userAuth.UserAuthResultCode.SUCCESS) { 125 console.info(`User identity authentication succeeded.`); 126 resolve(result.token); 127 } else { 128 console.error(`User identity authentication failed.`); 129 reject(); 130 } 131 } 132 }); 133 userAuthInstance.start(); 134 } catch (err) { 135 console.error(`User identity authentication failed. Code is ${err?.code}, message is ${err?.message}`); 136 reject(); 137 } 138 }) 139} 140 141function preQueryAsset(): Promise<Uint8Array> { 142 return new Promise((resolve, reject) => { 143 try { 144 let query: asset.AssetMap = new Map(); 145 query.set(asset.Tag.ALIAS, stringToArray('demo_alias')); 146 asset.preQuery(query).then((challenge: Uint8Array) => { 147 resolve(challenge); 148 }).catch(() => { 149 reject(); 150 }) 151 } catch (err) { 152 console.error(`Failed to pre-query Asset. Code is ${err?.code}, message is ${err?.message}`); 153 reject(); 154 } 155 }); 156} 157 158async function postQueryAsset(challenge: Uint8Array) { 159 let handle: asset.AssetMap = new Map(); 160 handle.set(asset.Tag.AUTH_CHALLENGE, challenge); 161 try { 162 await asset.postQuery(handle); 163 console.info(`Succeeded in post-querying Asset.`); 164 } catch (err) { 165 console.error(`Failed to post-query Asset. Code is ${err?.code}, message is ${err?.message}`); 166 } 167} 168 169async function queryAsset() { 170 // step1. 调用asset.preQuery获取挑战值。 171 preQueryAsset().then(async (challenge: Uint8Array) => { 172 try { 173 // step2. 传入挑战值，拉起用户认证框。 174 let authToken: Uint8Array = await userAuthenticate(challenge); 175 // step3 用户认证通过后，传入挑战值和授权令牌，查询关键资产明文。 176 let query: asset.AssetMap = new Map(); 177 query.set(asset.Tag.ALIAS, stringToArray('demo_alias')); 178 query.set(asset.Tag.RETURN_TYPE, asset.ReturnType.ALL); 179 query.set(asset.Tag.AUTH_CHALLENGE, challenge); 180 query.set(asset.Tag.AUTH_TOKEN, authToken); 181 let res: Array<asset.AssetMap> = await asset.query(query); 182 for (let i = 0; i < res.length; i++) { 183 // 解析secret。 184 let secret: Uint8Array = res[i].get(asset.Tag.SECRET) as Uint8Array; 185 // 将Uint8Array转换为string类型。 186 let secretStr: string = arrayToString(secret); 187 } 188 // step4. 关键资产明文查询成功后，需要调用asset.postQuery进行查询的后置处理。 189 postQueryAsset(challenge); 190 } catch (error) { 191 // step5. preQuery成功，后续操作失败，也需要调用asset.postQuery进行查询的后置处理。 192 postQueryAsset(challenge); 193 } 194 }).catch((err: BusinessError) => { 195 console.error(`Failed to pre-query Asset. Code is ${err.code}, message is ${err.message}`); 196 }) 197} 198``` 199