Encrypt()
Encrypts a string. Uses a symmetric key-based algorithm, in which the same key is used to encrypt and decrypt a string.
The security of the encrypted string depends on maintaining the secrecy of the key. Uses an XOR-based algorithm that uses a pseudo-random 32-bit key, based on a seed passed by the user as a function parameter.
Encrypt( string=string, key=string, algorithm=string, encoding=string, IVorSalt=any, iterations=number, precise=boolean );
Returns: String
Argument | Description | Default |
---|---|---|
string
string,
required
|
String to encrypt. |
|
key
string,
required
|
Key or seed used to encrypt the string.
|
|
algorithm
string,
optional
|
The algorithm to use to decrypt the string. Must be the same as the algorithm used to encrypt the string.
You may also specify other algorithm names as well as the feedback mode and padding scheme where applicable (in the format algorithm/mode/padding) as documented in the Java Cryptography Architecture (JCA) Reference Guide. |
cfmx_compat |
encoding
string,
optional
|
The binary encoding used to represent the data as a string. Must be the same as the algorithm used to encrypt the string.
|
uu |
IVorSalt
any,
optional
|
Initialization Vector for algorithms with Feedback Mode that is not ECB, or Salt for Password Based Encryption algorithms |
|
iterations
number,
optional
|
number of Iterations for Password Based Encryption algorithms (ignored for all other algorithms). NIST recommends a minimum value of 1000. |
|
precise
boolean,
optional
|
if set to true the input must follow the rule for that encoding a 100%, the decryptor will not try to interpret inputs that are not a 100% correct. This should be used to avoid false positives. Introduced: 6.0.0.227 |
true |
Examples
key=generateSecretKey("AES");
testEncrypt = encrypt("safeourtree",key,"AES","base64");
writeDump(testEncrypt);
Simple Example(6.2.2.58-SNAPSHOT)
// Supported from Lucee 6.2.2.58-SNAPSHOT
encryptData = encrypt("lucee","abc","AES","Hex",3);
writeDump(encryptData);
See also
- Cryptography
- Encryption/Decryption with RSA public and private keys
- Decrypt()
- GenerateRSAkeys()
- GenerateSecretKey()
- string.encrypt()
- Search Issue Tracker
- Search Lucee Test Cases (good for further, detailed examples)