Difference between revisions of "Hashing Module"
Jump to navigation
Jump to search
Line 60: | Line 60: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Computes the hash of the given {{Code|$ | + | |Computes the hash of the given string, using the specified {{Code|$algorithm}}.<br />The following algorithms are supported: {{Code|MD2}}, {{Code|MD5}}, {{Code|SHA-1}},{{Code|SHA-256}},{{Code|SHA-384}}, and {{Code|SHA-512}}. |
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|HASH0001|#Errors}} the specified hashing algorithm is unknown. | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * {{Code|util:md5("", "MD5")}} returns {{Code|D41D8CD98F00B204E9800998ECF8427E}}. | ||
+ | * {{Code|util:md5("", "")}} raises an error. | ||
+ | |} | ||
+ | |||
+ | ==util:hash-binary== | ||
+ | {| | ||
+ | |- | ||
+ | | width='90' | '''Signatures''' | ||
+ | |{{Func|util:hash-binary|$value as basex:binary, $algorithm as xs:string|xs:hexBinary}}<br /> | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Computes the hash of the given binary item (xs:base64Binary, xs:hexBinary), using the specified {{Code|$algorithm}}.<br />The following algorithms are supported: {{Code|MD2}}, {{Code|MD5}}, {{Code|SHA-1}},{{Code|SHA-256}},{{Code|SHA-384}}, and {{Code|SHA-512}}. | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' |
Revision as of 02:29, 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 item(), $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.