Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 ad38b383 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 a28fe1ae
显示空白变更内容
内联 并排
Showing with 57 addition and 72 deletion
zh-cn/application-dev/reference/apis/js-apis-huks.md
浏览文件 @ ad38b383
...@@ -44,7 +44,7 @@ huks Handle结构体。 ...@@ -44,7 +44,7 @@ huks Handle结构体。
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------- | ---------- | ---- | ---------------------------------------------------- | | --------- | ---------- | ---- | ---------------------------------------------------- |
| handle | number | 是 | 表示handle值。 | | handle | number | 是 | 表示handle值。 |
| challenge | Uint8Array | 否 | 表示[init](#huksinit)操作之后获取到的challenge信息。 | | challenge | Uint8Array | 否 | 表示[initSession](#huksinitsession9)操作之后获取到的challenge信息。 |
## HuksReturnResult<sup>9+</sup> ## HuksReturnResult<sup>9+</sup>
...@@ -426,7 +426,7 @@ attestKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<H ...@@ -426,7 +426,7 @@ attestKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<H
| -------- | ---------------------------------------------------- | ---- | --------------------------------------------- | | -------- | ---------------------------------------------------- | ---- | --------------------------------------------- |
| keyAlias | string | 是 | 密钥别名，存放待获取证书密钥的别名。 | | keyAlias | string | 是 | 密钥别名，存放待获取证书密钥的别名。 |
| options | [HuksOptions](#huksoptions) | 是 | 用于获取证书时指定所需参数与数据。 | | options | [HuksOptions](#huksoptions) | 是 | 用于获取证书时指定所需参数与数据。 |
| callback | AsyncCallback<[HuksReturnResult](#huksreturnresult)> | 是 | 回调函数。不返回err值时表示接口使用成功，其他时为错误。 | | callback | AsyncCallback<[HuksReturnResult](#huksreturnresult9)> | 是 | 回调函数。不返回err值时表示接口使用成功，其他时为错误。 |
**示例：** **示例：**
...@@ -553,7 +553,7 @@ attestKeyItem(keyAlias: string, options: HuksOptions) : Promise\<HuksReturnResul ...@@ -553,7 +553,7 @@ attestKeyItem(keyAlias: string, options: HuksOptions) : Promise\<HuksReturnResul
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------------- | --------------------------------------------- | | ---------------------------------------------- | --------------------------------------------- |
| Promise<[HuksReturnResult](#huksreturnresult)> | Promise对象。不返回err值时表示接口使用成功，其他时为错误。 | | Promise<[HuksReturnResult](#huksreturnresult9)> | Promise对象。不返回err值时表示接口使用成功，其他时为错误。 |
**示例：** **示例：**
...@@ -926,7 +926,7 @@ exportKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<H ...@@ -926,7 +926,7 @@ exportKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<H
| -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
| keyAlias | string | 是 | 密钥别名，应与所用密钥生成时使用的别名相同。 | | keyAlias | string | 是 | 密钥别名，应与所用密钥生成时使用的别名相同。 |
| options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 | | options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 |
| callback | AsyncCallback<[HuksReturnResult](#huksreturnresult)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。outData：返回从密钥中导出的公钥。 | | callback | AsyncCallback<[HuksReturnResult](#huksreturnresult9)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。outData：返回从密钥中导出的公钥。 |
**示例：** **示例：**
...@@ -968,7 +968,7 @@ exportKeyItem(keyAlias: string, options: HuksOptions) : Promise\<HuksReturnResul ...@@ -968,7 +968,7 @@ exportKeyItem(keyAlias: string, options: HuksOptions) : Promise\<HuksReturnResul
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------------- | ------------------------------------------------------------ | | ---------------------------------------------- | ------------------------------------------------------------ |
| Promise<[HuksReturnResult](#huksreturnresult)> | Promise对象。不返回err值时表示接口使用成功，其他时为错误。outData：返回从密钥中导出的公钥。 | | Promise<[HuksReturnResult](#huksreturnresult9)> | Promise对象。不返回err值时表示接口使用成功，其他时为错误。outData：返回从密钥中导出的公钥。 |
**示例：** **示例：**
...@@ -1005,7 +1005,7 @@ getKeyItemProperties(keyAlias: string, options: HuksOptions, callback: AsyncCall ...@@ -1005,7 +1005,7 @@ getKeyItemProperties(keyAlias: string, options: HuksOptions, callback: AsyncCall
| -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
| keyAlias | string | 是 | 密钥别名，应与所用密钥生成时使用的别名相同。 | | keyAlias | string | 是 | 密钥别名，应与所用密钥生成时使用的别名相同。 |
| options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 | | options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 |
| callback | AsyncCallback<[HuksReturnResult](#huksreturnresult)> | 是 | 回调函数。errorCode：返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 | | callback | AsyncCallback<[HuksReturnResult](#huksreturnresult9)> | 是 | 回调函数。errorCode：返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 |
**示例：** **示例：**
...@@ -1047,7 +1047,7 @@ getKeyItemProperties(keyAlias: string, options: HuksOptions) : Promise\<HuksRetu ...@@ -1047,7 +1047,7 @@ getKeyItemProperties(keyAlias: string, options: HuksOptions) : Promise\<HuksRetu
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------------------- | ------------------------------------------------------------ | | ----------------------------------------------- | ------------------------------------------------------------ |
| Promise\<[HuksReturnResult](#huksreturnresult)> | Promise对象。不返回err值时表示接口使用成功，其他时为错误。properties：返回值为生成密钥时所需参数。 | | Promise\<[HuksReturnResult](#huksreturnresult9)> | Promise对象。不返回err值时表示接口使用成功，其他时为错误。properties：返回值为生成密钥时所需参数。 |
**示例：** **示例：**
...@@ -1163,8 +1163,7 @@ initSession操作密钥接口，使用Callback回调异步返回结果。huks.in ...@@ -1163,8 +1163,7 @@ initSession操作密钥接口，使用Callback回调异步返回结果。huks.in
| -------- | ------------------------------------------------------- | ---- | ---------------------------------------------------- | | -------- | ------------------------------------------------------- | ---- | ---------------------------------------------------- |
| keyAlias | string | 是 | Init操作密钥的别名。 | | keyAlias | string | 是 | Init操作密钥的别名。 |
| options | [HuksOptions](#huksoptions) | 是 | Init操作的参数集合。 | | options | [HuksOptions](#huksoptions) | 是 | Init操作的参数集合。 |
| callback | AsyncCallback\<[HuksSessionHandle](#hukssessionhandle)> | 是 | 回调函数。将Init操作操作返回的handle添加到密钥管理系统的回调。 | | callback | AsyncCallback\<[HuksSessionHandle](#hukssessionhandle9)> | 是 | 回调函数。将Init操作操作返回的handle添加到密钥管理系统的回调。 |
## huks.initSession<sup>9+</sup> ## huks.initSession<sup>9+</sup>
...@@ -1185,7 +1184,7 @@ initSession操作密钥接口，使用Promise方式异步返回结果。huks.ini ...@@ -1185,7 +1184,7 @@ initSession操作密钥接口，使用Promise方式异步返回结果。huks.ini
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise\<[HuksSessionHandle](#hukssessionhandle)> | Promise对象。将Init操作返回的handle添加到密钥管理系统的回调。 | | Promise\<[HuksSessionHandle](#hukssessionhandle9)> | Promise对象。将Init操作返回的handle添加到密钥管理系统的回调。 |
## huks.updateSession<sup>9+</sup> ## huks.updateSession<sup>9+</sup>
...@@ -1201,7 +1200,7 @@ updateSession操作密钥接口，使用Callback回调异步返回结果。huks. ...@@ -1201,7 +1200,7 @@ updateSession操作密钥接口，使用Callback回调异步返回结果。huks.
| -------- | ---------------------------------------------------- | ---- | -------------------------------------------- | | -------- | ---------------------------------------------------- | ---- | -------------------------------------------- |
| handle | number | 是 | Update操作的handle。 | | handle | number | 是 | Update操作的handle。 |
| options | [HuksOptions](#huksoptions) | 是 | Update的参数集合。 | | options | [HuksOptions](#huksoptions) | 是 | Update的参数集合。 |
| callback | AsyncCallback<[HuksReturnResult](#huksreturnresult)> | 是 | 回调函数。将Update操作的结果添加到密钥管理系统的回调。 | | callback | AsyncCallback<[HuksReturnResult](#huksreturnresult9)> | 是 | 回调函数。将Update操作的结果添加到密钥管理系统的回调。 |
## huks.updateSession<sup>9+</sup> ## huks.updateSession<sup>9+</sup>
...@@ -1219,7 +1218,7 @@ updateSession操作密钥接口，使用Callback回调异步返回结果。huks. ...@@ -1219,7 +1218,7 @@ updateSession操作密钥接口，使用Callback回调异步返回结果。huks.
| handle | number | 是 | Update操作的handle。 | | handle | number | 是 | Update操作的handle。 |
| options | [HuksOptions](#huksoptions) | 是 | Update操作的参数集合。 | | options | [HuksOptions](#huksoptions) | 是 | Update操作的参数集合。 |
| token | Uint8Array | 是 | Update操作的token。 | | token | Uint8Array | 是 | Update操作的token。 |
| callback | AsyncCallback<[HuksReturnResult](#huksreturnresult)> | 是 | 回调函数。将Update操作的结果添加到密钥管理系统的回调。 | | callback | AsyncCallback<[HuksReturnResult](#huksreturnresult9)> | 是 | 回调函数。将Update操作的结果添加到密钥管理系统的回调。 |
## huks.updateSession<sup>9+</sup> ## huks.updateSession<sup>9+</sup>
...@@ -1241,7 +1240,7 @@ uupdateSession操作密钥接口，使用Promise方式异步返回结果。huks. ...@@ -1241,7 +1240,7 @@ uupdateSession操作密钥接口，使用Promise方式异步返回结果。huks.
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise<[HuksReturnResult](#huksreturnresult)> | Promise对象。将Update操作的结果添加到密钥管理系统的回调。 | | Promise<[HuksReturnResult](#huksreturnresult9)> | Promise对象。将Update操作的结果添加到密钥管理系统的回调。 |
## huks.finishSession<sup>9+</sup> ## huks.finishSession<sup>9+</sup>
...@@ -1258,7 +1257,7 @@ finishSession操作密钥接口，使用Callback回调异步返回结果。huks. ...@@ -1258,7 +1257,7 @@ finishSession操作密钥接口，使用Callback回调异步返回结果。huks.
| handle | number | 是 | Finish操作的handle。 | | handle | number | 是 | Finish操作的handle。 |
| options | [HuksOptions](#huksoptions) | 是 | Finish的参数集合。 | | options | [HuksOptions](#huksoptions) | 是 | Finish的参数集合。 |
| token | Uint8Array | 是 | Finish操作的token。 | | token | Uint8Array | 是 | Finish操作的token。 |
| callback | AsyncCallback<[HuksReturnResult](#huksreturnresult)> | 是 | 回调函数。将Finish操作的结果添加到密钥管理系统的回调。 | | callback | AsyncCallback<[HuksReturnResult](#huksreturnresult9)> | 是 | 回调函数。将Finish操作的结果添加到密钥管理系统的回调。 |
## huks.finishSession<sup>9+</sup> ## huks.finishSession<sup>9+</sup>
...@@ -1275,8 +1274,7 @@ finishSession操作密钥接口，使用Callback回调异步返回结果。huks. ...@@ -1275,8 +1274,7 @@ finishSession操作密钥接口，使用Callback回调异步返回结果。huks.
| handle | number | 是 | Finish操作的handle。 | | handle | number | 是 | Finish操作的handle。 |
| options | [HuksOptions](#huksoptions) | 是 | Finish的参数集合。 | | options | [HuksOptions](#huksoptions) | 是 | Finish的参数集合。 |
| token | Uint8Array | 是 | Finish操作的token。 | | token | Uint8Array | 是 | Finish操作的token。 |
| callback | AsyncCallback\<[HuksReturnResult](#huksreturnresult)> | 是 | 回调函数。将Finish操作的结果添加到密钥管理系统的回调。 | | callback | AsyncCallback\<[HuksReturnResult](#huksreturnresult9)> | 是 | 回调函数。将Finish操作的结果添加到密钥管理系统的回调。 |
## huks.finishSession<sup>9+</sup> ## huks.finishSession<sup>9+</sup>
...@@ -1298,8 +1296,7 @@ finishSession操作密钥接口，使用Promise方式异步返回结果。huks.i ...@@ -1298,8 +1296,7 @@ finishSession操作密钥接口，使用Promise方式异步返回结果。huks.i
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise\<[HuksReturnResult](#huksreturnresult)> | Promise对象，用于获取异步返回结果。 | | Promise\<[HuksReturnResult](#huksreturnresult9)> | Promise对象，用于获取异步返回结果。 |
## huks.abortSession<sup>9+</sup> ## huks.abortSession<sup>9+</sup>
...@@ -1993,7 +1990,7 @@ generateKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<Huk ...@@ -1993,7 +1990,7 @@ generateKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<Huk
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| keyAlias | string | 是 | 别名。 | | keyAlias | string | 是 | 别名。 |
| options | [HuksOptions](#huksoptions) | 是 | 用于存放生成key所需TAG。 | | options | [HuksOptions](#huksoptions) | 是 | 用于存放生成key所需TAG。 |
| callback | AsyncCallback\<[HuksResult](#huksresult)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其余结果请参考HuksResult进行错误码查询。 | | callback | AsyncCallback\<[HuksResult](#huksresultdeprecated)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其余结果请参考HuksResult进行错误码查询。 |
**示例：** **示例：**
...@@ -2050,7 +2047,7 @@ generateKey(keyAlias: string, options: HuksOptions) : Promise\<HuksResult> ...@@ -2050,7 +2047,7 @@ generateKey(keyAlias: string, options: HuksOptions) : Promise\<HuksResult>
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise\<[HuksResult](#huksresult)> | Promise对象。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 | | Promise\<[HuksResult](#huksresultdeprecated)> | Promise对象。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 |
**示例：** **示例：**
...@@ -2082,7 +2079,6 @@ let options = { ...@@ -2082,7 +2079,6 @@ let options = {
let result = huks.generateKey(keyAlias, options); let result = huks.generateKey(keyAlias, options);
``` ```
## huks.deleteKey<sup>(deprecated)</sup> ## huks.deleteKey<sup>(deprecated)</sup>
deleteKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksResult>) : void deleteKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksResult>) : void
...@@ -2099,7 +2095,7 @@ deleteKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksR ...@@ -2099,7 +2095,7 @@ deleteKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksR
| -------- | ----------------------------------------- | ---- | -------------------------------------------------- | | -------- | ----------------------------------------- | ---- | -------------------------------------------------- |
| keyAlias | string | 是 | 密钥别名，应为生成key时传入的别名。 | | keyAlias | string | 是 | 密钥别名，应为生成key时传入的别名。 |
| options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 | | options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 |
| callback | AsyncCallback\<[HuksResult](#huksresult)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 | | callback | AsyncCallback\<[HuksResult](#huksresultdeprecated)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 |
**示例：** **示例：**
...@@ -2133,7 +2129,7 @@ deleteKey(keyAlias: string, options: HuksOptions) : Promise\<HuksResult> ...@@ -2133,7 +2129,7 @@ deleteKey(keyAlias: string, options: HuksOptions) : Promise\<HuksResult>
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise\<[HuksResult](#huksresult)> | Promise对象。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 | | Promise\<[HuksResult](#huksresultdeprecated)> | Promise对象。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 |
**示例：** **示例：**
...@@ -2146,7 +2142,6 @@ let emptyOptions = { ...@@ -2146,7 +2142,6 @@ let emptyOptions = {
let result = huks.deleteKey(keyAlias, emptyOptions); let result = huks.deleteKey(keyAlias, emptyOptions);
``` ```
## huks.importKey<sup>(deprecated)</sup> ## huks.importKey<sup>(deprecated)</sup>
importKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksResult>) : void importKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksResult>) : void
...@@ -2163,7 +2158,7 @@ importKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksR ...@@ -2163,7 +2158,7 @@ importKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksR
| -------- | ------------------------ | ---- | ------------------------------------------------- | | -------- | ------------------------ | ---- | ------------------------------------------------- |
| keyAlias | string | 是 | 密钥别名。 | | keyAlias | string | 是 | 密钥别名。 |
| options | [HuksOptions](#huksoptions) | 是 | 用于导入时所需TAG和需要导入的密钥。 | | options | [HuksOptions](#huksoptions) | 是 | 用于导入时所需TAG和需要导入的密钥。 |
| callback | AsyncCallback\<[HuksResult](#huksresult)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 | | callback | AsyncCallback\<[HuksResult](#huksresultdeprecated)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 |
**示例：** **示例：**
...@@ -2228,7 +2223,7 @@ importKey(keyAlias: string, options: HuksOptions) : Promise\<HuksResult> ...@@ -2228,7 +2223,7 @@ importKey(keyAlias: string, options: HuksOptions) : Promise\<HuksResult>
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise\<[HuksResult](#huksresult)> | Promise对象。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 | | Promise\<[HuksResult](#huksresultdeprecated)> | Promise对象。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 |
**示例：** **示例：**
...@@ -2274,7 +2269,6 @@ let huksoptions = { ...@@ -2274,7 +2269,6 @@ let huksoptions = {
let result = huks.importKey(keyAlias, huksoptions); let result = huks.importKey(keyAlias, huksoptions);
``` ```
## huks.exportKey<sup>(deprecated)</sup> ## huks.exportKey<sup>(deprecated)</sup>
exportKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksResult>) : void exportKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksResult>) : void
...@@ -2291,7 +2285,7 @@ exportKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksR ...@@ -2291,7 +2285,7 @@ exportKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksR
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| keyAlias | string | 是 | 密钥别名，应与所用密钥生成时使用的别名相同。 | | keyAlias | string | 是 | 密钥别名，应与所用密钥生成时使用的别名相同。 |
| options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 | | options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 |
| callback | AsyncCallback\<[HuksResult](#huksresult)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。outData：返回从密钥中导出的公钥。 | | callback | AsyncCallback\<[HuksResult](#huksresultdeprecated)> | 是 | 回调函数。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。outData：返回从密钥中导出的公钥。 |
**示例：** **示例：**
...@@ -2325,7 +2319,7 @@ exportKey(keyAlias: string, options: HuksOptions) : Promise\<HuksResult> ...@@ -2325,7 +2319,7 @@ exportKey(keyAlias: string, options: HuksOptions) : Promise\<HuksResult>
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | ------------------------------------------------------------ | | ----------------------------------- | ------------------------------------------------------------ |
| Promise\<[HuksResult](#huksresult)> | Promise对象。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。outData：返回从密钥中导出的公钥。 | | Promise\<[HuksResult](#huksresultdeprecated)> | Promise对象。返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。outData：返回从密钥中导出的公钥。 |
**示例：** **示例：**
...@@ -2338,7 +2332,6 @@ let emptyOptions = { ...@@ -2338,7 +2332,6 @@ let emptyOptions = {
let result = huks.exportKey(keyAlias, emptyOptions); let result = huks.exportKey(keyAlias, emptyOptions);
``` ```
## huks.getKeyProperties<sup>(deprecated)</sup> ## huks.getKeyProperties<sup>(deprecated)</sup>
getKeyProperties(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksResult>) : void getKeyProperties(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<HuksResult>) : void
...@@ -2355,7 +2348,7 @@ getKeyProperties(keyAlias: string, options: HuksOptions, callback: AsyncCallback ...@@ -2355,7 +2348,7 @@ getKeyProperties(keyAlias: string, options: HuksOptions, callback: AsyncCallback
| -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| keyAlias | string | 是 | 密钥别名，应与所用密钥生成时使用的别名相同。 | | keyAlias | string | 是 | 密钥别名，应与所用密钥生成时使用的别名相同。 |
| options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 | | options | [HuksOptions](#huksoptions) | 是 | 空对象（此处传空即可）。 |
| callback | AsyncCallback\<[HuksResult](#huksresult)> | 是 | 回调函数。errorCode：返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 | | callback | AsyncCallback\<[HuksResult](#huksresultdeprecated)> | 是 | 回调函数。errorCode：返回HUKS_SUCCESS时表示接口使用成功，其他时为错误。 |
**示例：** **示例：**
...@@ -2402,7 +2395,6 @@ let emptyOptions = { ...@@ -2402,7 +2395,6 @@ let emptyOptions = {
let result = huks.getKeyProperties(keyAlias, emptyOptions); let result = huks.getKeyProperties(keyAlias, emptyOptions);
``` ```
## huks.isKeyExist<sup>(deprecated)</sup> ## huks.isKeyExist<sup>(deprecated)</sup>
isKeyExist(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<boolean>) : void isKeyExist(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<boolean>) : void
...@@ -2482,8 +2474,7 @@ init操作密钥接口，使用Callback回调异步返回结果。huks.init, huk ...@@ -2482,8 +2474,7 @@ init操作密钥接口，使用Callback回调异步返回结果。huks.init, huk
| -------- | ---------------------- | ---- | ------------------------------------- | | -------- | ---------------------- | ---- | ------------------------------------- |
| keyAlias | string | 是 | Init操作密钥的别名。 | | keyAlias | string | 是 | Init操作密钥的别名。 |
| options | [HuksOptions](#huksoptions) | 是 | Init操作的参数集合。 | | options | [HuksOptions](#huksoptions) | 是 | Init操作的参数集合。 |
| callback | AsyncCallback\<[HuksHandle](#hukshandle)> | 是 | 回调函数。将Init操作操作返回的handle添加到密钥管理系统的回调。 | | callback | AsyncCallback\<[HuksHandle](#hukshandledeprecated)> | 是 | 回调函数。将Init操作操作返回的handle添加到密钥管理系统的回调。 |
## huks.init<sup>(deprecated)</sup> ## huks.init<sup>(deprecated)</sup>
...@@ -2506,11 +2497,11 @@ init操作密钥接口，使用Promise方式异步返回结果。huks.init, huks ...@@ -2506,11 +2497,11 @@ init操作密钥接口，使用Promise方式异步返回结果。huks.init, huks
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise\<[HuksHandle](#hukshandle)> | Promise对象。将Init操作返回的handle添加到密钥管理系统的回调。 | | Promise\<[HuksHandle](#hukshandledeprecated)> | Promise对象。将Init操作返回的handle添加到密钥管理系统的回调。 |
## huks.update<sup>(deprecated)</sup> ## huks.update<sup>(deprecated)</sup>
update(handle: number, token?: Uint8Array, options: HuksOptions, callback: AsyncCallback<HuksResult>) : void update(handle: number, token?: Uint8Array, options: HuksOptions, callback: AsyncCallback\<HuksResult>) : void
update操作密钥接口，使用Callback回调异步返回结果。huks.init, huks.update, huks.finish为三段式接口，需要一起使用。 update操作密钥接口，使用Callback回调异步返回结果。huks.init, huks.update, huks.finish为三段式接口，需要一起使用。
...@@ -2525,11 +2516,11 @@ update操作密钥接口，使用Callback回调异步返回结果。huks.init, h ...@@ -2525,11 +2516,11 @@ update操作密钥接口，使用Callback回调异步返回结果。huks.init, h
| handle | number | 是 | Update操作的handle。 | | handle | number | 是 | Update操作的handle。 |
| token | Uint8Array | 否 | Update操作的token。 | | token | Uint8Array | 否 | Update操作的token。 |
| options | [HuksOptions](#huksoptions) | 是 | Update操作的参数集合。 | | options | [HuksOptions](#huksoptions) | 是 | Update操作的参数集合。 |
| callback | AsyncCallback\<[HuksResult](#huksresult)> | 是 | 回调函数。将Update操作的结果添加到密钥管理系统的回调。 | | callback | AsyncCallback\<[HuksResult](#huksresultdeprecated)> | 是 | 回调函数。将Update操作的结果添加到密钥管理系统的回调。 |
## huks.update<sup>(deprecated)</sup> ## huks.update<sup>(deprecated)</sup>
update(handle: number, token?: Uint8Array, options: HuksOptions) : Promise<HuksResult>; update(handle: number, token?: Uint8Array, options: HuksOptions) : Promise\<HuksResult>;
update操作密钥接口，使用Promise方式异步返回结果。huks.init, huks.update, huks.finish为三段式接口，需要一起使用。 update操作密钥接口，使用Promise方式异步返回结果。huks.init, huks.update, huks.finish为三段式接口，需要一起使用。
...@@ -2549,8 +2540,7 @@ update操作密钥接口，使用Promise方式异步返回结果。huks.init, hu ...@@ -2549,8 +2540,7 @@ update操作密钥接口，使用Promise方式异步返回结果。huks.init, hu
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise\<[HuksResult](#huksresult)> | Promise对象。将Update操作的结果添加到密钥管理系统的回调。 | | Promise\<[HuksResult](#huksresultdeprecated)> | Promise对象。将Update操作的结果添加到密钥管理系统的回调。 |
## huks.finish<sup>(deprecated)</sup> ## huks.finish<sup>(deprecated)</sup>
...@@ -2568,8 +2558,7 @@ finish操作密钥接口，使用Callback回调异步返回结果。huks.init, h ...@@ -2568,8 +2558,7 @@ finish操作密钥接口，使用Callback回调异步返回结果。huks.init, h
| -------- | ---------------------- | ---- | ------------------------------------- | | -------- | ---------------------- | ---- | ------------------------------------- |
| handle | number | 是 | Finish操作的handle。 | | handle | number | 是 | Finish操作的handle。 |
| options | [HuksOptions](#huksoptions) | 是 | Finish的参数集合。 | | options | [HuksOptions](#huksoptions) | 是 | Finish的参数集合。 |
| callback | AsyncCallback\<[HuksResult](#huksresult)> | 是 | 回调函数。将Finish操作的结果添加到密钥管理系统的回调。 | | callback | AsyncCallback\<[HuksResult](#huksresultdeprecated)> | 是 | 回调函数。将Finish操作的结果添加到密钥管理系统的回调。 |
## huks.finish<sup>(deprecated)</sup> ## huks.finish<sup>(deprecated)</sup>
...@@ -2592,8 +2581,7 @@ finish操作密钥接口，使用Promise方式异步返回结果。huks.init, hu ...@@ -2592,8 +2581,7 @@ finish操作密钥接口，使用Promise方式异步返回结果。huks.init, hu
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise\<[HuksResult](#huksresult)> | Promise对象，用于获取异步返回结果。 | | Promise\<[HuksResult](#huksresultdeprecated)> | Promise对象，用于获取异步返回结果。 |
## huks.abort<sup>(deprecated)</sup> ## huks.abort<sup>(deprecated)</sup>
...@@ -2611,7 +2599,7 @@ abort操作密钥接口，使用Callback回调异步返回结果。 ...@@ -2611,7 +2599,7 @@ abort操作密钥接口，使用Callback回调异步返回结果。
| -------- | ---------------------- | ---- | ------------------------------------- | | -------- | ---------------------- | ---- | ------------------------------------- |
| handle | number | 是 | Abort操作的handle。 | | handle | number | 是 | Abort操作的handle。 |
| options | [HuksOptions](#huksoptions) | 是 | Abort操作的参数集合。 | | options | [HuksOptions](#huksoptions) | 是 | Abort操作的参数集合。 |
| callback | AsyncCallback\<[HuksResult](#huksresult)> | 是 | 回调函数。将Abort操作的结果添加到密钥管理系统的回调。 | | callback | AsyncCallback\<[HuksResult](#huksresultdeprecated)> | 是 | 回调函数。将Abort操作的结果添加到密钥管理系统的回调。 |
**示例：** **示例：**
...@@ -2727,7 +2715,7 @@ abort操作密钥接口，使用Promise方式异步返回结果。 ...@@ -2727,7 +2715,7 @@ abort操作密钥接口，使用Promise方式异步返回结果。
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- | | ----------------------------------- | -------------------------------------------------- |
| Promise\<[HuksResult](#huksresult)> | Promise对象。将Abort操作的结果添加到密钥管理系统的回调。 | | Promise\<[HuksResult](#huksresultdeprecated)> | Promise对象。将Abort操作的结果添加到密钥管理系统的回调。 |
**示例：** **示例：**
...@@ -2828,7 +2816,6 @@ function huksAbort() { ...@@ -2828,7 +2816,6 @@ function huksAbort() {
} }
``` ```
## HuksHandle<sup>(deprecated)</sup> ## HuksHandle<sup>(deprecated)</sup>
huks Handle结构体。 huks Handle结构体。
...@@ -2839,8 +2826,7 @@ huks Handle结构体。 ...@@ -2839,8 +2826,7 @@ huks Handle结构体。
| ---------- | ---------------- | ---- | -------- | | ---------- | ---------------- | ---- | -------- |
| errorCode | number | 是 | 表示错误码。 | | errorCode | number | 是 | 表示错误码。 |
| handle | number | 是 | 表示handle值。 | | handle | number | 是 | 表示handle值。 |
| token | Uint8Array | 否 | 表示[init](#huksinit)操作之后获取到的challenge信息。 | | token | Uint8Array | 否 | 表示[init](#huksinitdeprecated)操作之后获取到的challenge信息。 |
## HuksResult<sup>(deprecated)</sup> ## HuksResult<sup>(deprecated)</sup>
...@@ -2848,7 +2834,6 @@ huks Handle结构体。 ...@@ -2848,7 +2834,6 @@ huks Handle结构体。
**系统能力**：SystemCapability.Security.Huks **系统能力**：SystemCapability.Security.Huks
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------- | ---- | ---------------- | | ---------- | ------------------------------- | ---- | ---------------- |
| errorCode | number | 是 | 表示错误码。 | | errorCode | number | 是 | 表示错误码。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或