1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_xenc_encrypt">
<refmeta>
<refentrytitle>xenc_encrypt</refentrytitle>
<refmiscinfo>hash</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xenc_encrypt</refname>
<refpurpose>Encrypt and optionally sign a SOAP message</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xenc_encrypt">
<funcprototype id="fproto_xenc_encrypt">
<funcdef>varchar <function>xenc_encrypt</function></funcdef>
<paramdef>in <parameter>message</parameter> varchar</paramdef>
<paramdef>in <parameter>soap_ver</parameter> int</paramdef>
<paramdef>in <parameter>template</parameter> varchar</paramdef>
<paramdef>in <parameter>ns</parameter> any</paramdef>
<paramdef>in <parameter>xp-n</parameter> varchar</paramdef>
<paramdef>in <parameter>ki-n</parameter> any</paramdef>
<paramdef>in <parameter>what-n</parameter> varchar</paramdef>
<paramdef> <parameter>...</parameter> </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_xenc_encrypt">
<title>Description</title>
<para>Encrypt SOAP message and optionally attach an XML signature. The keys are retrieved from the
key store of the calling user account.</para>
</refsect1>
<refsect1 id="params_xenc_encrypt">
<title>Parameters</title>
<refsect2><title>message</title>
<para>A string containing SOAP message</para>
</refsect2>
<refsect2><title>soap_ver</title>
<para>SOAP version (11 = 1.1, 10 = 1.0 etc.)</para>
</refsect2>
<refsect2><title>template</title>
<para>a string containing Digital signature template.</para>
</refsect2>
<refsect2><title>ns</title>
<para>an array of strings containing WS-Security extension and WS-Utility
version information.</para>
</refsect2>
<refsect2><title>xp-n</title>
<para>XPath expression to locate n-th part of the message to be encrypted</para>
</refsect2>
<refsect2><title>ki-n</title>
<para>Key instance to encrypt the part</para>
</refsect2>
<refsect2><title>what-n</title>
<para>'Content' - the content under located element will be encrypted; 'Element' the located element and content will be encrypted.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_xenc_encrypt"><title>Return Types</title>
<para>
On success the function will return a string containing encrypted and
optionally signed SOAP message.
</para>
</refsect1>
<refsect1 id="examples_xenc_encrypt">
<title>Examples</title>
<example id="ex_xenc_encrypt"><title>Encrypting and signing SOAP message</title>
<screen><![CDATA[
...
ns := vector ();
template := dsig_template_ext (...);
keyi := xenc_key_inst_create ('myAES', xenc_key_inst_create ('rsa-test'));
resp := xenc_encrypt (request, 11, template, ns, '/Envelope/Body', keyi, 'Content');
...
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_xenc_encrypt">
<title>See Also</title>
<para><link linkend="fn_encrypt"><function>encrypt()</function></link></para>
<para><link linkend="fn_decrypt"><function>decrypt()</function></link></para>
<para><link linkend="fn_dsig_template_ext"><function>dsig_template_ext()</function></link></para>
<para><link linkend="fn_xenc_key_inst_create"><function>xenc_key_inst_create()</function></link></para>
</refsect1>
</refentry>
|
