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
|
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* XSEC
*
* XSECCanon := Base (abstract) class for canonicalisation objects
*
*
* Author(s): Berin Lautenbach
*
* $Id$
*/
#ifndef XSECCanon_INCLUDE
#define XSECCanon_INCLUDE
// XSEC includes
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/utils/XSECSafeBuffer.hpp>
XSEC_DECLARE_XERCES_CLASS(DOMNode)
XSEC_DECLARE_XERCES_CLASS(DOMDocument)
// --------------------------------------------------------------------------------
// Defines
// --------------------------------------------------------------------------------
#define XSECCANNON_BUFFER_START_SIZE 8192 /* Default size for the outBuffer */
// --------------------------------------------------------------------------------
// XSECCanon Virtual Class definition
// --------------------------------------------------------------------------------
// Most of the interface work is done within this class. However the actual
// processing is done via the processNextNode virtual function that must be
// implemented by all children classes.
class XSEC_EXPORT XSECCanon {
protected:
// Data structures
XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * mp_doc; // Xerces DOM Node that defines the document
XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * mp_startNode, // Node to start processing from
*mp_nextNode; // Next Node to be processeed
safeBuffer m_buffer; // Buffer holding parsed output
XMLSize_t m_bufferLength, // Length of input currently in buffer
m_bufferPoint; // Next "character" to copy out
bool m_allNodesDone; // Have we completed?
public:
// Constructors
XSECCanon();
XSECCanon(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *newDoc);
XSECCanon(
XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *newDoc,
XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *newStartNode);
// Destructors
virtual ~XSECCanon();
// Public Methods
// outputBuffer is used by all canonicalisers to output the next numBytes bytes of
// canonicalised XML to the nominated buffer
XMLSize_t outputBuffer(unsigned char *outBuffer, XMLSize_t numBytes);
// setStartNode sets the starting point for the output if it is a sub-document
// that needs canonicalisation and we want to re-start
bool setStartNode(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *newStartNode);
protected:
// processNextNode is the pure virtual function that must be implemented by all canons
virtual XMLSize_t processNextNode() = 0;
};
#endif /* XSECCanon_INCLUDE */
|
