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
|
<!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: WinCAPICryptoKeyHMAC 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>WinCAPICryptoKeyHMAC Class Reference<br>
<small>
[<a class="el" href="group__wincapicrypto.html">Windows Crypto API Interface</a>]</small>
</h1><code>#include <<a class="el" href="WinCAPICryptoKeyHMAC_8hpp-source.html">WinCAPICryptoKeyHMAC.hpp</a>></code>
<p>
Inheritance diagram for WinCAPICryptoKeyHMAC:<p><center><img src="classWinCAPICryptoKeyHMAC__inherit__graph.png" border="0" usemap="#WinCAPICryptoKeyHMAC__inherit__map" alt="Inheritance graph"></center>
<map name="WinCAPICryptoKeyHMAC__inherit__map">
<area href="classXSECCryptoKeyHMAC.html" shape="rect" coords="17,84,177,108" alt="">
<area href="classXSECCryptoKey.html" shape="rect" coords="36,9,158,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for WinCAPICryptoKeyHMAC:<p><center><img src="classWinCAPICryptoKeyHMAC__coll__graph.png" border="0" usemap="#WinCAPICryptoKeyHMAC__coll__map" alt="Collaboration graph"></center>
<map name="WinCAPICryptoKeyHMAC__coll__map">
<area href="classXSECCryptoKeyHMAC.html" shape="rect" coords="7,86,167,110" alt="">
<area href="classXSECCryptoKey.html" shape="rect" coords="26,9,149,33" alt="">
<area href="classsafeBuffer.html" shape="rect" coords="191,86,274,110" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classWinCAPICryptoKeyHMAC-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Windows Crypto API implementation for HMAC keys.
<p>
Used to provide HMAC keys to WinCAPI CryptoHashHMAC<p>
Provides two types of key.<p>
A <b>Windows Key</b> (via setWinKey) is a direct key that can be used by the Windows HMAC implementation.<p>
A <b>byte</b> key (via setKey) is a string of bytes that will be used as a key. This requires an internal implementation of an HMAC using the Windows Digest functions, as the Windows API does not allow direct loading of these keys.
<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="classWinCAPICryptoKeyHMAC.html#z125_0">WinCAPICryptoKeyHMAC</a> (HCRYPTPROV prov)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#z125_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWinCAPICryptoKeyHMAC.html#z125_1">~WinCAPICryptoKeyHMAC</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="classWinCAPICryptoKeyHMAC.html#z126_0">getKeyType</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the type of this key. <a href="#z126_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="classWinCAPICryptoKeyHMAC.html#z126_1">clone</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replicate key. <a href="#z126_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="classWinCAPICryptoKeyHMAC.html#z126_2">getProviderName</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the WinCAPI string identifier. <a href="#z126_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Optional Interface methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWinCAPICryptoKeyHMAC.html#z127_0">setKey</a> (unsigned char *inBuf, unsigned int inLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the key. <a href="#z127_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="classWinCAPICryptoKeyHMAC.html#z127_1">getKey</a> (<a class="el" href="classsafeBuffer.html">safeBuffer</a> &outBuf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the key value. <a href="#z127_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Windows specific keys</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWinCAPICryptoKeyHMAC.html#z128_0">setWinKey</a> (HCRYPTKEY k)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Windows key. <a href="#z128_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">HCRYPTKEY </td><td class="memItemRight" valign="bottom"><a class="el" href="classWinCAPICryptoKeyHMAC.html#z128_1">getWinKey</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a windows key. <a href="#z128_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">HCRYPTPROV </td><td class="memItemRight" valign="bottom"><a class="el" href="classWinCAPICryptoKeyHMAC.html#z128_2">getWinKeyProv</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a windows key provider. <a href="#z128_2"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z125_0" doxytag="WinCAPICryptoKeyHMAC::WinCAPICryptoKeyHMAC"></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">WinCAPICryptoKeyHMAC::WinCAPICryptoKeyHMAC </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">HCRYPTPROV </td>
<td class="mdname1" valign="top" nowrap> <em>prov</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constructor.
<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>prov</em> </td><td>The handle to the provider context that was used to create any Windows keys (later set via setKey). If this is not to be used for a windows key (i.e. will be used for a "normal" buffer of bytes as a key, then this value can be set to 0 </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z125_1" doxytag="WinCAPICryptoKeyHMAC::~WinCAPICryptoKeyHMAC"></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 WinCAPICryptoKeyHMAC::~WinCAPICryptoKeyHMAC </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="z126_1" doxytag="WinCAPICryptoKeyHMAC::clone"></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>* WinCAPICryptoKeyHMAC::clone </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Replicate key.
<p>
<p>
Implements <a class="el" href="classXSECCryptoKeyHMAC.html#z164_1">XSECCryptoKeyHMAC</a>. </td>
</tr>
</table>
<a class="anchor" name="z127_1" doxytag="WinCAPICryptoKeyHMAC::getKey"></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 WinCAPICryptoKeyHMAC::getKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classsafeBuffer.html">safeBuffer</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>outBuf</em> </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>
Get the key value.
<p>
Copy the key into the <a class="el" href="classsafeBuffer.html">safeBuffer</a> and return the number of bytes copied.<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>outBuf</em> </td><td>Buffer to copy key into </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes copied in </dd></dl>
<p>
Implements <a class="el" href="classXSECCryptoKeyHMAC.html#z165_1">XSECCryptoKeyHMAC</a>. </td>
</tr>
</table>
<a class="anchor" name="z126_0" doxytag="WinCAPICryptoKeyHMAC::getKeyType"></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> WinCAPICryptoKeyHMAC::getKeyType </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>
Return the type of this key.
<p>
For DSA keys, this allows people to determine whether this is a public key, private key or a key pair
<p>
Reimplemented from <a class="el" href="classXSECCryptoKeyHMAC.html#z164_0">XSECCryptoKeyHMAC</a>. </td>
</tr>
</table>
<a class="anchor" name="z126_2" doxytag="WinCAPICryptoKeyHMAC::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* WinCAPICryptoKeyHMAC::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> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the WinCAPI string identifier.
<p>
<p>
Implements <a class="el" href="classXSECCryptoKey.html#z158_1">XSECCryptoKey</a>. </td>
</tr>
</table>
<a class="anchor" name="z128_1" doxytag="WinCAPICryptoKeyHMAC::getWinKey"></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">HCRYPTKEY WinCAPICryptoKeyHMAC::getWinKey </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get a windows key.
<p>
Used by <a class="el" href="classWinCAPICryptoHashHMAC.html">WinCAPICryptoHashHMAC</a> to retrieve the key in order to load it into the HMAC function.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The key to use or 0 if this object does not hold one </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z128_2" doxytag="WinCAPICryptoKeyHMAC::getWinKeyProv"></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">HCRYPTPROV WinCAPICryptoKeyHMAC::getWinKeyProv </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get a windows key provider.
<p>
Used by <a class="el" href="classWinCAPICryptoHashHMAC.html">WinCAPICryptoHashHMAC</a> to retrieve the provider handle associated with an HMAC key in order to load it into the HMAC function.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The key to use or 0 if this object does not hold one </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z127_0" doxytag="WinCAPICryptoKeyHMAC::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 WinCAPICryptoKeyHMAC::setKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned char * </td>
<td class="mdname" nowrap> <em>inBuf</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"></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>
Set the key.
<p>
Set the key from the 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>inBuf</em> </td><td>Buffer containing the direct bitwise representation of the key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inLength</em> </td><td>Number of bytes of key in the buffer</td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>isSensitive() should have been called on the inbound buffer to ensure the contents is overwritten when the <a class="el" href="classsafeBuffer.html">safeBuffer</a> is deleted </dd></dl>
<p>
Implements <a class="el" href="classXSECCryptoKeyHMAC.html#z165_0">XSECCryptoKeyHMAC</a>. </td>
</tr>
</table>
<a class="anchor" name="z128_0" doxytag="WinCAPICryptoKeyHMAC::setWinKey"></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 WinCAPICryptoKeyHMAC::setWinKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">HCRYPTKEY </td>
<td class="mdname1" valign="top" nowrap> <em>k</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set a Windows key.
<p>
Set a Windows Crypto key that has been either derived via the various Crypt functions or has been loaded from an encrypted BLOB<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>k</em> </td><td>Windows CAPI key to load Note that the library now owns this key (and will destroy it). </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="WinCAPICryptoKeyHMAC_8hpp-source.html">WinCAPICryptoKeyHMAC.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:43:39 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>
|
