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
|
<!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: XKMSAuthentication 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>XKMSAuthentication 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="XKMSAuthentication_8hpp-source.html">XKMSAuthentication.hpp</a>></code>
<p>
<a href="classXKMSAuthentication-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface definition for the Authentication elements.
<p>
The <Authentication> Element used within a number of X-KRSS requests as the mechanism for authentication a request from a client to the server<p>
It can contain either a standard XML-Signature element (via a KeyBindingAuthentication element) or a straight password (not otherwise protected).<p>
The schema definition for ValidityInterval is as follows :<p>
<div class="fragment"><pre class="fragment"> <!-- Authentication -->
<element name="Authentication" type="xkms:AuthenticationType"/>
<complexType name="AuthenticationType">
<sequence>
<element ref="xkms:KeyBindingAuthentication" minOccurs="0"/>
<element ref="xkms:NotBoundAuthentication" minOccurs="0"/>
</sequence>
</complexType>
<!-- /Authentication -->
</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="classXKMSAuthentication.html#z259_0">~XKMSAuthentication</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSAuthentication.html#z259_1">XKMSAuthentication</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Get Methods</div></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="classXKMSAuthentication.html#z260_0">getKeyBindingAuthenticationSignature</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get KeyBindingAuthentication signature construct. <a href="#z260_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXKMSNotBoundAuthentication.html">XKMSNotBoundAuthentication</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSAuthentication.html#z260_1">getNotBoundAuthentication</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the NotBoundAuthentication structure. <a href="#z260_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Set Methods</div></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="classXKMSAuthentication.html#z261_0">addKeyBindingAuthenticationSignature</a> (<a class="el" href="DSIGConstants_8hpp.html#a102">canonicalizationMethod</a> cm=CANON_C14NE_NOC, <a class="el" href="DSIGConstants_8hpp.html#a103">signatureMethod</a> sm=SIGNATURE_HMAC, <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 KeyBindingAuthentication signature to the message. <a href="#z261_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXKMSAuthentication.html#z261_1">setNotBoundAuthentication</a> (const XMLCh *uri, const XMLCh *value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the NotBoundAuthentication value. <a href="#z261_1"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z259_1" doxytag="XKMSAuthentication::XKMSAuthentication"></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">XKMSAuthentication::XKMSAuthentication </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="z259_0" doxytag="XKMSAuthentication::~XKMSAuthentication"></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 XKMSAuthentication::~XKMSAuthentication </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="z261_0" doxytag="XKMSAuthentication::addKeyBindingAuthenticationSignature"></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>* XKMSAuthentication::addKeyBindingAuthenticationSignature </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_C14NE_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_HMAC</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 KeyBindingAuthentication signature to the message.
<p>
Allows the application to add a new signature into a KeyBindingAuthentication element<p>
<dl compact><dt><b>Returns:</b></dt><dd>the new Signature structure </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z260_0" doxytag="XKMSAuthentication::getKeyBindingAuthenticationSignature"></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>* XKMSAuthentication::getKeyBindingAuthenticationSignature </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 KeyBindingAuthentication signature construct.
<p>
A <XKMSAuthentication> can have a <KeyBindingAuthentication> element as an immediate child. This element is used to hold a XML-Signature over the PrototypeKeyBinding.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The signature held in the KeyBindingAuthentication - or NULL if none is set. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z260_1" doxytag="XKMSAuthentication::getNotBoundAuthentication"></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="classXKMSNotBoundAuthentication.html">XKMSNotBoundAuthentication</a>* XKMSAuthentication::getNotBoundAuthentication </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 NotBoundAuthentication structure.
<p>
The NotBoundAuthentication element is used to pass a plaintext key along with the request message as the authentication mechanism.<p>
<dl compact><dt><b>Note:</b></dt><dd>The XKMS Spec indicates that this element MUST NOT be used unless there is another form of security being used to wrap the requests - e.g. authenticated SSL.</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The NotBoundAuthentication structure (or NULL if none is defined) </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z261_1" doxytag="XKMSAuthentication::setNotBoundAuthentication"></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 XKMSAuthentication::setNotBoundAuthentication </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>uri</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>value</em></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>
Set the NotBoundAuthentication value.
<p>
Allows applications to set a authentication value<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>uri</em> </td><td>URI defining the authentication protocol </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Base64 encoded value to set as the authentication value </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XKMSAuthentication_8hpp-source.html">XKMSAuthentication.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:44:01 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>
|
