提交 d498accb 编写于 作者: H hxt_lucky

modify cipher api md file

Signed-off-by: Nhxt_lucky <huxiaotian2@huawei.com>
上级 aab1f0cb
......@@ -3,7 +3,8 @@
> **说明:**
>
> 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 从API version 9开始废弃, 建议使用[cryptoFramework-Cipher](js-apis-cryptoFramework.md#Cipher)替代。
## 导入模块
......@@ -18,17 +19,20 @@ import cipher from '@system.cipher';
**系统能力**:SystemCapability.Security.Cipher
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------ |
| text | string | 是 | 返回的内容。 |
| 名称 | 类型 | 可读 | 可写 |说明 |
| ------ | ------ | ---- | ---- | ------------ |
| 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 编码使用默认风格。 |
......@@ -44,7 +48,7 @@ import cipher from '@system.cipher';
**系统能力**:SystemCapability.Security.Cipher
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
| action | string | 是 | 加密类型,可选项有:<br/>1. encrypt 加密<br/>2. decrypt 解密 |
| text | string | 是 | 待加密或解密的文本内容。待加密的文本内容应该是一段普通文本。待解密的文本内容应该是经过 base64 编码的一段二进制值。base64 编码使用默认风格。 |
......@@ -74,39 +78,39 @@ RSA 算法加解密。
**示例:**
```js
export default {
rsa() {
cipher.rsa({
//加密
action: 'encrypt',
//待加密的文本内容
text: 'hello',
//base64编码后的加密公钥
key:
'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCx414QSP3RsYWYzf9mkBMiBAXo\n' +
'6S7Lpva1fKlcuVxjoFC1iMnzD4mC0uiL4k5MNi43J64c7dbqi3qAJjdAtuwQ6NZJ\n' +
export default {
rsa() {
cipher.rsa({
//加密
action: 'encrypt',
//待加密的文本内容
text: 'hello',
//base64编码后的加密公钥
key:
'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCx414QSP3RsYWYzf9mkBMiBAXo\n' +
'6S7Lpva1fKlcuVxjoFC1iMnzD4mC0uiL4k5MNi43J64c7dbqi3qAJjdAtuwQ6NZJ\n' +
'+Enz0RzmVFh/4yk6lmqRzuEFQqhQqSZzaLq6sq2N2G0Sv2Xl3sLvqAfe2HNm2oBw\n' +
'jBpApTJ3TeneOo6Z5QIDAQAB',
success: function(data) {
console.log(`handling success:${data.text}`);
},
fail: function(data, code) {
console.log(`### cipher.rsa encrypt fail ### ${code}:${data}`);
'jBpApTJ3TeneOo6Z5QIDAQAB',
success: function(data) {
console.log(`handling success:${data.text}`);
},
fail: function(data, code) {
console.log(`### cipher.rsa encrypt fail ### ${code}:${data}`);
},
complete: function() {
console.log(`operation complete!`);
}
});
cipher.rsa({
//解密:
action: 'decrypt',
//待解密的内容,是base64编码后的一段二进制值,解密后是文本内容“hello”
text:
});
cipher.rsa({
//解密:
action: 'decrypt',
//待解密的内容,是base64编码后的一段二进制值,解密后是文本内容“hello”
text:
'EPeCFPib6ayKbA0M6oSywARvFZ8dFYfjQv3nY8ikZGtS9UHq2sLPvAfpeIzggSiCxqbWeCftP1XQ\n' +
'Sa+jEpzFlT1qoSTunBbrYzugPTajIJDTg6R1IRsF/J+mmakn0POVPvi4jCo9wqavB324Bx0Wipnc\n' +
'EU5WO0oBHo5l4x6dTpU=',
//base64编码后的解密私钥
key:
'EU5WO0oBHo5l4x6dTpU=',
//base64编码后的解密私钥
key:
'MIICXgIBAAKBgQCx414QSP3RsYWYzf9mkBMiBAXo6S7Lpva1fKlcuVxjoFC1iMnz\n' +
'D4mC0uiL4k5MNi43J64c7dbqi3qAJjdAtuwQ6NZJ+Enz0RzmVFh/4yk6lmqRzuEF\n' +
'QqhQqSZzaLq6sq2N2G0Sv2Xl3sLvqAfe2HNm2oBwjBpApTJ3TeneOo6Z5QIDAQAB\n' +
......@@ -118,18 +122,18 @@ export default {
'PKoljdXmJeS6rGgzGibstuHLrP3tcIho4+0CQD3ZFWzF/xq0jxKlrpWhnJuNCRfE\n' +
'oO6e9yNvVA8J/5oEDSOcmqSNIp4+RhbUx8InUxnCG6Ryv5aSFu71pYcKrPkCQQCL\n' +
'RUGcm3ZGTnslduB0knNF+V2ndwzDUQ7P74UXT+PjurTPhujFYiuxCEd6ORVnEOzG\n' +
'M9TORIgdH8MjIbWsGnndAkEAw9yURDaorE8IYPLF2IEn09g1uzvWPs3phDb6smVx\n' +
'M9TORIgdH8MjIbWsGnndAkEAw9yURDaorE8IYPLF2IEn09g1uzvWPs3phDb6smVx\n' +
'8GfqIdUNf+aCG5TZK/kXBF1sqcsi7jXMAf4jBlejVbSVZg==',
success: function(data) {
console.log(`handling success:${data.text}`);
},
fail: function(data, code) {
console.log(`### cipher.rsa encrypt fail ### ${code}:${data}`);
success: function(data) {
console.log(`handling success:${data.text}`);
},
fail: function(data, code) {
console.log(`### cipher.rsa encrypt fail ### ${code}:${data}`);
},
complete: function() {
console.log(`operation complete!`);
}
});
}
});
}
}
```
......@@ -152,48 +156,48 @@ AES 算法加解密。
**示例:**
```js
export default {
aes() {
cipher.aes({
//加密
action: 'encrypt',
//待加密的文本内容
text: 'hello',
//base64编码后的密钥
key: 'NDM5Qjk2UjAzMEE0NzVCRjlFMkQwQkVGOFc1NkM1QkQ=',
transformation: 'AES/CBC/PKCS5Padding',
ivOffset: '0',
ivLen: '16',
success: function(data) {
console.log(`handling success:${data.text}`);
},
fail: function(data, code) {
console.log(`### cipher.rsa encrypt fail ### ${code}:${data}`);
export default {
aes() {
cipher.aes({
//加密
action: 'encrypt',
//待加密的文本内容
text: 'hello',
//base64编码后的密钥
key: 'NDM5Qjk2UjAzMEE0NzVCRjlFMkQwQkVGOFc1NkM1QkQ=',
transformation: 'AES/CBC/PKCS5Padding',
ivOffset: '0',
ivLen: '16',
success: function(data) {
console.log(`handling success:${data.text}`);
},
fail: function(data, code) {
console.log(`### cipher.rsa encrypt fail ### ${code}:${data}`);
},
complete: function() {
console.log(`operation complete!`);
}
});
cipher.aes({
//解密:
action: 'decrypt',
//待解密的内容,是base64编码后的一段二进制值
text: '1o0kf2HXwLxHkSh5W5NhzA==',
//base64编码后的密钥
key: 'NDM5Qjk2UjAzMEE0NzVCRjlFMkQwQkVGOFc1NkM1QkQ=',
transformation: 'AES/CBC/PKCS5Padding',
ivOffset: '0',
ivLen: '16',
success: function(data) {
console.log(`handling success:${data.text}`);
},
fail: function(data, code) {
console.log(`### cipher.aes encrypt fail ### ${code}:${data}`);
});
cipher.aes({
//解密:
action: 'decrypt',
//待解密的内容,是base64编码后的一段二进制值
text: '1o0kf2HXwLxHkSh5W5NhzA==',
//base64编码后的密钥
key: 'NDM5Qjk2UjAzMEE0NzVCRjlFMkQwQkVGOFc1NkM1QkQ=',
transformation: 'AES/CBC/PKCS5Padding',
ivOffset: '0',
ivLen: '16',
success: function(data) {
console.log(`handling success:${data.text}`);
},
fail: function(data, code) {
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.
先完成此消息的编辑!
想要评论请 注册