Difference between revisions of "Hashing Module"
Jump to navigation
Jump to search
| Line 9: | Line 9: | ||
==hash:md5== | ==hash:md5== | ||
{| width='100%' | {| width='100%' | ||
| − | |- | + | |- 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" |
| '''Summary''' | | '''Summary''' | ||
|Computes the MD5 hash of the given {{Code|$value}}, which may be of type {{Code|xs:string}}, {{Code|xs:base64Binary}}, or {{Code|xs:hexBinary}}. | |Computes the MD5 hash of the given {{Code|$value}}, which may be of type {{Code|xs:string}}, {{Code|xs:base64Binary}}, or {{Code|xs:hexBinary}}. | ||
| − | |- | + | |- valign="top" |
| '''Examples''' | | '''Examples''' | ||
| | | | ||
| Line 24: | Line 24: | ||
==hash:sha1== | ==hash:sha1== | ||
{| width='100%' | {| width='100%' | ||
| − | |- | + | |- 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" |
| '''Summary''' | | '''Summary''' | ||
|Computes the SHA-1 hash of the given {{Code|$value}}, which may be of type {{Code|xs:string}}, {{Code|xs:base64Binary}}, or {{Code|xs:hexBinary}}. | |Computes the SHA-1 hash of the given {{Code|$value}}, which may be of type {{Code|xs:string}}, {{Code|xs:base64Binary}}, or {{Code|xs:hexBinary}}. | ||
| − | |- | + | |- valign="top" |
| '''Examples''' | | '''Examples''' | ||
| | | | ||
| Line 39: | Line 39: | ||
==hash:sha256== | ==hash:sha256== | ||
{| width='100%' | {| width='100%' | ||
| − | |- | + | |- 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" |
| '''Summary''' | | '''Summary''' | ||
|Computes the SHA-256 hash of the given {{Code|$value}}, which may be of type {{Code|xs:string}}, {{Code|xs:base64Binary}}, or {{Code|xs:hexBinary}}. | |Computes the SHA-256 hash of the given {{Code|$value}}, which may be of type {{Code|xs:string}}, {{Code|xs:base64Binary}}, or {{Code|xs:hexBinary}}. | ||
| − | |- | + | |- valign="top" |
| '''Examples''' | | '''Examples''' | ||
| | | | ||
| Line 54: | Line 54: | ||
==hash:hash== | ==hash:hash== | ||
{| width='100%' | {| width='100%' | ||
| − | |- | + | |- 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" |
| '''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" |
| '''Errors''' | | '''Errors''' | ||
|{{Error|algorithm|#Errors}} the specified hashing algorithm is unknown. | |{{Error|algorithm|#Errors}} the specified hashing algorithm is unknown. | ||
| − | |- | + | |- valign="top" |
| '''Examples''' | | '''Examples''' | ||
| | | | ||
| Line 75: | Line 75: | ||
! width="110"|Code | ! width="110"|Code | ||
|Description | |Description | ||
| − | |- | + | |- valign="top" |
|{{Code|algorithm}} | |{{Code|algorithm}} | ||
|The specified hash algorithm is unknown. | |The specified hash algorithm is unknown. | ||
Revision as of 14:18, 20 July 2022
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.
