Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
7c47693f
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
7c47693f
编写于
4月 06, 2023
作者:
G
gaoshuyang
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add code for optimize huks-api doc
Signed-off-by:
N
gaoshuyang
<
gaoshuyang2@huawei.com
>
上级
785f0031
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
33 addition
and
27 deletion
+33
-27
zh-cn/application-dev/reference/apis/js-apis-huks.md
zh-cn/application-dev/reference/apis/js-apis-huks.md
+33
-27
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-huks.md
浏览文件 @
7c47693f
...
@@ -75,7 +75,7 @@ generateKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\
...
@@ -75,7 +75,7 @@ generateKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\
| -------- | --------------------------- | ---- | --------------------------------------------- |
| -------- | --------------------------- | ---- | --------------------------------------------- |
| keyAlias | string | 是 | 别名。 |
| keyAlias | string | 是 | 别名。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | 用于存放生成key所需TAG。其中密钥使用的算法、密钥用途、密钥长度为必选参数。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | 用于存放生成key所需TAG。其中密钥使用的算法、密钥用途、密钥长度为必选参数。 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。
不返回err值时表示接口使用成功,其他时为错误
。 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。
未捕获error时代表用户指定别名的密钥生成成功,基于密钥不出TEE原则,此接口不会返回密钥材料内容,若捕获error,则为生成阶段出现异常
。 |
**示例:**
**示例:**
...
@@ -121,7 +121,7 @@ try {
...
@@ -121,7 +121,7 @@ try {
generateKeyItem(keyAlias: string, options: HuksOptions) : Promise
\<
void>
generateKeyItem(keyAlias: string, options: HuksOptions) : Promise
\<
void>
生成密钥,使用Promise方式异步返回结果。
生成密钥,使用Promise方式异步返回结果
,基于密钥不出TEE原则,通过promise不会返回密钥材料内容,只用于表示此次调用是否成功
。
**系统能力**
:SystemCapability.Security.Huks
**系统能力**
:SystemCapability.Security.Huks
...
@@ -1084,7 +1084,7 @@ isKeyItemExist(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<
...
@@ -1084,7 +1084,7 @@ isKeyItemExist(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<
| -------- | --------------------------- | ---- | --------------------------------------- |
| -------- | --------------------------- | ---- | --------------------------------------- |
| keyAlias | string | 是 | 所需查找的密钥的别名。 |
| keyAlias | string | 是 | 所需查找的密钥的别名。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | 空对象(此处传空即可)。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | 空对象(此处传空即可)。 |
| callback | AsyncCallback
\<
boolean> | 是 | 回调函数。
FALSE代表密钥不存在,TRUE代表密钥存在。
|
| callback | AsyncCallback
\<
boolean> | 是 | 回调函数。
若密钥存在,data为true,若密钥不存在,则error中会输出不存在的error code
|
**示例:**
**示例:**
...
@@ -1094,17 +1094,19 @@ let keyAlias = 'keyAlias';
...
@@ -1094,17 +1094,19 @@ let keyAlias = 'keyAlias';
let
emptyOptions
=
{
let
emptyOptions
=
{
properties
:
[]
properties
:
[]
};
};
try
{
huks
.
isKeyItemExist
(
keyAlias
,
emptyOptions
,
function
(
error
,
data
)
{
huks
.
isKeyItemExist
(
keyAlias
,
emptyOptions
,
function
(
error
,
data
)
{
if
(
data
)
{
if
(
error
)
{
promptAction
.
showToast
({
console
.
error
(
`callback: isKeyItemExist failed, code:
${
error
.
code
}
, msg:
${
error
.
message
}
`
);
message
:
"
别名为:
"
+
keyAlias
+
"
的密钥是存在的!
"
,
}
else
{
duration
:
2500
,
console
.
info
(
`callback: isKeyItemExist success, data =
${
JSON
.
stringify
(
data
)}
`
);
})
}
}
else
{
});
promptAction
.
showToast
({
}
catch
(
error
)
{
message
:
"
密钥删除失败,错误码是:
"
+
error
.
code
+
"
错误吗信息:
"
+
error
.
message
,
console
.
error
(
`promise: isKeyItemExist input arg invalid, code:
${
error
.
code
}
, msg:
${
error
.
message
}
`
);
duration
:
2500
,
}
})
}
});
```
```
## huks.isKeyItemExist<sup>9+</sup>
## huks.isKeyItemExist<sup>9+</sup>
...
@@ -1126,7 +1128,7 @@ isKeyItemExist(keyAlias: string, options: HuksOptions) : Promise\<boolean>
...
@@ -1126,7 +1128,7 @@ isKeyItemExist(keyAlias: string, options: HuksOptions) : Promise\<boolean>
| 类型 | 说明 |
| 类型 | 说明 |
| ----------------- | --------------------------------------- |
| ----------------- | --------------------------------------- |
| Promise
\<
boolean> | Promise对象。
FALSE代表密钥不存在,TRUE代表密钥存在。
|
| Promise
\<
boolean> | Promise对象。
密钥存在时,可通过then 进行密钥存在后的相关处理,若不存在,可通过error 处理密钥不存在后的相关业务操作
|
**示例:**
**示例:**
...
@@ -1136,17 +1138,17 @@ let keyAlias = 'keyAlias';
...
@@ -1136,17 +1138,17 @@ let keyAlias = 'keyAlias';
let
emptyOptions
=
{
let
emptyOptions
=
{
properties
:
[]
properties
:
[]
};
};
try
{
await
huks
.
isKeyItemExist
(
keyAlias
,
emptyOptions
).
then
((
data
)
=>
{
huks
.
isKeyItemExist
(
keyAlias
,
emptyOptions
)
promptAction
.
showToast
({
.
then
((
data
)
=>
{
message
:
"
别名为:
"
+
keyAlias
+
"
的密钥是存在的!
"
,
console
.
info
(
`promise: isKeyItemExist success, data =
${
JSON
.
stringify
(
data
)}
`
);
duration
:
500
,
})
})
.
catch
(
error
=>
{
}).
catch
((
err
)
=>
{
console
.
error
(
`promise: isKeyItemExist failed, code:
${
error
.
code
}
, msg:
${
error
.
message
}
`
);
promptAction
.
showToast
({
});
message
:
"
密钥删除失败,错误码是:
"
+
err
.
code
+
"
错误吗信息:
"
+
err
.
message
,
}
catch
(
error
)
{
duration
:
6500
,
console
.
error
(
`promise: isKeyItemExist input arg invalid, code:
${
error
.
code
}
, msg:
${
error
.
message
}
`
);
})
}
})
```
```
## huks.initSession<sup>9+</sup>
## huks.initSession<sup>9+</sup>
...
@@ -1196,7 +1198,7 @@ updateSession操作密钥接口,使用Callback回调异步返回结果。huks.
...
@@ -1196,7 +1198,7 @@ updateSession操作密钥接口,使用Callback回调异步返回结果。huks.
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型
,
| 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | -------------------------------------------- |
| -------- | ---------------------------------------------------- | ---- | -------------------------------------------- |
| handle | number | 是 | updateSession操作的handle。 |
| handle | number | 是 | updateSession操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | updateSession的参数集合。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | updateSession的参数集合。 |
...
@@ -2821,6 +2823,7 @@ function huksAbort() {
...
@@ -2821,6 +2823,7 @@ function huksAbort() {
huks Handle结构体。
huks Handle结构体。
**系统能力**
:SystemCapability.Security.Huks
**系统能力**
:SystemCapability.Security.Huks
> **说明:** 从API Version 9开始废弃,建议使用[HuksSessionHandle<sup>9+</sup>](#hukssessionhandle9)替代。
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ---------------- | ---- | -------- |
| ---------- | ---------------- | ---- | -------- |
...
@@ -2834,6 +2837,8 @@ huks Handle结构体。
...
@@ -2834,6 +2837,8 @@ huks Handle结构体。
**系统能力**
:SystemCapability.Security.Huks
**系统能力**
:SystemCapability.Security.Huks
> **说明:** 从API Version 9开始废弃,建议使用[HuksReturnResult<sup>9+</sup>](#huksreturnresult9)替代。
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------- | ---- | ---------------- |
| ---------- | ------------------------------- | ---- | ---------------- |
| errorCode | number | 是 | 表示错误码。 |
| errorCode | number | 是 | 表示错误码。 |
...
@@ -2847,6 +2852,7 @@ huks Handle结构体。
...
@@ -2847,6 +2852,7 @@ huks Handle结构体。
表示错误码的枚举。
表示错误码的枚举。
**系统能力**
:SystemCapability.Security.Huks
**系统能力**
:SystemCapability.Security.Huks
> **说明:** 从API Version 9开始废弃,建议使用[HuksExceptionErrCode<sup>9+</sup>](#huksexceptionerrcode9)替代。
| 名称 | 值 | 说明 |
| 名称 | 值 | 说明 |
| -------------------------- | ----- | ---- |
| -------------------------- | ----- | ---- |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录