Encrypt

string

String to encrypt.

key

String. Key or seed used to encrypt the string.

• For the CFMX_COMPAT algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.

• For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the GenerateSecretKey function to generate the key.

algorithm

(Optional) The algorithm to use to encrypt the string.

The Enterprise Edition of ColdFusion installs the RSA BSafe Crypto-J library, which provides FIPS-140 Compliant Strong Cryptography. It includes the following algorithms:

• AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-19.
• DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
• DES-EDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
• DESX: The extended Data Encryption Standard symmetric encryption algorithm.
• RC2: The RC2 block symmetric encryption algorithm defined by RFC 2268.
• RC4: The RC4 symmetric encryption algorithm.
• RC5: The RC5 encryption algorithm.
• PBE: Password-based encryption algorithm defined in PKCS #5.
• AES/GCM/NoPadding: Encryption algorithm.
  
• AES/CBC/PKCS5Padding: Encryption algorithm.
  

In addition to these algorithms, you can use the algorithms provided in the Standard Edition of ColdFusion.

The Standard Edition of ColdFusion installs a cryptography library with the following algorithms:

• CFMX_COMPAT: the algorithm used in ColdFusion MX and prior releases. This algorithm is the least secure option (default).
• AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197.
• BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.
• DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
• DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.

If you install a security provider with additional cryptography algorithms, you can also specify any of its string encryption and decryption algorithms.

encoding

(Optional; if you specify this parameter, also specify the algorithm parameter). The binary encoding in which to represent the data as a string.

• Base64: the Base64 algorithm, as specified by IETF RFC 2045.

• Hex: the characters A-F0-9 represent the hexadecimal byte values.

• UU: the UUEncode algorithm (default).

IV_Salt

(Optional) Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software. If you specify this parameter, also specify thealgorithmparameter.

• For Block Encryption algorithms: This is the binary Initialization Vector value to use with the algorithm. The algorithm must contain a Feedback Mode other than ECB. This must be a binary value that is exactly the same size as the algorithm block size. Use the same value in theDecryptfunction to successfully decrypt the data.

• For Password Based Encryption algorithms: This is the binary Salt value to transform the password into a key. The same value must be used to decrypt the data.

iterations

(Optional) The number of iterations to transform the password into a binary key. Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software. If you specify this parameter, also specify the algorithm parameter with a Password Based Encryption (PBE) algorithm. Do not specify this parameter for Block Encryption algorithms. Use the same value to encrypt and decrypt the data.

-Dcoldfusion.enablefipscrypto=true

-Dcoldfusion.disablejsafe=true

<h3>Encrypt Example</h3>
<!--- Do the following if the form has been submitted. --->
<cfif IsDefined("Form.myString")>
<cfscript>
/* GenerateSecretKey does not generate key for the CFMX_COMPAT algorithm,
so use the key from the form.
*/
if (Form.myAlgorithm EQ "CFMX_COMPAT")
theKey=Form.MyKey;
// For all other encryption techniques, generate a secret key.
else
theKey=generateSecretKey(Form.myAlgorithm);
//Encrypt the string
encrypted=encrypt(Form.myString, theKey, Form.myAlgorithm,
Form.myEncoding);
//Decrypt it
decrypted=decrypt(encrypted, theKey, Form.myAlgorithm, Form.myEncoding);
</cfscript>

<!--- Display the values used for encryption and decryption,
and the results. --->
<cfoutput>
<b>The algorithm:</b> #Form.myAlgorithm#<br>
<b>The key:</B> #theKey#<br>
<br>
<b>The string:</b> #Form.myString# <br>
<br>
<b>Encrypted:</b> #encrypted#<br>
<br>
<b>Decrypted:</b> #decrypted#<br>
</cfoutput>
</cfif>

<!--- The input form.--->
<form action="#CGI.SCRIPT_NAME#" method="post">
<b>Select the encoding</b><br>
<select size="1" name="myEncoding">
<option selected>UU</option>
<option>Base64</option>
<option>Hex</option>
</select><br>
<br>
<b>Select the algorithm</b><br>
<select size="1" name="myAlgorithm">
<option selected>CFMX_COMPAT</option>
<option>AES</option>
<option>DES</option>
<option>DESEDE</option>
</select><br>
<br>
<b>Input your key</b> (used for CFMX_COMPAT encryption only)<br>
<input type = "Text" name = "myKey" value = "MyKey"><br>
<br>
<b>Enter string to encrypt</b><br>
<textArea name = "myString" cols = "40" rows = "5" WRAP = "VIRTUAL">This string will be encrypted (you can replace it with more typing).
</textArea><br>
<input type = "Submit" value = "Encrypt my String">
</form>