Difference between revisions of "Hashing Module"
Jump to navigation
Jump to search
Line 57: | Line 57: | ||
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
− | |{{Func|util:hash|$value as | + | |{{Func|util:hash|$value as xs:string, $algorithm as xs:string|xs:hexBinary}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
Line 67: | Line 67: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * {{Code|util: | + | * {{Code|util:hash("", "MD5")}} returns {{Code|D41D8CD98F00B204E9800998ECF8427E}}. |
− | * {{Code|util: | + | * {{Code|util:hash("", "")}} raises an error. |
|} | |} | ||
Revision as of 02:30, 14 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 $value , which may be a string or a 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 $value , which may be a string or a 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 $value , which may be a string or a binary item (xs:base64Binary, xs:hexBinary).
|
Examples |
|
util:hash
Signatures | util:hash($value as xs:string, $algorithm as xs:string) as xs:hexBinary |
Summary | Computes the hash of the given string, using the specified $algorithm .The following algorithms are supported: MD2 , MD5 , SHA-1 ,SHA-256 ,SHA-384 , and SHA-512 .
|
Errors | HASH0001 : the specified hashing algorithm is unknown.
|
Examples |
|
util:hash-binary
Signatures | util:hash-binary($value as basex:binary, $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 algorithms are supported: MD2 , MD5 , SHA-1 ,SHA-256 ,SHA-384 , and SHA-512 .
|
Errors | HASH0001 : the specified hashing algorithm is unknown.
|
Examples |
|
Errors
Code | Description |
---|---|
HASH0001
|
The specified hashing algorithm is unknown. |
Changelog
This module was introduced with Version 7.3.