Difference between revisions of "Hashing Module"
Jump to navigation
Jump to search
| Line 12: | Line 12: | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func|util:md5|$value as | + | |{{Func|util:md5|$value as item()|xs:hexBinary}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
| − | |Computes the MD5 hash of the given | + | |Computes the MD5 hash of the given binary item (xs:base64Binary, xs:hexBinary). |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| Line 27: | Line 27: | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func|util:sha1|$value as | + | |{{Func|util:sha1|$value as item()|xs:hexBinary}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
| − | |Computes the SHA-1 hash of the given | + | |Computes the SHA-1 hash of the given binary item (xs:base64Binary, xs:hexBinary). |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| Line 42: | Line 42: | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func|util:sha256|$value as | + | |{{Func|util:sha256|$value as item()|xs:hexBinary}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
| − | |Computes the SHA-256 hash of the given | + | |Computes the SHA-256 hash of the given binary item (xs:base64Binary, xs:hexBinary).<br /> |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| Line 57: | Line 57: | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func|util:hash|$value as | + | |{{Func|util:hash|$value as item(), $algorithm as xs:string|xs:hexBinary}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
| − | |Computes the hash of the given | + | |Computes the hash of the given binary item (xs:base64Binary, xs:hexBinary), using the specified {{Code|$algorithm}}.<br />The following three algorihms are supported: {{Code|MD5}}, {{Code|SHA-1}}, and {{Code|SHA-256}}. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
| Line 75: | Line 75: | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
| − | |{{Func|util:hash-binary|$value as | + | |{{Func|util:hash-binary|$value as item(), $algorithm as basex:binary|xs:hexBinary}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
Revision as of 20:47, 12 June 2012
This XQuery Module contains cryptographic hash functions.
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
util:md5
| Signatures | util:md5($value as item()) as xs:hexBinary |
| Summary | Computes the MD5 hash of the given binary item (xs:base64Binary, xs:hexBinary). |
| Examples |
|
util:sha1
| Signatures | util:sha1($value as item()) as xs:hexBinary |
| Summary | Computes the SHA-1 hash of the given binary item (xs:base64Binary, xs:hexBinary). |
| Examples |
|
util:sha256
| Signatures | util:sha256($value as item()) as xs:hexBinary |
| Summary | Computes the SHA-256 hash of the given binary item (xs:base64Binary, xs:hexBinary). |
| Examples |
|
util:hash
| Signatures | util:hash($value as item(), $algorithm as xs:string) as xs:hexBinary |
| Summary | Computes the hash of the given binary item (xs:base64Binary, xs:hexBinary), using the specified $algorithm.The following three algorihms are supported: MD5, SHA-1, and SHA-256.
|
| Errors | HASH0001: the specified hashing algorithm is unknown.
|
| Examples |
|
util:hash-binary
| Signatures | util:hash-binary($value as item(), $algorithm as basex:binary) as xs:hexBinary |
| Summary | Computes the hash of the given binary item (xs:base64Binary, xs:hexBinary), using the specified $algorithm.The following three algorihms are supported: MD5, SHA-1, and SHA-256.
|
| Errors | HASH0001: the specified hashing algorithm is unknown.
|
| Examples | util:md5(xs:hexBinary(""), "MD5") returns D41D8CD98F00B204E9800998ECF8427E.
|
Errors
| Code | Description |
|---|---|
HASH0001
|
The specified hashing algorithm is unknown. |
Changelog
This module was introduced with Version 7.3.
