View source for AES128CBCdecrypt and AES128CBCencrypt (String functions)

{{Template:String:AES128CBCdecrypt and AES128CBCencrypt subtitle}}

<var>AES128CBCdecrypt</var> and <var>AES128CBCencrypt</var> are synonyms for the [[String class]] function that applies the DEA (Data Encryption Algorithm) using a 128-bit symmetric key to decrypt or encrypt each 128-bit block of input text. CBC (Cipher Block Chaining) refers to a randomizing tactic whereby the result of applying the AES cipher to a 128-bit block is combined with the next block before the next block's encryption; and so on for each subsequent block. An initialization vector is used in the first block to make its encryption unique.

For more details about how the algorithm works, see [https://en.wikipedia.org/wiki/Data_Encryption_Standard Data Encryption Standard] and [https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Cipher Block Chaining (CBC) Cipher Block Chaining (CBC)].

The length of the returned string is the same as that of the object string.

AES is a two-way cipher, so encrypting a string with a key and then decrypting the result of that encryption with the same key produces the original string. That is, the following assertion should <b><i>always</i></b> hold:
<p class="code">[[Assert statement|assert]] %string:aes128cbcencrypt(%key):aes128cbcdecrypt(%key) eq %string
</p>
You can use <var>AES128CBCdecrypt</var> to "document" that you are decrypting, and
use <var>AES128CBCencrypt</var> to "document" that you are encrypting. You can use <var>AES128CBCdecrypt</var> and <var>AES128CBCencrypt</var> interchangeably on the rest of this page.

==Syntax==
{{Template:String:AES128CBCdecrypt syntax}}
{{Template:String:AES128CBCencrypt syntax}}

===Syntax terms===
<table>
<tr><th>%outString</th>
<td>A string variable to receive the encrypted or decrypted method object <var class="term">string</var>. Its length is the same as <var class="term">string</var>.</td></tr>

<tr><th>string</th>
<td>The string to which the method is applied. <var class="term">string</var> must be a multiple of eight bytes in length; its  maximum is 32768 bytes. It may be null.</td></tr>

<tr><th>key</th>
<td>A 16-byte (only) string variable whose value is used to encrypt or decrypt the method object, <var class="term">string</var>.</td></tr>

<tr><th>initVector</th>
<td>A 16-byte string that is used to randomize the encryption.
The initialization vector is used to ensure distinct ciphertexts are produced even when the same plaintext is encrypted multiple times independently with the same key.</td></tr>
</table>

==Usage notes==
<ul>
<li>You are <b><i>not</i></b> prevented from creating confusion by encrypting with <var>AES128CBCdecrypt</var> and decrypting with <var>AES128CBCencrypt</var>. </li>

<li>The <var>AES128CBCdecrypt</var> and <var>AES128CBCencrypt</var> functions are available as of <var class="product">Model&nbsp;204</var> 7.6. </li>
</ul>

==Examples==
In the following example, the output string from the <var>AES128CBCencrypt</var> method is converted to hex using the <var>[[StringToHex (String function)|StringToHex]]</var> function to reveal its non-displayable characters, then decrypted to return the original input string:

<p class="code">b                    
%ls is longstring    
%string is longstring
%key is string len 16
%iv is string len 16
%string = 'onetwothreefour0onetwothreefour0'
%key = '1234567816161616'
%iv = 'abcdefgh16161616'

%ls = %string:aes128cbcencrypt(%key, %iv)
[[PrintText statement|printText]] {~} is {%ls:stringTohex}
printText {~} is: {%ls:aes128cbcdecrypt(%key, %iv)}
end
</p>
The result is:
<p class="output">%ls:stringTohex is: 432A1AA959C6B064E11C1B12738DC6F247098971B4CFEC6720743AD66F5C32BB
%ls:aes128cbcdecrypt(%key, %iv) is: onetwothreefour0onetwothreefour0
</p>

==See also==
<ul>
<li>Additional AES methods:
<ul>
{{Template:AES crypto methods}}
</ul></li>

<li>Additional two-way ciphers: 
<ul>
{{Template:DEA crypto methods}}
<li>[[RC4decrypt and RC4encrypt (String functions)]]</li>
</ul></li>

<li><var>String</var> hashes: 
<ul>
{{Template:Digest methods}} 
</ul></li>
</ul>

{{Template:String:AES128CBCdecrypt and AES128CBCencrypt footer}}