1# @system.cipher (Cipher Algorithm) 2 3> **NOTE** 4> 5> - The initial APIs of this module are supported since API version 3. Newly added APIs will be marked with a superscript to indicate their earliest API version. 6>- The APIs provided by this module are deprecated since API version 9. You are advised to use [@ohos.security.cryptoFramework Cipher](js-apis-cryptoFramework.md#cipher). 7 8## Modules to Import 9 10 11```js 12import cipher from '@system.cipher'; 13``` 14 15## CipherResponse 16 17Defines the response to the cipher interface called. 18 19**System capability**: SystemCapability.Security.Cipher 20 21| Name| Type | Readable| Writable|Description | 22| ------ | ------ | ---- | ---- | ------------ | 23| text | string | Yes | No | Response content.| 24 25 26## CipherRsaOptions 27 28Defines the input parameters of **cipher.rsa()**. 29 30**System capability**: SystemCapability.Security.Cipher 31 32| Name | Type | Mandatory| Description | 33| -------------- | ------------------------------------ | ---- | ------------------------------------------------------------ | 34| action | string | Yes | Action to perform. The options are as follows:<br>1. **encrypt**: Encrypts data.<br>2. **decrypt**: Decrypts data.| 35| text | string | Yes | Text to be encrypted or decrypted.<br> The text to be encrypted must be a common text and cannot exceed the length calculated based on the formula (keySize/8 - 66). **keySize** indicates the key length. <br>For example, if the key length is 1024 bytes, the text cannot exceed 62 bytes (1024/8 - 66 = 62). The text to be decrypted must be a binary value encoded in Base64. The default format is used for Base64 encoding. | 36| key | string | Yes | RSA key. It is a public key in encryption and a private key in decryption. | 37| transformation | string | No | RSA padding. The default value is **RSA/None/OAEPWithSHA256AndMGF1Padding**.| 38| success | (data: [CipherResponse](#cipherresponse)) => void | No | Called when data is encrypted or decrypted successfully. | 39| fail | (data: string, code: number) => void | No | Called when data fails to be encrypted or decrypted. | 40| complete | () => void | No | Called when the execution is complete. | 41 42## CipherAesOptions 43 44Defines the input parameters of **cipher.aes()**. 45 46**System capability**: SystemCapability.Security.Cipher 47 48| Name | Type | Mandatory| Description | 49| -------------- | ------------------------------------ | ---- | ------------------------------------------------------------ | 50| action | string | Yes | Action to perform. The options are as follows:<br>1. **encrypt**: Encrypts data.<br>2. **decrypt**: Decrypts data.| 51| text | string | Yes | Text to be encrypted or decrypted.<br> The text to be encrypted must be common text. The text to be decrypted must be a binary value encoded in Base64. The default format is used for Base64 encoding.| 52| key | string | Yes | Key used for encryption or decryption. It is a Base64 encoded string.| 53| transformation | string | No | Encryption mode and padding of the AES algorithm. The default value is **AES/CBC/PKCS5Padding**. | 54| iv | string | No | Initialization vector (IV) for AES-based encryption and decryption. The value is a string encoded in Base64. The default value is the key value.| 55| ivOffset | string | No | Offset of the IV for AES-based encryption and decryption. The default value is **0**, which is the only value supported. | 56| ivLen | string | No | Length of the IV, in bytes. This field is reserved. The default value is **16**, which is the only value supported.| 57| success | (data: [CipherResponse](#cipherresponse)) => void | No | Called when data is encrypted or decrypted successfully. | 58| fail | (data: string, code: number) => void | No | Called when data fails to be encrypted or decrypted. | 59| complete | () => void | No | Called when the execution is complete. | 60 61## cipher.rsa 62 63rsa(options: CipherRsaOptions): void 64 65Encrypts or decrypts data using RSA. 66 67**System capability**: SystemCapability.Security.Cipher 68 69**Parameters** 70 71| Name| Type| Mandatory| Description| 72| -------- | -------- | -------- | -------- | 73| options | [CipherRsaOptions](#cipherrsaoptions) | Yes| Parameters set for RSA encryption or decryption.| 74 75**Example** 76 77```js 78export default { 79 rsa() { 80 cipher.rsa({ 81 // Encrypt data. 82 action: 'encrypt', 83 // Text to be encrypted. 84 text: 'hello', 85 // Base64-encoded public key used for encryption. 86 key: 87 'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCx414QSP3RsYWYzf9mkBMiBAXo\n' + 88 '6S7Lpva1fKlcuVxjoFC1iMnzD4mC0uiL4k5MNi43J64c7dbqi3qAJjdAtuwQ6NZJ\n' + 89 '+Enz0RzmVFh/4yk6lmqRzuEFQqhQqSZzaLq6sq2N2G0Sv2Xl3sLvqAfe2HNm2oBw\n' + 90 'jBpApTJ3TeneOo6Z5QIDAQAB', 91 success: function(data) { 92 console.log(`handling success:${data.text}`); 93 }, 94 fail: function(data, code) { 95 console.log(`### cipher.rsa encrypt fail ### ${code}:${data}`); 96 }, 97 complete: function() { 98 console.log(`operation complete!`); 99 } 100 }); 101 cipher.rsa({ 102 // Decrypt data. 103 action: 'decrypt', 104 // Text to be decrypted, which is binary text encoded in Base64. The decrypted text is "hello". 105 text: 106 'EPeCFPib6ayKbA0M6oSywARvFZ8dFYfjQv3nY8ikZGtS9UHq2sLPvAfpeIzggSiCxqbWeCftP1XQ\n' + 107 'Sa+jEpzFlT1qoSTunBbrYzugPTajIJDTg6R1IRsF/J+mmakn0POVPvi4jCo9wqavB324Bx0Wipnc\n' + 108 'EU5WO0oBHo5l4x6dTpU=', 109 // Base64-encoded private key used for decryption. 110 key: 111 'MIICXgIBAAKBgQCx414QSP3RsYWYzf9mkBMiBAXo6S7Lpva1fKlcuVxjoFC1iMnz\n' + 112 'D4mC0uiL4k5MNi43J64c7dbqi3qAJjdAtuwQ6NZJ+Enz0RzmVFh/4yk6lmqRzuEF\n' + 113 'QqhQqSZzaLq6sq2N2G0Sv2Xl3sLvqAfe2HNm2oBwjBpApTJ3TeneOo6Z5QIDAQAB\n' + 114 'AoGBAKPNtoRQcklxqo+2wQP0j2m3Qqnib1DggjVEgb/8f/LNYQSI3U2QdROemryU\n' + 115 'u3y6N3xacZ359PktTrRKfH5+8ohmHGhIuPAnefp6bLvAFUcl4t1xm74Cow62Kyw3\n' + 116 'aSbmuTG98dxPA1sXD0jiprdtsq2wQ9CoKNyY7/d/pKoqxNuBAkEA4GytZ60NCTj9\n' + 117 'w24jACFeko5YqCFY/TTLoc4SQvWtFMnimRPclLZhtUIK0P8dib71UFedx+AxklgL\n' + 118 'A5gjcfo+2QJBAMrqiwyCh3OQ5DhyRPDwt87x1/jg5fy4hhete2ufSf2FoQCVqO+w\n' + 119 'PKoljdXmJeS6rGgzGibstuHLrP3tcIho4+0CQD3ZFWzF/xq0jxKlrpWhnJuNCRfE\n' + 120 'oO6e9yNvVA8J/5oEDSOcmqSNIp4+RhbUx8InUxnCG6Ryv5aSFu71pYcKrPkCQQCL\n' + 121 'RUGcm3ZGTnslduB0knNF+V2ndwzDUQ7P74UXT+PjurTPhujFYiuxCEd6ORVnEOzG\n' + 122 'M9TORIgdH8MjIbWsGnndAkEAw9yURDaorE8IYPLF2IEn09g1uzvWPs3phDb6smVx\n' + 123 '8GfqIdUNf+aCG5TZK/kXBF1sqcsi7jXMAf4jBlejVbSVZg==', 124 success: function(data) { 125 console.log(`handling success:${data.text}`); 126 }, 127 fail: function(data, code) { 128 console.log(`### cipher.rsa encrypt fail ### ${code}:${data}`); 129 }, 130 complete: function() { 131 console.log(`operation complete!`); 132 } 133 }); 134 } 135} 136``` 137 138 139## cipher.aes 140 141aes(options: CipherAesOptions): void 142 143Encrypts or decrypts data using AES. 144 145**System capability**: SystemCapability.Security.Cipher 146 147**Parameters** 148 149| Name| Type| Mandatory| Description| 150| -------- | -------- | -------- | -------- | 151| options | [CipherAesOptions](#cipheraesoptions) | Yes| Parameters set for AES encryption or decryption.| 152 153**Example** 154 155```js 156export default { 157 aes() { 158 cipher.aes({ 159 // Encrypt data. 160 action: 'encrypt', 161 // Text to be encrypted. 162 text: 'hello', 163 // Base64-encoded key. 164 key: 'NDM5Qjk2UjAzMEE0NzVCRjlFMkQwQkVGOFc1NkM1QkQ=', 165 transformation: 'AES/CBC/PKCS5Padding', 166 ivOffset: '0', 167 ivLen: '16', 168 success: function(data) { 169 console.log(`handling success:${data.text}`); 170 }, 171 fail: function(data, code) { 172 console.log(`### cipher.rsa encrypt fail ### ${code}:${data}`); 173 }, 174 complete: function() { 175 console.log(`operation complete!`); 176 } 177 }); 178 cipher.aes({ 179 // Decrypt data. 180 action: 'decrypt', 181 // Text to be decrypted, which is binary text encoded in Base64. 182 text: '1o0kf2HXwLxHkSh5W5NhzA==', 183 // Base64-encoded key. 184 key: 'NDM5Qjk2UjAzMEE0NzVCRjlFMkQwQkVGOFc1NkM1QkQ=', 185 transformation: 'AES/CBC/PKCS5Padding', 186 ivOffset: '0', 187 ivLen: '16', 188 success: function(data) { 189 console.log(`handling success:${data.text}`); 190 }, 191 fail: function(data, code) { 192 console.log(`### cipher.aes encrypt fail ### ${code}:${data}`); 193 }, 194 complete: function() { 195 console.log(`operation complete!`); 196 } 197 }); 198 } 199} 200 201``` 202