SHAdigest (String function)

From m204wiki
Revision as of 16:18, 28 August 2015 by JAL (talk | contribs) (misc cleanup)
Jump to navigation Jump to search

20-byte SHA digest (String class)


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

Syntax

%outString = string:SHAdigest

Syntax terms

%outString 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.
  • This method is useful for storing one-way encrypted passwords in a file. SHA is considered unreversible. That is, the only way to get a password given a digest is brute force: trying passwords until one produces the digest (more or less a hash) value.
  • SHAdigest is available for use by Janus SOAP or Janus Network Security customers.
  • SHAdigest is available as of Sirius Mods Version 7.3.

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

  • MD5digest returns the MD5 digest of the method object string, and RC4encrypt returns the RC4 encryption of the method object string.