Difference between revisions of "Cryptography.aesEncrypt"

From GiderosMobile
(----)
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
=== Description ===
 
=== Description ===
Encrypt a string with AES cipher, either in ECB mode or CBC mode.
+
Encrypts a string with AES cipher, either in ECB mode or CBC mode.
 
+
<syntaxhighlight lang="lua">
<source lang="lua">
 
 
(string) = Cryptography.aesEncrypt(plaintext,key,iv,paddingType)
 
(string) = Cryptography.aesEncrypt(plaintext,key,iv,paddingType)
</source>
+
</syntaxhighlight>
  
 
=== Parameters ===
 
=== Parameters ===
'''plaintext''': (string) The message to be encrypted <br/>
+
'''plaintext''': (string) the message to be encrypted<br/>
'''key''': (string) encryption key as a 16,24 or 32 byte string <br/>
+
'''key''': (string) encryption key as a 16,24 or 32 byte string<br/>
'''iv''': (string) a 16 byte IV to be used for CBC mode. If not provided ECB mode is used. '''optional'''<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>
+
'''paddingType''': (number) type of padding to be used. Currently defined values are:</br>
 
<ul>
 
<ul>
 
<li>0: 0 padding  '''optional'''</li>
 
<li>0: 0 padding  '''optional'''</li>
Line 22: Line 21:
 
'''Returns''' (string) ciphered message<br/>
 
'''Returns''' (string) ciphered message<br/>
  
----
+
{{Cryptography}}
{{Special:PrefixIndex/Cryptography}}
 
<br/>
 

Latest revision as of 15:26, 13 July 2023

Available since: Gideros 2016.04
Class: Cryptography

Description

Encrypts 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