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
|
<!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: XSECCryptoHash 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>XSECCryptoHash Class Reference<br>
<small>
[<a class="el" href="group__crypto.html">Cryptographic Abstraction Layer</a>]</small>
</h1><code>#include <<a class="el" href="XSECCryptoHash_8hpp-source.html">XSECCryptoHash.hpp</a>></code>
<p>
Inheritance diagram for XSECCryptoHash:<p><center><img src="classXSECCryptoHash__inherit__graph.png" border="0" usemap="#XSECCryptoHash__inherit__map" alt="Inheritance graph"></center>
<map name="XSECCryptoHash__inherit__map">
<area href="classOpenSSLCryptoHash.html" shape="rect" coords="8,83,157,107" alt="">
<area href="classOpenSSLCryptoHashHMAC.html" shape="rect" coords="181,83,370,107" alt="">
<area href="classWinCAPICryptoHash.html" shape="rect" coords="394,83,541,107" alt="">
<area href="classWinCAPICryptoHashHMAC.html" shape="rect" coords="565,83,752,107" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECCryptoHash-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface definition for Hash functions.
<p>
The XSECCryptoHash function is used by the library to manipulate Hashing (Digest) functions.<p>
It is also used as the base class for HMAC functions, and thus has a <a class="el" href="classXSECCryptoHash.html#z156_0">setKey()</a> method.<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>bring the interface here in-line with that provided for <a class="el" href="classXSECCryptoBase64.html">XSECCryptoBase64</a> - really should have only one way of calling these kinds of objects.</dd></dl>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoHash.html#w7">HashType</a> { <br>
<a class="el" href="classXSECCryptoHash.html#w7w0">HASH_NONE</a> = 0,
<br>
<a class="el" href="classXSECCryptoHash.html#w7w1">HASH_SHA1</a> = 1,
<br>
<a class="el" href="classXSECCryptoHash.html#w7w2">HASH_MD5</a> = 2,
<br>
<a class="el" href="classXSECCryptoHash.html#w7w3">HASH_SHA224</a> = 3,
<br>
<a class="el" href="classXSECCryptoHash.html#w7w4">HASH_SHA256</a> = 4,
<br>
<a class="el" href="classXSECCryptoHash.html#w7w5">HASH_SHA384</a> = 5,
<br>
<a class="el" href="classXSECCryptoHash.html#w7w6">HASH_SHA512</a> = 6
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of Hash (Digest) types. <a href="classXSECCryptoHash.html#w7">More...</a><br></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="classXSECCryptoHash.html#a0">XSECCryptoHash</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoHash.html#a1">~XSECCryptoHash</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">Digest/Hash 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="classXSECCryptoHash.html#z154_0">reset</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rest the hash function. <a href="#z154_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="classXSECCryptoHash.html#z154_1">hash</a> (unsigned char *data, unsigned int length)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hash some data. <a href="#z154_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="classXSECCryptoHash.html#z154_2">finish</a> (unsigned char *hash, unsigned int maxLength)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finish up a Digest operation and read the result. <a href="#z154_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Information functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXSECCryptoHash.html#w7">HashType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoHash.html#z155_0">getHashType</a> (void)=0</td></tr>
<tr><td colspan="2"><div class="groupHeader">HMAC 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="classXSECCryptoHash.html#z156_0">setKey</a> (<a class="el" href="classXSECCryptoKey.html">XSECCryptoKey</a> *key)=0</td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w7" doxytag="XSECCryptoHash::HashType"></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">enum <a class="el" href="classXSECCryptoHash.html#w7">XSECCryptoHash::HashType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Enumeration of Hash (Digest) types.
<p>
The hash types known to XSEC <dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="w7w0" doxytag="HASH_NONE"></a>HASH_NONE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w7w1" doxytag="HASH_SHA1"></a>HASH_SHA1</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w7w2" doxytag="HASH_MD5"></a>HASH_MD5</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w7w3" doxytag="HASH_SHA224"></a>HASH_SHA224</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w7w4" doxytag="HASH_SHA256"></a>HASH_SHA256</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w7w5" doxytag="HASH_SHA384"></a>HASH_SHA384</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w7w6" doxytag="HASH_SHA512"></a>HASH_SHA512</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="XSECCryptoHash::XSECCryptoHash"></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">XSECCryptoHash::XSECCryptoHash </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="XSECCryptoHash::~XSECCryptoHash"></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 XSECCryptoHash::~XSECCryptoHash </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="z154_2" doxytag="XSECCryptoHash::finish"></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 XSECCryptoHash::finish </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned char * </td>
<td class="mdname" nowrap> <em>hash</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>maxLength</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>
Finish up a Digest operation and read the result.
<p>
This call tells the CryptoHash object that the input is complete and to finalise the Digest. The output of the digest is read into the hash buffer (at most maxLength bytes)<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>hash</em> </td><td>The buffer the hash should be read into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxLength</em> </td><td>The maximum number of bytes to be read into hash </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes copied into the hash buffer </dd></dl>
<p>
Implemented in <a class="el" href="classOpenSSLCryptoHash.html#z82_2">OpenSSLCryptoHash</a>, <a class="el" href="classOpenSSLCryptoHashHMAC.html#a2">OpenSSLCryptoHashHMAC</a>, <a class="el" href="classWinCAPICryptoHash.html#z114_2">WinCAPICryptoHash</a>, and <a class="el" href="classWinCAPICryptoHashHMAC.html#z118_2">WinCAPICryptoHashHMAC</a>. </td>
</tr>
</table>
<a class="anchor" name="z155_0" doxytag="XSECCryptoHash::getHashType"></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="classXSECCryptoHash.html#w7">HashType</a> XSECCryptoHash::getHashType </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>
Determine the hash type of this object<p>
<dl compact><dt><b>Returns:</b></dt><dd>The hash type </dd></dl>
<p>
Implemented in <a class="el" href="classOpenSSLCryptoHash.html#z83_0">OpenSSLCryptoHash</a>, <a class="el" href="classOpenSSLCryptoHashHMAC.html#z86_0">OpenSSLCryptoHashHMAC</a>, <a class="el" href="classWinCAPICryptoHash.html#z115_0">WinCAPICryptoHash</a>, and <a class="el" href="classWinCAPICryptoHashHMAC.html#z119_0">WinCAPICryptoHashHMAC</a>. </td>
</tr>
</table>
<a class="anchor" name="z154_1" doxytag="XSECCryptoHash::hash"></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 XSECCryptoHash::hash </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned char * </td>
<td class="mdname" nowrap> <em>data</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>length</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>
Hash some data.
<p>
Take length bytes of data from the data buffer and update the hash that already exists. This function may (and normally will) be called many times for large blocks of 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>data</em> </td><td>The buffer containing the data to be hashed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>The number of bytes to be read from data </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classOpenSSLCryptoHash.html#z82_1">OpenSSLCryptoHash</a>, <a class="el" href="classOpenSSLCryptoHashHMAC.html#a1">OpenSSLCryptoHashHMAC</a>, <a class="el" href="classWinCAPICryptoHash.html#z114_1">WinCAPICryptoHash</a>, and <a class="el" href="classWinCAPICryptoHashHMAC.html#z118_1">WinCAPICryptoHashHMAC</a>. </td>
</tr>
</table>
<a class="anchor" name="z154_0" doxytag="XSECCryptoHash::reset"></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 XSECCryptoHash::reset </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>
Rest the hash function.
<p>
XSEC will call the <a class="el" href="classXSECCryptoHash.html#z154_0">reset()</a> function prior to re-using a CryptoHash object.
<p>
Implemented in <a class="el" href="classOpenSSLCryptoHash.html#z82_0">OpenSSLCryptoHash</a>, <a class="el" href="classOpenSSLCryptoHashHMAC.html#a0">OpenSSLCryptoHashHMAC</a>, <a class="el" href="classWinCAPICryptoHash.html#z114_0">WinCAPICryptoHash</a>, and <a class="el" href="classWinCAPICryptoHashHMAC.html#z118_0">WinCAPICryptoHashHMAC</a>. </td>
</tr>
</table>
<a class="anchor" name="z156_0" doxytag="XSECCryptoHash::setKey"></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 XSECCryptoHash::setKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classXSECCryptoKey.html">XSECCryptoKey</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>key</em> </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>
The HMAC classes are treated in the library as standard hash objects that just happen to take a key. Thus all hash functions implement this function (potentially just to throw an exception)<p>
Sets the key - which needs to have a base class of <a class="el" href="classXSECCryptoKeyHMAC.html">XSECCryptoKeyHMAC</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>key</em> </td><td>The key the HMAC function should use. </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classOpenSSLCryptoHash.html#z81_0">OpenSSLCryptoHash</a>, <a class="el" href="classOpenSSLCryptoHashHMAC.html#z85_0">OpenSSLCryptoHashHMAC</a>, <a class="el" href="classWinCAPICryptoHash.html#z113_0">WinCAPICryptoHash</a>, and <a class="el" href="classWinCAPICryptoHashHMAC.html#z117_0">WinCAPICryptoHashHMAC</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSECCryptoHash_8hpp-source.html">XSECCryptoHash.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:45:21 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>
|
