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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
|
<!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: DSIGKeyInfo 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>DSIGKeyInfo Class Reference<br>
<small>
[<a class="el" href="group__pubsig.html">Main Signature API</a>]</small>
</h1><code>#include <<a class="el" href="DSIGKeyInfo_8hpp-source.html">DSIGKeyInfo.hpp</a>></code>
<p>
Inheritance diagram for DSIGKeyInfo:<p><center><img src="classDSIGKeyInfo__inherit__graph.png" border="0" usemap="#DSIGKeyInfo__inherit__map" alt="Inheritance graph"></center>
<map name="DSIGKeyInfo__inherit__map">
<area href="classDSIGKeyInfoMgmtData.html" shape="rect" coords="157,8,320,32" alt="">
<area href="classDSIGKeyInfoName.html" shape="rect" coords="170,56,306,80" alt="">
<area href="classDSIGKeyInfoPGPData.html" shape="rect" coords="160,104,317,128" alt="">
<area href="classDSIGKeyInfoSPKIData.html" shape="rect" coords="158,152,318,176" alt="">
<area href="classDSIGKeyInfoValue.html" shape="rect" coords="172,200,305,224" alt="">
<area href="classDSIGKeyInfoX509.html" shape="rect" coords="173,248,304,272" alt="">
<area href="classXENCEncryptedKey.html" shape="rect" coords="166,296,310,320" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for DSIGKeyInfo:<p><center><img src="classDSIGKeyInfo__coll__graph.png" border="0" usemap="#DSIGKeyInfo__coll__map" alt="Collaboration graph"></center>
<map name="DSIGKeyInfo__coll__map">
<area href="classXSECEnv.html" shape="rect" coords="184,281,266,305" alt="">
<area href="classXSECSafeBufferFormatter.html" shape="rect" coords="8,190,189,214" alt="">
<area href="classsafeBuffer.html" shape="rect" coords="85,9,168,33" alt="">
<area href="classsbFormatTarget.html" shape="rect" coords="176,99,293,123" alt="">
<area href="classXSECURIResolver.html" shape="rect" coords="213,190,349,214" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDSIGKeyInfo-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for <Key*> nodes in a KeyInfo list.
<p>
Digital signatures can have a number of KeyInfo elements that are used to communicate information about what key to use between the signer and the validator.<p>
In the XML-Security-C libary, KeyInfo elements are only used for holding information about keys. They do not in themselves perform any cryptographic function.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></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="classDSIGKeyInfo.html#w9">keyInfoType</a> { <br>
<a class="el" href="classDSIGKeyInfo.html#w9w0">KEYINFO_NOTSET</a> = 1,
<br>
<a class="el" href="classDSIGKeyInfo.html#w9w1">KEYINFO_X509</a> = 2,
<br>
<a class="el" href="classDSIGKeyInfo.html#w9w2">KEYINFO_VALUE_DSA</a> = 3,
<br>
<a class="el" href="classDSIGKeyInfo.html#w9w3">KEYINFO_VALUE_RSA</a> = 4,
<br>
<a class="el" href="classDSIGKeyInfo.html#w9w4">KEYINFO_NAME</a> = 5,
<br>
<a class="el" href="classDSIGKeyInfo.html#w9w5">KEYINFO_PGPDATA</a> = 6,
<br>
<a class="el" href="classDSIGKeyInfo.html#w9w6">KEYINFO_SPKIDATA</a> = 7,
<br>
<a class="el" href="classDSIGKeyInfo.html#w9w7">KEYINFO_MGMTDATA</a> = 8,
<br>
<a class="el" href="classDSIGKeyInfo.html#w9w8">KEYINFO_ENCRYPTEDKEY</a> = 9
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">List of potential KeyInfo types. <a href="classDSIGKeyInfo.html#w9">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfo.html#z0_0">DSIGKeyInfo</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct from an owning signature. <a href="#z0_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfo.html#z0_1">~DSIGKeyInfo</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The Destructor. <a href="#z0_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Get functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGKeyInfo.html#w9">keyInfoType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfo.html#z1_0">getKeyInfoType</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return type. <a href="#z1_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfo.html#z1_1">getKeyInfoDOMNode</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the DOMNode that heads up this DOMNode. <a href="#z1_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfo.html#z1_2">getKeyName</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of this key. <a href="#z1_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Load and Set</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfo.html#z2_0">load</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the DOM structures. <a href="#z2_0"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfo.html#p0">mp_keyInfoDOMNode</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGKeyInfo.html#p1">mp_env</a></td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w9" doxytag="DSIGKeyInfo::keyInfoType"></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="classDSIGKeyInfo.html#w9">DSIGKeyInfo::keyInfoType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
List of potential KeyInfo types.
<p>
The keyIntoType enumerated type defines the KeyInfo types known by the XML-Security-C library. <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="w9w0" doxytag="KEYINFO_NOTSET"></a>KEYINFO_NOTSET</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w1" doxytag="KEYINFO_X509"></a>KEYINFO_X509</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w2" doxytag="KEYINFO_VALUE_DSA"></a>KEYINFO_VALUE_DSA</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w3" doxytag="KEYINFO_VALUE_RSA"></a>KEYINFO_VALUE_RSA</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w4" doxytag="KEYINFO_NAME"></a>KEYINFO_NAME</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w5" doxytag="KEYINFO_PGPDATA"></a>KEYINFO_PGPDATA</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w6" doxytag="KEYINFO_SPKIDATA"></a>KEYINFO_SPKIDATA</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w7" doxytag="KEYINFO_MGMTDATA"></a>KEYINFO_MGMTDATA</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w8" doxytag="KEYINFO_ENCRYPTEDKEY"></a>KEYINFO_ENCRYPTEDKEY</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z0_0" doxytag="DSIGKeyInfo::DSIGKeyInfo"></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">DSIGKeyInfo::DSIGKeyInfo </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>env</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct from an owning signature.
<p>
All KeyInfo types take a constructor that provides the controlling environment.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>The environment that the KeyInfo is operating within </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z0_1" doxytag="DSIGKeyInfo::~DSIGKeyInfo"></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 DSIGKeyInfo::~DSIGKeyInfo </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>
The Destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1_1" doxytag="DSIGKeyInfo::getKeyInfoDOMNode"></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 DOMNode* DSIGKeyInfo::getKeyInfoDOMNode </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>
Return the DOMNode that heads up this DOMNode.
<p>
</td>
</tr>
</table>
<a class="anchor" name="z1_0" doxytag="DSIGKeyInfo::getKeyInfoType"></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="classDSIGKeyInfo.html#w9">keyInfoType</a> DSIGKeyInfo::getKeyInfoType </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>
Return type.
<p>
Can be used to find what type of KeyInfo this is
<p>
Implemented in <a class="el" href="classDSIGKeyInfoMgmtData.html#z10_0">DSIGKeyInfoMgmtData</a>, <a class="el" href="classDSIGKeyInfoName.html#z14_0">DSIGKeyInfoName</a>, <a class="el" href="classDSIGKeyInfoPGPData.html#z18_0">DSIGKeyInfoPGPData</a>, <a class="el" href="classDSIGKeyInfoSPKIData.html#z22_0">DSIGKeyInfoSPKIData</a>, <a class="el" href="classDSIGKeyInfoValue.html#z27_0">DSIGKeyInfoValue</a>, and <a class="el" href="classDSIGKeyInfoX509.html#z29_11">DSIGKeyInfoX509</a>. </td>
</tr>
</table>
<a class="anchor" name="z1_2" doxytag="DSIGKeyInfo::getKeyName"></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 const XMLCh* DSIGKeyInfo::getKeyName </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>
Return the name of this key.
<p>
For those KeyInfo types that have a keyname, this function should return it. For certificates, this may be the DN.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to a buffer containing the name </dd></dl>
<p>
Implemented in <a class="el" href="classDSIGKeyInfoMgmtData.html#z8_1">DSIGKeyInfoMgmtData</a>, <a class="el" href="classDSIGKeyInfoName.html#z12_1">DSIGKeyInfoName</a>, <a class="el" href="classDSIGKeyInfoPGPData.html#z16_3">DSIGKeyInfoPGPData</a>, <a class="el" href="classDSIGKeyInfoSPKIData.html#z20_3">DSIGKeyInfoSPKIData</a>, <a class="el" href="classDSIGKeyInfoValue.html#z27_1">DSIGKeyInfoValue</a>, and <a class="el" href="classDSIGKeyInfoX509.html#z29_2">DSIGKeyInfoX509</a>. </td>
</tr>
</table>
<a class="anchor" name="z2_0" doxytag="DSIGKeyInfo::load"></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 void DSIGKeyInfo::load </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load the DOM structures.
<p>
Used by the library to instruct the object to load information from the DOM nodes
<p>
Implemented in <a class="el" href="classDSIGKeyInfoMgmtData.html#z8_0">DSIGKeyInfoMgmtData</a>, <a class="el" href="classDSIGKeyInfoName.html#z12_0">DSIGKeyInfoName</a>, <a class="el" href="classDSIGKeyInfoPGPData.html#z16_0">DSIGKeyInfoPGPData</a>, <a class="el" href="classDSIGKeyInfoSPKIData.html#z20_0">DSIGKeyInfoSPKIData</a>, <a class="el" href="classDSIGKeyInfoValue.html#z24_0">DSIGKeyInfoValue</a>, and <a class="el" href="classDSIGKeyInfoX509.html#z29_0">DSIGKeyInfoX509</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p1" doxytag="DSIGKeyInfo::mp_env"></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">const <a class="el" href="classXSECEnv.html">XSECEnv</a>* <a class="el" href="classDSIGKeyInfo.html#p1">DSIGKeyInfo::mp_env</a><code> [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="p0" doxytag="DSIGKeyInfo::mp_keyInfoDOMNode"></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">XERCES_CPP_NAMESPACE_QUALIFIER DOMNode* <a class="el" href="classDSIGKeyInfo.html#p0">DSIGKeyInfo::mp_keyInfoDOMNode</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DSIGKeyInfo_8hpp-source.html">DSIGKeyInfo.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:40:47 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>
|
