xmltooling/XMLToolingConfig.cpp

   1 /*
   2  *  Copyright 2001-2006 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * XMLToolingConfig.cpp
  19  *
  20  * Library configuration
  21  */
  22
  23 #define XMLTOOLING_DECLARE_VALIDATORS
  24
  25 #include "internal.h"
  26 #include "exceptions.h"
  27 #include "XMLToolingConfig.h"
  28 #include "impl/UnknownElement.h"
  29 #include "signature/KeyInfo.h"
  30 #include "signature/Signature.h"
  31 #include "util/NDC.h"
  32 #include "util/XMLConstants.h"
  33 #include "validation/Validator.h"
  34
  35 #ifdef HAVE_DLFCN_H
  36 # include <dlfcn.h>
  37 #endif
  38
  39 #include <log4cpp/Category.hh>
  40 #include <log4cpp/PropertyConfigurator.hh>
  41 #include <log4cpp/OstreamAppender.hh>
  42 #include <xercesc/util/PlatformUtils.hpp>
  43 #ifndef XMLTOOLING_NO_XMLSEC
  44     #include <xsec/framework/XSECProvider.hpp>
  45 #endif
  46
  47 #include <stdexcept>
  48
  49 using namespace xmlsignature;
  50 using namespace xmltooling;
  51 using namespace log4cpp;
  52 using namespace std;
  53
  54 #define REGISTER_ELEMENT(namespaceURI,cname) \
  55     q=QName(namespaceURI,cname::LOCAL_NAME); \
  56     XMLObjectBuilder::registerBuilder(q,new cname##Builder()); \
  57     Validator::registerValidator(q,new cname##SchemaValidator())
  58
  59 #define REGISTER_TYPE(namespaceURI,cname) \
  60     q=QName(namespaceURI,cname::TYPE_NAME); \
  61     XMLObjectBuilder::registerBuilder(q,new cname##Builder()); \
  62     Validator::registerValidator(q,new cname##SchemaValidator())
  63
  64
  65 DECL_EXCEPTION_FACTORY(XMLParserException);
  66 DECL_EXCEPTION_FACTORY(XMLObjectException);
  67 DECL_EXCEPTION_FACTORY(MarshallingException);
  68 DECL_EXCEPTION_FACTORY(UnmarshallingException);
  69 DECL_EXCEPTION_FACTORY(UnknownElementException);
  70 DECL_EXCEPTION_FACTORY(UnknownAttributeException);
  71 DECL_EXCEPTION_FACTORY(ValidationException);
  72 DECL_EXCEPTION_FACTORY(SignatureException);
  73
  74 namespace xmltooling {
  75    XMLToolingInternalConfig g_config;
  76 }
  77
  78 XMLToolingConfig& XMLToolingConfig::getConfig()
  79 {
  80     return g_config;
  81 }
  82
  83 XMLToolingInternalConfig& XMLToolingInternalConfig::getInternalConfig()
  84 {
  85     return g_config;
  86 }
  87
  88 bool XMLToolingInternalConfig::log_config(const char* config)
  89 {
  90     try {
  91         if (!config || !*config)
  92             config=getenv("XMLTOOLING_LOG_CONFIG");
  93         if (!config || !*config)
  94             config="WARN";
  95
  96         bool level=false;
  97         Category& root = Category::getRoot();
  98         if (!strcmp(config,"DEBUG")) {
  99             root.setPriority(Priority::DEBUG);
 100             level=true;
 101         }
 102         else if (!strcmp(config,"INFO")) {
 103             root.setPriority(Priority::INFO);
 104             level=true;
 105         }
 106         else if (!strcmp(config,"NOTICE")) {
 107             root.setPriority(Priority::NOTICE);
 108             level=true;
 109         }
 110         else if (!strcmp(config,"WARN")) {
 111             root.setPriority(Priority::WARN);
 112             level=true;
 113         }
 114         else if (!strcmp(config,"ERROR")) {
 115             root.setPriority(Priority::ERROR);
 116             level=true;
 117         }
 118         else if (!strcmp(config,"CRIT")) {
 119             root.setPriority(Priority::CRIT);
 120             level=true;
 121         }
 122         else if (!strcmp(config,"ALERT")) {
 123             root.setPriority(Priority::ALERT);
 124             level=true;
 125         }
 126         else if (!strcmp(config,"EMERG")) {
 127             root.setPriority(Priority::EMERG);
 128             level=true;
 129         }
 130         else if (!strcmp(config,"FATAL")) {
 131             root.setPriority(Priority::FATAL);
 132             level=true;
 133         }
 134         if (level)
 135             root.setAppender(new OstreamAppender("default",&cerr));
 136         else
 137             PropertyConfigurator::configure(config);
 138     }
 139     catch (const ConfigureFailure& e) {
 140         Category::getInstance(XMLTOOLING_LOGCAT".Logging").crit("failed to initialize log4cpp: %s", e.what());
 141         return false;
 142     }
 143
 144     return true;
 145 }
 146
 147 bool XMLToolingInternalConfig::init()
 148 {
 149 #ifdef _DEBUG
 150     xmltooling::NDC ndc("init");
 151 #endif
 152     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
 153     try {
 154         log.debug("library initialization started");
 155
 156         xercesc::XMLPlatformUtils::Initialize();
 157         log.debug("Xerces initialization complete");
 158
 159 #ifndef XMLTOOLING_NO_XMLSEC
 160         XSECPlatformUtils::Initialise();
 161         m_xsecProvider=new XSECProvider();
 162         log.debug("XMLSec initialization complete");
 163 #endif
 164
 165         m_parserPool=new ParserPool();
 166         m_lock=xercesc::XMLPlatformUtils::makeMutex();
 167
 168         // default registrations
 169         XMLObjectBuilder::registerDefaultBuilder(new UnknownElementBuilder());
 170
 171         QName q;
 172         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,KeyInfo);
 173         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,KeyName);
 174         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,KeyValue);
 175         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,MgmtData);
 176         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,DSAKeyValue);
 177         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,RSAKeyValue);
 178         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,Exponent);
 179         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,Modulus);
 180         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,P);
 181         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,Q);
 182         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,G);
 183         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,Y);
 184         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,J);
 185         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,Seed);
 186         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,PgenCounter);
 187         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,XPath);
 188         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,Transform);
 189         REGISTER_ELEMENT(XMLConstants::XMLSIG_NS,Transforms);
 190         REGISTER_TYPE(XMLConstants::XMLSIG_NS,KeyInfo);
 191         REGISTER_TYPE(XMLConstants::XMLSIG_NS,KeyValue);
 192         REGISTER_TYPE(XMLConstants::XMLSIG_NS,DSAKeyValue);
 193         REGISTER_TYPE(XMLConstants::XMLSIG_NS,RSAKeyValue);
 194         REGISTER_TYPE(XMLConstants::XMLSIG_NS,Transform);
 195         REGISTER_TYPE(XMLConstants::XMLSIG_NS,Transforms);
 196
 197 #ifndef XMLTOOLING_NO_XMLSEC
 198         XMLObjectBuilder::registerBuilder(QName(XMLConstants::XMLSIG_NS,Signature::LOCAL_NAME),new SignatureBuilder());
 199 #endif
 200
 201         REGISTER_EXCEPTION_FACTORY(XMLParserException);
 202         REGISTER_EXCEPTION_FACTORY(XMLObjectException);
 203         REGISTER_EXCEPTION_FACTORY(MarshallingException);
 204         REGISTER_EXCEPTION_FACTORY(UnmarshallingException);
 205         REGISTER_EXCEPTION_FACTORY(UnknownElementException);
 206         REGISTER_EXCEPTION_FACTORY(UnknownAttributeException);
 207         REGISTER_EXCEPTION_FACTORY(ValidationException);
 208         REGISTER_EXCEPTION_FACTORY(SignatureException);
 209     }
 210     catch (const xercesc::XMLException&) {
 211         log.fatal("caught exception while initializing Xerces");
 212         return false;
 213     }
 214
 215     log.info("library initialization complete");
 216     return true;
 217 }
 218
 219 void XMLToolingInternalConfig::term()
 220 {
 221     XMLObjectBuilder::destroyBuilders();
 222
 223     for (vector<void*>::reverse_iterator i=m_libhandles.rbegin(); i!=m_libhandles.rend(); i++) {
 224 #if defined(WIN32)
 225         FARPROC fn=GetProcAddress(static_cast<HMODULE>(*i),"xmltooling_extension_term");
 226         if (fn)
 227             fn();
 228         FreeLibrary(static_cast<HMODULE>(*i));
 229 #elif defined(HAVE_DLFCN_H)
 230         void (*fn)()=(void (*)())dlsym(*i,"xmltooling_extension_term");
 231         if (fn)
 232             fn();
 233         dlclose(*i);
 234 #else
 235 # error "Don't know about dynamic loading on this platform!"
 236 #endif
 237     }
 238     m_libhandles.clear();
 239
 240     delete m_parserPool;
 241     m_parserPool=NULL;
 242
 243 #ifndef XMLTOOLING_NO_XMLSEC
 244     delete m_xsecProvider;
 245     m_xsecProvider=NULL;
 246     XSECPlatformUtils::Terminate();
 247 #endif
 248
 249     xercesc::XMLPlatformUtils::closeMutex(m_lock);
 250     m_lock=NULL;
 251     xercesc::XMLPlatformUtils::Terminate();
 252
 253  #ifdef _DEBUG
 254     xmltooling::NDC ndc("term");
 255 #endif
 256    Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig").info("library shutdown complete");
 257 }
 258
 259 ILockable& XMLToolingInternalConfig::lock()
 260 {
 261     xercesc::XMLPlatformUtils::lockMutex(m_lock);
 262     return *this;
 263 }
 264
 265 void XMLToolingInternalConfig::unlock()
 266 {
 267     xercesc::XMLPlatformUtils::unlockMutex(m_lock);
 268 }
 269
 270 bool XMLToolingInternalConfig::load_library(const char* path, void* context)
 271 {
 272 #ifdef _DEBUG
 273     xmltooling::NDC ndc("LoadLibrary");
 274 #endif
 275     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
 276     log.info("loading extension: %s", path);
 277
 278     Locker locker(this);
 279
 280 #if defined(WIN32)
 281     HMODULE handle=NULL;
 282     char* fixed=const_cast<char*>(path);
 283     if (strchr(fixed,'/')) {
 284         fixed=strdup(path);
 285         char* p=fixed;
 286         while (p=strchr(p,'/'))
 287             *p='\\';
 288     }
 289
 290     UINT em=SetErrorMode(SEM_FAILCRITICALERRORS);
 291     try {
 292         handle=LoadLibraryEx(fixed,NULL,LOAD_WITH_ALTERED_SEARCH_PATH);
 293         if (!handle)
 294              handle=LoadLibraryEx(fixed,NULL,0);
 295         if (!handle)
 296             throw runtime_error(string("unable to load extension library: ") + fixed);
 297         FARPROC fn=GetProcAddress(handle,"xmltooling_extension_init");
 298         if (!fn)
 299             throw runtime_error(string("unable to locate xmltooling_extension_init entry point: ") + fixed);
 300         if (reinterpret_cast<int(*)(void*)>(fn)(context)!=0)
 301             throw runtime_error(string("detected error in xmltooling_extension_init: ") + fixed);
 302         if (fixed!=path)
 303             free(fixed);
 304         SetErrorMode(em);
 305     }
 306     catch(runtime_error& e) {
 307         log.error(e.what());
 308         if (handle)
 309             FreeLibrary(handle);
 310         SetErrorMode(em);
 311         if (fixed!=path)
 312             free(fixed);
 313         return false;
 314     }
 315
 316 #elif defined(HAVE_DLFCN_H)
 317     void* handle=dlopen(path,RTLD_LAZY);
 318     if (!handle)
 319         throw runtime_error(string("unable to load extension library '") + path + "': " + dlerror());
 320     int (*fn)(void*)=(int (*)(void*))(dlsym(handle,"xmltooling_extension_init"));
 321     if (!fn) {
 322         dlclose(handle);
 323         throw runtime_error(
 324             string("unable to locate xmltooling_extension_init entry point in '") + path + "': " +
 325                 (dlerror() ? dlerror() : "unknown error")
 326             );
 327     }
 328     try {
 329         if (fn(context)!=0)
 330             throw runtime_error(string("detected error in xmltooling_extension_init in ") + path);
 331     }
 332     catch(runtime_error& e) {
 333         log.error(e.what());
 334         if (handle)
 335             dlclose(handle);
 336         return false;
 337     }
 338 #else
 339 # error "Don't know about dynamic loading on this platform!"
 340 #endif
 341     m_libhandles.push_back(handle);
 342     log.info("loaded extension: %s", path);
 343     return true;
 344 }