Difference between revisions of "Hashing Module"
Jump to navigation
Jump to search
m (Text replacement - "<br />" to "<br/>") |
|||
| Line 11: | Line 11: | ||
|- valign="top" | |- valign="top" | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
| − | |{{Func|hash:md5|$value as xs:anyAtomicType|xs:base64Binary}}<br /> | + | |{{Func|hash:md5|$value as xs:anyAtomicType|xs:base64Binary}}<br/> |
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
| Line 26: | Line 26: | ||
|- valign="top" | |- valign="top" | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
| − | |{{Func|hash:sha1|$value as xs:anyAtomicType|xs:base64Binary}}<br /> | + | |{{Func|hash:sha1|$value as xs:anyAtomicType|xs:base64Binary}}<br/> |
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
| Line 41: | Line 41: | ||
|- valign="top" | |- valign="top" | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
| − | |{{Func|hash:sha256|$value as xs:anyAtomicType|xs:base64Binary}}<br /> | + | |{{Func|hash:sha256|$value as xs:anyAtomicType|xs:base64Binary}}<br/> |
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
| Line 56: | Line 56: | ||
|- valign="top" | |- valign="top" | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
| − | |{{Func|hash:hash|$value as xs:anyAtomicType, $algorithm as xs:string|xs:base64Binary}}<br /> | + | |{{Func|hash:hash|$value as xs:anyAtomicType, $algorithm as xs:string|xs:base64Binary}}<br/> |
|- valign="top" | |- valign="top" | ||
| '''Summary''' | | '''Summary''' | ||
| − | |Computes the hash of the given {{Code|$value}}, using the specified {{Code|$algorithm}}. The specified values may be of type {{Code|xs:string}}, {{Code|xs:base64Binary}}, or {{Code|xs:hexBinary}}.<br />The following three algorithms are supported: {{Code|MD5}}, {{Code|SHA-1}}, and {{Code|SHA-256}}. | + | |Computes the hash of the given {{Code|$value}}, using the specified {{Code|$algorithm}}. The specified values may be of type {{Code|xs:string}}, {{Code|xs:base64Binary}}, or {{Code|xs:hexBinary}}.<br/>The following three algorithms are supported: {{Code|MD5}}, {{Code|SHA-1}}, and {{Code|SHA-256}}. |
|- valign="top" | |- valign="top" | ||
| '''Errors''' | | '''Errors''' | ||
Revision as of 10:21, 9 March 2023
This XQuery Module provides functions that perform different hash operations.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/hash namespace, which is statically bound to the hash 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.
|
| 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.
|
| 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.
|
| 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 algorithms are supported: MD5, SHA-1, and SHA-256.
|
| Errors | algorithm: the specified hashing algorithm is unknown.
|
| Examples |
|
Errors
| Code | Description |
|---|---|
algorithm
|
The specified hash algorithm is unknown. |
Changelog
- Version 9.0
- Updated: error codes updated; errors now use the module namespace
The module was introduced with Version 7.3.
