Cryptographic Module - Revision history

CG at 10:32, 8 May 2024

2024-05-08T10:32:05Z

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:39:27Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:37:14Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG: Text replacement - "" to "

2023-12-01T16:37:05Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG at 15:00, 9 March 2023

2023-03-09T15:00:45Z

CG at 13:25, 9 March 2023

2023-03-09T13:25:16Z

CG: Text replacement - "'''Signatures'''" to "'''Signature'''"

2023-03-09T13:03:13Z

Text replacement - "'''Signatures'''" to "'''Signature'''"

CG at 11:04, 9 March 2023

2023-03-09T11:04:12Z

CG at 12:17, 20 July 2022

2022-07-20T12:17:42Z

Show changes

CG at 17:57, 18 July 2022

2022-07-18T17:57:37Z

@@ Line 247: / Line 247: @@
 | '''Errors'''
 |{{Error|CX0015|#Errors}} the signature element cannot be found.<br/>{{Error|CX9994|#Errors}} an unspecified problem occurs during validation.<br/>{{Error|CX9996|#Errors}} an IO exception occurs during validation.<br/>
 |}

@@ Line 38: / Line 38: @@
 '''Result:'''
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 D1E3818B347252A75A4F6D747B21C2
 </pre>
@@ Line 112: / Line 112: @@
 '''Result:'''
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 message
 </pre>
@@ Line 122: / Line 122: @@
 '''XML Signature'''
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <Signature>
    <SignedInfo>
@@ Line 156: / Line 156: @@
 The {{Code|generate-signature}} function allows to pass a {{Code|digital certificate}}. This certificate holds parameters that allow to access key information stored in a Java key store which is then used to sign the input document. Passing a {{Code|digital certificate}} simply helps re-using the same key pair to sign and validate data. The {{Code|digital certificate}} is passed as a node and has the following form:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <digital-certificate>
    <keystore-type>JKS</keystore-type>
@@ Line 203: / Line 203: @@
 '''Result:'''
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <a>
    <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
@@ Line 258: / Line 258: @@
 '''Result:'''
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 true
 </pre>

@@ Line 35: / Line 35: @@
 <pre lang='xquery'>
 crypto:hmac('message', 'secretkey', 'md5', 'hex')
-</syntaxhighlight>
+</pre>
 '''Result:'''
 <syntaxhighlight lang="xml">
 D1E3818B347252A75A4F6D747B21C2
-</syntaxhighlight>
+</pre>
 |}
@@ Line 78: / Line 78: @@
 <pre lang='xquery'>
 crypto:encrypt('message', 'symmetric', 'keykeyke', 'DES')
-</syntaxhighlight>
+</pre>
 |}
@@ Line 109: / Line 109: @@
 let $encrypted := crypto:encrypt('message', 'symmetric', 'keykeyke', 'DES')
 return crypto:decrypt($encrypted, 'symmetric', 'keykeyke', 'DES')
-</syntaxhighlight>
+</pre>
 '''Result:'''
 <syntaxhighlight lang="xml">
 message
-</syntaxhighlight>
+</pre>
 |}
@@ Line 138: / Line 138: @@
    <Object/>
 </Signature>
-</syntaxhighlight>
+</pre>
 * '''SignedInfo''' contains or references the signed data and lists algorithm information
@@ Line 164: / Line 164: @@
    <keystore-uri>...</keystore-uri>
 </digital-certificate>
-</syntaxhighlight>
+</pre>
 ==crypto:generate-signature==
@@ Line 200: / Line 200: @@
 <pre lang='xquery'>
 crypto:generate-signature(<a/>, '', '', '', '', '')
-</syntaxhighlight>
+</pre>
 '''Result:'''
@@ Line 230: / Line 230: @@
    </Signature>
 </a>
-</syntaxhighlight>
+</pre>
 |}
@@ Line 255: / Line 255: @@
 let $sig := crypto:generate-signature(<a/>, '', '', '', '', '')
 return crypto:validate-signature($sig)
-</syntaxhighlight>
+</pre>
 '''Result:'''
 <syntaxhighlight lang="xml">
 true
-</syntaxhighlight>
+</pre>
 |}

@@ Line 33: / Line 33: @@
 |Return message authentication code (MAC) for a given string:
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 crypto:hmac('message', 'secretkey', 'md5', 'hex')
 </syntaxhighlight>
@@ Line 76: / Line 76: @@
 | '''Example'''
 |Encrypt input data:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 crypto:encrypt('message', 'symmetric', 'keykeyke', 'DES')
 </syntaxhighlight>
@@ Line 106: / Line 106: @@
 |Decrypt input data and return original string:
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $encrypted := crypto:encrypt('message', 'symmetric', 'keykeyke', 'DES')
 return crypto:decrypt($encrypted, 'symmetric', 'keykeyke', 'DES')
@@ Line 198: / Line 198: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 crypto:generate-signature(<a/>, '', '', '', '', '')
 </syntaxhighlight>
@@ Line 252: / Line 252: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $sig := crypto:generate-signature(<a/>, '', '', '', '', '')
 return crypto:validate-signature($sig)

@@ Line 177: / Line 177: @@
    $signature         as xs:string,
    $prefix            as xs:string,
-   $type              as xs:string
+   $type              as xs:string,
 ) as node()</pre>
 |- valign="top"
 | '''Summary'''

@@ Line 15: / Line 15: @@
 | width='120' | '''Signature'''
 |<pre>crypto:hmac(
-   $data       as xs:anyAtomicType
+   $data       as xs:anyAtomicType,
-   $key        as xs:anyAtomicType
+   $key        as xs:anyAtomicType,
-   $algorithm  as xs:string
+   $algorithm  as xs:string,
    $encoding   as xs:string         := ()
 ) as xs:string</pre>
@@ Line 58: / Line 58: @@
 | width='120' | '''Signature'''
 |<pre>crypto:encrypt(
-   $data       as xs:anyAtomicType
+   $data       as xs:anyAtomicType,
-   $type       as xs:string
+   $type       as xs:string,
-   $key        as xs:anyAtomicType
+   $key        as xs:anyAtomicType,
    $algorithm  as xs:string
 ) as xs:base64Binary</pre>
@@ Line 87: / Line 87: @@
 | width='120' | '''Signature'''
 |<pre>crypto:decrypt(
-   $data       as xs:anyAtomicType
+   $data       as xs:anyAtomicType,
-   $type       as xs:string
+   $type       as xs:string,
-   $key        as xs:anyAtomicType
+   $key        as xs:anyAtomicType,
    $algorithm  as xs:string
 ) as xs:string</pre>
@@ Line 172: / Line 172: @@
 | width='120' | '''Signature'''
 |<pre>crypto:generate-signature(
-   $input             as node()
+   $input             as node(),
-   $canonicalization  as xs:string
+   $canonicalization  as xs:string,
-   $digest            as xs:string
+   $digest            as xs:string,
-   $signature         as xs:string
+   $signature         as xs:string,
-   $prefix            as xs:string
+   $prefix            as xs:string,
    $type              as xs:string
 ) as node()</pre>

@@ Line 14: / Line 14: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|crypto:hmac|$data as xs:anyAtomicType, $key as xs:anyAtomicType, $algorithm as xs:string|xs:string}}<br/>{{Func|crypto:hmac|$data as xs:anyAtomicType, $key as xs:anyAtomicType, $algorithm as xs:string, $encoding as xs:string|xs:string}}
+|<pre>crypto:hmac(
 |- valign="top"
 | '''Summary'''
@@ Line 52: / Line 57: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|crypto:encrypt|$data as xs:anyAtomicType, $type as xs:string, $key as xs:anyAtomicType, $algorithm as xs:string|xs:base64Binary}}
+|<pre>crypto:encrypt(
 |- valign="top"
 | '''Summary'''
@@ Line 76: / Line 86: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|crypto:decrypt|$data as xs:anyAtomicType, $type as xs:string, $key as xs:anyAtomicType, $algorithm as xs:string|xs:string}}
+|<pre>crypto:decrypt(
 |- valign="top"
 | '''Summary'''
@@ Line 156: / Line 171: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|crypto:generate-signature|$input as node(), $canonicalization as xs:string, $digest as xs:string, $signature as xs:string, $prefix as xs:string, $type as xs:string|node()}}<br/>{{Func|crypto:generate-signature|$input as node(), $canonicalization as xs:string, $digest as xs:string, $signature as xs:string, $prefix as xs:string, $type as xs:string, $xpath as xs:string, $certificate as node()|node()}}<br/>{{Func|crypto:generate-signature|$input as node(), $canonicalization as xs:string, $digest as xs:string, $signature as xs:string, $prefix as xs:string, $type as xs:string, $ext as item()|node()}}
+|<pre>crypto:generate-signature(
 |- valign="top"
 | '''Summary'''
@@ Line 164: / Line 188: @@
 {{Code|$prefix}} may be empty and prefixes the {{Code|Signature}} element accordingly.<br/>
 {{Code|$type}} is the signature type. It must either be {{Code|enveloped}} or {{Code|enveloping}} (detached signatures are not supported so far). '''Default is {{Code|enveloped}}'''.<br/>
-{{Code|$xpath}} is an arbitrary XPath expression which specifies a subset of the document that is to be signed.<br/>
+{{Code|$ext1}} may either be an {{Code|$xpath}} expression or a {{Code|$certificate}}.<br/>
-{{Code|$certificate}} is the digitial certificate used to sign the input document.<br/>
+If {{Code|$ext2}} is specified as well, {{Code|$ext1}} is an arbitrary XPath expression which specifies a subset of the document that is to be signed, and {{Code|$ext2}} is the digitial certificate used to sign the input document.<br/>
 |- valign="top"
 | '''Errors'''
@@ Line 215: / Line 238: @@
 |- valign="top"
 | width='120' | '''Signatures'''
-|{{Func|crypto:validate-signature|$input-doc as node()|xs:boolean}}
+|<pre>crypto:validate-signature(
 |- valign="top"
 | '''Summary'''

@@ Line 329: / Line 329: @@
 ;Version 9.3
-* Updated: {{Function|Cryptographic|crypto:hmac}}, {{Function|Cryptographic|crypto:encrypt}}, {{Function|Cryptographic|crypto:decrypt}}: Function types revised.
+* Updated: {{Function||crypto:hmac}}, {{Function||crypto:encrypt}}, {{Function||crypto:decrypt}}: Function types revised.
 ;Version 8.6
-* Updated: {{Function|Cryptographic|crypto:hmac}}: The key can now be a string or a binary item.
+* Updated: {{Function||crypto:hmac}}: The key can now be a string or a binary item.
 The Module was introduced with Version 7.0.