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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
|
<!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: OpenSSLCryptoBase64 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>OpenSSLCryptoBase64 Class Reference<br>
<small>
[<a class="el" href="group__opensslcrypto.html">OpenSSL Interface</a>]</small>
</h1><code>#include <<a class="el" href="OpenSSLCryptoBase64_8hpp-source.html">OpenSSLCryptoBase64.hpp</a>></code>
<p>
Inheritance diagram for OpenSSLCryptoBase64:<p><center><img src="classOpenSSLCryptoBase64__inherit__graph.png" border="0" usemap="#OpenSSLCryptoBase64__inherit__map" alt="Inheritance graph"></center>
<map name="OpenSSLCryptoBase64__inherit__map">
<area href="classXSECCryptoBase64.html" shape="rect" coords="17,9,161,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for OpenSSLCryptoBase64:<p><center><img src="classOpenSSLCryptoBase64__coll__graph.png" border="0" usemap="#OpenSSLCryptoBase64__coll__map" alt="Collaboration graph"></center>
<map name="OpenSSLCryptoBase64__coll__map">
<area href="classXSECCryptoBase64.html" shape="rect" coords="17,9,161,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOpenSSLCryptoBase64-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Base64 encode/decode handler interface class.
<p>
The XSEC library will use implementations of this interface for translating bytes to/from base64 encoding.<p>
Uses the EVP decode/encode routines in OpenSSL to perform the work.<p>
<dl compact><dt><b>Note:</b></dt><dd>Requires implementation of OpenSSL > 0.9.6e as there was a bug in the Base64 decoding routines in this version and prior. </dd></dl>
<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 class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenSSLCryptoBase64.html#a0">OpenSSLCryptoBase64</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenSSLCryptoBase64.html#a1">~OpenSSLCryptoBase64</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">Decoding Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenSSLCryptoBase64.html#z77_0">decodeInit</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise the base64 object. <a href="#z77_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenSSLCryptoBase64.html#z77_1">decode</a> (const unsigned char *inData, unsigned int inLength, unsigned char *outData, unsigned int outLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode some passed in data. <a href="#z77_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenSSLCryptoBase64.html#z77_2">decodeFinish</a> (unsigned char *outData, unsigned int outLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finish off a decode. <a href="#z77_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Encoding Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenSSLCryptoBase64.html#z78_0">encodeInit</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise the base64 object for encoding. <a href="#z78_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenSSLCryptoBase64.html#z78_1">encode</a> (const unsigned char *inData, unsigned int inLength, unsigned char *outData, unsigned int outLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode some passed in data. <a href="#z78_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenSSLCryptoBase64.html#z78_2">encodeFinish</a> (unsigned char *outData, unsigned int outLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finish off an encode. <a href="#z78_2"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Library Specific Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static BIGNUM * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenSSLCryptoBase64.html#z79_0">b642BN</a> (char *b64in, unsigned int len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Translate a base64 encoded BN to a bignum. <a href="#z79_0"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="OpenSSLCryptoBase64::OpenSSLCryptoBase64"></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">OpenSSLCryptoBase64::OpenSSLCryptoBase64 </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="a1" doxytag="OpenSSLCryptoBase64::~OpenSSLCryptoBase64"></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 OpenSSLCryptoBase64::~OpenSSLCryptoBase64 </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="z79_0" doxytag="OpenSSLCryptoBase64::b642BN"></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">static BIGNUM* OpenSSLCryptoBase64::b642BN </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </td>
<td class="mdname" nowrap> <em>b64in</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> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Translate a base64 encoded BN to a bignum.
<p>
Take a ds:CryptoBinary number and translate to an OpenSSL representation of a "big number" BIGNUM. </td>
</tr>
</table>
<a class="anchor" name="z77_1" doxytag="OpenSSLCryptoBase64::decode"></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 unsigned int OpenSSLCryptoBase64::decode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const unsigned char * </td>
<td class="mdname" nowrap> <em>inData</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>inLength</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned char * </td>
<td class="mdname" nowrap> <em>outData</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>outLength</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Decode some passed in data.
<p>
Pass the encoded data through the OpenSSL base64 decode function and place the data in the outData buffer.<p>
<dl compact><dt><b>Note:</b></dt><dd>The OpenSSL library is very unkind if the output buffer is not large enough. It is the responsibility of the caller to ensure the buffer will take the data.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>inData</em> </td><td>Pointer to the buffer holding encoded data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inLength</em> </td><td>Length of the encoded data in the buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outData</em> </td><td>Buffer to place decoded data into </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outLength</em> </td><td>Maximum amount of data that can be placed in the buffer. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes placed in the outData buffer. </dd></dl>
<p>
Implements <a class="el" href="classXSECCryptoBase64.html#z149_1">XSECCryptoBase64</a>. </td>
</tr>
</table>
<a class="anchor" name="z77_2" doxytag="OpenSSLCryptoBase64::decodeFinish"></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 unsigned int OpenSSLCryptoBase64::decodeFinish </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned char * </td>
<td class="mdname" nowrap> <em>outData</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>outLength</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Finish off a decode.
<p>
Clean out any extra data in the OpenSSL decode context variable into the outData buffer.<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>outData</em> </td><td>Buffer to place any remaining decoded data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outLength</em> </td><td>Max amount of data to be placed in the buffer. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Amount of data placed in the outData buffer </dd></dl>
<p>
Implements <a class="el" href="classXSECCryptoBase64.html#z149_2">XSECCryptoBase64</a>. </td>
</tr>
</table>
<a class="anchor" name="z77_0" doxytag="OpenSSLCryptoBase64::decodeInit"></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 OpenSSLCryptoBase64::decodeInit </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Initialise the base64 object.
<p>
Initialises the OpenSSL decode context and gets ready for data to be decoded.
<p>
Implements <a class="el" href="classXSECCryptoBase64.html#z149_0">XSECCryptoBase64</a>. </td>
</tr>
</table>
<a class="anchor" name="z78_1" doxytag="OpenSSLCryptoBase64::encode"></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 unsigned int OpenSSLCryptoBase64::encode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const unsigned char * </td>
<td class="mdname" nowrap> <em>inData</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>inLength</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned char * </td>
<td class="mdname" nowrap> <em>outData</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>outLength</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Encode some passed in data.
<p>
Pass the data through the OpenSSL Base64 encoder and place the output in the outData buffer. Will keep any "overhang" data in the context buffer ready for the next pass of input data.<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>inData</em> </td><td>Pointer to the buffer holding data to be encoded. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inLength</em> </td><td>Length of the data in the buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outData</em> </td><td>Buffer to place encoded data into </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outLength</em> </td><td>Maximum amount of data that can be placed in the buffer. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes placed in the outData buffer. </dd></dl>
<p>
Implements <a class="el" href="classXSECCryptoBase64.html#z150_1">XSECCryptoBase64</a>. </td>
</tr>
</table>
<a class="anchor" name="z78_2" doxytag="OpenSSLCryptoBase64::encodeFinish"></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 unsigned int OpenSSLCryptoBase64::encodeFinish </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned char * </td>
<td class="mdname" nowrap> <em>outData</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>outLength</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Finish off an encode.
<p>
Take any data left in the context variable, and create the tail of the base64 encoding.<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>outData</em> </td><td>Buffer to place any remaining encoded data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outLength</em> </td><td>Max amount of data to be placed in the buffer. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Amount of data placed in the outData buffer </dd></dl>
<p>
Implements <a class="el" href="classXSECCryptoBase64.html#z150_2">XSECCryptoBase64</a>. </td>
</tr>
</table>
<a class="anchor" name="z78_0" doxytag="OpenSSLCryptoBase64::encodeInit"></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 OpenSSLCryptoBase64::encodeInit </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Initialise the base64 object for encoding.
<p>
Get the context variable ready for a base64 decode
<p>
Implements <a class="el" href="classXSECCryptoBase64.html#z150_0">XSECCryptoBase64</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OpenSSLCryptoBase64_8hpp-source.html">OpenSSLCryptoBase64.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:41:54 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>
|
