Difference between revisions of "Hashing Module"
Jump to navigation
Jump to search
m (Text replace - "\[\[Category:XQuery\]\]" to "") |
|||
| Line 19: | Line 19: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
| − | * {{Code|xs:hexBinary(hash:md5("BaseX"))}} returns {{Code|0D65185C9E296311C0A2200179E479A2}}. | + | * {{Code|string(xs:hexBinary(hash:md5("BaseX")))}} returns {{Code|0D65185C9E296311C0A2200179E479A2}}. |
| − | * {{Code|hash:md5(xs:base64Binary(""))}} returns <code>1B2M2Y8AsgTpgAmY7PhCfg==</code>. | + | * {{Code|string(hash:md5(xs:base64Binary("")))}} returns <code>1B2M2Y8AsgTpgAmY7PhCfg==</code>. |
|} | |} | ||
| Line 34: | Line 34: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
| − | * {{Code|xs:hexBinary(hash:sha1("BaseX"))}} returns {{Code|3AD5958F0F27D5AFFDCA2957560F121D0597A4ED}}. | + | * {{Code|string(xs:hexBinary(hash:sha1("BaseX")))}} returns {{Code|3AD5958F0F27D5AFFDCA2957560F121D0597A4ED}}. |
| − | * {{Code|hash:sha1(xs:base64Binary(""))}} returns <code>2jmj7l5rSw0yVb/vlWAYkK/YBwk=</code>. | + | * {{Code|string(hash:sha1(xs:base64Binary("")))}} returns <code>2jmj7l5rSw0yVb/vlWAYkK/YBwk=</code>. |
|} | |} | ||
| Line 49: | Line 49: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
| − | * {{Code|xs:hexBinary(hash:sha256("BaseX"))}} returns {{Code|15D570763DEB75D728BB69643392873B835CCCC94A2F1E881909DA47662821A3}}. | + | * {{Code|string(xs:hexBinary(hash:sha256("BaseX")))}} returns {{Code|15D570763DEB75D728BB69643392873B835CCCC94A2F1E881909DA47662821A3}}. |
| − | * {{Code|hash:sha256(xs:base64Binary(""))}} returns <code>47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=</code>. | + | * {{Code|string(hash:sha256(xs:base64Binary("")))}} returns <code>47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=</code>. |
|} | |} | ||
| Line 67: | Line 67: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
| − | * {{Code|xs:hexBinary(hash:hash("", "MD5"))}} returns {{Code|D41D8CD98F00B204E9800998ECF8427E}}. | + | * {{Code|string(xs:hexBinary(hash:hash("", "MD5")))}} returns {{Code|D41D8CD98F00B204E9800998ECF8427E}}. |
* {{Code|hash:hash("", "")}} raises an error. | * {{Code|hash:hash("", "")}} raises an error. | ||
|} | |} | ||
Revision as of 11:11, 22 May 2016
This XQuery Module provides functions that perform different hash operations.
Contents
Conventions
All functions in this module are assigned to the http://basex.org/modules/hash namespace, which is statically bound to the hash prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.
Functions
hash:md5
| Signatures | hash:md5($value as xs:anyAtomicType) as xs:base64Binary |
| Summary | Computes the MD5 hash of the given $value, which may be of type xs:string, xs:base64Binary, or xs:hexBinary.
|
| Examples |
|
hash:sha1
| Signatures | hash:sha1($value as xs:anyAtomicType) as xs:base64Binary |
| Summary | Computes the SHA-1 hash of the given $value, which may be of type xs:string, xs:base64Binary, or xs:hexBinary.
|
| Examples |
|
hash:sha256
| Signatures | hash:sha256($value as xs:anyAtomicType) as xs:base64Binary |
| Summary | Computes the SHA-256 hash of the given $value, which may be of type xs:string, xs:base64Binary, or xs:hexBinary.
|
| Examples |
|
hash:hash
| Signatures | hash:hash($value as xs:anyAtomicType, $algorithm as xs:string) as xs:base64Binary |
| Summary | Computes the hash of the given $value, using the specified $algorithm. The specified values may be of type xs:string, xs:base64Binary, or xs:hexBinary.The following three algorihms are supported: MD5, SHA-1, and SHA-256.
|
| Errors | HASH0001: the specified hashing algorithm is unknown.
|
| Examples |
|
Errors
| Code | Description |
|---|---|
HASH0001
|
The specified hash algorithm is unknown. |
Changelog
The module was introduced with Version 7.3.