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
|
<!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: XSECCryptoX509 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>XSECCryptoX509 Class Reference<br>
<small>
[<a class="el" href="group__crypto.html">Cryptographic Abstraction Layer</a>]</small>
</h1><code>#include <<a class="el" href="XSECCryptoX509_8hpp-source.html">XSECCryptoX509.hpp</a>></code>
<p>
Inheritance diagram for XSECCryptoX509:<p><center><img src="classXSECCryptoX509__inherit__graph.png" border="0" usemap="#XSECCryptoX509__inherit__map" alt="Inheritance graph"></center>
<map name="XSECCryptoX509__inherit__map">
<area href="classOpenSSLCryptoX509.html" shape="rect" coords="8,83,157,107" alt="">
<area href="classWinCAPICryptoX509.html" shape="rect" coords="181,83,328,107" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECCryptoX509-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface class for X509 certificates.
<p>
The library uses classes derived from this to process X509 Certificates.<p>
Strictly speaking, this class is not required (and is completely <em>Optional</em>. However it is used by <a class="el" href="classXSECKeyInfoResolverDefault.html">XSECKeyInfoResolverDefault</a> to extract a key from a certificate in cases where the caller is not worried about the trust level of the certificate.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></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="classXSECCryptoX509.html#z178_0">XSECCryptoX509</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoX509.html#z178_1">~XSECCryptoX509</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">Key Interface methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXSECCryptoKey.html#w9">XSECCryptoKey::KeyType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoX509.html#z179_0">getPublicKeyType</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the type of the key stored in the certificate. <a href="#z179_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXSECCryptoKey.html">XSECCryptoKey</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoX509.html#z179_1">clonePublicKey</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a copy of the public key. <a href="#z179_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="classXSECCryptoX509.html#z179_2">getProviderName</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a string that identifies the crypto owner of this library. <a href="#z179_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Load and Get the certificate</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoX509.html#z180_0">loadX509Base64Bin</a> (const char *buf, unsigned int len)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a certificate into the object. <a href="#z180_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoX509.html#z180_1">loadX509PEM</a> (const char *buf, unsigned int len=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a PEM encoded certificate into the object. <a href="#z180_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classsafeBuffer.html">safeBuffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoX509.html#z180_2">getDEREncodingSB</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Base64 DER encoded copy of the certificate. <a href="#z180_2"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z178_0" doxytag="XSECCryptoX509::XSECCryptoX509"></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">XSECCryptoX509::XSECCryptoX509 </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]</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="z178_1" doxytag="XSECCryptoX509::~XSECCryptoX509"></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 XSECCryptoX509::~XSECCryptoX509 </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="z179_1" doxytag="XSECCryptoX509::clonePublicKey"></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="classXSECCryptoKey.html">XSECCryptoKey</a>* XSECCryptoX509::clonePublicKey </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>
Get a copy of the public key.
<p>
The implementation should extract the key from the certificate, create an instance of the appropriate key type, and return it.
<p>
Implemented in <a class="el" href="classOpenSSLCryptoX509.html#z109_2">OpenSSLCryptoX509</a>, and <a class="el" href="classWinCAPICryptoX509.html#z145_1">WinCAPICryptoX509</a>. </td>
</tr>
</table>
<a class="anchor" name="z180_2" doxytag="XSECCryptoX509::getDEREncodingSB"></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="classsafeBuffer.html">safeBuffer</a>& XSECCryptoX509::getDEREncodingSB </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 a Base64 DER encoded copy of the certificate.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classsafeBuffer.html">safeBuffer</a> containing the DER encoded certificate </dd></dl>
<p>
Implemented in <a class="el" href="classOpenSSLCryptoX509.html#z110_1">OpenSSLCryptoX509</a>, and <a class="el" href="classWinCAPICryptoX509.html#z146_1">WinCAPICryptoX509</a>. </td>
</tr>
</table>
<a class="anchor" name="z179_2" doxytag="XSECCryptoX509::getProviderName"></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* XSECCryptoX509::getProviderName </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>
Returns a string that identifies the crypto owner of this library.
<p>
<p>
Implemented in <a class="el" href="classOpenSSLCryptoX509.html#z109_1">OpenSSLCryptoX509</a>, and <a class="el" href="classWinCAPICryptoX509.html#z145_2">WinCAPICryptoX509</a>. </td>
</tr>
</table>
<a class="anchor" name="z179_0" doxytag="XSECCryptoX509::getPublicKeyType"></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="classXSECCryptoKey.html#w9">XSECCryptoKey::KeyType</a> XSECCryptoX509::getPublicKeyType </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>
Return the type of the key stored in the certificate.
<p>
The implementation is expected to extract the key from the certificate and determine the type.
<p>
Implemented in <a class="el" href="classOpenSSLCryptoX509.html#z109_0">OpenSSLCryptoX509</a>, and <a class="el" href="classWinCAPICryptoX509.html#z145_0">WinCAPICryptoX509</a>. </td>
</tr>
</table>
<a class="anchor" name="z180_0" doxytag="XSECCryptoX509::loadX509Base64Bin"></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 XSECCryptoX509::loadX509Base64Bin </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>len</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>
Load a certificate into the object.
<p>
Take a base64 DER encoded certificate and load.<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>buf</em> </td><td>A buffer containing the Base64 encoded certificate </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The number of bytes of data in the certificate. </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classOpenSSLCryptoX509.html#z110_0">OpenSSLCryptoX509</a>, and <a class="el" href="classWinCAPICryptoX509.html#z146_0">WinCAPICryptoX509</a>. </td>
</tr>
</table>
<a class="anchor" name="z180_1" doxytag="XSECCryptoX509::loadX509PEM"></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">void XSECCryptoX509::loadX509PEM </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>len</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load a PEM encoded certificate into the object.
<p>
Take a PEM encoded certificate and load.<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>buf</em> </td><td>A buffer containing the PEM encoded certificate </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The number of bytes of data in the certificate. (0 if the string is null terminated.) </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="XSECCryptoX509_8hpp-source.html">XSECCryptoX509.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:45:37 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>
|
