Difference between revisions of "Cryptographic Module"

From BaseX Documentation
Jump to navigation Jump to search
m
m
Line 12: Line 12:
 
| valign='top' | '''Summary'''
 
| valign='top' | '''Summary'''
 
|Creates a message authentication code via a cryptographic hash function and a secret key. <br/>$encoding must either be <code>hex</code>, <code>base64</code> or the empty string (default is <code>base64</code>) and specifies the encoding of the returned authentication code.<br/>$algorithm describes the hash algorithm which is used for encryption. Currently supported are <code>md5</code>, <code>sha1</code>, <code>sha256</code>, <code>sha384</code>, <code>sha512</code>.
 
|Creates a message authentication code via a cryptographic hash function and a secret key. <br/>$encoding must either be <code>hex</code>, <code>base64</code> or the empty string (default is <code>base64</code>) and specifies the encoding of the returned authentication code.<br/>$algorithm describes the hash algorithm which is used for encryption. Currently supported are <code>md5</code>, <code>sha1</code>, <code>sha256</code>, <code>sha384</code>, <code>sha512</code>.
 +
|-
 +
| valign='top' | '''Errors'''
 +
|<b>?</b>
 +
|}
 +
 +
==crypto:encrypt==
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signatures'''
 +
|<code><b>crypto:encrypt</b>($input as xs:string(), $encryption-type as xs:string(), $secret-key as xs:string(), $cryptographic-algorithm as xs:string()) as xs:string()</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|?
 +
|-
 +
| valign='top' | '''Errors'''
 +
|<b>?</b>
 +
|}
 +
 +
==crypto:decrypt==
 +
{|
 +
|-
 +
| valign='top' width='90' | '''Signatures'''
 +
|<code><b>crypto:decrypt</b>($input as xs:string(), $decryption-type as xs:string(), $secret-key as xs:string(), $cryptographic-algorithm as xs:string()) as xs:string()</code>
 +
|-
 +
| valign='top' | '''Summary'''
 +
|?
 
|-
 
|-
 
| valign='top' | '''Errors'''
 
| valign='top' | '''Errors'''
 
|<b>?</b>
 
|<b>?</b>
 
|}
 
|}

Revision as of 15:37, 6 October 2011

The cryptographic module is based on an early draft of the EXPath Cryptographic Module and provides the following functionality:

  1. Creation of message authentication codes (HMAC)
  2. Creation and validation of an XML Digital Signature
  3. Encryption and decryption

crypto:hmac

Signatures crypto:hmac($message as xs:string(), $secret-key as xs:string(), algorithm as xs:string()) as xs:string()
crypto:hmac($message as xs:string(), $secret-key as xs:string(), algorithm as xs:string(), $encoding as xs:string()) as xs:string()
Summary Creates a message authentication code via a cryptographic hash function and a secret key.
$encoding must either be hex, base64 or the empty string (default is base64) and specifies the encoding of the returned authentication code.
$algorithm describes the hash algorithm which is used for encryption. Currently supported are md5, sha1, sha256, sha384, sha512.
Errors ?

crypto:encrypt

Signatures crypto:encrypt($input as xs:string(), $encryption-type as xs:string(), $secret-key as xs:string(), $cryptographic-algorithm as xs:string()) as xs:string()
Summary ?
Errors ?

crypto:decrypt

Signatures crypto:decrypt($input as xs:string(), $decryption-type as xs:string(), $secret-key as xs:string(), $cryptographic-algorithm as xs:string()) as xs:string()
Summary ?
Errors ?