1# 查询需要用户认证的关键资产(ArkTS) 2 3## 接口介绍 4 5接口文档链接： 6 7[preQuery(query: AssetMap): Promise\<Uint8Array>](../../reference/apis-asset-store-kit/js-apis-asset.md#assetprequery) 8 9[query(query: AssetMap): Promise\<Array\<AssetMap>>](../../reference/apis-asset-store-kit/js-apis-asset.md#assetquery) 10 11[postQuery(handle: AssetMap): Promise\<void>](../../reference/apis-asset-store-kit/js-apis-asset.md#assetpostquery) 12 13preQuery参数列表 14 15| 属性名称（Tag） | 属性内容（Value） | 是否必选 | 说明 | 16| --------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------ | 17| ALIAS | 类型为Uint8Array，长度为1-256字节 | 可选 | 关键资产别名，每条关键资产的唯一索引; | 18| ACCESSIBILITY | 类型为number，取值范围详见[Accessibility](../../reference/apis-asset-store-kit/js-apis-asset.md#accessibility) | 可选 | 基于锁屏状态的访问控制 | 19| REQUIRE_PASSWORD_SET | 类型为bool | 可选 | 是否仅在设置了锁屏密码的情况下，可访问关键资产 | 20| AUTH_TYPE | 类型为number，取值范围详见[AuthType](../../reference/apis-asset-store-kit/js-apis-asset.md#authtype) | 可选 | 访问关键资产所需的用户认证类型 | 21| AUTH_VALIDITY_PERIOD | 类型为number，取值范围：1-600，单位为秒 | 可选 | 用户认证的有效期 | 22| SYNC_TYPE | 类型为number，取值范围详见[SyncType](../../reference/apis-asset-store-kit/js-apis-asset.md#synctype) | 可选 | 关键资产支持的同步类型 | 23| IS_PERSISTENT | 类型为bool | 可选 | 在应用卸载时是否需要保留关键资产 | 24| DATA_LABEL_CRITICAL_1 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 25| DATA_LABEL_CRITICAL_2 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 26| DATA_LABEL_CRITICAL_3 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 27| DATA_LABEL_CRITICAL_4 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 28| DATA_LABEL_NORMAL_1 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 29| DATA_LABEL_NORMAL_2 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 30| DATA_LABEL_NORMAL_3 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 31| DATA_LABEL_NORMAL_4 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 32 33query参数列表 34 35| 属性名称（Tag） | 属性内容（Value） | 是否必选 | 说明 | 36| --------------------- | ------------------------------------------------------------ | -------- | ------------------------------------------------ | 37| ALIAS | 类型为Uint8Array，长度为1-256字节 | 必选 | 关键资产别名，每条关键资产的唯一索引; | 38| AUTH_CHALLENGE | 类型为Uint8Array，长度为32字节 | 必选 | 用户认证的挑战值 | 39| AUTH_TOKEN | 类型为Uint8Array，长度为148字节 | 必选 | 用户认证通过的授权令牌 | 40| RETURN_TYPE | 类型为number，asset.ReturnType.ALL | 必选 | 关键资产查询返回的结果类型 | 41| ACCESSIBILITY | 类型为number，取值范围详见[Accessibility](../../reference/apis-asset-store-kit/js-apis-asset.md#accessibility) | 可选 | 基于锁屏状态的访问控制 | 42| REQUIRE_PASSWORD_SET | 类型为bool | 可选 | 是否仅在设置了锁屏密码的情况下，可访问关键资产 | 43| AUTH_TYPE | 类型为number，取值范围详见[AuthType](../../reference/apis-asset-store-kit/js-apis-asset.md#authtype) | 可选 | 访问关键资产所需的用户认证类型 | 44| SYNC_TYPE | 类型为number，取值范围详见[SyncType](../../reference/apis-asset-store-kit/js-apis-asset.md#synctype) | 可选 | 关键资产支持的同步类型 | 45| IS_PERSISTENT | 类型为bool | 可选 | 在应用卸载时是否需要保留关键资产 | 46| DATA_LABEL_CRITICAL_1 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 47| DATA_LABEL_CRITICAL_2 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 48| DATA_LABEL_CRITICAL_3 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 49| DATA_LABEL_CRITICAL_4 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且有完整性保护 | 50| DATA_LABEL_NORMAL_1 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 51| DATA_LABEL_NORMAL_2 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 52| DATA_LABEL_NORMAL_3 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 53| DATA_LABEL_NORMAL_4 | 类型为Uint8Array，长度为1-512字节 | 可选 | 关键资产附属信息，内容由业务自定义且无完整性保护 | 54 55postQuery参数列表 56 57| 属性名称（Tag） | 属性内容（Value） | 是否必选 | 说明 | 58| ------------------- | ------------------------------ | -------- | -------------------- | 59| AUTH_CHALLENGE | 类型为Uint8Array，长度为32字节 | 必选 | 用户认证的挑战值 | 60 61## 代码示例 62 63查询别名是demo_alias且需要用户认证的关键资产。 64 65```typescript 66import { asset } from '@kit.AssetStoreKit'; 67import { util } from '@kit.ArkTS'; 68import userAuth from '@ohos.userIAM.userAuth'; 69import { BusinessError } from '@kit.BasicServicesKit'; 70 71function stringToArray(str: string): Uint8Array { 72 let textEncoder = new util.TextEncoder(); 73 return textEncoder.encodeInto(str); 74} 75 76function arrayToString(arr: Uint8Array): string { 77 let textDecoder = util.TextDecoder.create("utf-8", { ignoreBOM: true }); 78 let str = textDecoder.decodeWithStream(arr, { stream: false }) 79 return str; 80} 81 82async function userAuthenticate(challenge: Uint8Array): Promise<Uint8Array> { 83 return new Promise((resolve, reject) => { 84 const authParam: userAuth.AuthParam = { 85 challenge: challenge, 86 authType: [userAuth.UserAuthType.PIN], 87 authTrustLevel: userAuth.AuthTrustLevel.ATL1, 88 }; 89 const widgetParam: userAuth.WidgetParam = { title: '请输入锁屏密码' }; 90 try { 91 let userAuthInstance = userAuth.getUserAuthInstance(authParam, widgetParam); 92 userAuthInstance.on('result', { 93 onResult(result) { 94 if (result.result == userAuth.UserAuthResultCode.SUCCESS) { 95 console.info(`User identity authentication succeeded.`); 96 resolve(result.token); 97 } else { 98 console.error(`User identity authentication failed.`); 99 reject(); 100 } 101 } 102 }); 103 userAuthInstance.start(); 104 } catch (error) { 105 let err = error as BusinessError; 106 console.error(`User identity authentication failed. Code is ${err.code}, message is ${err.message}`); 107 reject(); 108 } 109 }) 110} 111 112function preQueryAsset(): Promise<Uint8Array> { 113 return new Promise((resolve, reject) => { 114 try { 115 let query: asset.AssetMap = new Map(); 116 query.set(asset.Tag.ALIAS, stringToArray('demo_alias')); 117 asset.preQuery(query).then((challenge: Uint8Array) => { 118 resolve(challenge); 119 }).catch(() => { 120 reject(); 121 }) 122 } catch (error) { 123 let err = error as BusinessError; 124 console.error(`Failed to pre-query Asset. Code is ${err.code}, message is ${err.message}`); 125 reject(); 126 } 127 }); 128} 129 130async function postQueryAsset(challenge: Uint8Array) { 131 let handle: asset.AssetMap = new Map(); 132 handle.set(asset.Tag.AUTH_CHALLENGE, challenge); 133 try { 134 await asset.postQuery(handle); 135 console.info(`Succeeded in post-querying Asset.`); 136 } catch (error) { 137 let err = error as BusinessError; 138 console.error(`Failed to post-query Asset. Code is ${err.code}, message is ${err.message}`); 139 } 140} 141 142async function queryAsset() { 143 // step1. 调用asset.preQuery获取挑战值 144 preQueryAsset().then(async (challenge: Uint8Array) => { 145 try { 146 // step2. 传入挑战值，拉起用户认证框 147 let authToken: Uint8Array = await userAuthenticate(challenge); 148 // step3 用户认证通过后，传入挑战值和授权令牌，查询关键资产明文 149 let query: asset.AssetMap = new Map(); 150 query.set(asset.Tag.ALIAS, stringToArray('demo_alias')); 151 query.set(asset.Tag.RETURN_TYPE, asset.ReturnType.ALL); 152 query.set(asset.Tag.AUTH_CHALLENGE, challenge); 153 query.set(asset.Tag.AUTH_TOKEN, authToken); 154 let res: Array<asset.AssetMap> = await asset.query(query); 155 for (let i = 0; i < res.length; i++) { 156 // parse the secret. 157 let secret: Uint8Array = res[i].get(asset.Tag.SECRET) as Uint8Array; 158 // parse uint8array to string 159 let secretStr: string = arrayToString(secret); 160 } 161 // step4. 关键资产明文查询成功后，需要调用asset.postQuery进行查询的后置处理。 162 postQueryAsset(challenge); 163 } catch (error) { 164 // step5. preQuery成功，后续操作失败，也需要调用asset.postQuery进行查询的后置处理。 165 postQueryAsset(challenge); 166 } 167 }).catch ((err: BusinessError) => { 168 console.error(`Failed to pre-query Asset. Code is ${err.code}, message is ${err.message}`); 169 }) 170} 171``` 172 173## 约束和限制 174 175无