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