Difference between revisions of "Hashing Module"
Jump to navigation
Jump to search
m (Text replace - "| width='90' | '''Signatures'''" to "| width='120' | '''Signatures'''") |
|||
Line 15: | Line 15: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Computes the MD5 hash of the given {{Code|$value}}, which may be of type xs:string or xs: | + | |Computes the MD5 hash of the given {{Code|$value}}, which may be of type xs:string, xs:base64Binary, or xs:hexBinary. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 33: | Line 33: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Computes the SHA-1 hash of the given {{Code|$value}}, which may be of type xs:string or xs: | + | |Computes the SHA-1 hash of the given {{Code|$value}}, which may be of type xs:string, xs:base64Binary, or xs:hexBinary. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 51: | Line 51: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Computes the SHA-256 hash of the given {{Code|$value}}, which may be of type xs:string or xs: | + | |Computes the SHA-256 hash of the given {{Code|$value}}, which may be of type xs:string, xs:base64Binary, or xs:hexBinary. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 69: | Line 69: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Computes the hash of the given {{Code|$value}}, using the specified {{Code|$algorithm}}. The specified values may be of type xs:string or xs: | + | |Computes the hash of the given {{Code|$value}}, using the specified {{Code|$algorithm}}. The specified values may be of type xs:string, xs:base64Binary, or xs:hexBinary.<br />The following three algorihms are supported: {{Code|MD5}}, {{Code|SHA-1}}, and {{Code|SHA-256}}. |
|- | |- | ||
| '''Errors''' | | '''Errors''' |
Revision as of 11:50, 25 January 2015
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.
|
Errors | FORG0006 : the specified value is neither a string nor a binary item.
|
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.
|
Errors | FORG0006 : the specified value is neither a string nor a binary item.
|
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.
|
Errors | FORG0006 : the specified value is neither a string nor a binary item.
|
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.FORG0006 : the specified value is neither a string nor a binary item.
|
Examples |
|
Errors
Code | Description |
---|---|
HASH0001
|
The specified hash algorithm is unknown. |
Changelog
The module was introduced with Version 7.3.