Difference between revisions of "Hashing Module"
Jump to navigation
Jump to search
Line 16: | Line 16: | ||
| '''Summary''' | | '''Summary''' | ||
|Computes the MD5 hash of the given {{Code|$value}}, which may be a string or a binary item (xs:base64Binary, xs:hexBinary). | |Computes the MD5 hash of the given {{Code|$value}}, which may be a string or a binary item (xs:base64Binary, xs:hexBinary). | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|FORG0006|XQuery Errors#Function Errors}} the specified value is neither a string nor a binary item. | ||
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 31: | Line 34: | ||
| '''Summary''' | | '''Summary''' | ||
|Computes the SHA-1 hash of the given {{Code|$value}}, which may be a string or a binary item (xs:base64Binary, xs:hexBinary). | |Computes the SHA-1 hash of the given {{Code|$value}}, which may be a string or a binary item (xs:base64Binary, xs:hexBinary). | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|FORG0006|XQuery Errors#Function Errors}} the specified value is neither a string nor a binary item. | ||
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 46: | Line 52: | ||
| '''Summary''' | | '''Summary''' | ||
|Computes the SHA-256 hash of the given {{Code|$value}}, which may be a string or a binary item (xs:base64Binary, xs:hexBinary). | |Computes the SHA-256 hash of the given {{Code|$value}}, which may be a string or a binary item (xs:base64Binary, xs:hexBinary). | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|FORG0006|XQuery Errors#Function Errors}} the specified value is neither a string nor a binary item. | ||
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 63: | Line 72: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error|HASH0001|#Errors}} the specified hashing algorithm is unknown. | + | |{{Error|HASH0001|#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''' | | '''Examples''' |
Revision as of 03:23, 17 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 xs:anyAtomicType) as xs:base64Binary |
Summary | Computes the MD5 hash of the given $value , which may be a string or a binary item (xs:base64Binary, xs:hexBinary).
|
Errors | FORG0006 : the specified value is neither a string nor a binary item.
|
Examples |
|
util:sha1
Signatures | util:sha1($value as xs:anyAtomicType) as xs:base64Binary |
Summary | Computes the SHA-1 hash of the given $value , which may be a string or a binary item (xs:base64Binary, xs:hexBinary).
|
Errors | FORG0006 : the specified value is neither a string nor a binary item.
|
Examples |
|
util:sha256
Signatures | util:sha256($value as xs:anyAtomicType) as xs:base64Binary |
Summary | Computes the SHA-256 hash of the given $value , which may be a string or a binary item (xs:base64Binary, xs:hexBinary).
|
Errors | FORG0006 : the specified value is neither a string nor a binary item.
|
Examples |
|
util:hash
Signatures | util: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 a string or a binary item (xs:base64Binary, xs:hexBinary)The following three algorihms are supported: MD5 , SHA-1 , and SHA-256 .
|
Errors | HASH0001 : the specified hashing algorithm is unknown.FORG0006 : the specified value is neither a string nor a binary item.
|
Examples |
|
Errors
Code | Description |
---|---|
HASH0001
|
The specified hashing algorithm is unknown. |
Changelog
This module was introduced with Version 7.3.