RC4decrypt and RC4encrypt (String functions): Difference between revisions
m (1 revision) |
m (match syntax diagram to template and fix tags; still some incomplete / unfound links) |
||
Line 1: | Line 1: | ||
{{Template:String:RC4encrypt subtitle}} | {{Template:String:RC4encrypt subtitle}} | ||
This [[Intrinsic classes|intrinsic]] function returns a binary string that is the method object string | This [[Intrinsic classes|intrinsic]] function returns a binary string that is the method object string encrypted or decrypted with the specified RC4 encryption key. The length of the returned string is the same as that of the object string. | ||
encrypted or decrypted with the specified RC4 encryption key. | |||
The length of the returned string is the same as that of the object string. | |||
RC4 is a two-way, or symmetric, cipher (algorithm), so encrypting a string with a key and then | RC4 is a two-way, or symmetric, cipher (algorithm), so encrypting a string with a key and then encrypting 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: | ||
encrypting the result of that encryption with the same key produces the original string. | |||
That is, the following assertion should | |||
<p class="code">assert %string:rc4encrypt(%key):rc4decrypt(%key) eq %string | <p class="code">assert %string:rc4encrypt(%key):rc4decrypt(%key) eq %string | ||
</p> | </p> | ||
<var>[[RC4decrypt_(String_function)|RC4decrypt]]</var> is a synonym for <var>RC4encrypt</var>. You can use the RC4decrypt synonym to "document" that you are decrypting rather than encrypting in a call. | |||
to "document" that you are decrypting rather than encrypting in a call. | |||
==Syntax== | ==Syntax== | ||
{{Template:String:RC4encrypt syntax}} | {{Template:String:RC4encrypt syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%outString</th> | ||
<td>A string variable to receive the encrypted or decrypted | <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">key</var>.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>The string to which the method is applied. | <td>The string to which the method is applied.</td></tr> | ||
<tr><th> | <tr><th>key</th> | ||
<td> A string variable whose value is used to encrypt or decrypt the method object string. | <td> A string variable whose value is used to encrypt or decrypt the method object <var class="term">string</var>. The key is transformed and then combined with the object string. This key value must not be null nor longer than 255 bytes. (RC4 keys are rarely longer than 64 bytes.)</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>A complete explanation of RC4 encryption can easily be found on the Internet. | |||
<li>You are <b><i>not</i></b> prevented from creating confusion by encrypting with <var>[[RC4decrypt_(String_function)|RC4decrypt]]</var> and decrypting with <var>RC4encrypt</var>. | |||
<li>The <var class="term">key</var> value you provide is (internally) concatenated with itself until it reaches 256 bytes and becomes the "true" key that participates in the encryption algorithm. A consequence of this is that a key that consists of text that repeats will produce the same encryption result as the text alone (without its repetitions). For example, the eight-byte key <code>'AAAAAAAA'</code> is no stronger than the one-byte key <code>'A'</code>, so it is not very secure. Similarly, the ten-byte key <code>'ababababab'</code> is no stronger than the two-byte key <code>'ab'</code>. | |||
<li>RC4 is the default stream cipher used in <var class="product">[[Janus Network Security]]</var>, and it may be used by customers who license <var class="product">[[Janus Network Security]]</var> or <var class="product">[[Janus_SOAP|Janus SOAP]]</var>. | |||
<li>The <var>RC4encrypt</var> function is available as of <var class="product">Sirius Mods</var> version 7.3.</ul> | |||
==Examples== | ==Examples== | ||
<ol> | |||
In the following example, the output string from the <var>RC4encrypt</var> method is assigned to a variable, converted to hex using the [[StringToHex (String function)|StringToHex]] intrinsic method to reveal its non-displayable characters, then decrypted to return the original input string: | <li>In the following example, the output string from the <var>RC4encrypt</var> method is assigned to a variable, converted to hex using the [[StringToHex (String function)|StringToHex]] intrinsic method to reveal its non-displayable characters, then decrypted to return the original input string: | ||
<p class="output">%string = 'this is a test':rc4encrypt('key') | <p class="output">%string = 'this is a test':rc4encrypt('key') | ||
printText {~} is {%string:stringTohex} | |||
printText {~} is: {%string:rc4decrypt('key')} | printText {~} is: {%string:rc4decrypt('key')} | ||
</p> | </p> | ||
The result is: | The result is: | ||
<p class="output">%string:stringTohex is E15655DAC416D10ACB3730FA22D2 | <p class="output">%string:stringTohex is E15655DAC416D10ACB3730FA22D2 | ||
%string:rc4decrypt('key') is: this is a test | %string:rc4decrypt('key') is: this is a test | ||
</p> | |||
</ol> | |||
==See also== | ==See also== | ||
<ul> | |||
<li>[[MD5digest (String function)|MD5digest]] and [[SHAdigest (String function)|SHAdigest]] are cryptographic hash functions that also operate on the method object <var class="term">string</var>. | |||
<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext|printText]]</var> | |||
</ul> | |||
{{Template:String:RC4encrypt footer}} | {{Template:String:RC4encrypt footer}} |
Revision as of 04:06, 2 February 2011
Template:String:RC4encrypt subtitle
This intrinsic function returns a binary string that is the method object string encrypted or decrypted with the specified RC4 encryption key. The length of the returned string is the same as that of the object string.
RC4 is a two-way, or symmetric, cipher (algorithm), so encrypting a string with a key and then encrypting the result of that encryption with the same key produces the original string. That is, the following assertion should always hold:
assert %string:rc4encrypt(%key):rc4decrypt(%key) eq %string
RC4decrypt is a synonym for RC4encrypt. You can use the RC4decrypt synonym to "document" that you are decrypting rather than encrypting in a call.
Syntax
%outString = string:RC4encrypt( key)
Syntax terms
%outString | A string variable to receive the encrypted or decrypted method object string. Its length is the same as key. |
---|---|
string | The string to which the method is applied. |
key | A string variable whose value is used to encrypt or decrypt the method object string. The key is transformed and then combined with the object string. This key value must not be null nor longer than 255 bytes. (RC4 keys are rarely longer than 64 bytes.) |
Usage notes
- A complete explanation of RC4 encryption can easily be found on the Internet.
- You are not prevented from creating confusion by encrypting with RC4decrypt and decrypting with RC4encrypt.
- The key value you provide is (internally) concatenated with itself until it reaches 256 bytes and becomes the "true" key that participates in the encryption algorithm. A consequence of this is that a key that consists of text that repeats will produce the same encryption result as the text alone (without its repetitions). For example, the eight-byte key
'AAAAAAAA'
is no stronger than the one-byte key'A'
, so it is not very secure. Similarly, the ten-byte key'ababababab'
is no stronger than the two-byte key'ab'
. - RC4 is the default stream cipher used in Janus Network Security, and it may be used by customers who license Janus Network Security or Janus SOAP.
- The RC4encrypt function is available as of Sirius Mods version 7.3.
Examples
- In the following example, the output string from the RC4encrypt method is assigned to a variable, converted to hex using the StringToHex intrinsic method to reveal its non-displayable characters, then decrypted to return the original input string:
%string = 'this is a test':rc4encrypt('key') printText {~} is {%string:stringTohex} printText {~} is: {%string:rc4decrypt('key')}
The result is:
%string:stringTohex is E15655DAC416D10ACB3730FA22D2 %string:rc4decrypt('key') is: this is a test
See also
- MD5digest and SHAdigest are cryptographic hash functions that also operate on the method object string.
- For details of the printtext statement, please see printText