xmltooling/XMLToolingConfig.cpp

   1 /*
   2  *  Copyright 2001-2009 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 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "logging.h"
  26 #include "XMLToolingConfig.h"
  27 #include "encryption/Encryption.h"
  28 #include "encryption/Encrypter.h"
  29 #include "io/HTTPRequest.h"
  30 #include "io/HTTPResponse.h"
  31 #include "impl/UnknownElement.h"
  32 #include "security/TrustEngine.h"
  33 #include "security/OpenSSLCryptoX509CRL.h"
  34 #include "security/CredentialResolver.h"
  35 #include "security/KeyInfoResolver.h"
  36 #include "signature/Signature.h"
  37 #include "soap/SOAP.h"
  38 #include "soap/SOAPTransport.h"
  39 #include "util/NDC.h"
  40 #include "util/PathResolver.h"
  41 #include "util/ReplayCache.h"
  42 #include "util/StorageService.h"
  43 #include "util/TemplateEngine.h"
  44 #include "util/URLEncoder.h"
  45 #include "util/XMLConstants.h"
  46 #include "validation/ValidatorSuite.h"
  47
  48 #ifdef HAVE_DLFCN_H
  49 # include <dlfcn.h>
  50 #endif
  51
  52 #include <stdexcept>
  53 #if defined(XMLTOOLING_LOG4SHIB)
  54 # include <log4shib/PropertyConfigurator.hh>
  55 # include <log4shib/OstreamAppender.hh>
  56 #elif defined(XMLTOOLING_LOG4CPP)
  57 # include <log4cpp/PropertyConfigurator.hh>
  58 # include <log4cpp/OstreamAppender.hh>
  59 #endif
  60 #include <xercesc/util/PlatformUtils.hpp>
  61 #ifndef XMLTOOLING_NO_XMLSEC
  62 # include <curl/curl.h>
  63 # include <openssl/err.h>
  64 # include <xsec/framework/XSECProvider.hpp>
  65 #endif
  66
  67 using namespace soap11;
  68 using namespace xmltooling::logging;
  69 using namespace xmltooling;
  70 using namespace std;
  71
  72 using xercesc::XMLPlatformUtils;
  73
  74 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLParserException,xmltooling);
  75 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLObjectException,xmltooling);
  76 DECL_XMLTOOLING_EXCEPTION_FACTORY(MarshallingException,xmltooling);
  77 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnmarshallingException,xmltooling);
  78 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnknownElementException,xmltooling);
  79 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnknownAttributeException,xmltooling);
  80 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnknownExtensionException,xmltooling);
  81 DECL_XMLTOOLING_EXCEPTION_FACTORY(ValidationException,xmltooling);
  82 DECL_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
  83
  84 #ifndef XMLTOOLING_NO_XMLSEC
  85 using namespace xmlencryption;
  86 using namespace xmlsignature;
  87     DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLSecurityException,xmltooling);
  88     DECL_XMLTOOLING_EXCEPTION_FACTORY(SignatureException,xmlsignature);
  89     DECL_XMLTOOLING_EXCEPTION_FACTORY(EncryptionException,xmlencryption);
  90 #endif
  91
  92 namespace xmltooling {
  93     static XMLToolingInternalConfig g_config;
  94 #ifndef XMLTOOLING_NO_XMLSEC
  95     static vector<Mutex*> g_openssl_locks;
  96
  97     extern "C" void openssl_locking_callback(int mode,int n,const char *file,int line)
  98     {
  99         if (mode & CRYPTO_LOCK)
 100             g_openssl_locks[n]->lock();
 101         else
 102             g_openssl_locks[n]->unlock();
 103     }
 104
 105 # ifndef WIN32
 106     extern "C" unsigned long openssl_thread_id(void)
 107     {
 108         return (unsigned long)(pthread_self());
 109     }
 110 # endif
 111 #endif
 112
 113 #ifdef WIN32
 114     BOOL LogEvent(\r
 115         LPCSTR  lpUNCServerName,\r
 116         WORD  wType,\r
 117         DWORD  dwEventID,\r
 118         PSID  lpUserSid,\r
 119         LPCSTR  message)\r
 120     {\r
 121         LPCSTR  messages[] = {message, NULL};\r
 122 \r
 123         HANDLE hElog = RegisterEventSource(lpUNCServerName, "OpenSAML XMLTooling Library");\r
 124         BOOL res = ReportEvent(hElog, wType, 0, dwEventID, lpUserSid, 1, 0, messages, NULL);\r
 125         return (DeregisterEventSource(hElog) && res);\r
 126     }\r
 127 #endif
 128 }
 129
 130 XMLToolingConfig& XMLToolingConfig::getConfig()
 131 {
 132     return g_config;
 133 }
 134
 135 XMLToolingInternalConfig& XMLToolingInternalConfig::getInternalConfig()
 136 {
 137     return g_config;
 138 }
 139
 140 bool XMLToolingInternalConfig::log_config(const char* config)
 141 {
 142     try {
 143         if (!config || !*config)
 144             config=getenv("XMLTOOLING_LOG_CONFIG");
 145         if (!config || !*config)
 146             config="WARN";
 147
 148         bool level=false;
 149         Category& root = Category::getRoot();
 150         if (!strcmp(config,"DEBUG")) {
 151             root.setPriority(Priority::DEBUG);
 152             level=true;
 153         }
 154         else if (!strcmp(config,"INFO")) {
 155             root.setPriority(Priority::INFO);
 156             level=true;
 157         }
 158         else if (!strcmp(config,"NOTICE")) {
 159             root.setPriority(Priority::NOTICE);
 160             level=true;
 161         }
 162         else if (!strcmp(config,"WARN")) {
 163             root.setPriority(Priority::WARN);
 164             level=true;
 165         }
 166         else if (!strcmp(config,"ERROR")) {
 167             root.setPriority(Priority::ERROR);
 168             level=true;
 169         }
 170         else if (!strcmp(config,"CRIT")) {
 171             root.setPriority(Priority::CRIT);
 172             level=true;
 173         }
 174         else if (!strcmp(config,"ALERT")) {
 175             root.setPriority(Priority::ALERT);
 176             level=true;
 177         }
 178         else if (!strcmp(config,"EMERG")) {
 179             root.setPriority(Priority::EMERG);
 180             level=true;
 181         }
 182         else if (!strcmp(config,"FATAL")) {
 183             root.setPriority(Priority::FATAL);
 184             level=true;
 185         }
 186         if (level) {
 187             root.setAppender(new OstreamAppender("default",&cerr));
 188         }
 189         else {
 190             string path(config);
 191             PropertyConfigurator::configure(m_pathResolver ? m_pathResolver->resolve(path, PathResolver::XMLTOOLING_CFG_FILE) : path);
 192         }
 193     }
 194     catch (const ConfigureFailure& e) {
 195         string msg = string("failed to configure logging: ") + e.what();
 196         Category::getInstance(XMLTOOLING_LOGCAT".Logging").crit(msg);
 197 #ifdef WIN32
 198         LogEvent(NULL, EVENTLOG_ERROR_TYPE, 2100, NULL, msg.c_str());\r
 199 #endif
 200         return false;
 201     }
 202
 203     return true;
 204 }
 205
 206 #ifndef XMLTOOLING_LITE
 207 void XMLToolingConfig::setReplayCache(ReplayCache* replayCache)
 208 {
 209     delete m_replayCache;
 210     m_replayCache = replayCache;
 211 }
 212 #endif
 213
 214 void XMLToolingConfig::setPathResolver(PathResolver* pathResolver)
 215 {
 216     delete m_pathResolver;
 217     m_pathResolver = pathResolver;
 218 }
 219
 220 void XMLToolingConfig::setTemplateEngine(TemplateEngine* templateEngine)
 221 {
 222     delete m_templateEngine;
 223     m_templateEngine = templateEngine;
 224 }
 225
 226 void XMLToolingConfig::setURLEncoder(URLEncoder* urlEncoder)
 227 {
 228     delete m_urlEncoder;
 229     m_urlEncoder = urlEncoder;
 230 }
 231
 232 bool XMLToolingInternalConfig::init()
 233 {
 234 #ifdef _DEBUG
 235     xmltooling::NDC ndc("init");
 236 #endif
 237     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
 238     try {
 239         log.debug("library initialization started");
 240
 241 #ifndef XMLTOOLING_NO_XMLSEC
 242         if (curl_global_init(CURL_GLOBAL_ALL)) {
 243             log.fatal("failed to initialize libcurl, OpenSSL, or Winsock");
 244             return false;
 245         }
 246         log.debug("libcurl %s initialization complete", LIBCURL_VERSION);
 247 #endif
 248
 249         XMLPlatformUtils::Initialize();
 250         log.debug("Xerces %s initialization complete", XERCES_FULLVERSIONDOT);
 251
 252 #ifndef XMLTOOLING_NO_XMLSEC
 253         XSECPlatformUtils::Initialise();
 254         m_xsecProvider=new XSECProvider();
 255         log.debug("XML-Security %s initialization complete", XSEC_FULLVERSIONDOT);
 256 #endif
 257
 258         m_parserPool=new ParserPool();
 259         m_validatingPool=new ParserPool(true,true);
 260         m_lock=XMLPlatformUtils::makeMutex();
 261
 262         // Load catalogs from path.
 263         if (!catalog_path.empty()) {
 264             char* catpath=strdup(catalog_path.c_str());
 265             char* sep=NULL;
 266             char* start=catpath;
 267             while (start && *start) {
 268                 sep=strchr(start,PATH_SEPARATOR_CHAR);
 269                 if (sep)
 270                     *sep=0;
 271                 auto_ptr_XMLCh temp(start);
 272                 m_validatingPool->loadCatalog(temp.get());
 273                 start = sep ? sep + 1 : NULL;
 274             }
 275             free(catpath);
 276         }
 277
 278         // default registrations
 279         XMLObjectBuilder::registerDefaultBuilder(new UnknownElementBuilder());
 280
 281         registerSOAPClasses();
 282
 283         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLParserException,xmltooling);
 284         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLObjectException,xmltooling);
 285         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MarshallingException,xmltooling);
 286         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnmarshallingException,xmltooling);
 287         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnknownElementException,xmltooling);
 288         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnknownAttributeException,xmltooling);
 289         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ValidationException,xmltooling);
 290         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
 291
 292 #ifndef XMLTOOLING_NO_XMLSEC
 293         XMLObjectBuilder::registerBuilder(QName(xmlconstants::XMLSIG_NS,Signature::LOCAL_NAME),new SignatureBuilder());
 294         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLSecurityException,xmltooling);
 295         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(SignatureException,xmlsignature);
 296         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(EncryptionException,xmlencryption);
 297         registerKeyInfoClasses();
 298         registerEncryptionClasses();
 299         registerKeyInfoResolvers();
 300         registerCredentialResolvers();
 301         registerTrustEngines();
 302         registerXMLAlgorithms();
 303         registerSOAPTransports();
 304         initSOAPTransports();
 305         registerStorageServices();
 306         m_keyInfoResolver = KeyInfoResolverManager.newPlugin(INLINE_KEYINFO_RESOLVER,NULL);
 307 #endif
 308
 309         m_pathResolver = new PathResolver();
 310         m_urlEncoder = new URLEncoder();
 311
 312         // Register xml:id as an ID attribute.
 313         static const XMLCh xmlid[] = UNICODE_LITERAL_2(i,d);
 314         AttributeExtensibleXMLObject::registerIDAttribute(QName(xmlconstants::XML_NS, xmlid));
 315     }
 316     catch (const xercesc::XMLException&) {
 317         log.fatal("caught exception while initializing Xerces");
 318 #ifndef XMLTOOLING_NO_XMLSEC
 319         curl_global_cleanup();
 320 #endif
 321         return false;
 322     }
 323
 324 #ifndef XMLTOOLING_NO_XMLSEC
 325     // Set up OpenSSL locking.
 326     for (int i=0; i<CRYPTO_num_locks(); i++)
 327         g_openssl_locks.push_back(Mutex::create());
 328     CRYPTO_set_locking_callback(openssl_locking_callback);
 329 # ifndef WIN32
 330     CRYPTO_set_id_callback(openssl_thread_id);
 331 # endif
 332 #endif
 333
 334     log.info("%s library initialization complete", PACKAGE_STRING);
 335     return true;
 336 }
 337
 338 void XMLToolingInternalConfig::term()
 339 {
 340 #ifndef XMLTOOLING_NO_XMLSEC
 341     CRYPTO_set_locking_callback(NULL);
 342     for_each(g_openssl_locks.begin(), g_openssl_locks.end(), xmltooling::cleanup<Mutex>());
 343     g_openssl_locks.clear();
 344 #endif
 345
 346     SchemaValidators.destroyValidators();
 347     XMLObjectBuilder::destroyBuilders();
 348     XMLToolingException::deregisterFactories();
 349     AttributeExtensibleXMLObject::deregisterIDAttributes();
 350
 351 #ifndef XMLTOOLING_NO_XMLSEC
 352     StorageServiceManager.deregisterFactories();
 353     termSOAPTransports();
 354     SOAPTransportManager.deregisterFactories();
 355     TrustEngineManager.deregisterFactories();
 356     CredentialResolverManager.deregisterFactories();
 357     KeyInfoResolverManager.deregisterFactories();
 358     m_algorithmMap.clear();
 359
 360     delete m_keyInfoResolver;
 361     m_keyInfoResolver = NULL;
 362
 363     delete m_replayCache;
 364     m_replayCache = NULL;
 365 #endif
 366
 367     delete m_pathResolver;
 368     m_pathResolver = NULL;
 369
 370     delete m_templateEngine;
 371     m_templateEngine = NULL;
 372
 373     delete m_urlEncoder;
 374     m_urlEncoder = NULL;
 375
 376     for (vector<void*>::reverse_iterator i=m_libhandles.rbegin(); i!=m_libhandles.rend(); i++) {
 377 #if defined(WIN32)
 378         FARPROC fn=GetProcAddress(static_cast<HMODULE>(*i),"xmltooling_extension_term");
 379         if (fn)
 380             fn();
 381         FreeLibrary(static_cast<HMODULE>(*i));
 382 #elif defined(HAVE_DLFCN_H)
 383         void (*fn)()=(void (*)())dlsym(*i,"xmltooling_extension_term");
 384         if (fn)
 385             fn();
 386         dlclose(*i);
 387 #else
 388 # error "Don't know about dynamic loading on this platform!"
 389 #endif
 390     }
 391     m_libhandles.clear();
 392
 393     delete m_parserPool;
 394     m_parserPool=NULL;
 395     delete m_validatingPool;
 396     m_validatingPool=NULL;
 397
 398 #ifndef XMLTOOLING_NO_XMLSEC
 399     delete m_xsecProvider;
 400     m_xsecProvider=NULL;
 401     XSECPlatformUtils::Terminate();
 402 #endif
 403
 404     XMLPlatformUtils::closeMutex(m_lock);
 405     m_lock=NULL;
 406     XMLPlatformUtils::Terminate();
 407
 408 #ifndef XMLTOOLING_NO_XMLSEC
 409     curl_global_cleanup();
 410 #endif
 411 #ifdef _DEBUG
 412     xmltooling::NDC ndc("term");
 413 #endif
 414    Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig").info("%s library shutdown complete", PACKAGE_STRING);
 415 }
 416
 417 Lockable* XMLToolingInternalConfig::lock()
 418 {
 419     xercesc::XMLPlatformUtils::lockMutex(m_lock);
 420     return this;
 421 }
 422
 423 void XMLToolingInternalConfig::unlock()
 424 {
 425     xercesc::XMLPlatformUtils::unlockMutex(m_lock);
 426 }
 427
 428 bool XMLToolingInternalConfig::load_library(const char* path, void* context)
 429 {
 430 #ifdef _DEBUG
 431     xmltooling::NDC ndc("LoadLibrary");
 432 #endif
 433     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
 434     log.info("loading extension: %s", path);
 435
 436     Locker locker(this);
 437
 438     string resolved(path);
 439     m_pathResolver->resolve(resolved, PathResolver::XMLTOOLING_LIB_FILE);
 440
 441 #if defined(WIN32)
 442     HMODULE handle=NULL;
 443     for (string::iterator i = resolved.begin(); i != resolved.end(); ++i)
 444         if (*i == '/')
 445             *i = '\\';
 446
 447     UINT em=SetErrorMode(SEM_FAILCRITICALERRORS);
 448     try {
 449         handle=LoadLibraryEx(resolved.c_str(),NULL,LOAD_WITH_ALTERED_SEARCH_PATH);
 450         if (!handle)
 451              handle=LoadLibraryEx(resolved.c_str(),NULL,0);
 452         if (!handle)
 453             throw runtime_error(string("unable to load extension library: ") + resolved);
 454         FARPROC fn=GetProcAddress(handle,"xmltooling_extension_init");
 455         if (!fn)
 456             throw runtime_error(string("unable to locate xmltooling_extension_init entry point: ") + resolved);
 457         if (reinterpret_cast<int(*)(void*)>(fn)(context)!=0)
 458             throw runtime_error(string("detected error in xmltooling_extension_init: ") + resolved);
 459         SetErrorMode(em);
 460     }
 461     catch(exception&) {
 462         if (handle)
 463             FreeLibrary(handle);
 464         SetErrorMode(em);
 465         throw;
 466     }
 467
 468 #elif defined(HAVE_DLFCN_H)
 469     void* handle=dlopen(resolved.c_str(),RTLD_LAZY);
 470     if (!handle)
 471         throw runtime_error(string("unable to load extension library '") + resolved + "': " + dlerror());
 472     int (*fn)(void*)=(int (*)(void*))(dlsym(handle,"xmltooling_extension_init"));
 473     if (!fn) {
 474         dlclose(handle);
 475         throw runtime_error(
 476             string("unable to locate xmltooling_extension_init entry point in '") + resolved + "': " +
 477                 (dlerror() ? dlerror() : "unknown error")
 478             );
 479     }
 480     try {
 481         if (fn(context)!=0)
 482             throw runtime_error(string("detected error in xmltooling_extension_init in ") + resolved);
 483     }
 484     catch(exception&) {
 485         if (handle)
 486             dlclose(handle);
 487         throw;
 488     }
 489 #else
 490 # error "Don't know about dynamic loading on this platform!"
 491 #endif
 492     m_libhandles.push_back(handle);
 493     log.info("loaded extension: %s", resolved.c_str());
 494     return true;
 495 }
 496
 497 #ifndef XMLTOOLING_NO_XMLSEC
 498 void xmltooling::log_openssl()
 499 {
 500     const char* file;
 501     const char* data;
 502     int flags,line;
 503
 504     unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
 505     while (code) {
 506         Category& log=Category::getInstance("OpenSSL");
 507         log.errorStream() << "error code: " << code << " in " << file << ", line " << line << logging::eol;
 508         if (data && (flags & ERR_TXT_STRING))
 509             log.errorStream() << "error data: " << data << logging::eol;
 510         code=ERR_get_error_line_data(&file,&line,&data,&flags);
 511     }
 512 }
 513
 514 XSECCryptoX509CRL* XMLToolingInternalConfig::X509CRL() const
 515 {
 516     return new OpenSSLCryptoX509CRL();
 517 }
 518
 519 void XMLToolingInternalConfig::registerXMLAlgorithms()
 520 {
 521     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_MD5, "RSA", 0);
 522     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA1, "RSA", 0);
 523     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA224, "RSA", 0);
 524     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA256, "RSA", 0);
 525     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA384, "RSA", 0);
 526     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA512, "RSA", 0);
 527
 528     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_1_5, "RSA", 0);
 529     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_OAEP_MGFP1, "RSA", 0);
 530
 531     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIDSA_SHA1, "DSA", 0);
 532
 533     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA1, "HMAC", 0);
 534     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA224, "HMAC", 0);
 535     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA256, "HMAC", 0);
 536     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA384, "HMAC", 0);
 537     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA512, "HMAC", 0);
 538
 539     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURI3DES_CBC, "DESede", 192);
 540     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_3DES, "DESede", 192);
 541
 542     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES128_CBC, "AES", 128);
 543     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES128, "AES", 128);
 544
 545     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES192_CBC, "AES", 192);
 546     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES192, "AES", 192);
 547
 548     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES256_CBC, "AES", 256);
 549     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES256, "AES", 256);
 550 }
 551 #endif
 552
 553 #ifdef WIN32
 554
 555 extern "C" __declspec(dllexport) BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID)
 556 {
 557     if (fdwReason == DLL_THREAD_DETACH || fdwReason == DLL_PROCESS_DETACH)
 558         ThreadKey::onDetach();
 559     return TRUE;
 560 }
 561
 562 #endif