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
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
|
<!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: XENCCipher 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>XENCCipher Class Reference</h1><code>#include <<a class="el" href="XENCCipher_8hpp-source.html">XENCCipher.hpp</a>></code>
<p>
<a href="classXENCCipher-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Main worker class for the XSEC implementation of XML Encryption.
<p>
The XENCCipher class not something that is directly defined in the XML Encryption standard. It is a control class used by the library to generate encrypted XML information and to decrypt information held in XML Encryption structures.<p>
All encryption and decryption work performed by the library is handled within this class. The other XENC classes simply handle marshalling and unmarshalling of the DOM data.
<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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z233_0">~XENCCipher</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">Decryption Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMDocument * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z234_0">decryptElement</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *element)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrypt the nominated element. <a href="#z234_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXSECBinTXFMInputStream.html">XSECBinTXFMInputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z234_1">decryptToBinInputStream</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *element)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrypt the nominated element and put the output to an InputStream. <a href="#z234_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z234_2">decryptKey</a> (<a class="el" href="classXENCEncryptedKey.html">XENCEncryptedKey</a> *encryptedKey, XMLByte *rawKey, int maxKeySize)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrypt a key. <a href="#z234_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z234_3">decryptKey</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *keyNode, XMLByte *rawKey, int maxKeySize)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrypt a key directly from DOM. <a href="#z234_3"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Encryption Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMDocument * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z235_0">encryptElement</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *element, <a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> em, const XMLCh *algorithmURI=NULL)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encrypt the nominated element. <a href="#z235_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMDocument * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z235_1">encryptElementContent</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *element, <a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> em, const XMLCh *algorithmURI=NULL)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encrypt the children of the nominated element. <a href="#z235_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCEncryptedKey.html">XENCEncryptedKey</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z235_2">encryptKey</a> (const unsigned char *keyBuffer, unsigned int keyLen, <a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> em, const XMLCh *algorithmURI=NULL)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encrypt a buffer of data as a key. <a href="#z235_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCEncryptedData.html">XENCEncryptedData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z235_3">encryptBinInputStream</a> (XERCES_CPP_NAMESPACE_QUALIFIER BinInputStream *plainText, <a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> em, const XMLCh *algorithmURI=NULL)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encrypt an input stream to a CipherValue. <a href="#z235_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCEncryptedData.html">XENCEncryptedData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z235_4">encryptTXFMChain</a> (<a class="el" href="classTXFMChain.html">TXFMChain</a> *plainText, <a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> em, const XMLCh *algorithmURI=NULL)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encrypt a <a class="el" href="classTXFMChain.html">TXFMChain</a> to a CipherValue. <a href="#z235_4"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Getter Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMDocument * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z236_0">getDocument</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get owning document. <a href="#z236_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="classXENCCipher.html#z236_1">getXENCNSPrefix</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get namespace prefix for XENC nodes. <a href="#z236_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCEncryptedData.html">XENCEncryptedData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z236_2">getEncryptedData</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the EncryptedData element. <a href="#z236_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z236_3">getPrettyPrint</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell caller whether PrettyPrinting is active. <a href="#z236_3"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Setter 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="classXENCCipher.html#z237_0">setKey</a> (<a class="el" href="classXSECCryptoKey.html">XSECCryptoKey</a> *key)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set decryption key for next operation. <a href="#z237_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="classXENCCipher.html#z237_1">setKEK</a> (<a class="el" href="classXSECCryptoKey.html">XSECCryptoKey</a> *key)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set Key Encryption Key for next operation. <a href="#z237_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="classXENCCipher.html#z237_2">setKeyInfoResolver</a> (const <a class="el" href="classXSECKeyInfoResolver.html">XSECKeyInfoResolver</a> *resolver)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a KeyInfoResolver. <a href="#z237_2"></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="classXENCCipher.html#z237_3">setXENCNSPrefix</a> (const XMLCh *prefix)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set prefix for XENC nodes. <a href="#z237_3"></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="classXENCCipher.html#z237_4">setPrettyPrint</a> (bool flag)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set Pretty Print. <a href="#z237_4"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Creation and loading Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCEncryptedData.html">XENCEncryptedData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z238_0">createEncryptedData</a> (<a class="el" href="classXENCCipherData.html#w3">XENCCipherData::XENCCipherDataType</a> type, const XMLCh *algorithm, const XMLCh *value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new EncryptedData element. <a href="#z238_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXENCEncryptedKey.html">XENCEncryptedKey</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXENCCipher.html#z238_1">loadEncryptedKey</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *keyNode)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load an EncryptedKey element. <a href="#z238_1"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z233_0" doxytag="XENCCipher::~XENCCipher"></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 XENCCipher::~XENCCipher </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="z238_0" doxytag="XENCCipher::createEncryptedData"></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="classXENCEncryptedData.html">XENCEncryptedData</a>* XENCCipher::createEncryptedData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classXENCCipherData.html#w3">XENCCipherData::XENCCipherDataType</a> </td>
<td class="mdname" nowrap> <em>type</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>algorithm</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>value</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>
Create a new EncryptedData element.
<p>
Method for creating a basic Encrypted Data element. Can be used in cases where an application needs to build this from scratch.<p>
In general, applications should use the higher level methods such as <a class="el" href="classXENCCipher.html#z235_0">encryptElement</a> or <a class="el" href="classXENCCipher.html#z235_1">encryptElementContent</a>.<p>
<dl compact><dt><b>Note:</b></dt><dd>The Cipher object will take on this new object as the current EncryptedData and delete any currently being held.</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>type</em> </td><td>Should this set up a CipherReference or a CipherValue </td></tr>
<tr><td valign="top"></td><td valign="top"><em>algorithm</em> </td><td>URI string to use for the Algorithm attribute in EncryptionMethod. Set to NULL for no defined algorithm. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>String to set the cipher data to if the type is VALUE_TYPE. for REFERENCE_TYPE CipherData elements, this should be the URI value. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An <a class="el" href="classXENCEncryptedData.html">XENCEncryptedData</a> object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z234_0" doxytag="XENCCipher::decryptElement"></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 DOMDocument* XENCCipher::decryptElement </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * </td>
<td class="mdname1" valign="top" nowrap> <em>element</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>
Decrypt the nominated element.
<p>
Decrypts the passed in element, which must be the root node of a <EncryptedData> method with a type of "#Element". If not, the library will throw an <a class="el" href="classXSECException.html">XSECException</a> exception.<p>
This is an "all in one method". The library will replace the passed in Element (i.e. the encrypted XML data) with the resultant plain text, after it has been parsed back into DOM nodes<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>element</em> </td><td>Root of EncryptedData DOM structyre to decrypt </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The owning document with the element replaced, or NULL if the decryption fails for some reason (normally an exception). </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXSECException.html">XSECException</a></em> </td><td>if the decryption fails, or if this is not a valid EncryptedData DOM structure. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z234_3" doxytag="XENCCipher::decryptKey"></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 int XENCCipher::decryptKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * </td>
<td class="mdname" nowrap> <em>keyNode</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>XMLByte * </td>
<td class="mdname" nowrap> <em>rawKey</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>maxKeySize</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>
Decrypt a key directly from DOM.
<p>
Loads an EncryptedKey from DOM and then decrypts the key. If a NULL buffer is passed in, will simply load the key and return<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>keyNode</em> </td><td>Node to load from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rawKey</em> </td><td>Buffer to decrypt to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxKeySize</em> </td><td>Length of rawKey buffer </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes decrypted </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z234_2" doxytag="XENCCipher::decryptKey"></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 int XENCCipher::decryptKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classXENCEncryptedKey.html">XENCEncryptedKey</a> * </td>
<td class="mdname" nowrap> <em>encryptedKey</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>XMLByte * </td>
<td class="mdname" nowrap> <em>rawKey</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>maxKeySize</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>
Decrypt a key.
<p>
Reads in the passed in KeyInfo structure for an EncryptedKey and decrypts the key to a 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>encryptedKey</em> </td><td>the already loaded encryptedKey structure </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rawKey</em> </td><td>Buffer to place the decrypted key into </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxKeySize</em> </td><td>Maximum number of bytes to place in the buffer </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z234_1" doxytag="XENCCipher::decryptToBinInputStream"></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="classXSECBinTXFMInputStream.html">XSECBinTXFMInputStream</a>* XENCCipher::decryptToBinInputStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * </td>
<td class="mdname1" valign="top" nowrap> <em>element</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>
Decrypt the nominated element and put the output to an InputStream.
<p>
Decrypts the passed in element, which must be the root node of a <EncryptedData> method.<p>
This call does not change the source DOM in any way. It simply processes the encrypted data and provides an InputStream that the caller can read from to read the plain text 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>element</em> </td><td>Root of EncryptedData DOM structyre to decrypt </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A BinInputStream object that the application can use to read the decrypted data. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXSECException.html">XSECException</a></em> </td><td>if the decryption fails, or if this is not a valid EncryptedData DOM structure. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z235_3" doxytag="XENCCipher::encryptBinInputStream"></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="classXENCEncryptedData.html">XENCEncryptedData</a>* XENCCipher::encryptBinInputStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER BinInputStream * </td>
<td class="mdname" nowrap> <em>plainText</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> </td>
<td class="mdname" nowrap> <em>em</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>algorithmURI</em> = <code>NULL</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>
Encrypt an input stream to a CipherValue.
<p>
Encrypts the data passed in via a Xerces BinInputStream and places it directly into a new EncryptedData element that contains a CipherValue<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>plainText</em> </td><td>The InputStream to read the plain text from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>em</em> </td><td>The encryptionMethod to use for this encryption. Use ENCRYPT_NONE if a user defined type is required. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>algorithmURI</em> </td><td>if ENCRYPT_NONE is used for em, this will be used as the algorithm URI</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the EncryptedData element containing the CipherValue of the data </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z235_0" doxytag="XENCCipher::encryptElement"></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 DOMDocument* XENCCipher::encryptElement </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * </td>
<td class="mdname" nowrap> <em>element</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> </td>
<td class="mdname" nowrap> <em>em</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>algorithmURI</em> = <code>NULL</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>
Encrypt the nominated element.
<p>
Encrypts the passed in element and all children. The element is replaced with an EncryptedData element<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>element</em> </td><td>Element (and children) to encrypt </td></tr>
<tr><td valign="top"></td><td valign="top"><em>em</em> </td><td>The encryptionMethod to use for this encryption. Use ENCRYPT_NONE if a user defined type is required. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>algorithmURI</em> </td><td>If ENCRYPT_NONE is passed in, this will be used to set the algorithm URI. If this is also NULL - no EncryptionMethod will be set. <b>NULL Value Unsupported if em not set! It's use could cause problems!</b></td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The owning document with the element replaced, or NULL if the decryption fails for some reason (normally an exception). </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXSECException.html">XSECException</a></em> </td><td>if the encryption fails. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z235_1" doxytag="XENCCipher::encryptElementContent"></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 DOMDocument* XENCCipher::encryptElementContent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * </td>
<td class="mdname" nowrap> <em>element</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> </td>
<td class="mdname" nowrap> <em>em</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>algorithmURI</em> = <code>NULL</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>
Encrypt the children of the nominated element.
<p>
Encrypts the all children of the passed in element, but leaves the element itself in place, with one new child - an EncryptedData node of type #content<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>element</em> </td><td>Element whose children are to be encrypted </td></tr>
<tr><td valign="top"></td><td valign="top"><em>em</em> </td><td>The encryptionMethod to use for this encryption. Use ENCRYPT_NONE if a user defined type is required. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>algorithmURI</em> </td><td>If ENCRYPT_NONE is passed in, this will be used to set the algorithm URI. If this is also NULL - no EncryptionMethod will be set. <b>NULL Value Unsupported if em not set! It's use could cause problems!</b></td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The owning document with the element's children replaced, or NULL if the decryption fails for some reason (normally an exception). </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXSECException.html">XSECException</a></em> </td><td>if the encryption fails. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z235_2" doxytag="XENCCipher::encryptKey"></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="classXENCEncryptedKey.html">XENCEncryptedKey</a>* XENCCipher::encryptKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const unsigned char * </td>
<td class="mdname" nowrap> <em>keyBuffer</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>keyLen</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> </td>
<td class="mdname" nowrap> <em>em</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>algorithmURI</em> = <code>NULL</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>
Encrypt a buffer of data as a key.
<p>
Encrypts the passed in data and creates an EncryptedKey element<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>keyBuffer</em> </td><td>The key data to encrypt </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keyLen</em> </td><td>Bytes to encrypt </td></tr>
<tr><td valign="top"></td><td valign="top"><em>em</em> </td><td>The encryptionMethod to use for this encryption. Use ENCRYPT_NONE if a user defined type is required. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>algorithmURI</em> </td><td>If ENCRYPT_NONE is used for em, this will be used as the algorithm URI.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The EncryptedKey element </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z235_4" doxytag="XENCCipher::encryptTXFMChain"></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="classXENCEncryptedData.html">XENCEncryptedData</a>* XENCCipher::encryptTXFMChain </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classTXFMChain.html">TXFMChain</a> * </td>
<td class="mdname" nowrap> <em>plainText</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="DSIGConstants_8hpp.html#a107">encryptionMethod</a> </td>
<td class="mdname" nowrap> <em>em</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>algorithmURI</em> = <code>NULL</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>
Encrypt a <a class="el" href="classTXFMChain.html">TXFMChain</a> to a CipherValue.
<p>
Encrypts the data passed in via a <a class="el" href="classTXFMChain.html">TXFMChain</a> and places it directly into a new EncryptedData element that contains a CipherValue.<p>
<dl compact><dt><b>Note:</b></dt><dd>This is not really intended for client apps, but is used internally and is provided for flexibility. The "formal" method is encryptBinInputStream</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>plainText</em> </td><td>The <a class="el" href="classTXFMChain.html">TXFMChain</a> to read the plain text from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>em</em> </td><td>The encryptionMethod to use for this encryption. Use ENCRYPT_NONE if a user defined type is required. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>algorithmURI</em> </td><td>if ENCRYPT_NONE is used for em, this will be used as the algorithm URI</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the EncryptedData element containing the CipherValue of the data </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z236_0" doxytag="XENCCipher::getDocument"></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 DOMDocument* XENCCipher::getDocument </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 owning document.
<p>
Every Cipher object is associated with an owning document (for generation of nodes etc.) This allows callers to retrieve this value.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The DOMDocument that is used by this object </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z236_2" doxytag="XENCCipher::getEncryptedData"></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="classXENCEncryptedData.html">XENCEncryptedData</a>* XENCCipher::getEncryptedData </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 EncryptedData element.
<p>
Allows the user to get the EncryptedData element that was last processed/ created by this XENCCipher object.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The last used EncryptedData </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z236_3" doxytag="XENCCipher::getPrettyPrint"></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 bool XENCCipher::getPrettyPrint </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>
Tell caller whether PrettyPrinting is active.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>True if Pretty Printing is active, false if not </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z236_1" doxytag="XENCCipher::getXENCNSPrefix"></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* XENCCipher::getXENCNSPrefix </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 namespace prefix for XENC nodes.
<p>
Find the string being used by the library to prefix nodes in the xenc: namespace.<p>
<dl compact><dt><b>Returns:</b></dt><dd>XENC namespace prefix </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z238_1" doxytag="XENCCipher::loadEncryptedKey"></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="classXENCEncryptedKey.html">XENCEncryptedKey</a>* XENCCipher::loadEncryptedKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMElement * </td>
<td class="mdname1" valign="top" nowrap> <em>keyNode</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>
Load an EncryptedKey element.
<p>
Take a passed in EncryptedKey DOMNode and return a loaded <a class="el" href="classXENCEncryptedKey.html">XENCEncryptedKey</a> object based on the DOMNode from the passed in element.<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>keyNode</em> </td><td>Element node to load EncryptedKey from </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An <a class="el" href="classXENCEncryptedKey.html">XENCEncryptedKey</a> structure (owned by the caller) based on the node. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z237_1" doxytag="XENCCipher::setKEK"></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 XENCCipher::setKEK </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>
Set Key Encryption Key for next operation.
<p>
Set the passed in key for the next key decryption/encryption operation.<p>
<dl compact><dt><b>Note:</b></dt><dd>This key will only be used to decrypt EncryptedKey elements. To set a key for decrypting an EncryptedData use <a class="el" href="classXENCCipher.html#z237_0">setKey</a> instead.</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>key</em> </td><td>Key to use </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>This function will take ownership of the key and delete it when done. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z237_0" doxytag="XENCCipher::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 XENCCipher::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>
Set decryption key for next operation.
<p>
Set the passed in key for the next decryption/encryption operation.<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>Key to use </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>This function will take ownership of the key and delete it when done. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z237_2" doxytag="XENCCipher::setKeyInfoResolver"></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 XENCCipher::setKeyInfoResolver </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classXSECKeyInfoResolver.html">XSECKeyInfoResolver</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>resolver</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>
Register a KeyInfoResolver.
<p>
Registers a KeyInfoResolver to be used by the cipher when it needs to find a key to be used to decrypt some ciper text<p>
<dl compact><dt><b>Note:</b></dt><dd>The library will use the #clone() function from the resolver to get a copy. The passed in resolver remains the property of the calling function</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>resolver</em> </td><td>Resolver to clone and use for resolving keys </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z237_4" doxytag="XENCCipher::setPrettyPrint"></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 XENCCipher::setPrettyPrint </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>flag</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 Pretty Print.
<p>
The pretty print functions controls whether the library will output CR/LF after the elements it adds to a document<p>
By default the library will do pretty printing (flag is true)<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>flag</em> </td><td>Value to set for Pretty Printing (true = do pretty printing) </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z237_3" doxytag="XENCCipher::setXENCNSPrefix"></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 XENCCipher::setXENCNSPrefix </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname1" valign="top" nowrap> <em>prefix</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 prefix for XENC nodes.
<p>
Set the namespace prefix the library will use when creating nodes in the XENC namespace </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XENCCipher_8hpp-source.html">XENCCipher.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:43:52 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>
|
