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
|
<!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: XSECCryptoKey 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>XSECCryptoKey Class Reference<br>
<small>
[<a class="el" href="group__crypto.html">Cryptographic Abstraction Layer</a>]</small>
</h1><code>#include <<a class="el" href="XSECCryptoKey_8hpp-source.html">XSECCryptoKey.hpp</a>></code>
<p>
Inheritance diagram for XSECCryptoKey:<p><center><img src="classXSECCryptoKey__inherit__graph.png" border="0" usemap="#XSECCryptoKey__inherit__map" alt="Inheritance graph"></center>
<map name="XSECCryptoKey__inherit__map">
<area href="classXSECCryptoKeyDSA.html" shape="rect" coords="8,83,157,107" alt="">
<area href="classXSECCryptoKeyHMAC.html" shape="rect" coords="181,83,341,107" alt="">
<area href="classXSECCryptoKeyRSA.html" shape="rect" coords="365,83,514,107" alt="">
<area href="classXSECCryptoSymmetricKey.html" shape="rect" coords="538,83,722,107" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECCryptoKey-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Base interface class for key material.
<p>
All keys used for signing and encrypting are derived from this base interface class. There are no methods for performing cryptographic functions, as this is a base class used to allow the library to pass key material to various objects without knowing how to directly use it.
<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="classXSECCryptoKey.html#w9">KeyType</a> { <br>
<a class="el" href="classXSECCryptoKey.html#w9w0">KEY_NONE</a>,
<br>
<a class="el" href="classXSECCryptoKey.html#w9w1">KEY_DSA_PUBLIC</a>,
<br>
<a class="el" href="classXSECCryptoKey.html#w9w2">KEY_DSA_PRIVATE</a>,
<br>
<a class="el" href="classXSECCryptoKey.html#w9w3">KEY_DSA_PAIR</a>,
<br>
<a class="el" href="classXSECCryptoKey.html#w9w4">KEY_RSA_PUBLIC</a>,
<br>
<a class="el" href="classXSECCryptoKey.html#w9w5">KEY_RSA_PRIVATE</a>,
<br>
<a class="el" href="classXSECCryptoKey.html#w9w6">KEY_RSA_PAIR</a>,
<br>
<a class="el" href="classXSECCryptoKey.html#w9w7">KEY_HMAC</a>,
<br>
<a class="el" href="classXSECCryptoKey.html#w9w8">KEY_SYMMETRIC</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Key types understood by the library. <a href="classXSECCryptoKey.html#w9">More...</a><br></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="classXSECCryptoKey.html#z157_0">XSECCryptoKey</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#z157_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="classXSECCryptoKey.html#z157_1">~XSECCryptoKey</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z157_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Interface classes</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXSECCryptoKey.html#w9">KeyType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECCryptoKey.html#z158_0">getKeyType</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of this key. <a href="#z158_0"></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="classXSECCryptoKey.html#z158_1">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="#z158_1"></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="classXSECCryptoKey.html#z158_2">clone</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone the key. <a href="#z158_2"></a><br></td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w9" doxytag="XSECCryptoKey::KeyType"></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="classXSECCryptoKey.html#w9">XSECCryptoKey::KeyType</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Key types understood by the library.
<p>
This type defines the list of key types that the library understands. <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="w9w0" doxytag="KEY_NONE"></a>KEY_NONE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w1" doxytag="KEY_DSA_PUBLIC"></a>KEY_DSA_PUBLIC</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w2" doxytag="KEY_DSA_PRIVATE"></a>KEY_DSA_PRIVATE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w3" doxytag="KEY_DSA_PAIR"></a>KEY_DSA_PAIR</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w4" doxytag="KEY_RSA_PUBLIC"></a>KEY_RSA_PUBLIC</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w5" doxytag="KEY_RSA_PRIVATE"></a>KEY_RSA_PRIVATE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w6" doxytag="KEY_RSA_PAIR"></a>KEY_RSA_PAIR</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w7" doxytag="KEY_HMAC"></a>KEY_HMAC</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="w9w8" doxytag="KEY_SYMMETRIC"></a>KEY_SYMMETRIC</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z157_0" doxytag="XSECCryptoKey::XSECCryptoKey"></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">XSECCryptoKey::XSECCryptoKey </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>
Constructor.
<p>
</td>
</tr>
</table>
<a class="anchor" name="z157_1" doxytag="XSECCryptoKey::~XSECCryptoKey"></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 XSECCryptoKey::~XSECCryptoKey </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>
Destructor.
<p>
Implementations must ensure that the held key is properly destroyed (overwritten) when key objects are deleted. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z158_2" doxytag="XSECCryptoKey::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>* XSECCryptoKey::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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Clone the key.
<p>
All keys need to be able to copy themselves and return a pointer to the copy. This allows the library to duplicate keys.
<p>
Implemented in <a class="el" href="classOpenSSLCryptoKeyDSA.html#z88_2">OpenSSLCryptoKeyDSA</a>, <a class="el" href="classOpenSSLCryptoKeyHMAC.html#z93_1">OpenSSLCryptoKeyHMAC</a>, <a class="el" href="classOpenSSLCryptoKeyRSA.html#z96_2">OpenSSLCryptoKeyRSA</a>, <a class="el" href="classOpenSSLCryptoSymmetricKey.html#z106_1">OpenSSLCryptoSymmetricKey</a>, <a class="el" href="classWinCAPICryptoKeyDSA.html#z121_2">WinCAPICryptoKeyDSA</a>, <a class="el" href="classWinCAPICryptoKeyHMAC.html#z126_1">WinCAPICryptoKeyHMAC</a>, <a class="el" href="classWinCAPICryptoKeyRSA.html#z130_2">WinCAPICryptoKeyRSA</a>, <a class="el" href="classWinCAPICryptoSymmetricKey.html#z141_1">WinCAPICryptoSymmetricKey</a>, <a class="el" href="classXSECCryptoKeyDSA.html#z160_1">XSECCryptoKeyDSA</a>, <a class="el" href="classXSECCryptoKeyHMAC.html#z164_1">XSECCryptoKeyHMAC</a>, <a class="el" href="classXSECCryptoKeyRSA.html#z167_1">XSECCryptoKeyRSA</a>, and <a class="el" href="classXSECCryptoSymmetricKey.html#z176_2">XSECCryptoSymmetricKey</a>. </td>
</tr>
</table>
<a class="anchor" name="z158_0" doxytag="XSECCryptoKey::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">KeyType</a> XSECCryptoKey::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>
Returns the type of this key.
<p>
<p>
Reimplemented in <a class="el" href="classOpenSSLCryptoKeyDSA.html#z88_0">OpenSSLCryptoKeyDSA</a>, <a class="el" href="classOpenSSLCryptoKeyHMAC.html#z93_0">OpenSSLCryptoKeyHMAC</a>, <a class="el" href="classOpenSSLCryptoKeyRSA.html#z96_0">OpenSSLCryptoKeyRSA</a>, <a class="el" href="classWinCAPICryptoKeyDSA.html#z121_0">WinCAPICryptoKeyDSA</a>, <a class="el" href="classWinCAPICryptoKeyHMAC.html#z126_0">WinCAPICryptoKeyHMAC</a>, <a class="el" href="classWinCAPICryptoKeyRSA.html#z130_0">WinCAPICryptoKeyRSA</a>, <a class="el" href="classXSECCryptoKeyDSA.html#z160_0">XSECCryptoKeyDSA</a>, <a class="el" href="classXSECCryptoKeyHMAC.html#z164_0">XSECCryptoKeyHMAC</a>, <a class="el" href="classXSECCryptoKeyRSA.html#z167_0">XSECCryptoKeyRSA</a>, and <a class="el" href="classXSECCryptoSymmetricKey.html#z176_0">XSECCryptoSymmetricKey</a>. </td>
</tr>
</table>
<a class="anchor" name="z158_1" doxytag="XSECCryptoKey::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* XSECCryptoKey::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="classOpenSSLCryptoKeyDSA.html#z88_1">OpenSSLCryptoKeyDSA</a>, <a class="el" href="classOpenSSLCryptoKeyHMAC.html#z93_2">OpenSSLCryptoKeyHMAC</a>, <a class="el" href="classOpenSSLCryptoKeyRSA.html#z96_1">OpenSSLCryptoKeyRSA</a>, <a class="el" href="classOpenSSLCryptoSymmetricKey.html#z106_0">OpenSSLCryptoSymmetricKey</a>, <a class="el" href="classWinCAPICryptoKeyDSA.html#z121_1">WinCAPICryptoKeyDSA</a>, <a class="el" href="classWinCAPICryptoKeyHMAC.html#z126_2">WinCAPICryptoKeyHMAC</a>, <a class="el" href="classWinCAPICryptoKeyRSA.html#z130_1">WinCAPICryptoKeyRSA</a>, <a class="el" href="classWinCAPICryptoSymmetricKey.html#z141_0">WinCAPICryptoSymmetricKey</a>, and <a class="el" href="classXSECCryptoSymmetricKey.html#z176_1">XSECCryptoSymmetricKey</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSECCryptoKey_8hpp-source.html">XSECCryptoKey.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:45:23 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>
|
