Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
553ae321
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,发现更多精彩内容 >>
未验证
提交
553ae321
编写于
11月 28, 2022
作者:
O
openharmony_ci
提交者:
Gitee
11月 28, 2022
浏览文件
操作
浏览文件
下载
差异文件
!11892 fix doc code check
Merge pull request !11892 from 胡玉/master
上级
41e3ad88
af3d0e05
变更
2
显示空白变更内容
内联
并排
Showing
2 changed file
with
68 addition
and
56 deletion
+68
-56
zh-cn/application-dev/reference/apis/js-apis-cryptoFramework.md
...application-dev/reference/apis/js-apis-cryptoFramework.md
+66
-54
zh-cn/application-dev/security/cryptoFramework-guidelines.md
zh-cn/application-dev/security/cryptoFramework-guidelines.md
+2
-2
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-cryptoFramework.md
浏览文件 @
553ae321
...
@@ -18,7 +18,7 @@ import cryptoFramework from "@ohos.security.cryptoFramework"
...
@@ -18,7 +18,7 @@ import cryptoFramework from "@ohos.security.cryptoFramework"
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ------------------------------------- | -------- | ---------------------------- |
| ------------------------------------- | -------- | ---------------------------- |
| INVALID_PARAMS | 401 | 非法入参。 |
| INVALID_PARAMS | 401 | 非法入参。 |
| NOT_SUPPORT | 801 | 操作不支持。 |
| NOT_SUPPORT | 801 | 操作不支持。 |
...
@@ -37,7 +37,7 @@ import cryptoFramework from "@ohos.security.cryptoFramework"
...
@@ -37,7 +37,7 @@ import cryptoFramework from "@ohos.security.cryptoFramework"
buffer数组。
buffer数组。
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ---- | ---------- | ---- | ---- | ------ |
| ---- | ---------- | ---- | ---- | ------ |
| data | Uint8Array | 是 | 是 | 数据。 |
| data | Uint8Array | 是 | 是 | 数据。 |
...
@@ -46,7 +46,7 @@ buffer数组。
...
@@ -46,7 +46,7 @@ buffer数组。
buffer数组的列表。
buffer数组的列表。
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ---- | ---------- | ---- | ---- | ---------- |
| ---- | ---------- | ---- | ---- | ---------- |
| data | Uint8Array | 是 | 是 | 数据列表。 |
| data | Uint8Array | 是 | 是 | 数据列表。 |
...
@@ -56,7 +56,7 @@ buffer数组的列表。
...
@@ -56,7 +56,7 @@ buffer数组的列表。
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 |
默认值 | 描述
|
| 名称 |
值 | 说明
|
| ---------- | ------ | --------- |
| ---------- | ------ | --------- |
| FORMAT_DER | 0 | DER格式。 |
| FORMAT_DER | 0 | DER格式。 |
| FORMAT_PEM | 1 | PEM格式。 |
| FORMAT_PEM | 1 | PEM格式。 |
...
@@ -70,9 +70,9 @@ buffer数组的列表。
...
@@ -70,9 +70,9 @@ buffer数组的列表。
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| -------------- | --------------------------------- | ---- | ---- | ------------------------------ |
| -------------- | --------------------------------- | ---- | ---- | ------------------------------ |
| data | Uint8Array | 是 | 是 | 传入的
数据中,包含的证书数量
。 |
| data | Uint8Array | 是 | 是 | 传入的
证书数据
。 |
| encodingFormat |
[
EncodingFormat
](
#encodingformat
)
| 是 | 是 | 指明证书编码格式。 |
| encodingFormat |
[
EncodingFormat
](
#encodingformat
)
| 是 | 是 | 指明证书编码格式。 |
...
@@ -84,7 +84,7 @@ buffer数组的列表。
...
@@ -84,7 +84,7 @@ buffer数组的列表。
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| -------------- | --------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| -------------- | --------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| data | Uint8Array | 是 | 是 | 证书数据,按照长度(2字节)-数据的形式传入,如:08ABCDEFGH07ABCDEFG,第一本证书,前2个字节表示证书的长度为8字节,后面附加8字节的证书数据;第2本证书前2个字节表示证书的长度为7字节,后面附加7字节的证书数据。 |
| data | Uint8Array | 是 | 是 | 证书数据,按照长度(2字节)-数据的形式传入,如:08ABCDEFGH07ABCDEFG,第一本证书,前2个字节表示证书的长度为8字节,后面附加8字节的证书数据;第2本证书前2个字节表示证书的长度为7字节,后面附加7字节的证书数据。 |
| count | number | 是 | 是 | 传入的数据中,包含的证书数量。 |
| count | number | 是 | 是 | 传入的数据中,包含的证书数量。 |
...
@@ -1017,7 +1017,7 @@ promiseGenerateRand.then(randData => {
...
@@ -1017,7 +1017,7 @@ promiseGenerateRand.then(randData => {
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| -------- | ------ | ---- | ---- | ----------------------- |
| -------- | ------ | ---- | ---- | ----------------------- |
| algoName | string | 是 | 是 | 指明对称加解密参数的算法模式。可选值如下:
<br/>
- "IvParamsSpec": 适用于CBC
\|
CTR
\|
OFB
\|
CFB模式
<br/>
- "GcmParamsSpec": 适用于GCM模式
<br/>
- "CcmParamsSpec": 适用于CCM模式 |
| algoName | string | 是 | 是 | 指明对称加解密参数的算法模式。可选值如下:
<br/>
- "IvParamsSpec": 适用于CBC
\|
CTR
\|
OFB
\|
CFB模式
<br/>
- "GcmParamsSpec": 适用于GCM模式
<br/>
- "CcmParamsSpec": 适用于CCM模式 |
...
@@ -1030,7 +1030,7 @@ promiseGenerateRand.then(randData => {
...
@@ -1030,7 +1030,7 @@ promiseGenerateRand.then(randData => {
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ---- | --------------------- | ---- | ---- | ------------------------------------------------------------ |
| ---- | --------------------- | ---- | ---- | ------------------------------------------------------------ |
| iv |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数iv。常见取值如下:
<br/>
- AES的CBC
\|
CTR
\|
OFB
\|
CFB模式:iv长度为16字节
<br/>
- 3DES的CBC
\|
OFB
\|
CFB模式:iv长度为8字节 |
| iv |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数iv。常见取值如下:
<br/>
- AES的CBC
\|
CTR
\|
OFB
\|
CFB模式:iv长度为16字节
<br/>
- 3DES的CBC
\|
OFB
\|
CFB模式:iv长度为8字节 |
...
@@ -1043,7 +1043,7 @@ promiseGenerateRand.then(randData => {
...
@@ -1043,7 +1043,7 @@ promiseGenerateRand.then(randData => {
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ------- | --------------------- | ---- | ---- | ------------------------------------------------------------ |
| ------- | --------------------- | ---- | ---- | ------------------------------------------------------------ |
| iv |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数iv,长度为12字节 |
| iv |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数iv,长度为12字节 |
| aad |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数aad,长度为8字节 |
| aad |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数aad,长度为8字节 |
...
@@ -1058,7 +1058,7 @@ promiseGenerateRand.then(randData => {
...
@@ -1058,7 +1058,7 @@ promiseGenerateRand.then(randData => {
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ------- | --------------------- | ---- | ---- | ------------------------------------------------------------ |
| ------- | --------------------- | ---- | ---- | ------------------------------------------------------------ |
| iv |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数iv,长度为7字节 |
| iv |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数iv,长度为7字节 |
| aad |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数aad,长度为8字节 |
| aad |
[
DataBlob
](
#datablob
)
| 是 | 是 | 指明加解密参数aad,长度为8字节 |
...
@@ -1073,7 +1073,7 @@ promiseGenerateRand.then(randData => {
...
@@ -1073,7 +1073,7 @@ promiseGenerateRand.then(randData => {
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 值 |
描述
|
| 名称 | 值 |
说明
|
| ------------ | ---- | ---------------- |
| ------------ | ---- | ---------------- |
| ENCRYPT_MODE | 0 | 表示进行加密操作 |
| ENCRYPT_MODE | 0 | 表示进行加密操作 |
| DECRYPT_MODE | 1 | 表示进行解密操作 |
| DECRYPT_MODE | 1 | 表示进行解密操作 |
...
@@ -1086,7 +1086,7 @@ promiseGenerateRand.then(randData => {
...
@@ -1086,7 +1086,7 @@ promiseGenerateRand.then(randData => {
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ------- | ------ | ---- | ---- | ---------------------------- |
| ------- | ------ | ---- | ---- | ---------------------------- |
| format | string | 是 | 否 | 密钥的格式。 |
| format | string | 是 | 否 | 密钥的格式。 |
| algName | string | 是 | 否 | 密钥对应的算法名(含长度)。 |
| algName | string | 是 | 否 | 密钥对应的算法名(含长度)。 |
...
@@ -1101,7 +1101,7 @@ getEncoded() : DataBlob
...
@@ -1101,7 +1101,7 @@ getEncoded() : DataBlob
**返回值:**
**返回值:**
| 类型 |
描述
|
| 类型 |
说明
|
| --------------------- | ------------------------ |
| --------------------- | ------------------------ |
|
[
DataBlob
](
#datablob
)
| 用于查看密钥的具体内容。 |
|
[
DataBlob
](
#datablob
)
| 用于查看密钥的具体内容。 |
...
@@ -1158,7 +1158,7 @@ console.info("key hex:" + uint8ArrayToShowStr(encodedKey.data)); // 输出全
...
@@ -1158,7 +1158,7 @@ console.info("key hex:" + uint8ArrayToShowStr(encodedKey.data)); // 输出全
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ------- | ------ | ---- | ---- | ---------------------------- |
| ------- | ------ | ---- | ---- | ---------------------------- |
| format | string | 是 | 否 | 密钥的格式。 |
| format | string | 是 | 否 | 密钥的格式。 |
| algName | string | 是 | 否 | 密钥对应的算法名(含长度)。 |
| algName | string | 是 | 否 | 密钥对应的算法名(含长度)。 |
...
@@ -1174,7 +1174,7 @@ getEncoded() : DataBlob
...
@@ -1174,7 +1174,7 @@ getEncoded() : DataBlob
**返回值:**
**返回值:**
| 类型 |
描述
|
| 类型 |
说明
|
| --------------------- | ------------------------ |
| --------------------- | ------------------------ |
|
[
DataBlob
](
#datablob
)
| 用于查看密钥的具体内容。 |
|
[
DataBlob
](
#datablob
)
| 用于查看密钥的具体内容。 |
...
@@ -1202,7 +1202,7 @@ console.info("key encoded:" + uint8ArrayToShowStr(encodedKey.data));
...
@@ -1202,7 +1202,7 @@ console.info("key encoded:" + uint8ArrayToShowStr(encodedKey.data));
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ------- | ------ | ---- | ---- | ---------------------------- |
| ------- | ------ | ---- | ---- | ---------------------------- |
| format | string | 是 | 否 | 密钥的格式。 |
| format | string | 是 | 否 | 密钥的格式。 |
| algName | string | 是 | 否 | 密钥对应的算法名(含长度)。 |
| algName | string | 是 | 否 | 密钥对应的算法名(含长度)。 |
...
@@ -1217,7 +1217,7 @@ getEncoded() : DataBlob
...
@@ -1217,7 +1217,7 @@ getEncoded() : DataBlob
**返回值:**
**返回值:**
| 类型 |
描述
|
| 类型 |
说明
|
| --------------------- | ------------------------ |
| --------------------- | ------------------------ |
|
[
DataBlob
](
#datablob
)
| 用于查看密钥的具体内容。 |
|
[
DataBlob
](
#datablob
)
| 用于查看密钥的具体内容。 |
...
@@ -1252,6 +1252,20 @@ let key; // key为使用非对称密钥生成器生成的非对称密钥的私
...
@@ -1252,6 +1252,20 @@ let key; // key为使用非对称密钥生成器生成的非对称密钥的私
key
.
clearMem
();
key
.
clearMem
();
```
```
## KeyPair
非对称密钥对,包含:公钥与私钥,。
<br/>
可以通过非对称密钥生成器AsyKeyGenerator来生成。
### 属性
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------- | ------ | ---- | ---- | ------------ |
| priKey |
[
PriKey
](
#prikey
)
| 是 | 否 | 私钥。 |
| pubKey |
[
PubKey
](
#pubkey
)
| 是 | 否 | 公钥。 |
## cryptoFramework.createSymKeyGenerator
## cryptoFramework.createSymKeyGenerator
createSymKeyGenerator(algName : string) : SymKeyGenerator
createSymKeyGenerator(algName : string) : SymKeyGenerator
...
@@ -1287,7 +1301,7 @@ let symKeyGenerator = cryptoFramework.createSymKeyGenerator('3DES192');
...
@@ -1287,7 +1301,7 @@ let symKeyGenerator = cryptoFramework.createSymKeyGenerator('3DES192');
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ------- | ------ | ---- | ---- | ------------------------------ |
| ------- | ------ | ---- | ---- | ------------------------------ |
| algName | string | 是 | 否 | 对称密钥生成器指定的算法名称。 |
| algName | string | 是 | 否 | 对称密钥生成器指定的算法名称。 |
...
@@ -1301,7 +1315,7 @@ generateSymKey(callback : AsyncCallback\<SymKey>) : void
...
@@ -1301,7 +1315,7 @@ generateSymKey(callback : AsyncCallback\<SymKey>) : void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback
\<
[
SymKey
](
#symkey
)
> | 是 | 回调函数。当生成对称密钥成功,err为undefined,data为获取到的SymKey;否则为错误对象。 |
| callback | AsyncCallback
\<
[
SymKey
](
#symkey
)
> | 是 | 回调函数。当生成对称密钥成功,err为undefined,data为获取到的SymKey;否则为错误对象。 |
...
@@ -1370,7 +1384,7 @@ convertKey(key : DataBlob, callback : AsyncCallback\<SymKey>) : void
...
@@ -1370,7 +1384,7 @@ convertKey(key : DataBlob, callback : AsyncCallback\<SymKey>) : void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | --------------------------------- | ---- | ------------------------------------------------------------ |
| key |
[
DataBlob
](
#datablob
)
| 是 | 指定的对称密钥材料。 |
| key |
[
DataBlob
](
#datablob
)
| 是 | 指定的对称密钥材料。 |
| callback | AsyncCallback
\<
[
SymKey
](
#symkey
)
> | 是 | 回调函数。当生成对称密钥成功,err为undefined,data为获取到的SymKey;否则为错误对象。 |
| callback | AsyncCallback
\<
[
SymKey
](
#symkey
)
> | 是 | 回调函数。当生成对称密钥成功,err为undefined,data为获取到的SymKey;否则为错误对象。 |
...
@@ -1417,7 +1431,7 @@ convertKey(key : DataBlob) : Promise\<SymKey>
...
@@ -1417,7 +1431,7 @@ convertKey(key : DataBlob) : Promise\<SymKey>
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------------- |
| ---- | --------------------- | ---- | -------------------- |
| key |
[
DataBlob
](
#datablob
)
| 是 | 指定的密钥材料数据。 |
| key |
[
DataBlob
](
#datablob
)
| 是 | 指定的密钥材料数据。 |
...
@@ -1461,6 +1475,7 @@ symKeyGenerator.convertKey(keyMaterialBlob)
...
@@ -1461,6 +1475,7 @@ symKeyGenerator.convertKey(keyMaterialBlob)
## cryptoFramework.createAsyKeyGenerator
## cryptoFramework.createAsyKeyGenerator
createAsyKeyGenerator(algName : string) : AsyKeyGenerator
createAsyKeyGenerator(algName : string) : AsyKeyGenerator
通过指定算法名称的字符串,获取相应的非对称密钥生成器实例。
通过指定算法名称的字符串,获取相应的非对称密钥生成器实例。
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
...
@@ -1493,7 +1508,7 @@ let asyKeyGenerator = cryptoFramework.createAsyKeyGenerator("ECC256");
...
@@ -1493,7 +1508,7 @@ let asyKeyGenerator = cryptoFramework.createAsyKeyGenerator("ECC256");
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ------- | ------ | ---- | ---- | -------------------------------- |
| ------- | ------ | ---- | ---- | -------------------------------- |
| algName | string | 是 | 否 | 非对称密钥生成器指定的算法名称。 |
| algName | string | 是 | 否 | 非对称密钥生成器指定的算法名称。 |
...
@@ -1507,7 +1522,7 @@ generateKeyPair(callback : AsyncCallback\<KeyPair>) : void;
...
@@ -1507,7 +1522,7 @@ generateKeyPair(callback : AsyncCallback\<KeyPair>) : void;
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------ |
| -------- | ----------------------- | ---- | ------------------------------ |
| callback | AsyncCallback
\<
KeyPair> | 是 | 回调函数,用于获取非对称密钥。 |
| callback | AsyncCallback
\<
KeyPair> | 是 | 回调函数,用于获取非对称密钥。 |
...
@@ -1565,7 +1580,7 @@ convertKey(pubKey : DataBlob, priKey : DataBlob, callback : AsyncCallback\<KeyPa
...
@@ -1565,7 +1580,7 @@ convertKey(pubKey : DataBlob, priKey : DataBlob, callback : AsyncCallback\<KeyPa
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ------------------------------ |
| -------- | ----------------------- | ---- | ------------------------------ |
| pubKey | DataBlob | 否 | 指定的公钥材料。 |
| pubKey | DataBlob | 否 | 指定的公钥材料。 |
| priKey | DataBlob | 否 | 指定的私钥材料。 |
| priKey | DataBlob | 否 | 指定的私钥材料。 |
...
@@ -1597,7 +1612,7 @@ convertKey(pubKey : DataBlob, priKey : DataBlob) : Promise\<KeyPair>
...
@@ -1597,7 +1612,7 @@ convertKey(pubKey : DataBlob, priKey : DataBlob) : Promise\<KeyPair>
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------ | -------- | ---- | ---------------- |
| ------ | -------- | ---- | ---------------- |
| pubKey | DataBlob | 否 | 指定的公钥材料。 |
| pubKey | DataBlob | 否 | 指定的公钥材料。 |
| priKey | DataBlob | 否 | 指定的私钥材料。 |
| priKey | DataBlob | 否 | 指定的私钥材料。 |
...
@@ -1683,7 +1698,7 @@ try {
...
@@ -1683,7 +1698,7 @@ try {
**系统能力:**
SystemCapability.Security.CryptoFramework
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 |
描述
|
| 名称 | 类型 | 可读 | 可写 |
说明
|
| ------- | ------ | ---- | ---- | ---------------------------- |
| ------- | ------ | ---- | ---- | ---------------------------- |
| algName | string | 是 | 否 | 加解密生成器指定的算法名称。 |
| algName | string | 是 | 否 | 加解密生成器指定的算法名称。 |
...
@@ -1697,7 +1712,7 @@ init(opMode : CryptoMode, key : Key, params : ParamsSpec, callback : AsyncCallba
...
@@ -1697,7 +1712,7 @@ init(opMode : CryptoMode, key : Key, params : ParamsSpec, callback : AsyncCallba
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| opMode |
[
CryptoMode
](
#cryptomode
)
| 是 | 加密或者解密模式。 |
| opMode |
[
CryptoMode
](
#cryptomode
)
| 是 | 加密或者解密模式。 |
| key |
[
Key
](
#key
)
| 是 | 指定加密或解密的密钥。 |
| key |
[
Key
](
#key
)
| 是 | 指定加密或解密的密钥。 |
...
@@ -1739,7 +1754,7 @@ init(opMode : CryptoMode, key : Key, params : ParamsSpec) : Promise\<void>
...
@@ -1739,7 +1754,7 @@ init(opMode : CryptoMode, key : Key, params : ParamsSpec) : Promise\<void>
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------ | ------------------------- | ---- | ------------------------------------------------------------ |
| ------ | ------------------------- | ---- | ------------------------------------------------------------ |
| opMode |
[
CryptoMode
](
#cryptomode
)
| 是 | 加密或者解密模式。 |
| opMode |
[
CryptoMode
](
#cryptomode
)
| 是 | 加密或者解密模式。 |
| key |
[
Key
](
#key
)
| 是 | 指定加密或解密的密钥。 |
| key |
[
Key
](
#key
)
| 是 | 指定加密或解密的密钥。 |
...
@@ -1789,7 +1804,7 @@ update(data : DataBlob, callback : AsyncCallback\<DataBlob>) : void
...
@@ -1789,7 +1804,7 @@ update(data : DataBlob, callback : AsyncCallback\<DataBlob>) : void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| data |
[
DataBlob
](
#datablob
)
| 是 | 加密或者解密的数据。data不能为null,也不允许传入{data : Uint8Array(空) } |
| data |
[
DataBlob
](
#datablob
)
| 是 | 加密或者解密的数据。data不能为null,也不允许传入{data : Uint8Array(空) } |
| callback | AsyncCallback
\<
[
DataBlob
](
#datablob
)
> | 是 | 回调函数。当更新加/解密数据成功,err为undefined,data为此次更新的加/解密结果DataBlob;否则为错误对象。 |
| callback | AsyncCallback
\<
[
DataBlob
](
#datablob
)
> | 是 | 回调函数。当更新加/解密数据成功,err为undefined,data为此次更新的加/解密结果DataBlob;否则为错误对象。 |
...
@@ -1846,7 +1861,7 @@ update(data : DataBlob) : Promise\<DataBlob>
...
@@ -1846,7 +1861,7 @@ update(data : DataBlob) : Promise\<DataBlob>
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------------- |
| ---- | --------------------- | ---- | -------------------- |
| data |
[
DataBlob
](
#datablob
)
| 是 | 加密或者解密的数据。data不能为null,也不允许传入{data : Uint8Array(空) } |
| data |
[
DataBlob
](
#datablob
)
| 是 | 加密或者解密的数据。data不能为null,也不允许传入{data : Uint8Array(空) } |
...
@@ -1911,7 +1926,7 @@ doFinal(data : DataBlob, callback : AsyncCallback\<DataBlob>) : void
...
@@ -1911,7 +1926,7 @@ doFinal(data : DataBlob, callback : AsyncCallback\<DataBlob>) : void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| data |
[
DataBlob
](
#datablob
)
| 是 | 加密或者解密的数据。在对称加解密中允许为null,但不允许传入{data : Uint8Array(空) }。 |
| data |
[
DataBlob
](
#datablob
)
| 是 | 加密或者解密的数据。在对称加解密中允许为null,但不允许传入{data : Uint8Array(空) }。 |
| callback | AsyncCallback
\<
[
DataBlob
](
#datablob
)
> | 是 | 回调函数。当最终加/解密数据成功,err为undefined,data为剩余数据的加/解密结果DataBlob;否则为错误对象。 |
| callback | AsyncCallback
\<
[
DataBlob
](
#datablob
)
> | 是 | 回调函数。当最终加/解密数据成功,err为undefined,data为剩余数据的加/解密结果DataBlob;否则为错误对象。 |
...
@@ -1963,7 +1978,7 @@ doFinal(data : DataBlob) : Promise\<DataBlob>
...
@@ -1963,7 +1978,7 @@ doFinal(data : DataBlob) : Promise\<DataBlob>
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------------- |
| ---- | --------------------- | ---- | -------------------- |
| data |
[
DataBlob
](
#datablob
)
| 是 | 加密或者解密的数据。data参数允许为null,但不允许传入{data : Uint8Array(空) } |
| data |
[
DataBlob
](
#datablob
)
| 是 | 加密或者解密的数据。data参数允许为null,但不允许传入{data : Uint8Array(空) } |
...
@@ -2104,7 +2119,7 @@ init(priKey : PriKey, callback : AsyncCallback\<void>) : void
...
@@ -2104,7 +2119,7 @@ init(priKey : PriKey, callback : AsyncCallback\<void>) : void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------- |
| -------- | -------------------- | ---- | ---------------- |
| priKey | Key | 是 | 用于Sign的初始化 |
| priKey |
Pri
Key | 是 | 用于Sign的初始化 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数的 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数的 |
### init
### init
...
@@ -2119,7 +2134,7 @@ init(opMode : CryptoMode, key : Key, params : ParamsSpec) : Promise\<void>
...
@@ -2119,7 +2134,7 @@ init(opMode : CryptoMode, key : Key, params : ParamsSpec) : Promise\<void>
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---------------- |
| ------ | ---- | ---- | ---------------- |
| priKey | Key | 是 | 用于Sign的初始化 |
| priKey |
Pri
Key | 是 | 用于Sign的初始化 |
**返回值:**
**返回值:**
...
@@ -2175,7 +2190,7 @@ sign(data : DataBlob, callback : AsyncCallback\<DataBlob>) : void
...
@@ -2175,7 +2190,7 @@ sign(data : DataBlob, callback : AsyncCallback\<DataBlob>) : void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------- |
| -------- | -------------------- | ---- | ---------- |
| data | DataBlob | 是 | 传入的消息 |
| data | DataBlob | 是 | 传入的消息 |
| callback | AsyncCallback
\<
void
> | 是 | 回调函数 |
| callback | AsyncCallback
\<
DataBlob
> | 是 | 回调函数 |
### sign
### sign
...
@@ -2323,7 +2338,7 @@ init(pubKey : PubKey, callback : AsyncCallback\<void>) : void
...
@@ -2323,7 +2338,7 @@ init(pubKey : PubKey, callback : AsyncCallback\<void>) : void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------- |
| -------- | -------------------- | ---- | ---------------------------- |
| pubKey | Key | 是 | 公钥对象,用于Verify的初始化 |
| pubKey |
Pub
Key | 是 | 公钥对象,用于Verify的初始化 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数 |
### init
### init
...
@@ -2338,7 +2353,7 @@ init(pubKey : PubKey) : Promise\<void>
...
@@ -2338,7 +2353,7 @@ init(pubKey : PubKey) : Promise\<void>
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | ---------------------------- |
| ------ | ---- | ---- | ---------------------------- |
| pubKey | Key | 是 | 公钥对象,用于Verify的初始化 |
| pubKey |
Pub
Key | 是 | 公钥对象,用于Verify的初始化 |
**返回值:**
**返回值:**
...
@@ -2395,7 +2410,7 @@ verify(data : DataBlob, signatureData : DataBlob, callback : AsyncCallback\<bool
...
@@ -2395,7 +2410,7 @@ verify(data : DataBlob, signatureData : DataBlob, callback : AsyncCallback\<bool
| ------------- | -------------------- | ---- | ---------- |
| ------------- | -------------------- | ---- | ---------- |
| data | DataBlob | 是 | 传入的消息 |
| data | DataBlob | 是 | 传入的消息 |
| signatureData | DataBlob | 是 | 签名数据 |
| signatureData | DataBlob | 是 | 签名数据 |
| callback | AsyncCallback
\<
void
> | 是 | 回调函数 |
| callback | AsyncCallback
\<
boolean
> | 是 | 回调函数 |
### verify
### verify
...
@@ -2612,8 +2627,8 @@ createX509Cert(inStream : EncodingBlob) : Promise\<X509Cert>
...
@@ -2612,8 +2627,8 @@ createX509Cert(inStream : EncodingBlob) : Promise\<X509Cert>
**返回值**
:
**返回值**
:
| 类型 | 说明 |
| 类型 | 说明 |
|
:
------- | ---------------- |
| ------- | ---------------- |
|
X509Cert
| 表示X509证书对象 |
|
Promise
\<
X509Cert>
| 表示X509证书对象 |
**示例**
:
**示例**
:
...
@@ -4569,6 +4584,16 @@ let validator = cryptoFramework.createCertChainValidator("PKIX");
...
@@ -4569,6 +4584,16 @@ let validator = cryptoFramework.createCertChainValidator("PKIX");
证书链校验器对象。
证书链校验器对象。
### 属性
**系统能力:**
SystemCapability.Security.CryptoFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------- | ------ | ---- | ---- | -------------------------- |
| algorithm | string | 是 | 否 | X509证书链校验器算法名称。 |
### validate
### validate
validate(certChain : CertChainData, callback : AsyncCallback
\<
void>) : void
validate(certChain : CertChainData, callback : AsyncCallback
\<
void>) : void
...
@@ -4655,19 +4680,6 @@ validator.validate(certChainData).then(result => {
...
@@ -4655,19 +4680,6 @@ validator.validate(certChainData).then(result => {
});
});
```
```
### algorithm
algorithm : string
表示X509证书链校验器算法名称。
**系统能力**
:SystemCapability.Security.CryptoFramework
**返回值**
:
| 类型 | 说明 |
| ------ | ------------------------ |
| string | 表示证书链校验器算法名称 |
**示例**
:
**示例**
:
...
...
zh-cn/application-dev/security/cryptoFramework-guidelines.md
浏览文件 @
553ae321
...
@@ -13,7 +13,7 @@
...
@@ -13,7 +13,7 @@
1.
随机生成算法库密钥对象。该对象可用于后续的加解密等操作。
1.
随机生成算法库密钥对象。该对象可用于后续的加解密等操作。
2.
根据指定数据生成算法库密钥对象(也就是将外部或存储的二进制数据转换为算法库的密钥对象)。该对象可用于后续的加解密等操作。
2.
根据指定数据生成算法库密钥对象(也就是将外部或存储的二进制数据转换为算法库的密钥对象)。该对象可用于后续的加解密等操作。
3.
获取算法库密钥对象的二进制数据,用于存储或传输。
3.
获取算法库密钥对象的二进制数据,用于存储或传输。
> **说明**:密钥对象Key包括对称密钥SymKey和非对称密钥(公钥PubKey和私钥PriKey),其中公钥和私钥组成密钥对KeyPair。密钥之间的具体关系可参考[
接口声明
](../reference/apis/js-apis-cryptoFramework.md)。
> **说明**:密钥对象Key包括对称密钥SymKey和非对称密钥(公钥PubKey和私钥PriKey),其中公钥和私钥组成密钥对KeyPair。密钥之间的具体关系可参考[
API参考
](../reference/apis/js-apis-cryptoFramework.md)。
**接口及参数说明**
**接口及参数说明**
...
@@ -107,7 +107,7 @@ function testGenerateAesKey() {
...
@@ -107,7 +107,7 @@ function testGenerateAesKey() {
import
cryptoFramework
from
'
@ohos.security.cryptoFramework
'
;
import
cryptoFramework
from
'
@ohos.security.cryptoFramework
'
;
function
convertAsyKey
()
{
function
convertAsyKey
()
{
let
rsaGenerator
=
c
fm
.
createAsyKeyGenerator
(
"
RSA1024
"
);
let
rsaGenerator
=
c
ryptoFramework
.
createAsyKeyGenerator
(
"
RSA1024
"
);
let
pkval
=
new
Uint8Array
([
48
,
129
,
159
,
48
,
13
,
6
,
9
,
42
,
134
,
72
,
134
,
247
,
13
,
1
,
1
,
1
,
5
,
0
,
3
,
129
,
141
,
0
,
48
,
129
,
137
,
2
,
129
,
129
,
0
,
174
,
203
,
113
,
83
,
113
,
3
,
143
,
213
,
194
,
79
,
91
,
9
,
51
,
142
,
87
,
45
,
97
,
65
,
136
,
24
,
166
,
35
,
5
,
179
,
42
,
47
,
212
,
79
,
111
,
74
,
134
,
120
,
73
,
67
,
21
,
19
,
235
,
80
,
46
,
152
,
209
,
133
,
232
,
87
,
192
,
140
,
18
,
206
,
27
,
106
,
106
,
169
,
106
,
46
,
135
,
111
,
118
,
32
,
129
,
27
,
89
,
255
,
183
,
116
,
247
,
38
,
12
,
7
,
238
,
77
,
151
,
167
,
6
,
102
,
153
,
126
,
66
,
28
,
253
,
253
,
216
,
64
,
20
,
138
,
117
,
72
,
15
,
216
,
178
,
37
,
208
,
179
,
63
,
204
,
39
,
94
,
244
,
170
,
48
,
190
,
21
,
11
,
73
,
169
,
156
,
104
,
193
,
3
,
17
,
100
,
28
,
60
,
50
,
92
,
235
,
218
,
57
,
73
,
119
,
19
,
101
,
164
,
192
,
161
,
197
,
106
,
105
,
73
,
2
,
3
,
1
,
0
,
1
]);
let
pkval
=
new
Uint8Array
([
48
,
129
,
159
,
48
,
13
,
6
,
9
,
42
,
134
,
72
,
134
,
247
,
13
,
1
,
1
,
1
,
5
,
0
,
3
,
129
,
141
,
0
,
48
,
129
,
137
,
2
,
129
,
129
,
0
,
174
,
203
,
113
,
83
,
113
,
3
,
143
,
213
,
194
,
79
,
91
,
9
,
51
,
142
,
87
,
45
,
97
,
65
,
136
,
24
,
166
,
35
,
5
,
179
,
42
,
47
,
212
,
79
,
111
,
74
,
134
,
120
,
73
,
67
,
21
,
19
,
235
,
80
,
46
,
152
,
209
,
133
,
232
,
87
,
192
,
140
,
18
,
206
,
27
,
106
,
106
,
169
,
106
,
46
,
135
,
111
,
118
,
32
,
129
,
27
,
89
,
255
,
183
,
116
,
247
,
38
,
12
,
7
,
238
,
77
,
151
,
167
,
6
,
102
,
153
,
126
,
66
,
28
,
253
,
253
,
216
,
64
,
20
,
138
,
117
,
72
,
15
,
216
,
178
,
37
,
208
,
179
,
63
,
204
,
39
,
94
,
244
,
170
,
48
,
190
,
21
,
11
,
73
,
169
,
156
,
104
,
193
,
3
,
17
,
100
,
28
,
60
,
50
,
92
,
235
,
218
,
57
,
73
,
119
,
19
,
101
,
164
,
192
,
161
,
197
,
106
,
105
,
73
,
2
,
3
,
1
,
0
,
1
]);
let
pkBlob
=
{
data
:
pkval
};
let
pkBlob
=
{
data
:
pkval
};
rsaGenerator
.
convertKey
(
pkBlob
,
null
,
function
(
err
,
keyPair
)
{
rsaGenerator
.
convertKey
(
pkBlob
,
null
,
function
(
err
,
keyPair
)
{
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录