administrator, editor
2
edits
Changes
Jump to navigation
Jump to search
m
Corrected spelling: "algorihms" -> "algorithms"
This [[Module Library|XQuery Module]] provides functions that perform different hash operations.
=Conventions=
All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/hash</nowiki></code> namespace, which is statically bound to the {{Code|hash}} prefix.<br/>
=Functions=
==hash:md5==
{|width='100%'
|-
| width='90120' | '''Signatures'''
|{{Func|hash:md5|$value as xs:anyAtomicType|xs:base64Binary}}<br />
|-
| '''Summary'''
|Computes the MD5 hash of the given {{Code|$value}}, which may be of type xs:string , xs:base64Binary, or xs:base64Binary.|-| '''Errors'''|{{Error|FORG0006|XQuery Errors#Function Errors}} the specified value is neither a string nor a binary itemhexBinary.
|-
| '''Examples'''
|
* {{Code|string(xs:hexBinary(hash:md5("BaseX")))}} returns {{Code|0D65185C9E296311C0A2200179E479A2}}.* {{Code|string(hash:md5(xs:base64Binary("")))}} returns {{Code|<code>1B2M2Y8AsgTpgAmY7PhCfg==}}</code>.
|}
==hash:sha1==
{|width='100%'
|-
| width='90120' | '''Signatures'''
|{{Func|hash:sha1|$value as xs:anyAtomicType|xs:base64Binary}}<br />
|-
| '''Summary'''
|Computes the SHA-1 hash of the given {{Code|$value}}, which may be of type xs:string , xs:base64Binary, or xs:base64Binary.|-| '''Errors'''|{{Error|FORG0006|XQuery Errors#Function Errors}} the specified value is neither a string nor a binary itemhexBinary.
|-
| '''Examples'''
|
* {{Code|string(xs:hexBinary(hash:sha1("BaseX")))}} returns {{Code|3AD5958F0F27D5AFFDCA2957560F121D0597A4ED}}.* {{Code|string(hash:sha1(xs:base64Binary("")))}} returns {{Code|<code>2jmj7l5rSw0yVb/vlWAYkK/YBwk=}}</code>.
|}
==hash:sha256==
{|width='100%'
|-
| width='90120' | '''Signatures'''
|{{Func|hash:sha256|$value as xs:anyAtomicType|xs:base64Binary}}<br />
|-
| '''Summary'''
|Computes the SHA-256 hash of the given {{Code|$value}}, which may be of type xs:string , xs:base64Binary, or xs:base64Binary.|-| '''Errors'''|{{Error|FORG0006|XQuery Errors#Function Errors}} the specified value is neither a string nor a binary itemhexBinary.
|-
| '''Examples'''
|
* {{Code|string(xs:hexBinary(hash:sha256("BaseX")))}} returns {{Code|15D570763DEB75D728BB69643392873B835CCCC94A2F1E881909DA47662821A3}}.* {{Code|string(hash:sha256(xs:base64Binary("")))}} returns {{Code|<code>47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=}}</code>.
|}
==hash:hash==
{|width='100%'
|-
| width='90120' | '''Signatures'''
|{{Func|hash:hash|$value as xs:anyAtomicType, $algorithm as xs:string|xs:base64Binary}}<br />
|-
| '''Summary'''
|Computes the hash of the given {{Code|$value}}, using the specified {{Code|$algorithm}}. The specified values may be of type xs:string , xs:base64Binary, or xs:base64BinaryhexBinary.<br />The following three algorihms algorithms are supported: {{Code|MD5}}, {{Code|SHA-1}}, and {{Code|SHA-256}}.
|-
| '''Errors'''
|{{Error|HASH0001algorithm|#Errors}} the specified hashing algorithm is unknown.<br/>{{Error|FORG0006|XQuery Errors#Function Errors}} the specified value is neither a string nor a binary item.
|-
| '''Examples'''
|
* {{Code|string(xs:hexBinary(hash:md5hash("", "MD5")))}} returns {{Code|D41D8CD98F00B204E9800998ECF8427E}}.* {{Code|string(hash:md5hash("", ""))}} raises an error, because no algorithm was specified.
|}
=Errors=
{| class="wikitable" width="100%"
! width="110"|Code
|Description
|-
|{{Code|algorithm}}
|The specified hash algorithm is unknown.
|}
=Changelog=
;Version 9.0
* Updated: error codes updated; errors now use the module namespace
The module was introduced with Version 7.3.
