Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
XKZJ_WCL
Docs
提交
fc862090
D
Docs
项目概览
XKZJ_WCL
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
0
Fork
0
代码
文件
提交
分支
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,发现更多精彩内容 >>
未验证
提交
fc862090
编写于
4月 07, 2023
作者:
O
openharmony_ci
提交者:
Gitee
4月 07, 2023
浏览文件
操作
浏览文件
下载
差异文件
!16935
https://gitee.com/openharmony/docs/issues/I6TDUL
Merge pull request !16935 from 高高阳/master
上级
4b104d03
d3c76a73
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
42 addition
and
36 deletion
+42
-36
zh-cn/application-dev/reference/apis/js-apis-huks.md
zh-cn/application-dev/reference/apis/js-apis-huks.md
+42
-36
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-huks.md
浏览文件 @
fc862090
...
...
@@ -75,7 +75,7 @@ generateKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\
| -------- | --------------------------- | ---- | --------------------------------------------- |
| keyAlias | string | 是 | 别名。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | 用于存放生成key所需TAG。其中密钥使用的算法、密钥用途、密钥长度为必选参数。 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。
不返回err值时表示接口使用成功,其他时为错误
。 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。
未捕获error时代表用户指定别名的密钥生成成功,基于密钥不出TEE原则,此接口不会返回密钥材料内容,若捕获error,则为生成阶段出现异常
。 |
**示例:**
...
...
@@ -121,7 +121,7 @@ try {
generateKeyItem(keyAlias: string, options: HuksOptions) : Promise
\<
void>
生成密钥,使用Promise方式异步返回结果。
生成密钥,使用Promise方式异步返回结果
,基于密钥不出TEE原则,通过promise不会返回密钥材料内容,只用于表示此次调用是否成功
。
**系统能力**
:SystemCapability.Security.Huks
...
...
@@ -1084,7 +1084,7 @@ isKeyItemExist(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<
| -------- | --------------------------- | ---- | --------------------------------------- |
| keyAlias | string | 是 | 所需查找的密钥的别名。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | 空对象(此处传空即可)。 |
| callback | AsyncCallback
\<
boolean> | 是 | 回调函数。
FALSE代表密钥不存在,TRUE代表密钥存在。
|
| callback | AsyncCallback
\<
boolean> | 是 | 回调函数。
若密钥存在,data为true,若密钥不存在,则error中会输出不存在的error code
|
**示例:**
...
...
@@ -1094,17 +1094,19 @@ let keyAlias = 'keyAlias';
let
emptyOptions
=
{
properties
:
[]
};
try
{
huks
.
isKeyItemExist
(
keyAlias
,
emptyOptions
,
function
(
error
,
data
)
{
if
(
error
)
{
console
.
error
(
`callback: isKeyItemExist failed, code:
${
error
.
code
}
, msg:
${
error
.
message
}
`
);
huks
.
isKeyItemExist
(
keyAlias
,
emptyOptions
,
function
(
error
,
data
)
{
if
(
data
)
{
promptAction
.
showToast
({
message
:
"
keyAlias:
"
+
keyAlias
+
"
is existed!
"
,
duration
:
2500
,
})
}
else
{
console
.
info
(
`callback: isKeyItemExist success, data =
${
JSON
.
stringify
(
data
)}
`
);
promptAction
.
showToast
({
message
:
"
find key failed,error code:
"
+
error
.
code
+
"
error msg:
"
+
error
.
message
,
duration
:
2500
,
})
}
});
}
catch
(
error
)
{
console
.
error
(
`promise: isKeyItemExist input arg invalid, code:
${
error
.
code
}
, msg:
${
error
.
message
}
`
);
}
});
```
## huks.isKeyItemExist<sup>9+</sup>
...
...
@@ -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';
let
emptyOptions
=
{
properties
:
[]
};
try
{
huks
.
isKeyItemExist
(
keyAlias
,
emptyOptions
)
.
then
((
data
)
=>
{
console
.
info
(
`promise: isKeyItemExist success, data =
${
JSON
.
stringify
(
data
)}
`
);
await
huks
.
isKeyItemExist
(
keyAlias
,
emptyOptions
).
then
((
data
)
=>
{
promptAction
.
showToast
({
message
:
"
keyAlias:
"
+
keyAlias
+
"
is existed!
"
,
duration
:
500
,
})
}).
catch
((
err
)
=>
{
promptAction
.
showToast
({
message
:
"
find key failed, error code:
"
+
err
.
code
+
"
error message:
"
+
err
.
message
,
duration
:
6500
,
})
})
.
catch
(
error
=>
{
console
.
error
(
`promise: isKeyItemExist failed, code:
${
error
.
code
}
, msg:
${
error
.
message
}
`
);
});
}
catch
(
error
)
{
console
.
error
(
`promise: isKeyItemExist input arg invalid, code:
${
error
.
code
}
, msg:
${
error
.
message
}
`
);
}
```
## huks.initSession<sup>9+</sup>
...
...
@@ -1707,7 +1709,7 @@ async function huksAbort() {
| HUKS_ECC_KEY_SIZE_384 | 384 | 表示使用ECC算法的密钥长度为384bit。 |
| HUKS_ECC_KEY_SIZE_521 | 521 | 表示使用ECC算法的密钥长度为521bit。 |
| HUKS_AES_KEY_SIZE_128 | 128 | 表示使用AES算法的密钥长度为128bit。 |
| HUKS_AES_KEY_SIZE_192 | 192 | 表示使用AES算法的密钥长度为19
6
bit。 |
| HUKS_AES_KEY_SIZE_192 | 192 | 表示使用AES算法的密钥长度为19
2
bit。 |
| HUKS_AES_KEY_SIZE_256 | 256 | 表示使用AES算法的密钥长度为256bit。 |
| HUKS_AES_KEY_SIZE_512 | 512 | 表示使用AES算法的密钥长度为512bit。 |
| HUKS_CURVE25519_KEY_SIZE_256 | 256 | 表示使用CURVE25519算法的密钥长度为256bit。 |
...
...
@@ -1918,16 +1920,16 @@ async function huksAbort() {
| HUKS_TAG_DERIVE_KEY_SIZE | HuksTagType.HUKS_TAG_TYPE_UINT
\|
24 | 表示派生密钥的大小。 |
| HUKS_TAG_IMPORT_KEY_TYPE
<sup>
9+
</sup>
| HuksTagType.HUKS_TAG_TYPE_UINT
\|
25 | 表示导入的密钥类型。 |
| HUKS_TAG_UNWRAP_ALGORITHM_SUITE
<sup>
9+
</sup>
| HuksTagType.HUKS_TAG_TYPE_UINT
\|
26 | 表示导入加密密钥的套件。 |
| HUKS_TAG_ACTIVE_DATETIME
| HuksTagType.HUKS_TAG_TYPE_ULONG
\|
201 |
预留。 |
| HUKS_TAG_ORIGINATION_EXPIRE_DATETIME
| HuksTagType.HUKS_TAG_TYPE_ULONG
\|
202 |
预留。 |
| HUKS_TAG_USAGE_EXPIRE_DATETIME
| HuksTagType.HUKS_TAG_TYPE_ULONG
\|
203 |
预留。 |
| HUKS_TAG_CREATION_DATETIME
| HuksTagType.HUKS_TAG_TYPE_ULONG
\|
204 | 预留。
|
| HUKS_TAG_ALL_USERS | HuksTagType.HUKS_TAG_TYPE_BOOL
\|
301 | 预留
。
|
| HUKS_TAG_USER_ID | HuksTagType.HUKS_TAG_TYPE_UINT
\|
302 |
预留。
|
| HUKS_TAG_ACTIVE_DATETIME
<sup>
deprecated
</sup>
| HuksTagType.HUKS_TAG_TYPE_ULONG
\|
201 | 原为证书业务预留字段,当前证书管理已独立,此字段废弃,不再
预留。 |
| HUKS_TAG_ORIGINATION_EXPIRE_DATETIME
<sup>
deprecated
</sup>
| HuksTagType.HUKS_TAG_TYPE_ULONG
\|
202 | 原为证书业务预留字段,当前证书管理已独立,此字段废弃,不再
预留。 |
| HUKS_TAG_USAGE_EXPIRE_DATETIME
<sup>
deprecated
</sup>
| HuksTagType.HUKS_TAG_TYPE_ULONG
\|
203 | 原为证书业务预留字段,当前证书管理已独立,此字段废弃,不再
预留。 |
| HUKS_TAG_CREATION_DATETIME
<sup>
deprecated
</sup>
| HuksTagType.HUKS_TAG_TYPE_ULONG
\|
204 | 原为证书业务预留字段,当前证书管理已独立,此字段废弃,不再预留。
|
| HUKS_TAG_ALL_USERS | HuksTagType.HUKS_TAG_TYPE_BOOL
\|
301 | 预留 |
| HUKS_TAG_USER_ID | HuksTagType.HUKS_TAG_TYPE_UINT
\|
302 |
表示当前密钥属于哪个userID
|
| HUKS_TAG_NO_AUTH_REQUIRED | HuksTagType.HUKS_TAG_TYPE_BOOL
\|
303 | 预留。 |
| HUKS_TAG_USER_AUTH_TYPE | HuksTagType.HUKS_TAG_TYPE_UINT
\|
304 | 表示用户认证类型。从
[
HuksUserAuthType
](
#huksuserauthtype9
)
中选择,需要与安全访问控制类型同时设置。支持同时指定两种用户认证类型,如:安全访问控制类型指定为HKS_SECURE_ACCESS_INVALID_NEW_BIO_ENROLL时,密钥访问认证类型可以指定以下三种: HKS_USER_AUTH_TYPE_FACE 、HKS_USER_AUTH_TYPE_FINGERPRINT、HKS_USER_AUTH_TYPE_FACE
\|
HKS_USER_AUTH_TYPE_FINGERPRINT |
| HUKS_TAG_AUTH_TIMEOUT | HuksTagType.HUKS_TAG_TYPE_UINT
\|
305 |
预留
。 |
| HUKS_TAG_AUTH_TOKEN | HuksTagType.HUKS_TAG_TYPE_BYTES
\|
306 |
预留。
|
| HUKS_TAG_AUTH_TIMEOUT | HuksTagType.HUKS_TAG_TYPE_UINT
\|
305 |
表示authtoken 单次有效期
。 |
| HUKS_TAG_AUTH_TOKEN | HuksTagType.HUKS_TAG_TYPE_BYTES
\|
306 |
用于传入authToken 的字段
|
| HUKS_TAG_KEY_AUTH_ACCESS_TYPE
<sup>
9+
</sup>
| HuksTagType.HUKS_TAG_TYPE_UINT
\|
307 | 表示安全访问控制类型。从
[
HuksAuthAccessType
](
#huksauthaccesstype9
)
中选择,需要和用户认证类型同时设置。 |
| HUKS_TAG_KEY_SECURE_SIGN_TYPE
<sup>
9+
</sup>
| HuksTagType.HUKS_TAG_TYPE_UINT
\|
308 | 表示生成或导入密钥时,指定该密钥的签名类型。 |
| HUKS_TAG_CHALLENGE_TYPE
<sup>
9+
</sup>
| HuksTagType.HUKS_TAG_TYPE_UINT
\|
309 | 表示密钥使用时生成的challenge类型。从
[
HuksChallengeType
](
#hukschallengetype9
)
中选择 |
...
...
@@ -1966,7 +1968,7 @@ async function huksAbort() {
| HUKS_TAG_KEY | HuksTagType.HUKS_TAG_TYPE_BYTES
\|
10006 | 预留。 |
| HUKS_TAG_KEY_VERSION | HuksTagType.HUKS_TAG_TYPE_UINT
\|
10007 | 表示密钥版本的Tag。 |
| HUKS_TAG_PAYLOAD_LEN | HuksTagType.HUKS_TAG_TYPE_UINT
\|
10008 | 预留。 |
| HUKS_TAG_AE_TAG | HuksTagType.HUKS_TAG_TYPE_BYTES
\|
10009 |
预留
。 |
| HUKS_TAG_AE_TAG | HuksTagType.HUKS_TAG_TYPE_BYTES
\|
10009 |
用于传入GCM模式中的AEAD 数据的字段
。 |
| HUKS_TAG_IS_KEY_HANDLE | HuksTagType.HUKS_TAG_TYPE_ULONG
\|
10010 | 预留。 |
| HUKS_TAG_OS_VERSION | HuksTagType.HUKS_TAG_TYPE_UINT
\|
10101 | 表示操作系统版本的Tag。 |
| HUKS_TAG_OS_PATCHLEVEL | HuksTagType.HUKS_TAG_TYPE_UINT
\|
10102 | 表示操作系统补丁级别的Tag。 |
...
...
@@ -2821,6 +2823,7 @@ function huksAbort() {
huks Handle结构体。
**系统能力**
:SystemCapability.Security.Huks
> **说明:** 从API Version 9开始废弃,建议使用[HuksSessionHandle<sup>9+</sup>](#hukssessionhandle9)替代。
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ---------------- | ---- | -------- |
...
...
@@ -2834,6 +2837,8 @@ huks Handle结构体。
**系统能力**
:SystemCapability.Security.Huks
> **说明:** 从API Version 9开始废弃,建议使用[HuksReturnResult<sup>9+</sup>](#huksreturnresult9)替代。
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------- | ---- | ---------------- |
| errorCode | number | 是 | 表示错误码。 |
...
...
@@ -2847,6 +2852,7 @@ huks Handle结构体。
表示错误码的枚举。
**系统能力**
: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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录