SHAdigest (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 8: Line 8:
{{Template:String:SHAdigest syntax}}
{{Template:String:SHAdigest syntax}}
===Syntax terms===
===Syntax terms===
<dl>                                                                                                      
<table class="syntaxTable">
<dt>%outStr                                                                                                 
<tr><th>%outStr                                                                                                </th>
<dd>A string variable to receive the SHA digest of the method object string.                                 
<td>A string variable to receive the SHA digest of the method object string.                                </td></tr>
<dt>string                                                                                                   
<tr><th>string                                                                                                  </th>
<dd>The string to which the method is applied.                                                            
<td>The string to which the method is applied.</td></tr>
                                                                                                           
</table>
</dl>                                                                                                      
                                                                                                     
==Usage notes==
==Usage notes==
*SHA (Secure Hash Algorithm) is a set of cryptographic hashing functions;  SHAdigest provides SHA-1, the most commonly used. A complete explanation of SHA hashing can easily be found on the internet.                                   
*SHA (Secure Hash Algorithm) is a set of cryptographic hashing functions;  SHAdigest provides SHA-1, the most commonly used. A complete explanation of SHA hashing can easily be found on the internet.                                   

Revision as of 05:39, 19 January 2011

20-byte SHA digest (String class)


This intrinsic function returns the 20-byte (always) binary string that is the SHA digest of the method object string.

The SHAdigest function is available as of version 7.3 of the Sirius Mods.

Syntax

%outString = string:SHAdigest

Syntax terms

%outStr A string variable to receive the SHA digest of the method object string.
string The string to which the method is applied.

Usage notes

  • SHA (Secure Hash Algorithm) is a set of cryptographic hashing functions; SHAdigest provides SHA-1, the most commonly used. A complete explanation of SHA hashing can easily be found on the internet.
  • SHAdigest is available for use by Janus SOAP or Janus Network Security customers.
  • MD5digest returns the MD5 digest of the method object string, and RC4encrypt returns the RC4 encryption of the method object string.

Examples

The 20-byte SHA hash of a string is typically expressed as a 40-digit hex value. In the following example, the output string from the SHAdigest method is converted to hex using the StringToHex intrinsic method:

   printText {'this is a simple test':shadigest:stringtohex}                       
                                                                                                           

The result (displayed on two lines) is:

   'this is a simple test':shadigest:stringtohex is BC38AA2D6769639946806616C14AF0C69477AABE

See also

List of intrinsic String methods