提交 04c29bed 编写于 作者: C CheungVane

修改接口文档不一致问题

Signed-off-by: Nzhangwenzhi <zhangwenzhi3@huawei.com>
上级 879ad62c
...@@ -19,7 +19,7 @@ import huks from '@ohos.security.huks' ...@@ -19,7 +19,7 @@ import huks from '@ohos.security.huks'
**系统能力**:SystemCapability.Security.Huks **系统能力**:SystemCapability.Security.Huks
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | ---- | ------------ | | ------ | ----------------------------------- | ---- | ------------ |
| tag | [HuksTag](#hukstag) | 是 | 标签。 | | tag | [HuksTag](#hukstag) | 是 | 标签。 |
| value | boolean\|number\|bigint\|Uint8Array | 是 | 标签对应值。 | | value | boolean\|number\|bigint\|Uint8Array | 是 | 标签对应值。 |
...@@ -30,7 +30,7 @@ import huks from '@ohos.security.huks' ...@@ -30,7 +30,7 @@ import huks from '@ohos.security.huks'
**系统能力**:SystemCapability.Security.Huks **系统能力**:SystemCapability.Security.Huks
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---------- | ----------------- | ---- | ------------------------ | | ---------- | ----------------- | ---- | ------------------------ |
| properties | Array\<[HuksParam](#huksparam)> | 否 | 属性,用于存HuksParam的数组。 | | properties | Array\<[HuksParam](#huksparam)> | 否 | 属性,用于存HuksParam的数组。 |
| inData | Uint8Array | 否 | 输入数据。 | | inData | Uint8Array | 否 | 输入数据。 |
...@@ -41,7 +41,7 @@ huks Handle结构体。 ...@@ -41,7 +41,7 @@ huks Handle结构体。
**系统能力**:SystemCapability.Security.Huks **系统能力**:SystemCapability.Security.Huks
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------- | ---------- | ---- | ---------------------------------------------------- | | --------- | ---------- | ---- | ---------------------------------------------------- |
| handle | number | 是 | 表示handle值。 | | handle | number | 是 | 表示handle值。 |
| challenge | Uint8Array | 否 | 表示[init](#huksinit)操作之后获取到的challenge信息。 | | challenge | Uint8Array | 否 | 表示[init](#huksinit)操作之后获取到的challenge信息。 |
...@@ -54,7 +54,7 @@ huks Handle结构体。 ...@@ -54,7 +54,7 @@ huks Handle结构体。
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------- | ---- | ---------------- | | ---------- | ------------------------------- | ---- | ---------------- |
| outData | Uint8Array | 否 | 表示输出数据。 | | outData | Uint8Array | 否 | 表示输出数据。 |
| properties | Array\<[HuksParam](#huksparam)> | 否 | 表示属性信息。 | | properties | Array\<[HuksParam](#huksparam)> | 否 | 表示属性信息。 |
...@@ -1605,26 +1605,26 @@ async function huksAbort() { ...@@ -1605,26 +1605,26 @@ async function huksAbort() {
**系统能力**:SystemCapability.Security.Huks **系统能力**:SystemCapability.Security.Huks
| 名称 | 说明 | 错误码 | | 名称 | 值 | 说明 |
| ---------------------------------------------- | --------------------------- | -------- | | ---------------------------------------------- | -------- |--------------------------- |
| HUKS_ERR_CODE_PERMISSION_FAIL | 权限错误导致失败。 | 201 | | HUKS_ERR_CODE_PERMISSION_FAIL | 201 | 权限错误导致失败。 |
| HUKS_ERR_CODE_ILLEGAL_ARGUMENT | 参数错误导致失败。 | 401 | | HUKS_ERR_CODE_ILLEGAL_ARGUMENT | 401 | 参数错误导致失败。 |
| HUKS_ERR_CODE_NOT_SUPPORTED_API | 不支持的API。 | 801 | | HUKS_ERR_CODE_NOT_SUPPORTED_API | 801 | 不支持的API。 |
| HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED | 不支持的功能/特性。 | 12000001 | | HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED | 12000001 | 不支持的功能/特性。 |
| HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT | 缺少密钥算法参数。 | 12000002 | | HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT | 12000002 | 缺少密钥算法参数。 |
| HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT | 无效密钥算法参数。 | 12000003 | | HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT | 12000003 | 无效密钥算法参数。 |
| HUKS_ERR_CODE_FILE_OPERATION_FAIL | 文件操作失败。 | 12000004 | | HUKS_ERR_CODE_FILE_OPERATION_FAIL | 12000004 | 文件操作失败。 |
| HUKS_ERR_CODE_COMMUNICATION_FAIL | 通信失败。 | 12000005 | | HUKS_ERR_CODE_COMMUNICATION_FAIL | 12000005 | 通信失败。 |
| HUKS_ERR_CODE_CRYPTO_FAIL | 算法库操作失败。 | 12000006 | | HUKS_ERR_CODE_CRYPTO_FAIL | 12000006 | 算法库操作失败。 |
| HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED | 密钥访问失败-密钥访问失效。 | 12000007 | | HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED | 12000007 | 密钥访问失败-密钥访问失效。 |
| HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED | 密钥访问失败-密钥认证失败。 | 12000008 | | HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED | 12000008 | 密钥访问失败-密钥认证失败。 |
| HUKS_ERR_CODE_KEY_AUTH_TIME_OUT | 密钥访问失败-密钥访问超时。 | 12000009 | | HUKS_ERR_CODE_KEY_AUTH_TIME_OUT | 12000009 | 密钥访问失败-密钥访问超时。 |
| HUKS_ERR_CODE_SESSION_LIMIT | 密钥操作会话数已达上限。 | 12000010 | | HUKS_ERR_CODE_SESSION_LIMIT | 12000010 | 密钥操作会话数已达上限。 |
| HUKS_ERR_CODE_ITEM_NOT_EXIST | 目标对象不存在。 | 12000011 | | HUKS_ERR_CODE_ITEM_NOT_EXIST | 12000011 | 目标对象不存在。 |
| HUKS_ERR_CODE_EXTERNAL_ERROR | 外部错误。 | 12000012 | | HUKS_ERR_CODE_EXTERNAL_ERROR | 12000012 | 外部错误。 |
| HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST | 缺失所需凭据。 | 12000013 | | HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST | 12000013 | 缺失所需凭据。 |
| HUKS_ERR_CODE_INSUFFICIENT_MEMORY | 内存不足。 | 12000014 | | HUKS_ERR_CODE_INSUFFICIENT_MEMORY | 12000014 | 内存不足。 |
| HUKS_ERR_CODE_CALL_SERVICE_FAILED | 调用其他系统服务失败。 | 12000015 | | HUKS_ERR_CODE_CALL_SERVICE_FAILED | 12000015 | 调用其他系统服务失败。 |
## HuksKeyPurpose ## HuksKeyPurpose
...@@ -1710,7 +1710,7 @@ async function huksAbort() { ...@@ -1710,7 +1710,7 @@ async function huksAbort() {
| HUKS_ECC_KEY_SIZE_384 | 384 | 表示使用ECC算法的密钥长度为384bit。 | | HUKS_ECC_KEY_SIZE_384 | 384 | 表示使用ECC算法的密钥长度为384bit。 |
| HUKS_ECC_KEY_SIZE_521 | 521 | 表示使用ECC算法的密钥长度为521bit。 | | HUKS_ECC_KEY_SIZE_521 | 521 | 表示使用ECC算法的密钥长度为521bit。 |
| HUKS_AES_KEY_SIZE_128 | 128 | 表示使用AES算法的密钥长度为128bit。 | | HUKS_AES_KEY_SIZE_128 | 128 | 表示使用AES算法的密钥长度为128bit。 |
| HUKS_AES_KEY_SIZE_192 | 196 | 表示使用AES算法的密钥长度为196bit。 | | HUKS_AES_KEY_SIZE_192 | 192 | 表示使用AES算法的密钥长度为196bit。 |
| HUKS_AES_KEY_SIZE_256 | 256 | 表示使用AES算法的密钥长度为256bit。 | | HUKS_AES_KEY_SIZE_256 | 256 | 表示使用AES算法的密钥长度为256bit。 |
| HUKS_AES_KEY_SIZE_512 | 512 | 表示使用AES算法的密钥长度为512bit。 | | HUKS_AES_KEY_SIZE_512 | 512 | 表示使用AES算法的密钥长度为512bit。 |
| HUKS_CURVE25519_KEY_SIZE_256 | 256 | 表示使用CURVE25519算法的密钥长度为256bit。 | | HUKS_CURVE25519_KEY_SIZE_256 | 256 | 表示使用CURVE25519算法的密钥长度为256bit。 |
...@@ -2835,7 +2835,7 @@ huks Handle结构体。 ...@@ -2835,7 +2835,7 @@ huks Handle结构体。
**系统能力**:SystemCapability.Security.Huks **系统能力**:SystemCapability.Security.Huks
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ---------- | ---------------- | ---- | -------- | | ---------- | ---------------- | ---- | -------- |
| errorCode | number | 是 | 表示错误码。 | | errorCode | number | 是 | 表示错误码。 |
| handle | number | 是 | 表示handle值。 | | handle | number | 是 | 表示handle值。 |
...@@ -2849,8 +2849,7 @@ huks Handle结构体。 ...@@ -2849,8 +2849,7 @@ huks Handle结构体。
**系统能力**:SystemCapability.Security.Huks **系统能力**:SystemCapability.Security.Huks
| 名称 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------- | ---- | ---------------- | | ---------- | ------------------------------- | ---- | ---------------- |
| errorCode | number | 是 | 表示错误码。 | | errorCode | number | 是 | 表示错误码。 |
| outData | Uint8Array | 否 | 表示输出数据。 | | outData | Uint8Array | 否 | 表示输出数据。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册