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
|
<!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: XENCEncryptedKey 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>XENCEncryptedKey Class Reference<br>
<small>
[<a class="el" href="group__xenc.html">XML Encryption Implementation</a>]</small>
</h1><code>#include <<a class="el" href="XENCEncryptedKey_8hpp-source.html">XENCEncryptedKey.hpp</a>></code>
<p>
Inheritance diagram for XENCEncryptedKey:<p><center><img src="classXENCEncryptedKey__inherit__graph.png" border="0" usemap="#XENCEncryptedKey__inherit__map" alt="Inheritance graph"></center>
<map name="XENCEncryptedKey__inherit__map">
<area href="classXENCEncryptedType.html" shape="rect" coords="8,9,157,33" alt="">
<area href="classDSIGKeyInfo.html" shape="rect" coords="181,9,280,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XENCEncryptedKey:<p><center><img src="classXENCEncryptedKey__coll__graph.png" border="0" usemap="#XENCEncryptedKey__coll__map" alt="Collaboration graph"></center>
<map name="XENCEncryptedKey__coll__map">
<area href="classXENCEncryptedType.html" shape="rect" coords="7,372,157,396" alt="">
<area href="classDSIGKeyInfo.html" shape="rect" coords="181,372,279,396" alt="">
<area href="classXSECEnv.html" shape="rect" coords="189,281,271,305" alt="">
<area href="classXSECSafeBufferFormatter.html" shape="rect" coords="13,190,194,214" alt="">
<area href="classsafeBuffer.html" shape="rect" coords="90,9,173,33" alt="">
<area href="classsbFormatTarget.html" shape="rect" coords="181,100,298,124" alt="">
<area href="classXSECURIResolver.html" shape="rect" coords="218,190,354,214" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXENCEncryptedKey-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface definition for the EncryptedKey object.
<p>
The <EncryptedKey> element is an abstract type which builds on the EncryptedType element for encrypted data (as opposed to encrypted data).<p>
In general, this class should not be used directly. For most applications, callers will want to use the <a class="el" href="classXENCCipher.html">XENCCipher</a> class instead.<p>
The schema definition for EncryptedKey is as follows:<p>
<div class="fragment"><pre class="fragment"> <element name='EncryptedKey' type='xenc:EncryptedKeyType'/>
<complexType name='EncryptedKeyType'>
<complexContent>
<extension base='xenc:EncryptedType'>
<sequence>
<element ref='xenc:ReferenceList' minOccurs='0'/>
<element name='CarriedKeyName' type='string' minOccurs='0'/>
</sequence>
<attribute name='Recipient' type='string' use='optional'/>
</extension>
</complexContent>
</complexType>
</pre></div>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Constructors and Destructors</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedKey.html#z249_0">~XENCEncryptedKey</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedKey.html#z249_1">XENCEncryptedKey</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">EncryptedKey Specific Getter Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedKey.html#z250_0">getCarriedKeyName</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the CarriedKeyName. <a href="#z250_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="classXENCEncryptedKey.html#z250_1">getRecipient</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Recipient name. <a href="#z250_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">EncryptedKey Specific Setter 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="classXENCEncryptedKey.html#z251_0">setCarriedKeyName</a> (const XMLCh *name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the CarriedKeyName. <a href="#z251_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="classXENCEncryptedKey.html#z251_1">setRecipient</a> (const XMLCh *recipient)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Recipient name. <a href="#z251_1"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z249_1" doxytag="XENCEncryptedKey::XENCEncryptedKey"></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">XENCEncryptedKey::XENCEncryptedKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>env</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</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="z249_0" doxytag="XENCEncryptedKey::~XENCEncryptedKey"></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 XENCEncryptedKey::~XENCEncryptedKey </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="z250_0" doxytag="XENCEncryptedKey::getCarriedKeyName"></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* XENCEncryptedKey::getCarriedKeyName </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> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the CarriedKeyName.
<p>
EncryptedKey elements MAY have a CarriedKeyName element that links the EncryptedKey to a KeyName KeyInfo element in another EncryptedKey or EncryptedData element.<p>
This method allows applications to retrieve the Carried Key Name for the particular EncryptedKey<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer (owned by the library) to the CarriedKeyName string (or NULL if none) </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z250_1" doxytag="XENCEncryptedKey::getRecipient"></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* XENCEncryptedKey::getRecipient </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> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the Recipient name.
<p>
EncryptedKey elements MAY have a Recipient Attribute on the main EncryptedKey element that provide a hint to the application as to who the recipient of the key is.<p>
This method returns this string in cases where it has been provided<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer (owned by the library) to the Recipient string (or NULL if none provided). </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z251_0" doxytag="XENCEncryptedKey::setCarriedKeyName"></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 XENCEncryptedKey::setCarriedKeyName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>name</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>
Set the CarriedKeyName.
<p>
EncryptedKey elements MAY have a CarriedKeyName element that links the EncryptedKey to a KeyName KeyInfo element in another EncryptedKey or EncryptedData element.<p>
This method allows applications to set the Carried Key Name for the particular EncryptedKey<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>name</em> </td><td>String to set in the CarriedKeyName element </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z251_1" doxytag="XENCEncryptedKey::setRecipient"></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 XENCEncryptedKey::setRecipient </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>recipient</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>
Set the Recipient name.
<p>
EncryptedKey elements MAY have a Recipient Attribute on the main EncryptedKey element that provide a hint to the application as to who the recipient of the key is.<p>
This method sets the Recipient string<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>recipient</em> </td><td>String to set in the Recipient attribute </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="XENCEncryptedKey_8hpp-source.html">XENCEncryptedKey.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:43:59 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>
|
