Difference between revisions of "Cryptography.aesEncrypt"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
+
'''Available since:''' Gideros 2016.04<br/>
'''<translate>Available since</translate>:''' Gideros 2016.04<br/>
+
'''Class:''' [[Cryptography]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Cryptography|Cryptography]]<br/>
+
 
=== <translate>Description</translate> ===
+
=== Description ===
<translate>Encrypt a string with AES 128 cipher, either in ECB mode or CBC mode</translate>
+
Encrypts a string with AES cipher, either in ECB mode or CBC mode.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(string) = Cryptography.aesEncrypt(plaintext,key,iv,paddingType)
 
(string) = Cryptography.aesEncrypt(plaintext,key,iv,paddingType)
</source>
+
</syntaxhighlight>
=== <translate>Parameters</translate> ===
+
 
'''plaintext''': (string) <translate>The message to be encrypted</translate> <br/>
+
=== Parameters ===
'''key''': (string) <translate>encryption key as a 16 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/>
 +
 
 +
{{Cryptography}}

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