Difference between revisions of "Cryptography.aesEncrypt"

From GiderosMobile
(----)
Line 1: Line 1:
__NOTOC__
+
'''Available since:''' Gideros 2016.04<br/>
<languages />
+
'''Class:''' [[Cryptography]]<br/>
'''<translate>Available since</translate>:''' Gideros 2016.04<br/>
+
 
'''<translate>Class</translate>:''' [[Special:MyLanguage/Cryptography|Cryptography]]<br/>
+
=== Description ===
=== <translate>Description</translate> ===
+
Encrypt a string with AES cipher, either in ECB mode or CBC mode.
<translate>Encrypt a string with AES cipher, either in ECB mode or CBC mode</translate>
+
 
 
<source lang="lua">
 
<source lang="lua">
 
(string) = Cryptography.aesEncrypt(plaintext,key,iv,paddingType)
 
(string) = Cryptography.aesEncrypt(plaintext,key,iv,paddingType)
 
</source>
 
</source>
=== <translate>Parameters</translate> ===
+
 
'''plaintext''': (string) <translate>The message to be encrypted</translate> <br/>
+
=== Parameters ===
'''key''': (string) <translate>encryption key as a 16,24 or 32 byte string</translate> <br/>
+
'''plaintext''': (string) The message to be encrypted <br/>
'''iv''': (string) <translate>a 16 byte IV to be used for CBC mode. If not provided ECB mode is used.</translate> '''optional'''<br/>
+
'''key''': (string) encryption key as a 16,24 or 32 byte string <br/>
'''paddingType''': (number) <translate>Type of padding to be used. Currently defined values are:</br>
+
'''iv''': (string) a 16 byte IV to be used for CBC mode. If not provided ECB mode is used. '''optional'''<br/>
 +
'''paddingType''': (number) Type of padding to be used. Currently defined values are:</br>
 
<ul>
 
<ul>
<li>0: 0 padding </li>
+
<li>0: 0 padding '''optional'''</li>
<li>1: PKCS7 padding</li>
+
<li>1: PKCS7 padding '''optional'''</li>
</ul></translate> '''optional'''<br/>
+
</ul>
=== <translate>Return values</translate> ===
+
 
'''<translate>Returns</translate>''' (string) <translate>ciphered message</translate><br/>
+
=== Return values ===
 +
'''Returns''' (string) ciphered message<br/>
 +
 
 +
----
 +
{{Special:PrefixIndex/Cryptography}}
 +
<br/>

Revision as of 17:15, 2 December 2019

Available since: Gideros 2016.04
Class: Cryptography

Description

Encrypt a string with AES cipher, either in ECB mode or CBC mode.

(string) = Cryptography.aesEncrypt(plaintext,key,iv,paddingType)

Parameters

plaintext: (string) The message to be encrypted
key: (string) encryption key as a 16,24 or 32 byte string
iv: (string) a 16 byte IV to be used for CBC mode. If not provided ECB mode is used. optional
paddingType: (number) Type of padding to be used. Currently defined values are:

  • 0: 0 padding optional
  • 1: PKCS7 padding optional

Return values

Returns (string) ciphered message