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
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
|
<!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: XENCEncryptedType 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>XENCEncryptedType Class Reference<br>
<small>
[<a class="el" href="group__xenc.html">XML Encryption Implementation</a>]</small>
</h1><code>#include <<a class="el" href="XENCEncryptedType_8hpp-source.html">XENCEncryptedType.hpp</a>></code>
<p>
Inheritance diagram for XENCEncryptedType:<p><center><img src="classXENCEncryptedType__inherit__graph.png" border="0" usemap="#XENCEncryptedType__inherit__map" alt="Inheritance graph"></center>
<map name="XENCEncryptedType__inherit__map">
<area href="classXENCEncryptedData.html" shape="rect" coords="7,83,157,107" alt="">
<area href="classXENCEncryptedKey.html" shape="rect" coords="181,83,325,107" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXENCEncryptedType-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface definition for the EncryptedType object.
<p>
The <EncryptedType> element is an abstract type on which EncryptedData and EncryptedKey objects are built.<p>
This is the base class on which most of the XML Encryption standard is built. Using classes derived from this, calling programs can decrypt the content, determine KeyInfo references etc.<p>
In general derived objects should not be used directly. The <a class="el" href="classXENCCipher.html">XENCCipher</a> class should be used to operate on them.<p>
The schema definition for EncryptedType is as follows :<p>
<div class="fragment"><pre class="fragment"> <complexType name='EncryptedType' abstract='true'>
<sequence>
<element name='EncryptionMethod' type='xenc:EncryptionMethodType'
minOccurs='0'/>
<element ref='ds:KeyInfo' minOccurs='0'/>
<element ref='xenc:CipherData'/>
<element ref='xenc:EncryptionProperties' minOccurs='0'/>
</sequence>
<attribute name='Id' type='ID' use='optional'/>
<attribute name='Type' type='anyURI' use='optional'/>
<attribute name='MimeType' type='string' use='optional'/>
<attribute name='Encoding' type='anyURI' use='optional'/>
</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="classXENCEncryptedType.html#z252_0">~XENCEncryptedType</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedType.html#z252_1">XENCEncryptedType</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Basic Interface Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCCipherData.html">XENCCipherData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedType.html#z253_0">getCipherData</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the CipherData element. <a href="#z253_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCEncryptionMethod.html">XENCEncryptionMethod</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedType.html#z253_1">getEncryptionMethod</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the EncryptionMethod element. <a href="#z253_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedType.html#z253_2">getElement</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the DOM Element Node of this structure. <a href="#z253_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Getter interface 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="classXENCEncryptedType.html#z254_0">getType</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Type URI for the EncryptedType. <a href="#z254_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="classXENCEncryptedType.html#z254_1">getMimeType</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the MimeType of the EncryptedType. <a href="#z254_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="classXENCEncryptedType.html#z254_2">getEncoding</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Encoding of the EncryptedType. <a href="#z254_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Setter 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="classXENCEncryptedType.html#z255_0">setType</a> (const XMLCh *uri)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Type URI for the EncryptedType. <a href="#z255_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="classXENCEncryptedType.html#z255_1">setMimeType</a> (const XMLCh *mimeType)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the MimeType of the EncryptedType. <a href="#z255_1"></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="classXENCEncryptedType.html#z255_2">setEncoding</a> (const XMLCh *uri)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Encoding of the EncryptedType. <a href="#z255_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">KeyInfo Element Manipulation</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGKeyInfoList.html">DSIGKeyInfoList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedType.html#z256_0">getKeyInfoList</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the list of <KeyInfo> elements. <a href="#z256_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="classXENCEncryptedType.html#z256_1">clearKeyInfo</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear out all KeyInfo elements in the signature. <a href="#z256_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGKeyInfoValue.html">DSIGKeyInfoValue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedType.html#z256_2">appendDSAKeyValue</a> (const XMLCh *P, const XMLCh *Q, const XMLCh *G, const XMLCh *Y)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a DSA KeyValue element. <a href="#z256_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGKeyInfoValue.html">DSIGKeyInfoValue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedType.html#z256_3">appendRSAKeyValue</a> (const XMLCh *modulus, const XMLCh *exponent)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a RSA KeyValue element. <a href="#z256_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGKeyInfoX509.html">DSIGKeyInfoX509</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedType.html#z256_4">appendX509Data</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a X509Data element. <a href="#z256_4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDSIGKeyInfoName.html">DSIGKeyInfoName</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCEncryptedType.html#z256_5">appendKeyName</a> (const XMLCh *name, bool isDName=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a KeyName element. <a href="#z256_5"></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="classXENCEncryptedType.html#z256_6">appendEncryptedKey</a> (<a class="el" href="classXENCEncryptedKey.html">XENCEncryptedKey</a> *encryptedKey)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append an already created EncryptedKey. <a href="#z256_6"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z252_1" doxytag="XENCEncryptedType::XENCEncryptedType"></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">XENCEncryptedType::XENCEncryptedType </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, 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="z252_0" doxytag="XENCEncryptedType::~XENCEncryptedType"></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 XENCEncryptedType::~XENCEncryptedType </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="z256_2" doxytag="XENCEncryptedType::appendDSAKeyValue"></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="classDSIGKeyInfoValue.html">DSIGKeyInfoValue</a>* XENCEncryptedType::appendDSAKeyValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>P</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>Q</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>G</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>Y</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>
Append a DSA KeyValue element.
<p>
Add a new KeyInfo element for a DSA Value<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>P</em> </td><td>Base64 encoded value of P </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Q</em> </td><td>Base64 encoded value of Q </td></tr>
<tr><td valign="top"></td><td valign="top"><em>G</em> </td><td>Base64 encoded value of G </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Y</em> </td><td>Base64 encoded value of Y </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z256_6" doxytag="XENCEncryptedType::appendEncryptedKey"></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 XENCEncryptedType::appendEncryptedKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classXENCEncryptedKey.html">XENCEncryptedKey</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>encryptedKey</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>
Append an already created EncryptedKey.
<p>
Add an already created EncryptedKey.<p>
<dl compact><dt><b>Note:</b></dt><dd>The encryptedKey becomes the property of the owning EncryptedType object and will be deleted upon its destruction.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>encryptedKey</em> </td><td>A pointer to the encrypted Key </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z256_5" doxytag="XENCEncryptedType::appendKeyName"></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="classDSIGKeyInfoName.html">DSIGKeyInfoName</a>* XENCEncryptedType::appendKeyName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>isDName</em> = <code>false</code></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>
Append a KeyName element.
<p>
Add a new KeyInfo element for a key name.<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>The name of the key to set in the XML </td></tr>
<tr><td valign="top"></td><td valign="top"><em>isDName</em> </td><td>Treat the name as a Distinguished name and encode accordingly </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z256_3" doxytag="XENCEncryptedType::appendRSAKeyValue"></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="classDSIGKeyInfoValue.html">DSIGKeyInfoValue</a>* XENCEncryptedType::appendRSAKeyValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>modulus</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const XMLCh * </td>
<td class="mdname" nowrap> <em>exponent</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>
Append a RSA KeyValue element.
<p>
Add a new KeyInfo element for a RSA Value<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>modulus</em> </td><td>Base64 encoded value of the modulus </td></tr>
<tr><td valign="top"></td><td valign="top"><em>exponent</em> </td><td>Base64 encoded value of exponent </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z256_4" doxytag="XENCEncryptedType::appendX509Data"></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="classDSIGKeyInfoX509.html">DSIGKeyInfoX509</a>* XENCEncryptedType::appendX509Data </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>
Append a X509Data element.
<p>
Add a new KeyInfo element for X509 data.<p>
<dl compact><dt><b>Note:</b></dt><dd>The added element is empty. The caller must make use of the returned object to set the required values.</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created object. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z256_1" doxytag="XENCEncryptedType::clearKeyInfo"></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 XENCEncryptedType::clearKeyInfo </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>
Clear out all KeyInfo elements in the signature.
<p>
This function will delete all KeyInfo elements from both the EncryptedType object <em>and the associated DOM</em>. </td>
</tr>
</table>
<a class="anchor" name="z253_0" doxytag="XENCEncryptedType::getCipherData"></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="classXENCCipherData.html">XENCCipherData</a>* XENCEncryptedType::getCipherData </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>
Retrieve the CipherData element.
<p>
CipherData elements are the sub part of the EncryptedData that hold the actual enciphered information.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The CipherData object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z253_2" doxytag="XENCEncryptedType::getElement"></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 XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* XENCEncryptedType::getElement </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 DOM Element Node of this structure.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the DOM Element Node representing the <EncryptionType> element </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z254_2" doxytag="XENCEncryptedType::getEncoding"></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* XENCEncryptedType::getEncoding </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 Encoding of the EncryptedType.
<p>
If this object is an EncryptedData, it <em>may</em> have an encoding attribute that describes how the data has been encoded prior to encryption. (E.g. <a href="http://www.w3.org/2000/09/xmldsig#base64">http://www.w3.org/2000/09/xmldsig#base64</a>)<p>
The XML-Security-C library makes no use of this attribute, but it provides these functions to allow applications to set and get.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A string (owned by the library) providing the encoding URI </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z253_1" doxytag="XENCEncryptedType::getEncryptionMethod"></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="classXENCEncryptionMethod.html">XENCEncryptionMethod</a>* XENCEncryptedType::getEncryptionMethod </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>
Retrieve the EncryptionMethod element.
<p>
The EncryptionMethod element holds information about the encryption algorithm to be used to encrypt/decrypt the data<p>
This method provides a means to extract the EncryptionMethod element from the EncryptedType<p>
<dl compact><dt><b>Returns:</b></dt><dd>The EncryptionMethod element </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z256_0" doxytag="XENCEncryptedType::getKeyInfoList"></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="classDSIGKeyInfoList.html">DSIGKeyInfoList</a>* XENCEncryptedType::getKeyInfoList </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>
Get the list of <KeyInfo> elements.
<p>
This function recovers list that contains the KeyInfo elements read in from the DOM document.<p>
This list should be used by calling applications to determine what key is appropriate for decrypting the document.<p>
<dl compact><dt><b>Note:</b></dt><dd>The list should never be modified directly. If you need to add keyInfo elements, call the appropriate functions in EncryptedType</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the <a class="el" href="classDSIGKeyInfoList.html">DSIGKeyInfoList</a> object held by the <a class="el" href="classXENCCipher.html">XENCCipher</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z254_1" doxytag="XENCEncryptedType::getMimeType"></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* XENCEncryptedType::getMimeType </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 MimeType of the EncryptedType.
<p>
If this object is an EncryptedData, it <em>may</em> have a MimeType attribute that "describes the media type of the data which has been encrypted" (from the XML Encryption spec).<p>
The XML-Security-C library makes no use of this attribute, but it provides these functions to allow applications to set and get.<p>
<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the MimeType string (owned by the library) or NULL if no MimeType is set </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z254_0" doxytag="XENCEncryptedType::getType"></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* XENCEncryptedType::getType </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 Type URI for the EncryptedType.
<p>
If this object is an EncryptedData, it <em>may</em> have a Type attribute that defines whether it is an encrypted Element or Element Content. This method allows the caller to see this type URI.<p>
<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the URI string (owned by the library) or NULL if no type is set </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z255_2" doxytag="XENCEncryptedType::setEncoding"></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 XENCEncryptedType::setEncoding </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>uri</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 Encoding of the EncryptedType.
<p>
If this object is an EncryptedData, it <em>may</em> have an encoding attribute that describes how the data has been encoded prior to encryption. (E.g. <a href="http://www.w3.org/2000/09/xmldsig#base64">http://www.w3.org/2000/09/xmldsig#base64</a>)<p>
The XML-Security-C library makes no use of this attribute, but it provides these functions to allow applications to set and get.<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>uri</em> </td><td>String (URI) to set in the Encoding attribute. </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>no checking of this string is done by the library - it simply sets the value of the Encoding attribute to this value. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z255_1" doxytag="XENCEncryptedType::setMimeType"></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 XENCEncryptedType::setMimeType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>mimeType</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 MimeType of the EncryptedType.
<p>
If this object is an EncryptedData, it <em>may</em> have a MimeType attribute that "describes the media type of the data which has been encrypted" (from the XML Encryption spec).<p>
The XML-Security-C library makes no use of this attribute, but it provides these functions to allow applications to set and get.<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>mimeType</em> </td><td>String to set in the MimeType attribute. </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>no checking of this string is done by the library - it simply sets the value of the MimeType attribute to this value. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z255_0" doxytag="XENCEncryptedType::setType"></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 XENCEncryptedType::setType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>uri</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 Type URI for the EncryptedType.
<p>
Allows a calling application to set a particular Type URI for the EncryptedType.<p>
<dl compact><dt><b>Note:</b></dt><dd>calls to encryptElement and encryptElementContent automatically set the appropriate Type URI.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uri</em> </td><td>The URI to set </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="XENCEncryptedType_8hpp-source.html">XENCEncryptedType.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:44:00 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>
|
