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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XML-Security-C: XENCCipherData Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>XENCCipherData Class Reference<br>
<small>
[<a class="el" href="group__xenc.html">XML Encryption Implementation</a>]</small>
</h1><code>#include <<a class="el" href="XENCCipherData_8hpp-source.html">XENCCipherData.hpp</a>></code>
<p>
<a href="classXENCCipherData-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface definition for the CipherData object.
<p>
The <CipherData> element either holds the encrypted data (via a CipherValue element) or a reference to the encrypted data.<p>
Within the library, the CipherData element can only be used to hold and read the encrypted data. To actually decrypt/encrypt data, an <a class="el" href="classXENCEncryptedType.html">XENCEncryptedType</a> derivative object of <a class="el" href="classXENCCipher.html">XENCCipher</a> object should be used.<p>
The schema for CipherData is as follows:<p>
<div class="fragment"><pre class="fragment"><element name='CipherData' type='xenc:CipherDataType'/>
<complexType name='CipherDataType'>
<choice>
<element name='CipherValue' type='base64Binary'/>
<element ref='xenc:CipherReference'/>
</choice>
</complexType>
</pre></div>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Constructors and Destructors</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherData.html#z239_0">~XENCCipherData</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherData.html#z239_1">XENCCipherData</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherData.html#w3">XENCCipherDataType</a> { <br>
<a class="el" href="classXENCCipherData.html#w3w0">NO_TYPE</a> = 0,
<br>
<a class="el" href="classXENCCipherData.html#w3w1">VALUE_TYPE</a> = 1,
<br>
<a class="el" href="classXENCCipherData.html#w3w2">REFERENCE_TYPE</a> = 2
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Get Interface Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCCipherData.html#w3">XENCCipherDataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherData.html#z240_0">getCipherDataType</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find the type of Cipher Data held. <a href="#z240_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCCipherValue.html">XENCCipherValue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherData.html#z240_1">getCipherValue</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the CipherValue element. <a href="#z240_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCCipherReference.html">XENCCipherReference</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherData.html#z240_2">getCipherReference</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the CipherReference element. <a href="#z240_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipherData.html#z240_3">getElement</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the DOM Node of this structure. <a href="#z240_3"></a><br></td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w3" doxytag="XENCCipherData::XENCCipherDataType"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">enum <a class="el" href="classXENCCipherData.html#w3">XENCCipherData::XENCCipherDataType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
CipherDataType <dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="w3w0" doxytag="NO_TYPE"></a>NO_TYPE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w3w1" doxytag="VALUE_TYPE"></a>VALUE_TYPE</em> </td><td>
Not Set </td></tr>
<tr><td valign="top"><em><a class="anchor" name="w3w2" doxytag="REFERENCE_TYPE"></a>REFERENCE_TYPE</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z239_1" doxytag="XENCCipherData::XENCCipherData"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">XENCCipherData::XENCCipherData </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="z239_0" doxytag="XENCCipherData::~XENCCipherData"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual XENCCipherData::~XENCCipherData </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z240_0" doxytag="XENCCipherData::getCipherDataType"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classXENCCipherData.html#w3">XENCCipherDataType</a> XENCCipherData::getCipherDataType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Find the type of Cipher Data held.
<p>
CipherData elements can hold either a CipherValue element (whose text is the encrypted data) or a CipherReference element, where the contents tell the library how to retrieve the encrypted data from elsewhere.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The type of CipherData </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z240_2" doxytag="XENCCipherData::getCipherReference"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classXENCCipherReference.html">XENCCipherReference</a>* XENCCipherData::getCipherReference </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the CipherReference element.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the CipherReference element, or NULL if one is not held </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z240_1" doxytag="XENCCipherData::getCipherValue"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classXENCCipherValue.html">XENCCipherValue</a>* XENCCipherData::getCipherValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the CipherValue element.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the CipherValue element, or NULL if one is not held </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z240_3" doxytag="XENCCipherData::getElement"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* XENCCipherData::getElement </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the DOM Node of this structure.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the DOM Node representing the <CipherData> element </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XENCCipherData_8hpp-source.html">XENCCipherData.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:43:52 2005 for XML-Security-C by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
