/usr/include/xmltooling/util/ReloadableXMLFile.h is in libxmltooling-dev 1.5.3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /**
* Licensed to the University Corporation for Advanced Internet
* Development, Inc. (UCAID) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* UCAID 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.
*/
/**
* @file xmltooling/util/ReloadableXMLFile.h
*
* Base class for file-based XML configuration.
*/
#ifndef __xmltooling_reloadable_h__
#define __xmltooling_reloadable_h__
#include <xmltooling/logging.h>
#include <xmltooling/Lockable.h>
#include <ctime>
#include <string>
#include <xercesc/dom/DOM.hpp>
#ifndef XMLTOOLING_LITE
namespace xmlsignature {
class XMLTOOL_API Signature;
};
#endif
namespace xmltooling {
class XMLTOOL_API CondWait;
class XMLTOOL_API RWLock;
class XMLTOOL_API Thread;
#ifndef XMLTOOLING_LITE
class XMLTOOL_API CredentialResolver;
class XMLTOOL_API SignatureTrustEngine;
#endif
/**
* Base class for file-based XML configuration.
*/
class XMLTOOL_API ReloadableXMLFile : protected virtual Lockable
{
MAKE_NONCOPYABLE(ReloadableXMLFile);
protected:
/**
* Constructor taking a DOM element supporting the following content:
*
* <dl>
* <dt>file | filename | path | pathname</dt>
* <dd>identifies a local file</dd>
* <dt>uri | url</dt>
* <dd>identifies a remote resource</dd>
* <dt>validate</dt>
* <dd>use a validating parser</dd>
* <dt>reloadChanges</dt>
* <dd>enables monitoring of local file for changes</dd>
* <dt>reloadInterval or maxRefreshDelay</dt>
* <dd>enables periodic refresh of remote file</dd>
* <dt>backingFilePath</dt>
* <dd>location for backup of remote resource</dd>
* <dt>id</dt>
* <dd>identifies the plugin instance for logging purposes</dd>
* <dt>certificate</dt>
* <dd>requires XML be signed with an enveloped signature verifiable with specified key</dd>
* <dt>signerName</dt>
* <dd>requires XML be signed with an enveloped signature verifiable with <TrustEngine>
* by certificate containing this name</dd>
* <dt><CredentialResolver></dt>
* <dd>requires XML be signed with an enveloped signature verifiable with specified key</dd>
* <dt><TrustEngine></dt>
* <dd>requires XML be signed with an enveloped signature verifiable with specified TrustEngine</dd>
* </dl>
*
* @param e DOM to supply configuration
* @param log logging object to use
* @param startReloadThread true iff refresh thread for resources should be started by constructor
*/
ReloadableXMLFile(const xercesc::DOMElement* e, logging::Category& log, bool startReloadThread=true);
virtual ~ReloadableXMLFile();
/**
* Loads configuration material.
*
* <p>This method is called to load configuration material
* initially and any time a change is detected. The base version
* performs basic parsing duties and returns the result.
*
* <p>This method is not called with the object locked, so actual
* modification of implementation state requires explicit locking within
* the method override.
*
* @return a pair consisting of a flag indicating whether to take ownership of
* the document, and the root element of the tree to load
*/
virtual std::pair<bool,xercesc::DOMElement*> background_load();
/**
* @deprecated
* Basic load/parse of configuration material.
*
* <p>The base version performs basic parsing duties and returns the result.
* Subclasses should override the new background_load() method and perform
* their own locking in conjunction with use of this method.
*
* <p>Subclasses that continue to override this method will function, but
* a write lock will be acquired and held for the entire operation.
*
* @return a pair consisting of a flag indicating whether to take ownership of
* the document, and the root element of the tree to load
*/
virtual std::pair<bool,xercesc::DOMElement*> load();
/**
* Basic load/parse of configuration material.
*
* <p>The base version performs basic parsing duties and returns the result.
* Subclasses should override the new background_load() method and perform
* their own locking in conjunction with use of this method.
*
* <p>This version allows subclasses to explicitly control the use of a
* backup for remote resources, which allows additional validation to be
* performed besides just successful XML parsing.
*
* @param backup true iff the backup source should be loaded
* @return a pair consisting of a flag indicating whether to take ownership of
* the document, and the root element of the tree to load
*/
virtual std::pair<bool,xercesc::DOMElement*> load(bool backup);
/**
* Accesses a lock interface protecting use of backup file associated with the
* object.
*
* <p>The lock is <strong>NOT</strong> acquired automatically.
*
* @return pointer to a lock interface, or nullptr if unnecessary
*/
virtual Lockable* getBackupLock();
/**
* Preserves the last remote resource caching identifier in a backup file
* for use on the next restart.
*/
void preserveCacheTag();
/**
* Starts up reload thread, can be automatically called by constructor, or
* manually invoked by subclass.
*/
void startup();
/**
* Shuts down reload thread, should be called from subclass destructor.
*/
void shutdown();
/** Root of the original DOM element passed into constructor. */
const xercesc::DOMElement* m_root;
/** Indicates whether resources is local or remote. */
bool m_local;
/** Use a validating parser when parsing XML. */
bool m_validate;
/** Resource location, may be a local path or a URI. */
std::string m_source;
/** Path to backup copy for remote resource. */
std::string m_backing;
/** Last modification of local resource. */
time_t m_filestamp;
/** Time in seconds to wait before trying for new copy of remote resource. */
time_t m_reloadInterval;
/** Caching tag associated with remote resource. */
std::string m_cacheTag;
/** Shared lock for guarding reloads. */
RWLock* m_lock;
/** Logging object. */
logging::Category& m_log;
/** Plugin identifier. */
std::string m_id;
/** Indicates whether a usable version of the resource is in place. */
bool m_loaded;
#ifndef XMLTOOLING_LITE
/** CredentialResolver for signature verification. */
CredentialResolver* m_credResolver;
/** TrustEngine for signature verification. */
SignatureTrustEngine* m_trust;
/** Name of signer for signature verification. */
std::string m_signerName;
#endif
public:
Lockable* lock();
void unlock();
private:
#ifndef XMLTOOLING_LITE
void validateSignature(xmlsignature::Signature& sigObj) const;
#endif
// Used to manage background reload/refresh.
bool m_shutdown;
CondWait* m_reload_wait;
Thread* m_reload_thread;
static void* reload_fn(void*);
};
};
#endif /* __xmltooling_reloadable_h__ */
|