File: classXSECCryptoBase64.html

package info (click to toggle)
xml-security-c 1.2.1-3
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 24,464 kB
  • ctags: 6,673
  • sloc: cpp: 36,830; xml: 23,415; sh: 2,365; makefile: 340; perl: 221
file content (466 lines) | stat: -rw-r--r-- 22,750 bytes parent folder | download | duplicates (2)
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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
<!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: XSECCryptoBase64 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&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>XSECCryptoBase64 Class Reference<br>
<small>
[<a class="el" href="group__crypto.html">Cryptographic Abstraction Layer</a>]</small>
</h1><code>#include &lt;<a class="el" href="XSECCryptoBase64_8hpp-source.html">XSECCryptoBase64.hpp</a>&gt;</code>
<p>
Inheritance diagram for XSECCryptoBase64:<p><center><img src="classXSECCryptoBase64__inherit__graph.png" border="0" usemap="#XSECCryptoBase64__inherit__map" alt="Inheritance graph"></center>
<map name="XSECCryptoBase64__inherit__map">
<area href="classOpenSSLCryptoBase64.html" shape="rect" coords="8,83,170,107" alt="">
<area href="classXSCryptCryptoBase64.html" shape="rect" coords="194,83,352,107" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECCryptoBase64-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>
There are many places where XML DSIG uses Base64 encoding for embedding data in the &lt;Signature&gt; structure. In some cases this object is used. In other cases, the library passes base64 code directly to the cryptographic handler.<p>
<dl compact><dt><b>Note:</b></dt><dd>The library may re-use Base64 objects. However it will always call the ??Init function prior to re-use. In addtion, the object does not need to be able to handle concurrent encode/decode operations. </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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoBase64.html#a0">XSECCryptoBase64</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoBase64.html#a1">~XSECCryptoBase64</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoBase64.html#z149_0">decodeInit</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise the base64 object.  <a href="#z149_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoBase64.html#z149_1">decode</a> (const unsigned char *inData, unsigned int inLength, unsigned char *outData, unsigned int outLength)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decode some passed in data.  <a href="#z149_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoBase64.html#z149_2">decodeFinish</a> (unsigned char *outData, unsigned int outLength)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finish off a decode.  <a href="#z149_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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoBase64.html#z150_0">encodeInit</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise the base64 object for encoding.  <a href="#z150_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoBase64.html#z150_1">encode</a> (const unsigned char *inData, unsigned int inLength, unsigned char *outData, unsigned int outLength)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encode some passed in data.  <a href="#z150_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoBase64.html#z150_2">encodeFinish</a> (unsigned char *outData, unsigned int outLength)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finish off an encode.  <a href="#z150_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">Utility functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoBase64.html#z151_0">cleanBuffer</a> (const char *buffer, unsigned int bufLen, unsigned int &amp;retBufLen)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clean a buffer of base64 text.  <a href="#z151_0"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="XSECCryptoBase64::XSECCryptoBase64"></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">XSECCryptoBase64::XSECCryptoBase64           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="XSECCryptoBase64::~XSECCryptoBase64"></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 XSECCryptoBase64::~XSECCryptoBase64           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z151_0" doxytag="XSECCryptoBase64::cleanBuffer"></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 char* XSECCryptoBase64::cleanBuffer           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname" nowrap> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>unsigned int&nbsp;</td>
          <td class="mdname" nowrap> <em>bufLen</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>unsigned int &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>retBufLen</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Clean a buffer of base64 text. 
<p>
Creates a new copy of the passed in buffer with new lines in accord with the MIME standard.<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>buffer</em>&nbsp;</td><td>The buffer of base64 text to clean </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>bufLen</em>&nbsp;</td><td>The number of characters to clean in the buffer (0 for strlen) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>retBufLen</em>&nbsp;</td><td>The number of characters placed in the cleaned buffer </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A clean version of the buffer </dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This is NOT re-implemented in any of the crypto interfaces. It is a Base64 utility function only. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z149_1" doxytag="XSECCryptoBase64::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 XSECCryptoBase64::decode           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const unsigned char *&nbsp;</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&nbsp;</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 *&nbsp;</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&nbsp;</td>
          <td class="mdname" nowrap> <em>outLength</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</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>
      &nbsp;
    </td>
    <td>

<p>
Decode some passed in data. 
<p>
The XSEC library will pass a block of data into the decoder and request that as much as possible be decoded into the outData buffer.<p>
Due to the nature of base64, there may be data that cannot be fully decoded (not enough encoding through yet). The implementation is expected to keep this in memory until another call to <a class="el" href="classXSECCryptoBase64.html#z149_1">decode()</a> or a call to <a class="el" href="classXSECCryptoBase64.html#z149_2">decodeFinish()</a>.<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>&nbsp;</td><td>Pointer to the buffer holding encoded data. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>inLength</em>&nbsp;</td><td>Length of the encoded data in the buffer </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>outData</em>&nbsp;</td><td>Buffer to place decoded data into </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>outLength</em>&nbsp;</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>
Implemented in <a class="el" href="classOpenSSLCryptoBase64.html#z77_1">OpenSSLCryptoBase64</a>, and <a class="el" href="classXSCryptCryptoBase64.html#z147_1">XSCryptCryptoBase64</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z149_2" doxytag="XSECCryptoBase64::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 XSECCryptoBase64::decodeFinish           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char *&nbsp;</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&nbsp;</td>
          <td class="mdname" nowrap> <em>outLength</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</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>
      &nbsp;
    </td>
    <td>

<p>
Finish off a decode. 
<p>
The library will call this when there is no more base64 data for the current decode.<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>&nbsp;</td><td>Buffer to place any remaining decoded data </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>outLength</em>&nbsp;</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>
Implemented in <a class="el" href="classOpenSSLCryptoBase64.html#z77_2">OpenSSLCryptoBase64</a>, and <a class="el" href="classXSCryptCryptoBase64.html#z147_2">XSCryptCryptoBase64</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z149_0" doxytag="XSECCryptoBase64::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 XSECCryptoBase64::decodeInit           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Initialise the base64 object. 
<p>
The XSEC library will <em>always</em> call this function prior to decoding any data. This function will also be called when one decode (or encode) has been completed and the library wishes to re-use the object for another decode operation. 
<p>
Implemented in <a class="el" href="classOpenSSLCryptoBase64.html#z77_0">OpenSSLCryptoBase64</a>, and <a class="el" href="classXSCryptCryptoBase64.html#z147_0">XSCryptCryptoBase64</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z150_1" doxytag="XSECCryptoBase64::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 XSECCryptoBase64::encode           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const unsigned char *&nbsp;</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&nbsp;</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 *&nbsp;</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&nbsp;</td>
          <td class="mdname" nowrap> <em>outLength</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</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>
      &nbsp;
    </td>
    <td>

<p>
Encode some passed in data. 
<p>
The XSEC library will pass a block of data into the Encoder and request that as much as possible be encoded into the outData buffer.<p>
Due to the nature of the implementation, there may be data that cannot be fully encoded (not enough data through yet). The implementation is expected to keep this in memory until another call to <a class="el" href="classXSECCryptoBase64.html#z150_1">encode()</a> or a call to <a class="el" href="classXSECCryptoBase64.html#z150_2">encodeFinish()</a>.<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>&nbsp;</td><td>Pointer to the buffer holding data to be encoded. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>inLength</em>&nbsp;</td><td>Length of the data in the buffer </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>outData</em>&nbsp;</td><td>Buffer to place encoded data into </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>outLength</em>&nbsp;</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>
Implemented in <a class="el" href="classOpenSSLCryptoBase64.html#z78_1">OpenSSLCryptoBase64</a>, and <a class="el" href="classXSCryptCryptoBase64.html#z148_1">XSCryptCryptoBase64</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z150_2" doxytag="XSECCryptoBase64::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 XSECCryptoBase64::encodeFinish           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char *&nbsp;</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&nbsp;</td>
          <td class="mdname" nowrap> <em>outLength</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</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>
      &nbsp;
    </td>
    <td>

<p>
Finish off an encode. 
<p>
The library will call this when there is no more data for the current encode operation.<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>&nbsp;</td><td>Buffer to place any remaining encoded data </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>outLength</em>&nbsp;</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>
Implemented in <a class="el" href="classOpenSSLCryptoBase64.html#z78_2">OpenSSLCryptoBase64</a>, and <a class="el" href="classXSCryptCryptoBase64.html#z148_2">XSCryptCryptoBase64</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z150_0" doxytag="XSECCryptoBase64::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 XSECCryptoBase64::encodeInit           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Initialise the base64 object for encoding. 
<p>
The XSEC library will <em>always</em> call this function prior to encoding any data. This function will also be called when one encode (or decode) has been completed and the library wishes to re-use the object for another encode operation. 
<p>
Implemented in <a class="el" href="classOpenSSLCryptoBase64.html#z78_0">OpenSSLCryptoBase64</a>, and <a class="el" href="classXSCryptCryptoBase64.html#z148_0">XSCryptCryptoBase64</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSECCryptoBase64_8hpp-source.html">XSECCryptoBase64.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:45:19 2005 for XML-Security-C by&nbsp;
<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>