Convert from NULL macro to nullptr.
[shibboleth/cpp-xmltooling.git] / xmltooling / XMLToolingConfig.cpp
index 6066437..be6d53a 100644 (file)
@@ -1,6 +1,6 @@
 /*
- *  Copyright 2001-2007 Internet2
- * 
+ *  Copyright 2001-2010 Internet2
+ *
  * Licensed 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
 
 /**
  * XMLToolingConfig.cpp
- * 
- * Library configuration 
+ *
+ * Library configuration.
  */
 
 #include "internal.h"
 #include "exceptions.h"
+#include "logging.h"
 #include "XMLToolingConfig.h"
+#include "encryption/Encryption.h"
 #include "encryption/Encrypter.h"
 #include "impl/UnknownElement.h"
+#include "io/HTTPResponse.h"
 #include "security/TrustEngine.h"
 #include "security/OpenSSLCryptoX509CRL.h"
 #include "security/CredentialResolver.h"
 #include "security/KeyInfoResolver.h"
+#include "signature/KeyInfo.h"
 #include "signature/Signature.h"
 #include "soap/SOAP.h"
-#include "soap/SOAPTransport.h"
 #include "util/NDC.h"
+#include "util/PathResolver.h"
 #include "util/ReplayCache.h"
 #include "util/StorageService.h"
 #include "util/TemplateEngine.h"
+#include "util/Threads.h"
 #include "util/URLEncoder.h"
-#include "util/XMLConstants.h"
 #include "validation/ValidatorSuite.h"
 
 #ifdef HAVE_DLFCN_H
 #endif
 
 #include <stdexcept>
-#include <curl/curl.h>
-#include <log4cpp/Category.hh>
-#include <log4cpp/PropertyConfigurator.hh>
-#include <log4cpp/OstreamAppender.hh>
+#if defined(XMLTOOLING_LOG4SHIB)
+# include <log4shib/PropertyConfigurator.hh>
+# include <log4shib/OstreamAppender.hh>
+#elif defined(XMLTOOLING_LOG4CPP)
+# include <log4cpp/PropertyConfigurator.hh>
+# include <log4cpp/OstreamAppender.hh>
+#endif
 #include <xercesc/util/PlatformUtils.hpp>
+#include <xercesc/util/XMLUniDefs.hpp>
 #ifndef XMLTOOLING_NO_XMLSEC
-    #include <xsec/framework/XSECProvider.hpp>
-    #include <openssl/err.h>
+# include <curl/curl.h>
+# include <openssl/err.h>
+# include <xsec/framework/XSECProvider.hpp>
 #endif
 
 using namespace soap11;
-using namespace xmlencryption;
-using namespace xmlsignature;
+using namespace xmltooling::logging;
 using namespace xmltooling;
-using namespace log4cpp;
 using namespace std;
 
+using xercesc::XMLPlatformUtils;
+
 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLParserException,xmltooling);
 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLObjectException,xmltooling);
 DECL_XMLTOOLING_EXCEPTION_FACTORY(MarshallingException,xmltooling);
@@ -73,6 +82,8 @@ DECL_XMLTOOLING_EXCEPTION_FACTORY(ValidationException,xmltooling);
 DECL_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
 
 #ifndef XMLTOOLING_NO_XMLSEC
+using namespace xmlencryption;
+using namespace xmlsignature;
     DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLSecurityException,xmltooling);
     DECL_XMLTOOLING_EXCEPTION_FACTORY(SignatureException,xmlsignature);
     DECL_XMLTOOLING_EXCEPTION_FACTORY(EncryptionException,xmlencryption);
@@ -80,6 +91,7 @@ DECL_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
 
 namespace xmltooling {
     static XMLToolingInternalConfig g_config;
+#ifndef XMLTOOLING_NO_XMLSEC
     static vector<Mutex*> g_openssl_locks;
 
     extern "C" void openssl_locking_callback(int mode,int n,const char *file,int line)
@@ -89,13 +101,30 @@ namespace xmltooling {
         else
             g_openssl_locks[n]->unlock();
     }
-    
-    #ifndef WIN32
+
+ifndef WIN32
     extern "C" unsigned long openssl_thread_id(void)
     {
         return (unsigned long)(pthread_self());
     }
-    #endif
+# endif
+#endif
+
+#ifdef WIN32
+    BOOL LogEvent(
+        LPCSTR  lpUNCServerName,
+        WORD  wType,
+        DWORD  dwEventID,
+        PSID  lpUserSid,
+        LPCSTR  message)
+    {
+        LPCSTR  messages[] = {message, nullptr};
+
+        HANDLE hElog = RegisterEventSource(lpUNCServerName, "OpenSAML XMLTooling Library");
+        BOOL res = ReportEvent(hElog, wType, 0, dwEventID, lpUserSid, 1, 0, messages, nullptr);
+        return (DeregisterEventSource(hElog) && res);
+    }
+#endif
 }
 
 XMLToolingConfig& XMLToolingConfig::getConfig()
@@ -108,6 +137,20 @@ XMLToolingInternalConfig& XMLToolingInternalConfig::getInternalConfig()
     return g_config;
 }
 
+#ifndef XMLTOOLING_NO_XMLSEC
+XMLToolingConfig::XMLToolingConfig()
+    : m_keyInfoResolver(nullptr), m_replayCache(nullptr), m_pathResolver(nullptr), m_templateEngine(nullptr), m_urlEncoder(nullptr), clock_skew_secs(180)
+#else
+XMLToolingConfig::XMLToolingConfig()
+    : m_pathResolver(nullptr), m_templateEngine(nullptr), m_urlEncoder(nullptr), clock_skew_secs(180)
+#endif
+{
+}
+
+XMLToolingConfig::~XMLToolingConfig()
+{
+}
+
 bool XMLToolingInternalConfig::log_config(const char* config)
 {
     try {
@@ -115,7 +158,7 @@ bool XMLToolingInternalConfig::log_config(const char* config)
             config=getenv("XMLTOOLING_LOG_CONFIG");
         if (!config || !*config)
             config="WARN";
-        
+
         bool level=false;
         Category& root = Category::getRoot();
         if (!strcmp(config,"DEBUG")) {
@@ -154,24 +197,70 @@ bool XMLToolingInternalConfig::log_config(const char* config)
             root.setPriority(Priority::FATAL);
             level=true;
         }
-        if (level)
+        if (level) {
             root.setAppender(new OstreamAppender("default",&cerr));
-        else
-            PropertyConfigurator::configure(config);
+        }
+        else {
+            string path(config);
+            PropertyConfigurator::configure(m_pathResolver ? m_pathResolver->resolve(path, PathResolver::XMLTOOLING_CFG_FILE) : path);
+        }
     }
     catch (const ConfigureFailure& e) {
-        Category::getInstance(XMLTOOLING_LOGCAT".Logging").crit("failed to initialize log4cpp: %s", e.what());
+        string msg = string("failed to configure logging: ") + e.what();
+        Category::getInstance(XMLTOOLING_LOGCAT".Logging").crit(msg);
+#ifdef WIN32
+        LogEvent(nullptr, EVENTLOG_ERROR_TYPE, 2100, nullptr, msg.c_str());
+#endif
         return false;
     }
-    
+
     return true;
 }
 
+#ifndef XMLTOOLING_LITE
+const KeyInfoResolver* XMLToolingConfig::getKeyInfoResolver() const
+{
+    return m_keyInfoResolver;
+}
+
+ReplayCache* XMLToolingConfig::getReplayCache() const
+{
+    return m_replayCache;
+}
+
+void XMLToolingConfig::setKeyInfoResolver(xmltooling::KeyInfoResolver *keyInfoResolver)
+{
+    delete m_keyInfoResolver;
+    m_keyInfoResolver = keyInfoResolver;
+}
+
 void XMLToolingConfig::setReplayCache(ReplayCache* replayCache)
 {
     delete m_replayCache;
     m_replayCache = replayCache;
 }
+#endif
+
+PathResolver* XMLToolingConfig::getPathResolver() const
+{
+    return m_pathResolver;
+}
+
+TemplateEngine* XMLToolingConfig::getTemplateEngine() const
+{
+    return m_templateEngine;
+}
+
+const URLEncoder* XMLToolingConfig::getURLEncoder() const
+{
+    return m_urlEncoder;
+}
+
+void XMLToolingConfig::setPathResolver(PathResolver* pathResolver)
+{
+    delete m_pathResolver;
+    m_pathResolver = pathResolver;
+}
 
 void XMLToolingConfig::setTemplateEngine(TemplateEngine* templateEngine)
 {
@@ -194,29 +283,31 @@ bool XMLToolingInternalConfig::init()
     try {
         log.debug("library initialization started");
 
+#ifndef XMLTOOLING_NO_XMLSEC
         if (curl_global_init(CURL_GLOBAL_ALL)) {
             log.fatal("failed to initialize libcurl, OpenSSL, or Winsock");
             return false;
         }
         log.debug("libcurl %s initialization complete", LIBCURL_VERSION);
+#endif
 
-        xercesc::XMLPlatformUtils::Initialize();
-        log.debug("Xerces initialization complete");
+        XMLPlatformUtils::Initialize();
+        log.debug("Xerces %s initialization complete", XERCES_FULLVERSIONDOT);
 
 #ifndef XMLTOOLING_NO_XMLSEC
         XSECPlatformUtils::Initialise();
         m_xsecProvider=new XSECProvider();
-        log.debug("XMLSec initialization complete");
+        log.debug("XML-Security %s initialization complete", XSEC_FULLVERSIONDOT);
 #endif
 
         m_parserPool=new ParserPool();
         m_validatingPool=new ParserPool(true,true);
-        m_lock=xercesc::XMLPlatformUtils::makeMutex();
-        
+        m_lock=XMLPlatformUtils::makeMutex();
+
         // Load catalogs from path.
         if (!catalog_path.empty()) {
             char* catpath=strdup(catalog_path.c_str());
-            char* sep=NULL;
+            char* sep=nullptr;
             char* start=catpath;
             while (start && *start) {
                 sep=strchr(start,PATH_SEPARATOR_CHAR);
@@ -224,7 +315,7 @@ bool XMLToolingInternalConfig::init()
                     *sep=0;
                 auto_ptr_XMLCh temp(start);
                 m_validatingPool->loadCatalog(temp.get());
-                start = sep ? sep + 1 : NULL;
+                start = sep ? sep + 1 : nullptr;
             }
             free(catpath);
         }
@@ -232,8 +323,6 @@ bool XMLToolingInternalConfig::init()
         // default registrations
         XMLObjectBuilder::registerDefaultBuilder(new UnknownElementBuilder());
 
-        registerKeyInfoClasses();
-        registerEncryptionClasses();
         registerSOAPClasses();
 
         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLParserException,xmltooling);
@@ -244,78 +333,93 @@ bool XMLToolingInternalConfig::init()
         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnknownAttributeException,xmltooling);
         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ValidationException,xmltooling);
         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
-        
+
 #ifndef XMLTOOLING_NO_XMLSEC
         XMLObjectBuilder::registerBuilder(QName(xmlconstants::XMLSIG_NS,Signature::LOCAL_NAME),new SignatureBuilder());
         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLSecurityException,xmltooling);
         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(SignatureException,xmlsignature);
         REGISTER_XMLTOOLING_EXCEPTION_FACTORY(EncryptionException,xmlencryption);
+        registerKeyInfoClasses();
+        registerEncryptionClasses();
         registerKeyInfoResolvers();
         registerCredentialResolvers();
         registerTrustEngines();
         registerXMLAlgorithms();
-#endif
         registerSOAPTransports();
         initSOAPTransports();
         registerStorageServices();
+        m_keyInfoResolver = KeyInfoResolverManager.newPlugin(INLINE_KEYINFO_RESOLVER,nullptr);
+#endif
 
+        m_pathResolver = new PathResolver();
         m_urlEncoder = new URLEncoder();
-        m_keyInfoResolver = KeyInfoResolverManager.newPlugin(INLINE_KEYINFO_RESOLVER,NULL);
-        
-        // Register xml:id as an ID attribute.        
+
+        HTTPResponse::getAllowedSchemes().push_back("https");
+        HTTPResponse::getAllowedSchemes().push_back("http");
+
+        // Register xml:id as an ID attribute.
         static const XMLCh xmlid[] = UNICODE_LITERAL_2(i,d);
-        AttributeExtensibleXMLObject::registerIDAttribute(QName(xmlconstants::XML_NS, xmlid)); 
+        AttributeExtensibleXMLObject::registerIDAttribute(QName(xmlconstants::XML_NS, xmlid));
     }
     catch (const xercesc::XMLException&) {
         log.fatal("caught exception while initializing Xerces");
+#ifndef XMLTOOLING_NO_XMLSEC
         curl_global_cleanup();
+#endif
         return false;
     }
 
+#ifndef XMLTOOLING_NO_XMLSEC
     // Set up OpenSSL locking.
     for (int i=0; i<CRYPTO_num_locks(); i++)
         g_openssl_locks.push_back(Mutex::create());
     CRYPTO_set_locking_callback(openssl_locking_callback);
-#ifndef WIN32
+# ifndef WIN32
     CRYPTO_set_id_callback(openssl_thread_id);
+# endif
 #endif
 
-    log.info("library initialization complete");
+    log.info("%s library initialization complete", PACKAGE_STRING);
     return true;
 }
 
 void XMLToolingInternalConfig::term()
 {
-    CRYPTO_set_locking_callback(NULL);
+#ifndef XMLTOOLING_NO_XMLSEC
+    CRYPTO_set_locking_callback(nullptr);
     for_each(g_openssl_locks.begin(), g_openssl_locks.end(), xmltooling::cleanup<Mutex>());
     g_openssl_locks.clear();
+#endif
 
     SchemaValidators.destroyValidators();
     XMLObjectBuilder::destroyBuilders();
     XMLToolingException::deregisterFactories();
     AttributeExtensibleXMLObject::deregisterIDAttributes();
 
+#ifndef XMLTOOLING_NO_XMLSEC
     StorageServiceManager.deregisterFactories();
     termSOAPTransports();
     SOAPTransportManager.deregisterFactories();
-#ifndef XMLTOOLING_NO_XMLSEC
     TrustEngineManager.deregisterFactories();
     CredentialResolverManager.deregisterFactories();
     KeyInfoResolverManager.deregisterFactories();
     m_algorithmMap.clear();
-#endif
 
     delete m_keyInfoResolver;
-    m_keyInfoResolver = NULL;
+    m_keyInfoResolver = nullptr;
 
     delete m_replayCache;
-    m_replayCache = NULL;
-    
+    m_replayCache = nullptr;
+#endif
+
+    delete m_pathResolver;
+    m_pathResolver = nullptr;
+
     delete m_templateEngine;
-    m_templateEngine = NULL;
+    m_templateEngine = nullptr;
 
     delete m_urlEncoder;
-    m_urlEncoder = NULL;
+    m_urlEncoder = nullptr;
 
     for (vector<void*>::reverse_iterator i=m_libhandles.rbegin(); i!=m_libhandles.rend(); i++) {
 #if defined(WIN32)
@@ -333,28 +437,29 @@ void XMLToolingInternalConfig::term()
 #endif
     }
     m_libhandles.clear();
-    
+
     delete m_parserPool;
-    m_parserPool=NULL;
+    m_parserPool=nullptr;
     delete m_validatingPool;
-    m_validatingPool=NULL;
+    m_validatingPool=nullptr;
 
 #ifndef XMLTOOLING_NO_XMLSEC
     delete m_xsecProvider;
-    m_xsecProvider=NULL;
+    m_xsecProvider=nullptr;
     XSECPlatformUtils::Terminate();
 #endif
 
-    xercesc::XMLPlatformUtils::closeMutex(m_lock);
-    m_lock=NULL;
-    xercesc::XMLPlatformUtils::Terminate();
+    XMLPlatformUtils::closeMutex(m_lock);
+    m_lock=nullptr;
+    XMLPlatformUtils::Terminate();
 
+#ifndef XMLTOOLING_NO_XMLSEC
     curl_global_cleanup();
-    
- #ifdef _DEBUG
+#endif
+#ifdef _DEBUG
     xmltooling::NDC ndc("term");
 #endif
-   Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig").info("library shutdown complete");
+   Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig").info("%s library shutdown complete", PACKAGE_STRING);
 }
 
 Lockable* XMLToolingInternalConfig::lock()
@@ -378,69 +483,62 @@ bool XMLToolingInternalConfig::load_library(const char* path, void* context)
 
     Locker locker(this);
 
+    string resolved(path);
+    m_pathResolver->resolve(resolved, PathResolver::XMLTOOLING_LIB_FILE);
+
 #if defined(WIN32)
-    HMODULE handle=NULL;
-    char* fixed=const_cast<char*>(path);
-    if (strchr(fixed,'/')) {
-        fixed=strdup(path);
-        char* p=fixed;
-        while (p=strchr(p,'/'))
-            *p='\\';
-    }
+    HMODULE handle=nullptr;
+    for (string::iterator i = resolved.begin(); i != resolved.end(); ++i)
+        if (*i == '/')
+            *i = '\\';
 
     UINT em=SetErrorMode(SEM_FAILCRITICALERRORS);
     try {
-        handle=LoadLibraryEx(fixed,NULL,LOAD_WITH_ALTERED_SEARCH_PATH);
+        handle=LoadLibraryEx(resolved.c_str(),nullptr,LOAD_WITH_ALTERED_SEARCH_PATH);
         if (!handle)
-             handle=LoadLibraryEx(fixed,NULL,0);
+             handle=LoadLibraryEx(resolved.c_str(),nullptr,0);
         if (!handle)
-            throw runtime_error(string("unable to load extension library: ") + fixed);
+            throw runtime_error(string("unable to load extension library: ") + resolved);
         FARPROC fn=GetProcAddress(handle,"xmltooling_extension_init");
         if (!fn)
-            throw runtime_error(string("unable to locate xmltooling_extension_init entry point: ") + fixed);
+            throw runtime_error(string("unable to locate xmltooling_extension_init entry point: ") + resolved);
         if (reinterpret_cast<int(*)(void*)>(fn)(context)!=0)
-            throw runtime_error(string("detected error in xmltooling_extension_init: ") + fixed);
-        if (fixed!=path)
-            free(fixed);
+            throw runtime_error(string("detected error in xmltooling_extension_init: ") + resolved);
         SetErrorMode(em);
     }
-    catch(runtime_error& e) {
-        log.error(e.what());
+    catch(exception&) {
         if (handle)
             FreeLibrary(handle);
         SetErrorMode(em);
-        if (fixed!=path)
-            free(fixed);
-        return false;
+        throw;
     }
 
 #elif defined(HAVE_DLFCN_H)
-    void* handle=dlopen(path,RTLD_LAZY);
+    void* handle=dlopen(resolved.c_str(),RTLD_LAZY);
     if (!handle)
-        throw runtime_error(string("unable to load extension library '") + path + "': " + dlerror());
+        throw runtime_error(string("unable to load extension library '") + resolved + "': " + dlerror());
     int (*fn)(void*)=(int (*)(void*))(dlsym(handle,"xmltooling_extension_init"));
     if (!fn) {
         dlclose(handle);
         throw runtime_error(
-            string("unable to locate xmltooling_extension_init entry point in '") + path + "': " +
+            string("unable to locate xmltooling_extension_init entry point in '") + resolved + "': " +
                 (dlerror() ? dlerror() : "unknown error")
             );
     }
     try {
         if (fn(context)!=0)
-            throw runtime_error(string("detected error in xmltooling_extension_init in ") + path);
+            throw runtime_error(string("detected error in xmltooling_extension_init in ") + resolved);
     }
-    catch(runtime_error& e) {
-        log.error(e.what());
+    catch(exception&) {
         if (handle)
             dlclose(handle);
-        return false;
+        throw;
     }
 #else
 # error "Don't know about dynamic loading on this platform!"
 #endif
     m_libhandles.push_back(handle);
-    log.info("loaded extension: %s", path);
+    log.info("loaded extension: %s", resolved.c_str());
     return true;
 }
 
@@ -454,9 +552,9 @@ void xmltooling::log_openssl()
     unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
     while (code) {
         Category& log=Category::getInstance("OpenSSL");
-        log.errorStream() << "error code: " << code << " in " << file << ", line " << line << CategoryStream::ENDLINE;
+        log.errorStream() << "error code: " << code << " in " << file << ", line " << line << logging::eol;
         if (data && (flags & ERR_TXT_STRING))
-            log.errorStream() << "error data: " << data << CategoryStream::ENDLINE;
+            log.errorStream() << "error data: " << data << logging::eol;
         code=ERR_get_error_line_data(&file,&line,&data,&flags);
     }
 }
@@ -499,3 +597,14 @@ void XMLToolingInternalConfig::registerXMLAlgorithms()
     registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES256, "AES", 256);
 }
 #endif
+
+#ifdef WIN32
+
+extern "C" __declspec(dllexport) BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID)
+{
+    if (fdwReason == DLL_THREAD_DETACH || fdwReason == DLL_PROCESS_DETACH)
+        ThreadKey::onDetach();
+    return TRUE;
+}
+
+#endif