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
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
|
<!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: DSIGReference 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>DSIGReference Class Reference<br>
<small>
[<a class="el" href="group__pubsig.html">Main Signature API</a>]</small>
</h1><code>#include <<a class="el" href="DSIGReference_8hpp-source.html">DSIGReference.hpp</a>></code>
<p>
Collaboration diagram for DSIGReference:<p><center><img src="classDSIGReference__coll__graph.png" border="0" usemap="#DSIGReference__coll__map" alt="Collaboration graph"></center>
<map name="DSIGReference__coll__map">
<area href="classDSIGTransformList.html" shape="rect" coords="8,372,144,396" alt="">
<area href="classXSECSafeBufferFormatter.html" shape="rect" coords="241,190,422,214" alt="">
<area href="classXSECEnv.html" shape="rect" coords="624,281,706,305" alt="">
<area href="classXSECNameSpaceExpander.html" shape="rect" coords="237,281,426,305" alt="">
<area href="classsafeBuffer.html" shape="rect" coords="318,9,401,33" alt="">
<area href="classsbFormatTarget.html" shape="rect" coords="409,100,526,124" alt="">
<area href="classXSECURIResolver.html" shape="rect" coords="597,190,733,214" alt="">
<area href="classTXFMBase.html" shape="rect" coords="333,372,421,396" alt="">
<area href="classXSECXPathNodeList.html" shape="rect" coords="450,281,600,305" alt="">
<area href="classDSIGReferenceList.html" shape="rect" coords="669,372,805,396" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDSIGReference-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
The class used for manipulating Reference Elements within a signature.
<p>
The DSIGReference class creates and manipulates (including hashing and validating) <Reference> elements.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z35_0">DSIGReference</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *dom)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contructor for use with existing XML signatures or templates. <a href="#z35_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z35_1">DSIGReference</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contructor for use when creating new Reference structures. <a href="#z35_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z35_2">~DSIGReference</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z35_2"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Reference Construction and Manipulation</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z36_0">load</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a DSIGReference from an existing DOM structure. <a href="#z36_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">XERCES_CPP_NAMESPACE_QUALIFIER <br>
DOMElement * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z36_1">createBlankReference</a> (const XMLCh *URI, <a class="el" href="DSIGConstants_8hpp.html#a104">hashMethod</a> hm, char *type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a Reference structure in the document. <a href="#z36_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGTransformEnvelope.html">DSIGTransformEnvelope</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z36_2">appendEnvelopedSignatureTransform</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append an Enveloped Signature Transform to the Reference. <a href="#z36_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGTransformBase64.html">DSIGTransformBase64</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z36_3">appendBase64Transform</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a Base64 Transform to the Reference. <a href="#z36_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGTransformXPath.html">DSIGTransformXPath</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z36_4">appendXPathTransform</a> (const char *expr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append an XPath Transform to the Reference. <a href="#z36_4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGTransformXPathFilter.html">DSIGTransformXPathFilter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z36_5">appendXPathFilterTransform</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append an XPath-Filter2 Transform to the Reference. <a href="#z36_5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGTransformXSL.html">DSIGTransformXSL</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z36_6">appendXSLTransform</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *stylesheet)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append an XSLT Transform to the Reference. <a href="#z36_6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGTransformC14n.html">DSIGTransformC14n</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z36_7">appendCanonicalizationTransform</a> (<a class="el" href="DSIGConstants_8hpp.html#a102">canonicalizationMethod</a> cm)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a Canonicalization Transform to the Reference. <a href="#z36_7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z36_8">setPreHashTXFM</a> (<a class="el" href="classTXFMBase.html">TXFMBase</a> *t)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a "debug" transformer. <a href="#z36_8"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Getting Information</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXSECBinTXFMInputStream.html">XSECBinTXFMInputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z37_0">makeBinInputStream</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an input stream based on the digested byte stream. <a href="#z37_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z37_1">getURI</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the URI string of the Reference. <a href="#z37_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="DSIGConstants_8hpp.html#a104">hashMethod</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z37_2">getHashMethod</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Digest method. <a href="#z37_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z37_3">getTransforms</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the transforms for this reference. <a href="#z37_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z37_4">isManifest</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine whether the reference is a manifest. <a href="#z37_4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classDSIGReferenceList.html">DSIGReferenceList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z37_5">getManifestReferenceList</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Manifest. <a href="#z37_5"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Message Digest/Hash manipulation</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z38_0">calculateHash</a> (XMLByte *toFill, unsigned int maxToFill)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate the Hash value of a reference. <a href="#z38_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z38_1">readHash</a> (XMLByte *toFill, unsigned int maxToFill)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the hash from the Reference element. <a href="#z38_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z38_2">checkHash</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Validate the Reference element. <a href="#z38_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z38_3">setHash</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of the hash in the Reference. <a href="#z38_3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Helper (static) Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTXFMChain.html">TXFMChain</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z39_0">createTXFMChainFromList</a> (<a class="el" href="classTXFMBase.html">TXFMBase</a> *input, <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> *lst)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a Transformer chain. <a href="#z39_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z39_1">loadTransforms</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *transformsNode, <a class="el" href="classXSECSafeBufferFormatter.html">XSECSafeBufferFormatter</a> *formatter, const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a Transforms list from the <Transforms> DOMNode. <a href="#z39_1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classTXFMBase.html">TXFMBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z39_2">getURIBaseTXFM</a> (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *doc, const XMLCh *URI, const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a starting point for a TXFM Chain. <a href="#z39_2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classDSIGReferenceList.html">DSIGReferenceList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z39_3">loadReferenceListFromXML</a> (const <a class="el" href="classXSECEnv.html">XSECEnv</a> *env, XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *firstReference)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a series of references. <a href="#z39_3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z39_4">verifyReferenceList</a> (<a class="el" href="classDSIGReferenceList.html">DSIGReferenceList</a> *lst, <a class="el" href="classsafeBuffer.html">safeBuffer</a> &errorStr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Validate a list of references. <a href="#z39_4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDSIGReference.html#z39_5">hashReferenceList</a> (<a class="el" href="classDSIGReferenceList.html">DSIGReferenceList</a> *list, bool interlocking=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hash a reference list. <a href="#z39_5"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z35_0" doxytag="DSIGReference::DSIGReference"></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">DSIGReference::DSIGReference </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="mdname" nowrap> <em>env</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname" nowrap> <em>dom</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Contructor for use with existing XML signatures or templates.
<p>
Create a DSIGReference object based on an already existing DSIG Reference XML node. It is assumed that the underlying DOM structure is in place and works correctly.<p>
<dl compact><dt><b>Note:</b></dt><dd>DSIGReference structures should only ever be created via calls to a <a class="el" href="classDSIGSignature.html">DSIGSignature</a> object.</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>env</em> </td><td>The operating environment in which the Reference is operating </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dom</em> </td><td>The DOM node (within doc) that is to be used as the base of the reference. </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classDSIGReference.html#z36_0">load</a> <p>
<a class="el" href="classDSIGSignature.html#z45_6">DSIGSignature::createReference</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z35_1" doxytag="DSIGReference::DSIGReference"></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">DSIGReference::DSIGReference </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></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Contructor for use when creating new Reference structures.
<p>
Create a DSIGReference object that can later be used to create a new Reference structure in the DOM document.<p>
<dl compact><dt><b>Note:</b></dt><dd>DSIGReference structures should only ever be created via calls to a <a class="el" href="classDSIGSignature.html">DSIGSignature</a> object.</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>env</em> </td><td>The environment object for this reference. </td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classDSIGReference.html#z36_0">load</a> <p>
<a class="el" href="classDSIGSignature.html#z45_6">DSIGSignature::createReference</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z35_2" doxytag="DSIGReference::~DSIGReference"></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">DSIGReference::~DSIGReference </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destructor.
<p>
<dl compact><dt><b>Note:</b></dt><dd>Does not impact any created DOM structures when destroyed.<p>
DSIGReferences should <em>never</em> be destroyed/deleted by applications. They are owned and managed by <a class="el" href="classDSIGSignature.html">DSIGSignature</a> structures. </dd></dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z36_3" doxytag="DSIGReference::appendBase64Transform"></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"><a class="el" href="classDSIGTransformBase64.html">DSIGTransformBase64</a>* DSIGReference::appendBase64Transform </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a Base64 Transform to the Reference.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The newly created Base64 transform. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z36_7" doxytag="DSIGReference::appendCanonicalizationTransform"></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"><a class="el" href="classDSIGTransformC14n.html">DSIGTransformC14n</a>* DSIGReference::appendCanonicalizationTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="DSIGConstants_8hpp.html#a102">canonicalizationMethod</a> </td>
<td class="mdname1" valign="top" nowrap> <em>cm</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a Canonicalization Transform to the Reference.
<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>cm</em> </td><td>The type of canonicalisation to be added. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The newly create canonicalisation transform </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z36_2" doxytag="DSIGReference::appendEnvelopedSignatureTransform"></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"><a class="el" href="classDSIGTransformEnvelope.html">DSIGTransformEnvelope</a>* DSIGReference::appendEnvelopedSignatureTransform </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append an Enveloped Signature Transform to the Reference.
<p>
Appends a simple enveloped-signature transform to the list of transforms in this element.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The newly created envelope transform. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z36_5" doxytag="DSIGReference::appendXPathFilterTransform"></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"><a class="el" href="classDSIGTransformXPathFilter.html">DSIGTransformXPathFilter</a>* DSIGReference::appendXPathFilterTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append an XPath-Filter2 Transform to the Reference.
<p>
The returned <a class="el" href="classDSIGTransformXPathFilter.html">DSIGTransformXPathFilter</a> will have no actual filter expressions loaded, but calls can be made to DSIGTransformXPathFilter::appendTransform to add them.<p>
<dl compact><dt><b>Returns:</b></dt><dd>The newly created XPath Filter transform </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z36_4" doxytag="DSIGReference::appendXPathTransform"></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"><a class="el" href="classDSIGTransformXPath.html">DSIGTransformXPath</a>* DSIGReference::appendXPathTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>expr</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append an XPath Transform to the Reference.
<p>
Append an XPath transform. Namespaces can be added to the transform directly using the returned <em><a class="el" href="classDSIGTransformXPath.html">DSIGTransformXPath</a></em> structure<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>expr</em> </td><td>The XPath expression to be placed in the transform. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The newly created XPath transform </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z36_6" doxytag="DSIGReference::appendXSLTransform"></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"><a class="el" href="classDSIGTransformXSL.html">DSIGTransformXSL</a>* DSIGReference::appendXSLTransform </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname1" valign="top" nowrap> <em>stylesheet</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append an XSLT Transform to the Reference.
<p>
The caller must have already create the stylesheet and turned it into a DOM structure that is passed in as the stylesheet parameter.<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>stylesheet</em> </td><td>The stylesheet DOM structure to be placed in the reference. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The newly create XSLT transform </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z38_0" doxytag="DSIGReference::calculateHash"></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">unsigned int DSIGReference::calculateHash </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XMLByte * </td>
<td class="mdname" nowrap> <em>toFill</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>maxToFill</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Calculate the Hash value of a reference.
<p>
Takes the Reference URI, performs all the transforms and finally calculates the Hash value of the data using the Digest algorithm indicated in the reference<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>toFill</em> </td><td>A Buffer that the raw hash will be copied into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxToFill</em> </td><td>Maximum number of bytes to place in the buffer </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes copied into the buffer </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z38_2" doxytag="DSIGReference::checkHash"></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">bool DSIGReference::checkHash </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Validate the Reference element.
<p>
Performs a <a class="el" href="classDSIGReference.html#z38_0">calculateHash()</a> and a <a class="el" href="classDSIGReference.html#z38_1">readHash()</a> and then compares the results.<p>
<dl compact><dt><b>Returns:</b></dt><dd>true iff the hash of the data matches the hash stored in the reference. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z36_1" doxytag="DSIGReference::createBlankReference"></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">XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* DSIGReference::createBlankReference </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const XMLCh * </td>
<td class="mdname" nowrap> <em>URI</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#a104">hashMethod</a> </td>
<td class="mdname" nowrap> <em>hm</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char * </td>
<td class="mdname" nowrap> <em>type</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a Reference structure in the document.
<p>
This function will create a Reference structure in the owner document. In some cases, a call to this function will be sufficient to put the required Reference in place. In other cases, calls will also need to be made to the various append*Transform methods.<p>
<dl compact><dt><b>Note:</b></dt><dd>The XSEC Library currently makes very little use of <em>type</em> attributes in <Reference> Elements. However this may of use to calling applications.</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 (data source) for this reference. Set to NULL for an anonymous reference. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hm</em> </td><td>The type of Digest to be used (generally SHA-1) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>A type string (as defined by XML Signature). </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The root Reference element of the newly created DOM structure. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z39_0" doxytag="DSIGReference::createTXFMChainFromList"></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">static <a class="el" href="classTXFMChain.html">TXFMChain</a>* DSIGReference::createTXFMChainFromList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classTXFMBase.html">TXFMBase</a> * </td>
<td class="mdname" nowrap> <em>input</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> * </td>
<td class="mdname" nowrap> <em>lst</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a Transformer chain.
<p>
Given a TransformList create the corresponding TXFM chain to allow the caller to read the reference byte stream<p>
<dl compact><dt><b>Note:</b></dt><dd>This method is primarily for use within the XSEC library. Users wishing to get the byte stream should use the <a class="el" href="classDSIGReference.html#z37_0">makeBinInputStream</a> method 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>input</em> </td><td>The input transformer to which the TXFMs will be applied to This is generally created from the URI attribute of the reference. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>lst</em> </td><td>The list of Transform elements from which to build the transformer list. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The <b>end</b> of the newly build TXFM chain. This can be read from using <a class="el" href="classTXFMBase.html#a12">TXFMBase::readBytes()</a> to give the end result of the transforms. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z37_2" doxytag="DSIGReference::getHashMethod"></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"><a class="el" href="DSIGConstants_8hpp.html#a104">hashMethod</a> DSIGReference::getHashMethod </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> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the Digest method.
<p>
Obtain the digest method used to find a hash for this reference<p>
<dl compact><dt><b>Returns:</b></dt><dd>the hashMethod </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z37_5" doxytag="DSIGReference::getManifestReferenceList"></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"><a class="el" href="classDSIGReferenceList.html">DSIGReferenceList</a>* DSIGReference::getManifestReferenceList </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the Manifest.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The ReferenceList containing the references in the Manifest list of this reference element. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z37_3" doxytag="DSIGReference::getTransforms"></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"><a class="el" href="classDSIGTransformList.html">DSIGTransformList</a>* DSIGReference::getTransforms </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> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Obtain the transforms for this reference.
<p>
Get the <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a> object for this reference. Can be used to obtain information about the transforms and also change the the transforms </td>
</tr>
</table>
<a class="anchor" name="z37_1" doxytag="DSIGReference::getURI"></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">const XMLCh* DSIGReference::getURI </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the URI string of the Reference.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the buffer (owned by the Reference) containing the value of the URI stored inthe reference </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z39_2" doxytag="DSIGReference::getURIBaseTXFM"></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">static <a class="el" href="classTXFMBase.html">TXFMBase</a>* DSIGReference::getURIBaseTXFM </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * </td>
<td class="mdname" nowrap> <em>doc</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>URI</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td>
<td class="mdname" nowrap> <em>env</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a starting point for a TXFM Chain.
<p>
Uses the provided URI to find the base data that the Transformer chain will be built upon.<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>doc</em> </td><td>The document that the signature is based on (used for local URIs) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>URI</em> </td><td>The URI to build the base from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>The environment the signature is operating in </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A base TXFM element. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z39_5" doxytag="DSIGReference::hashReferenceList"></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">static void DSIGReference::hashReferenceList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGReferenceList.html">DSIGReferenceList</a> * </td>
<td class="mdname" nowrap> <em>list</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>interlocking</em> = <code>true</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Hash a reference list.
<p>
Run through a list of references and calculate the hash value of each element. Finally set the Base64 encoded string according to the newly calcuated hash.<p>
<dl compact><dt><b>Note:</b></dt><dd>This is an internal library function and should not be called directly.</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>list</em> </td><td>The list of references </td></tr>
<tr><td valign="top"></td><td valign="top"><em>interlocking</em> </td><td>If set to false, the library will assume there are no inter-related references. The algorithm for determining this internally is very primitive and CPU intensive, so this is a method to bypass the checks. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z37_4" doxytag="DSIGReference::isManifest"></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">bool DSIGReference::isManifest </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Determine whether the reference is a manifest.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true iff the Reference element is a Manifest reference </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z36_0" doxytag="DSIGReference::load"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void DSIGReference::load </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load a DSIGReference from an existing DOM structure.
<p>
This function will load a Reference structure from the owner document. </td>
</tr>
</table>
<a class="anchor" name="z39_3" doxytag="DSIGReference::loadReferenceListFromXML"></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">static <a class="el" href="classDSIGReferenceList.html">DSIGReferenceList</a>* DSIGReference::loadReferenceListFromXML </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="mdname" nowrap> <em>env</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname" nowrap> <em>firstReference</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load a series of references.
<p>
Takes a series of <Reference> elements in a DOM structure and creates the corresponding ReferenceList object.<p>
<dl compact><dt><b>Note:</b></dt><dd>Internal function - meant for use by the library</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>env</em> </td><td>The environment in which this reference resides </td></tr>
<tr><td valign="top"></td><td valign="top"><em>firstReference</em> </td><td>First reference in DOM structure </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the created list. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z39_1" doxytag="DSIGReference::loadTransforms"></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">static <a class="el" href="classDSIGTransformList.html">DSIGTransformList</a>* DSIGReference::loadTransforms </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * </td>
<td class="mdname" nowrap> <em>transformsNode</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classXSECSafeBufferFormatter.html">XSECSafeBufferFormatter</a> * </td>
<td class="mdname" nowrap> <em>formatter</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classXSECEnv.html">XSECEnv</a> * </td>
<td class="mdname" nowrap> <em>env</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load a Transforms list from the <Transforms> DOMNode.
<p>
Reads the data from the XML data stored in the DOM and create the associated DSIGTrasnformList.<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>transformsNode</em> </td><td>Starting node in the DOM </td></tr>
<tr><td valign="top"></td><td valign="top"><em>formatter</em> </td><td>The formatter to be used to move from XMLCh to strings </td></tr>
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment in which to operate </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the created list. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z37_0" doxytag="DSIGReference::makeBinInputStream"></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"><a class="el" href="classXSECBinTXFMInputStream.html">XSECBinTXFMInputStream</a>* DSIGReference::makeBinInputStream </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create an input stream based on the digested byte stream.
<p>
This method allows applications to read the fully canonicalised byte stream that is hashed for a reference.<p>
All transforms are performed up to the point where they would normally be fed into the Digest function.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A BinInputSource of the canonicalised SignedInfo </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z38_1" doxytag="DSIGReference::readHash"></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">unsigned int DSIGReference::readHash </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XMLByte * </td>
<td class="mdname" nowrap> <em>toFill</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>maxToFill</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Read the hash from the Reference element.
<p>
Reads the Base64 encoded element from the Reference element. The hash is then translated from Base64 back into raw form and written into the indicated 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>toFill</em> </td><td>Pointer to the buffer where the raw hash will be written </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxToFill</em> </td><td>Maximum bytes to write to the buffer </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Number of bytes written </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z38_3" doxytag="DSIGReference::setHash"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void DSIGReference::setHash </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the value of the hash in the Reference.
<p>
Hashes the data referenced by the element and then writes the Base64 encoded hash value into the Reference. </td>
</tr>
</table>
<a class="anchor" name="z36_8" doxytag="DSIGReference::setPreHashTXFM"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void DSIGReference::setPreHashTXFM </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classTXFMBase.html">TXFMBase</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>t</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Append a "debug" transformer.
<p>
This method allows applications to provide a TXFM that will be appended to the transform chain just prior to the application of the hash algorithm.<p>
<dl compact><dt><b>Note:</b></dt><dd>This is primarily for debugging. It should not be used to modify the contents of the byte stream.</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>t</em> </td><td>The TXFM element to insert. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z39_4" doxytag="DSIGReference::verifyReferenceList"></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">static bool DSIGReference::verifyReferenceList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGReferenceList.html">DSIGReferenceList</a> * </td>
<td class="mdname" nowrap> <em>lst</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classsafeBuffer.html">safeBuffer</a> & </td>
<td class="mdname" nowrap> <em>errorStr</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Validate a list of references.
<p>
Runs through a reference list, calling verify() on each and setting the ErrroStrings for any errors found<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>lst</em> </td><td>The list to verify </td></tr>
<tr><td valign="top"></td><td valign="top"><em>errorStr</em> </td><td>The string to append any errors found to </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true iff all the references validate successfully. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DSIGReference_8hpp-source.html">DSIGReference.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:41:17 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>
|
