Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
8a98c488
D
Docs
项目概览
OpenHarmony
/
Docs
接近 2 年 前同步成功
通知
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看板
提交
8a98c488
编写于
10月 18, 2022
作者:
W
wangyongzhong2
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update JS api reference for Cipher
Signed-off-by:
N
wangyongzhong2
<
wangyongzhong2@huawei.com
>
上级
2e11c80f
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
49 addition
and
20 deletion
+49
-20
zh-cn/application-dev/reference/apis/js-apis-system-cipher.md
...n/application-dev/reference/apis/js-apis-system-cipher.md
+49
-20
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-system-cipher.md
浏览文件 @
8a98c488
...
...
@@ -12,10 +12,54 @@
import
cipher
from
'
@system.cipher
'
;
```
## CipherResponse
调用cipher接口后,返回的内容。
**系统能力**
:SystemCapability.Security.Cipher
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------ |
| text | string | 是 | 返回的内容。 |
## CipherRsaOptions
调用cipher rsa方法时,传入的参数。
**系统能力**
:SystemCapability.Security.Cipher
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
| action | string | 是 | 加密类型,可选项有:
<br/>
1. encrypt 加密
<br/>
2. decrypt 解密 |
| text | string | 是 | 待加密或解密的文本内容。待加密的文本内容应该是一段普通文本,长度不能超过 keySize / 8 - 66,其中 keySize 是密钥的长度(例如密钥长度为 1024 时,text 不能超过 62 个字节)。待解密的文本内容应该是经过 base64 编码的一段二进制值。base64 编码使用默认风格。 |
| key | string | 是 | 加密的密钥,RSA的密钥。加密时key为公钥,解密时key为私钥。 |
| transformation | string | 否 | RSA算法的填充项,默认为RSA/None/OAEPWithSHA256AndMGF1Padding。 |
| success | (data:
[
CipherResponse
](
#cipherresponse
)
) => void | 否 | 接口调用成功的回调函数。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
## CipherAesOptions
调用cipher aes方法时,传入的参数。
**系统能力**
:SystemCapability.Security.Cipher
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
| action | string | 是 | 加密类型,可选项有:
<br/>
1. encrypt 加密
<br/>
2. decrypt 解密 |
| text | string | 是 | 待加密或解密的文本内容。待加密的文本内容应该是一段普通文本。待解密的文本内容应该是经过 base64 编码的一段二进制值。base64 编码使用默认风格。 |
| key | string | 是 | 加密或解密使用到的密钥,经过 base64 编码后生成的字符串。 |
| transformation | string | 否 | AES算法的加密模式和填充项,默认AES/CBC/PKCS5Padding。 |
| iv | string | 否 | AES加解密的初始向量,经过base64编码后的字符串,默认值为key值。 |
| ivOffset | string | 否 | AES加解密的初始向量偏移,默认值0,仅支持0。 |
| ivLen | string | 否 | AES加解密的初始向量字节长度,当前为预留字段,默认值16,仅支持16。 |
| success | (data:
[
CipherResponse
](
#cipherresponse
)
) => void | 否 | 接口调用成功的回调函数。 |
| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 |
| complete | () => void | 否 | 接口调用结束的回调函数。 |
## cipher.rsa
rsa(
Object
): void
rsa(
options: CipherRsaOptions
): void
RSA 算法加解密。
...
...
@@ -25,13 +69,7 @@ RSA 算法加解密。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| action | string | 是 | 加密类型,可选项有:
<br/>
1.
encrypt
加密
<br/>
2.
decrypt
解密 |
| text | string | 是 | 待加密或解密的文本内容。待加密的文本内容应该是一段普通文本,长度不能超过
keySize
/
8
-
66,其中
keySize
是密钥的长度(例如密钥长度为
1024
时,text
不能超过
62
个字节)。待解密的文本内容应该是经过
base64
编码的一段二进制值。base64
编码使用默认风格。 |
| key | string | 是 | 加密的密钥,RSA的密钥。加密时key为公钥,解密时key为私钥 |
| transformation | string | 否 | RSA算法的填充项,默认为RSA/None/OAEPWithSHA256AndMGF1Padding |
| success | Function | 否 | 接口调用成功的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
| complete | Function | 否 | 接口调用结束的回调函数。 |
| options |
[
CipherRsaOptions
](
#cipherrsaoptions
)
| 是 | rsa加解密需要设置的参数 |
**示例:**
...
...
@@ -99,7 +137,7 @@ export default {
## cipher.aes
aes(
Object
): void
aes(
options: CipherAesOptions
): void
AES 算法加解密。
...
...
@@ -109,16 +147,7 @@ AES 算法加解密。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| action | string | 是 | 加密类型,可选项有:
<br/>
1.
encrypt
加密
<br/>
2.
decrypt
解密 |
| text | string | 是 | 待加密或解密的文本内容。待加密的文本内容应该是一段普通文本。待解密的文本内容应该是经过
base64
编码的一段二进制值。base64
编码使用默认风格 |
| key | string | 是 | 加密或解密使用到的密钥,经过
base64
编码后生成的字符串 |
| transformation | string | 否 | AES算法的加密模式和填充项,默认AES/CBC/PKCS5Padding |
| iv | string | 否 | AES加解密的初始向量,经过base64编码后的字符串,默认值为key值 |
| ivOffset | string | 否 | AES加解密的初始向量偏移,默认值0,仅支持0。 |
| ivLen | string | 否 | AES加解密的初始向量字节长度,当前为预留字段,默认值16,仅支持16。 |
| success | Function | 否 | 接口调用成功的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
| complete | Function | 否 | 接口调用结束的回调函数。 |
| options |
[
CipherAesOptions
](
#cipheraesoptions
)
| 是 | aes加解密需要设置的参数 |
**示例:**
...
...
@@ -159,7 +188,7 @@ export default {
console
.
log
(
`handling success:
${
data
.
text
}
`
);
},
fail
:
function
(
data
,
code
)
{
console
.
log
(
`### cipher.
rsa
encrypt fail ###
${
code
}
:
${
data
}
`
);
console
.
log
(
`### cipher.
aes
encrypt fail ###
${
code
}
:
${
data
}
`
);
},
complete
:
function
()
{
console
.
log
(
`operation complete!`
);
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录