2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * XMLToolingConfig.cpp
20 * Library configuration
24 #include "exceptions.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"
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"
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>
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>
67 using namespace soap11;
68 using namespace xmltooling::logging;
69 using namespace xmltooling;
72 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLParserException,xmltooling);
73 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLObjectException,xmltooling);
74 DECL_XMLTOOLING_EXCEPTION_FACTORY(MarshallingException,xmltooling);
75 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnmarshallingException,xmltooling);
76 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnknownElementException,xmltooling);
77 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnknownAttributeException,xmltooling);
78 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnknownExtensionException,xmltooling);
79 DECL_XMLTOOLING_EXCEPTION_FACTORY(ValidationException,xmltooling);
80 DECL_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
82 #ifndef XMLTOOLING_NO_XMLSEC
83 using namespace xmlencryption;
84 using namespace xmlsignature;
85 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLSecurityException,xmltooling);
86 DECL_XMLTOOLING_EXCEPTION_FACTORY(SignatureException,xmlsignature);
87 DECL_XMLTOOLING_EXCEPTION_FACTORY(EncryptionException,xmlencryption);
90 namespace xmltooling {
91 static XMLToolingInternalConfig g_config;
92 #ifndef XMLTOOLING_NO_XMLSEC
93 static vector<Mutex*> g_openssl_locks;
95 extern "C" void openssl_locking_callback(int mode,int n,const char *file,int line)
97 if (mode & CRYPTO_LOCK)
98 g_openssl_locks[n]->lock();
100 g_openssl_locks[n]->unlock();
104 extern "C" unsigned long openssl_thread_id(void)
106 return (unsigned long)(pthread_self());
112 XMLToolingConfig& XMLToolingConfig::getConfig()
117 XMLToolingInternalConfig& XMLToolingInternalConfig::getInternalConfig()
122 bool XMLToolingInternalConfig::log_config(const char* config)
125 if (!config || !*config)
126 config=getenv("XMLTOOLING_LOG_CONFIG");
127 if (!config || !*config)
131 Category& root = Category::getRoot();
132 if (!strcmp(config,"DEBUG")) {
133 root.setPriority(Priority::DEBUG);
136 else if (!strcmp(config,"INFO")) {
137 root.setPriority(Priority::INFO);
140 else if (!strcmp(config,"NOTICE")) {
141 root.setPriority(Priority::NOTICE);
144 else if (!strcmp(config,"WARN")) {
145 root.setPriority(Priority::WARN);
148 else if (!strcmp(config,"ERROR")) {
149 root.setPriority(Priority::ERROR);
152 else if (!strcmp(config,"CRIT")) {
153 root.setPriority(Priority::CRIT);
156 else if (!strcmp(config,"ALERT")) {
157 root.setPriority(Priority::ALERT);
160 else if (!strcmp(config,"EMERG")) {
161 root.setPriority(Priority::EMERG);
164 else if (!strcmp(config,"FATAL")) {
165 root.setPriority(Priority::FATAL);
169 root.setAppender(new OstreamAppender("default",&cerr));
173 PropertyConfigurator::configure(m_pathResolver ? m_pathResolver->resolve(path, PathResolver::XMLTOOLING_CFG_FILE) : path);
176 catch (const ConfigureFailure& e) {
177 Category::getInstance(XMLTOOLING_LOGCAT".Logging").crit("failed to initialize log4cpp: %s", e.what());
184 #ifndef XMLTOOLING_LITE
185 void XMLToolingConfig::setReplayCache(ReplayCache* replayCache)
187 delete m_replayCache;
188 m_replayCache = replayCache;
192 void XMLToolingConfig::setPathResolver(PathResolver* pathResolver)
194 delete m_pathResolver;
195 m_pathResolver = pathResolver;
198 void XMLToolingConfig::setTemplateEngine(TemplateEngine* templateEngine)
200 delete m_templateEngine;
201 m_templateEngine = templateEngine;
204 void XMLToolingConfig::setURLEncoder(URLEncoder* urlEncoder)
207 m_urlEncoder = urlEncoder;
210 bool XMLToolingInternalConfig::init()
213 xmltooling::NDC ndc("init");
215 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
217 log.debug("library initialization started");
219 #ifndef XMLTOOLING_NO_XMLSEC
220 if (curl_global_init(CURL_GLOBAL_ALL)) {
221 log.fatal("failed to initialize libcurl, OpenSSL, or Winsock");
224 log.debug("libcurl %s initialization complete", LIBCURL_VERSION);
227 XMLPlatformUtils::Initialize();
228 log.debug("Xerces %s initialization complete", XERCES_FULLVERSIONDOT);
230 #ifndef XMLTOOLING_NO_XMLSEC
231 XSECPlatformUtils::Initialise();
232 m_xsecProvider=new XSECProvider();
233 log.debug("XML-Security %s initialization complete", XSEC_FULLVERSIONDOT);
236 m_parserPool=new ParserPool();
237 m_validatingPool=new ParserPool(true,true);
238 m_lock=XMLPlatformUtils::makeMutex();
240 // Load catalogs from path.
241 if (!catalog_path.empty()) {
242 char* catpath=strdup(catalog_path.c_str());
245 while (start && *start) {
246 sep=strchr(start,PATH_SEPARATOR_CHAR);
249 auto_ptr_XMLCh temp(start);
250 m_validatingPool->loadCatalog(temp.get());
251 start = sep ? sep + 1 : NULL;
256 // default registrations
257 XMLObjectBuilder::registerDefaultBuilder(new UnknownElementBuilder());
259 registerSOAPClasses();
261 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLParserException,xmltooling);
262 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLObjectException,xmltooling);
263 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MarshallingException,xmltooling);
264 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnmarshallingException,xmltooling);
265 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnknownElementException,xmltooling);
266 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnknownAttributeException,xmltooling);
267 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ValidationException,xmltooling);
268 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
270 #ifndef XMLTOOLING_NO_XMLSEC
271 XMLObjectBuilder::registerBuilder(QName(xmlconstants::XMLSIG_NS,Signature::LOCAL_NAME),new SignatureBuilder());
272 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLSecurityException,xmltooling);
273 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(SignatureException,xmlsignature);
274 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(EncryptionException,xmlencryption);
275 registerKeyInfoClasses();
276 registerEncryptionClasses();
277 registerKeyInfoResolvers();
278 registerCredentialResolvers();
279 registerTrustEngines();
280 registerXMLAlgorithms();
281 registerSOAPTransports();
282 initSOAPTransports();
283 registerStorageServices();
284 m_keyInfoResolver = KeyInfoResolverManager.newPlugin(INLINE_KEYINFO_RESOLVER,NULL);
287 m_pathResolver = new PathResolver();
288 m_urlEncoder = new URLEncoder();
290 // Register xml:id as an ID attribute.
291 static const XMLCh xmlid[] = UNICODE_LITERAL_2(i,d);
292 AttributeExtensibleXMLObject::registerIDAttribute(QName(xmlconstants::XML_NS, xmlid));
294 catch (const xercesc::XMLException&) {
295 log.fatal("caught exception while initializing Xerces");
296 #ifndef XMLTOOLING_NO_XMLSEC
297 curl_global_cleanup();
302 #ifndef XMLTOOLING_NO_XMLSEC
303 // Set up OpenSSL locking.
304 for (int i=0; i<CRYPTO_num_locks(); i++)
305 g_openssl_locks.push_back(Mutex::create());
306 CRYPTO_set_locking_callback(openssl_locking_callback);
308 CRYPTO_set_id_callback(openssl_thread_id);
312 log.info("%s library initialization complete", PACKAGE_STRING);
316 void XMLToolingInternalConfig::term()
318 #ifndef XMLTOOLING_NO_XMLSEC
319 CRYPTO_set_locking_callback(NULL);
320 for_each(g_openssl_locks.begin(), g_openssl_locks.end(), xmltooling::cleanup<Mutex>());
321 g_openssl_locks.clear();
324 SchemaValidators.destroyValidators();
325 XMLObjectBuilder::destroyBuilders();
326 XMLToolingException::deregisterFactories();
327 AttributeExtensibleXMLObject::deregisterIDAttributes();
329 #ifndef XMLTOOLING_NO_XMLSEC
330 StorageServiceManager.deregisterFactories();
331 termSOAPTransports();
332 SOAPTransportManager.deregisterFactories();
333 TrustEngineManager.deregisterFactories();
334 CredentialResolverManager.deregisterFactories();
335 KeyInfoResolverManager.deregisterFactories();
336 m_algorithmMap.clear();
338 delete m_keyInfoResolver;
339 m_keyInfoResolver = NULL;
341 delete m_replayCache;
342 m_replayCache = NULL;
345 delete m_pathResolver;
346 m_pathResolver = NULL;
348 delete m_templateEngine;
349 m_templateEngine = NULL;
354 for (vector<void*>::reverse_iterator i=m_libhandles.rbegin(); i!=m_libhandles.rend(); i++) {
356 FARPROC fn=GetProcAddress(static_cast<HMODULE>(*i),"xmltooling_extension_term");
359 FreeLibrary(static_cast<HMODULE>(*i));
360 #elif defined(HAVE_DLFCN_H)
361 void (*fn)()=(void (*)())dlsym(*i,"xmltooling_extension_term");
366 # error "Don't know about dynamic loading on this platform!"
369 m_libhandles.clear();
373 delete m_validatingPool;
374 m_validatingPool=NULL;
376 #ifndef XMLTOOLING_NO_XMLSEC
377 delete m_xsecProvider;
379 XSECPlatformUtils::Terminate();
382 XMLPlatformUtils::closeMutex(m_lock);
384 XMLPlatformUtils::Terminate();
386 #ifndef XMLTOOLING_NO_XMLSEC
387 curl_global_cleanup();
390 xmltooling::NDC ndc("term");
392 Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig").info("%s library shutdown complete", PACKAGE_STRING);
395 Lockable* XMLToolingInternalConfig::lock()
397 xercesc::XMLPlatformUtils::lockMutex(m_lock);
401 void XMLToolingInternalConfig::unlock()
403 xercesc::XMLPlatformUtils::unlockMutex(m_lock);
406 bool XMLToolingInternalConfig::load_library(const char* path, void* context)
409 xmltooling::NDC ndc("LoadLibrary");
411 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
412 log.info("loading extension: %s", path);
416 string resolved(path);
417 m_pathResolver->resolve(resolved, PathResolver::XMLTOOLING_LIB_FILE);
421 for (string::iterator i = resolved.begin(); i != resolved.end(); ++i)
425 UINT em=SetErrorMode(SEM_FAILCRITICALERRORS);
427 handle=LoadLibraryEx(resolved.c_str(),NULL,LOAD_WITH_ALTERED_SEARCH_PATH);
429 handle=LoadLibraryEx(resolved.c_str(),NULL,0);
431 throw runtime_error(string("unable to load extension library: ") + resolved);
432 FARPROC fn=GetProcAddress(handle,"xmltooling_extension_init");
434 throw runtime_error(string("unable to locate xmltooling_extension_init entry point: ") + resolved);
435 if (reinterpret_cast<int(*)(void*)>(fn)(context)!=0)
436 throw runtime_error(string("detected error in xmltooling_extension_init: ") + resolved);
446 #elif defined(HAVE_DLFCN_H)
447 void* handle=dlopen(resolved.c_str(),RTLD_LAZY);
449 throw runtime_error(string("unable to load extension library '") + resolved + "': " + dlerror());
450 int (*fn)(void*)=(int (*)(void*))(dlsym(handle,"xmltooling_extension_init"));
454 string("unable to locate xmltooling_extension_init entry point in '") + resolved + "': " +
455 (dlerror() ? dlerror() : "unknown error")
460 throw runtime_error(string("detected error in xmltooling_extension_init in ") + resolved);
468 # error "Don't know about dynamic loading on this platform!"
470 m_libhandles.push_back(handle);
471 log.info("loaded extension: %s", resolved.c_str());
475 #ifndef XMLTOOLING_NO_XMLSEC
476 void xmltooling::log_openssl()
482 unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
484 Category& log=Category::getInstance("OpenSSL");
485 log.errorStream() << "error code: " << code << " in " << file << ", line " << line << logging::eol;
486 if (data && (flags & ERR_TXT_STRING))
487 log.errorStream() << "error data: " << data << logging::eol;
488 code=ERR_get_error_line_data(&file,&line,&data,&flags);
492 XSECCryptoX509CRL* XMLToolingInternalConfig::X509CRL() const
494 return new OpenSSLCryptoX509CRL();
497 void XMLToolingInternalConfig::registerXMLAlgorithms()
499 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_MD5, "RSA", 0);
500 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA1, "RSA", 0);
501 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA224, "RSA", 0);
502 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA256, "RSA", 0);
503 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA384, "RSA", 0);
504 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA512, "RSA", 0);
506 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_1_5, "RSA", 0);
507 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_OAEP_MGFP1, "RSA", 0);
509 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIDSA_SHA1, "DSA", 0);
511 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA1, "HMAC", 0);
512 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA224, "HMAC", 0);
513 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA256, "HMAC", 0);
514 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA384, "HMAC", 0);
515 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA512, "HMAC", 0);
517 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURI3DES_CBC, "DESede", 192);
518 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_3DES, "DESede", 192);
520 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES128_CBC, "AES", 128);
521 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES128, "AES", 128);
523 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES192_CBC, "AES", 192);
524 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES192, "AES", 192);
526 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES256_CBC, "AES", 256);
527 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES256, "AES", 256);