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
|
<!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: XKMSRegisterRequest 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>XKMSRegisterRequest Class Reference<br>
<small>
[<a class="el" href="group__xkms.html">XML Key Management System Implementation</a>]</small>
</h1><code>#include <<a class="el" href="XKMSRegisterRequest_8hpp-source.html">XKMSRegisterRequest.hpp</a>></code>
<p>
Inheritance diagram for XKMSRegisterRequest:<p><center><img src="classXKMSRegisterRequest__inherit__graph.png" border="0" usemap="#XKMSRegisterRequest__inherit__map" alt="Inheritance graph"></center>
<map name="XKMSRegisterRequest__inherit__map">
<area href="classXKMSRequestAbstractType.html" shape="rect" coords="10,84,200,108" alt="">
<area href="classXKMSMessageAbstractType.html" shape="rect" coords="8,9,202,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XKMSRegisterRequest:<p><center><img src="classXKMSRegisterRequest__coll__graph.png" border="0" usemap="#XKMSRegisterRequest__coll__map" alt="Collaboration graph"></center>
<map name="XKMSRegisterRequest__coll__map">
<area href="classXKMSRequestAbstractType.html" shape="rect" coords="10,84,200,108" alt="">
<area href="classXKMSMessageAbstractType.html" shape="rect" coords="8,9,202,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXKMSRegisterRequest-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface definition for the RegisterRequest elements.
<p>
The <RegisterRequest> is one of the fundamental message types of the X-KRMS service. It is used by a client wishing to register a key with a service.<p>
The schema definition for RegisterRequest is as follows :<p>
<div class="fragment"><pre class="fragment"> <!-- RegisterRequest -->
<element name="RegisterRequest" type="xkms:RegisterRequestType"/>
<complexType name="RegisterRequestType">
<complexContent>
<extension base="xkms:RequestAbstractType">
<sequence>
<element ref="xkms:PrototypeKeyBinding"/>
<element ref="xkms:Authentication"/>
<element ref="xkms:ProofOfPossession" minOccurs="0"/>
</sequence>
</extension>
</complexContent>
</complexType>
<!-- /RegisterRequest -->
</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="classXKMSRegisterRequest.html#z302_0">~XKMSRegisterRequest</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSRegisterRequest.html#z302_1">XKMSRegisterRequest</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Getter Interface Methods</div></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="classXKMSRegisterRequest.html#z303_0">getElement</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the element at the base of the message. <a href="#z303_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXKMSPrototypeKeyBinding.html">XKMSPrototypeKeyBinding</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSRegisterRequest.html#z303_1">getPrototypeKeyBinding</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the PrototypKeyBinding element. <a href="#z303_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXKMSAuthentication.html">XKMSAuthentication</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSRegisterRequest.html#z303_2">getAuthentication</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Authentication element. <a href="#z303_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGSignature.html">DSIGSignature</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSRegisterRequest.html#z303_3">getProofOfPossessionSignature</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the signature used to prove possession of the private key. <a href="#z303_3"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Setter Interface Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXKMSPrototypeKeyBinding.html">XKMSPrototypeKeyBinding</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSRegisterRequest.html#z304_0">addPrototypeKeyBinding</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a PrototypeKeyBinding element. <a href="#z304_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXKMSAuthentication.html">XKMSAuthentication</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSRegisterRequest.html#z304_1">addAuthentication</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an Authentication element. <a href="#z304_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGSignature.html">DSIGSignature</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSRegisterRequest.html#z304_2">addProofOfPossessionSignature</a> (<a class="el" href="DSIGConstants_8hpp.html#a102">canonicalizationMethod</a> cm=CANON_C14N_NOC, <a class="el" href="DSIGConstants_8hpp.html#a103">signatureMethod</a> sm=SIGNATURE_DSA, <a class="el" href="DSIGConstants_8hpp.html#a104">hashMethod</a> hm=HASH_SHA1)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a ProofOfPossession signature to the message. <a href="#z304_2"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z302_1" doxytag="XKMSRegisterRequest::XKMSRegisterRequest"></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">XKMSRegisterRequest::XKMSRegisterRequest </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="z302_0" doxytag="XKMSRegisterRequest::~XKMSRegisterRequest"></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 XKMSRegisterRequest::~XKMSRegisterRequest </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="z304_1" doxytag="XKMSRegisterRequest::addAuthentication"></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="classXKMSAuthentication.html">XKMSAuthentication</a>* XKMSRegisterRequest::addAuthentication </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>
Add an Authentication element.
<p>
Set a Authentication element in the Request message. The returned object can be manipulated to add Authentication information to the request.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the newly created Authenticaton object, or the pointer to extant object if one already existed. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z304_2" doxytag="XKMSRegisterRequest::addProofOfPossessionSignature"></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="classDSIGSignature.html">DSIGSignature</a>* XKMSRegisterRequest::addProofOfPossessionSignature </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="DSIGConstants_8hpp.html#a102">canonicalizationMethod</a> </td>
<td class="mdname" nowrap> <em>cm</em> = <code>CANON_C14N_NOC</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="DSIGConstants_8hpp.html#a103">signatureMethod</a> </td>
<td class="mdname" nowrap> <em>sm</em> = <code>SIGNATURE_DSA</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="DSIGConstants_8hpp.html#a104">hashMethod</a> </td>
<td class="mdname" nowrap> <em>hm</em> = <code>HASH_SHA1</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add a ProofOfPossession signature to the message.
<p>
Allows the application to add a new ProofOfPossession signature into a RegisterRequest element<p>
<dl compact><dt><b>Note:</b></dt><dd>the client application will need to set the key and sign the message - however the appropriate reference (to the PrototypeKeyBinding element) will be set. This implies that the PrototypeKeyBinding *must* be added prior to the call to this method.</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>the new Signature structure </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z304_0" doxytag="XKMSRegisterRequest::addPrototypeKeyBinding"></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="classXKMSPrototypeKeyBinding.html">XKMSPrototypeKeyBinding</a>* XKMSRegisterRequest::addPrototypeKeyBinding </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>
Add a PrototypeKeyBinding element.
<p>
Set a PrototypeKeyBinding element in the Request message. The returned object can be manipulated to add KeyInfo elements to the Request.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the newly created PrototypeKeyBinding object, or the pointer to extant object if one already existed. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z303_2" doxytag="XKMSRegisterRequest::getAuthentication"></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="classXKMSAuthentication.html">XKMSAuthentication</a>* XKMSRegisterRequest::getAuthentication </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> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the Authentication element.
<p>
The Authentication element of the RegisterRequest is used by the client to authenticate the request to the server.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the Authentication structure </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z303_0" doxytag="XKMSRegisterRequest::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* XKMSRegisterRequest::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> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the element at the base of the message.
<p>
<p>
Implements <a class="el" href="classXKMSRequestAbstractType.html#z309_0">XKMSRequestAbstractType</a>. </td>
</tr>
</table>
<a class="anchor" name="z303_3" doxytag="XKMSRegisterRequest::getProofOfPossessionSignature"></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="classDSIGSignature.html">DSIGSignature</a>* XKMSRegisterRequest::getProofOfPossessionSignature </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> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the signature used to prove possession of the private key.
<p>
When the client presents a request for a key generated by them, this element is used to show that the client is authorised to make this request using this key.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the proof of possession Signature object (or NULL if none was defined </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z303_1" doxytag="XKMSRegisterRequest::getPrototypeKeyBinding"></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="classXKMSPrototypeKeyBinding.html">XKMSPrototypeKeyBinding</a>* XKMSRegisterRequest::getPrototypeKeyBinding </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> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Obtain the PrototypKeyBinding element.
<p>
The PrototypeKeyBinding element is the core of the RegisterRequest message, and defines the key information that will be sent to the server for registration.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classXKMSPrototypeKeyBinding.html">XKMSPrototypeKeyBinding</a> element </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XKMSRegisterRequest_8hpp-source.html">XKMSRegisterRequest.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:44:35 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>
|
