AES128decrypt and AES128encrypt (String functions): Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "{{Template:String:AES128decrypt and AES128encrypt subtitle}} This page is under construction. ==Syntax== {{Template:String:AES128decrypt syntax}} {{Template:String:AES12...")
 
m (add detail)
Line 1: Line 1:
{{Template:String:AES128decrypt and AES128encrypt subtitle}}
{{Template:String:AES128decrypt and AES128encrypt subtitle}}


This page is [[under construction]].
<var>AES128decrypt</var> and <var>AES128encrypt</var> are synonyms for the [[String class]] function that applies the AES (Advanced Encryption Standard) using a 128-bit symmetric key to decrypt or encrypt each 128-bit block of input text. For more details about how the algorithm works, see [https://en.wikipedia.org/wiki/Advanced_Encryption_Standard Advanced Encryption Standard].
 
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:aes128encrypt(%key):aes128decrypt(%key) eq %string
</p>
You can use <var>AES128decrypt</var> to "document" that you are decrypting, and
use <var>AES128encrypt</var> to "document" that you are enrypting. You can use <var>AES128decrypt</var> and <var>AES128encrypt</var> interchangeably on the rest of this page.


==Syntax==
==Syntax==
Line 9: Line 17:
===Syntax terms===
===Syntax terms===
<table>
<table>
<tr><th>%outString</th><td>string</td></tr>
<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>
<tr><th>string</th>
<td>string</td></tr>
<td>The string to which the method is applied. <var class="term">string</var> must be a multiple of sixteen bytes in length; its  maximum is 32768 bytes. It may be null.</td></tr>


<tr><th>key</th>
<tr><th>key</th>
<td>string, length 16</td></tr>
<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>
</table>
</table>


==Usage notes==
==Usage notes==
<ul>
<li>You are <b><i>not</i></b> prevented from creating confusion by encrypting with <var>AES128decrypt</var> and decrypting with <var>AES128encrypt</var>. </li>
<li>The <var>AES128decrypt</var> and <var>AES128encrypt</var> functions are available as of <var class="product">Model&nbsp;204</var> 7.6. </li>
</ul>


==Examples==
==Examples==
In the following example, the output string from the <var>AES128encrypt</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
%string = 'onetwothreefour0onetwothreefour0'
%key = '1234567816161616'
%ls = %string:aes128encrypt(%key)
[[PrintText statement|printText]] {~} is {%ls:stringTohex}
printText {~} is: {%ls:aes128decrypt(%key)}
end
</p>
The result is:
<p class="output">%ls:stringTohex is: 5B97010EF3A73C8C286C50B171C9AF455B97010EF3A73C8C286C50B171C9AF45
%ls:aes128decrypt(%key) is: onetwothreefour0onetwothreefour0
</p>


==See also==
==See also==
<ul>
<li><var>[[AES192decrypt and AES192encrypt (String functions)]]</var> </li>
<li><var>[[AES256decrypt and AES256encrypt (String functions)]]</var> </li>
<li><var>[[AES128CBCdecrypt and AES128CBCencrypt (String functions)]]</var> </li>
<li><var>[[AES192CBCdecrypt and AES192CBCencrypt (String functions)]]</var> </li>
<li><var>[[AES256CBCdecrypt and AES256CBCencrypt (String functions)]]</var> </li>
</ul>
{{Template:String:AES128decrypt and AES128encrypt footer}}
{{Template:String:AES128decrypt and AES128encrypt footer}}

Revision as of 22:17, 11 March 2016

AES128 encryption or decryption (String class)

[Introduced in Model 204 7.6]


AES128decrypt and AES128encrypt are synonyms for the String class function that applies the AES (Advanced Encryption Standard) using a 128-bit symmetric key to decrypt or encrypt each 128-bit block of input text. For more details about how the algorithm works, see Advanced Encryption Standard.

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 always hold:

assert %string:aes128encrypt(%key):aes128decrypt(%key) eq %string

You can use AES128decrypt to "document" that you are decrypting, and use AES128encrypt to "document" that you are enrypting. You can use AES128decrypt and AES128encrypt interchangeably on the rest of this page.

Syntax

%outString = string:AES128decrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:AES128encrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

Syntax terms

%outString A string variable to receive the encrypted or decrypted method object string. Its length is the same as string.
string The string to which the method is applied. string must be a multiple of sixteen bytes in length; its maximum is 32768 bytes. It may be null.
key A 16-byte (only) string variable whose value is used to encrypt or decrypt the method object, string.

Usage notes

  • You are not prevented from creating confusion by encrypting with AES128decrypt and decrypting with AES128encrypt.
  • The AES128decrypt and AES128encrypt functions are available as of Model 204 7.6.

Examples

In the following example, the output string from the AES128encrypt method is converted to hex using the StringToHex function to reveal its non-displayable characters, then decrypted to return the original input string:

b %ls is longstring %string is longstring %key is string len 16 %string = 'onetwothreefour0onetwothreefour0' %key = '1234567816161616' %ls = %string:aes128encrypt(%key) printText {~} is {%ls:stringTohex} printText {~} is: {%ls:aes128decrypt(%key)} end

The result is:

%ls:stringTohex is: 5B97010EF3A73C8C286C50B171C9AF455B97010EF3A73C8C286C50B171C9AF45 %ls:aes128decrypt(%key) is: onetwothreefour0onetwothreefour0

See also