Hashing Module

From BaseX Documentation
Revision as of 20:25, 12 June 2012 by CG (talk | contribs) (Created page with "This XQuery Module contains cryptographic hash functions. =Conventions= All functions in this module are assigned to the {{Code|http://basex.org/modules/hash...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This XQuery Module contains cryptographic hash functions.

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:string) as xs:hexBinary
Summary Computes the MD5 hash of the given string $value.
Examples
  • util:md5("") returns 'D41D8CD98F00B204E9800998ECF8427E'.
  • util:md5('BaseX') returns '0D65185C9E296311C0A2200179E479A2'.

util:sha1

Signatures util:sha1($value as xs:string) as xs:hexBinary
Summary Computes the SHA-1 hash of the given string $value.
Examples
  • util:sha1("") returns 'DA39A3EE5E6B4B0D3255BFEF95601890AFD80709'.
  • util:sha1("BaseX") returns '3AD5958F0F27D5AFFDCA2957560F121D0597A4ED'.

util:sha256

Signatures util:sha256($value as xs:string) as xs:hexBinary
Summary Computes the SHA-256 hash of the given string $value.
Examples
  • util:sha256("") returns 'E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855'.
  • util:sha256("BaseX") returns '15D570763DEB75D728BB69643392873B835CCCC94A2F1E881909DA47662821A3'.

util:hash

Signatures util:hash($value as xs:string, $algorithm as xs:string) as xs:hexBinary
Summary Computes the hash of the given string $value, using the specified $algorithm.
The following three algorihms are supported: Template:@Code, Template:@Code, and Template:@Code.
Errors HASH0001: the specified hashing algorithm is unknown.
Examples util:md5("", "MD5") returns 'D41D8CD98F00B204E9800998ECF8427E'.

util:md5("", "") raises an error.

Errors

Code Description
HASH0001 The specified hashing algorithm is unknown.

Changelog

This module was introduced with Version 7.3.