SHAdigest (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(27 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:String:SHAdigest subtitle}}
{{Template:String:SHAdigest subtitle}}


This [[Intrinsic classes|intrinsic]] function returns the 20-byte (always) binary string that is the
The <var>SHAdigest</var> [[Intrinsic classes|intrinsic]] function returns the 20-byte (always) binary string that is the SHA-1 digest of the method object string.
SHA digest of the method object string.


The SHAdigest function is available as of version 7.3 of the [[Sirius Mods]].
==Syntax==
==Syntax==
{{Template:String:SHAdigest syntax}}
{{Template:String:SHAdigest syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table>
<tr><th>%outStr                                                                                                </th>
<tr><th>%outString</th>
<td>A string variable to receive the SHA digest of the method object string.                               </td></tr>
<td>A string variable to receive the SHA-1 digest of the method object <var class="term">string</var>.</td></tr>
<tr><th>string                                                                                                 </th>
 
<tr><th>string</th>
<td>The string to which the method is applied.</td></tr>
<td>The string to which the method is applied.</td></tr>
</table>
</table>


==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.
<ul>
*SHAdigest is available for use by '''''Janus SOAP''''' or '''''Janus Network Security''''' customers.
<li>SHA (Secure Hash Algorithm) is a set of cryptographic hashing functions;  <var>SHAdigest</var> provides SHA-1, which was the most commonly used. SHA-1 is no longer recommended for the signing of Internet security certificates. A complete explanation of SHA hashing can easily be found on the internet. </li>
*[[MD5digest (String function)|MD5digest]] returns the MD5 digest of the method object string, and [[RC4encrypt (String function)|RC4encrypt]] returns the RC4 encryption of the method object string.


==Examples==
<li>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. </li>
 
<li><var>SHAdigest</var> is available for use by <var class="product">Model&nbsp;204</var> V7.5 or <var class="product">[[Media:jansslr.pdf|Janus Network Security]]</var> customers. </li>


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 (String function)|StringToHex]] intrinsic method:
<li><var>SHAdigest</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3. </li>
    [[Intrinsic classes#printtext|printText]] {'this is a simple test':shadigest:stringtohex}
</ul>


The result (displayed on two lines) is:
==Examples==
    'this is a simple test':shadigest:stringtohex is BC38AA2D6769639946806616C14AF0C69477AABE
The 20-byte SHA-1 hash of a string is typically expressed as a 40-digit hex value. In the following example, the output string from the <var>SHAdigest</var> method is converted to hex using the <var>[[StringToHex (String function)|StringToHex]]</var> intrinsic method:
<p class="code">[[PrintText statement|printText]] {~} is {'this is a simple test':shadigest:stringtohex}
</p>
The result is:
<p class="output">'this is a simple test':shadigest:stringtohex is BC38AA2D6769639946806616C14AF0C69477AABE
</p>


==See also==
==See also==
[[List of intrinsic String methods]]
<ul>
<li>Additional hashes:
<ul>
{{Template:Digest methods}}
</ul></li>
<li>Two-way ciphers:
<ul>
{{Template:AES crypto methods}}
{{Template:DEA crypto methods}}
<li>[[RC4decrypt and RC4encrypt (String functions)]] </li>
</ul></li>
</ul>


[[Category:String methods|SHAdigest function]]
{{Template:String:SHAdigest footer}}
[[Category:Intrinsic methods]]

Latest revision as of 04:19, 11 April 2016

20-byte SHA digest (String class)


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

Syntax

%outString = string:SHAdigest

Syntax terms

%outString A string variable to receive the SHA-1 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, which was the most commonly used. SHA-1 is no longer recommended for the signing of Internet security certificates. 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 Model 204 V7.5 or Janus Network Security customers.
  • SHAdigest is available as of Sirius Mods Version 7.3.

Examples

The 20-byte SHA-1 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 {~} is {'this is a simple test':shadigest:stringtohex}

The result is:

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

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=SHAdigest_(String_function)&oldid=83711"