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 using xercesc::XMLPlatformUtils;
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);
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);
92 namespace xmltooling {
93 static XMLToolingInternalConfig g_config;
94 #ifndef XMLTOOLING_NO_XMLSEC
95 static vector<Mutex*> g_openssl_locks;
97 extern "C" void openssl_locking_callback(int mode,int n,const char *file,int line)
99 if (mode & CRYPTO_LOCK)
100 g_openssl_locks[n]->lock();
102 g_openssl_locks[n]->unlock();
106 extern "C" unsigned long openssl_thread_id(void)
108 return (unsigned long)(pthread_self());
114 XMLToolingConfig& XMLToolingConfig::getConfig()
119 XMLToolingInternalConfig& XMLToolingInternalConfig::getInternalConfig()
124 bool XMLToolingInternalConfig::log_config(const char* config)
127 if (!config || !*config)
128 config=getenv("XMLTOOLING_LOG_CONFIG");
129 if (!config || !*config)
133 Category& root = Category::getRoot();
134 if (!strcmp(config,"DEBUG")) {
135 root.setPriority(Priority::DEBUG);
138 else if (!strcmp(config,"INFO")) {
139 root.setPriority(Priority::INFO);
142 else if (!strcmp(config,"NOTICE")) {
143 root.setPriority(Priority::NOTICE);
146 else if (!strcmp(config,"WARN")) {
147 root.setPriority(Priority::WARN);
150 else if (!strcmp(config,"ERROR")) {
151 root.setPriority(Priority::ERROR);
154 else if (!strcmp(config,"CRIT")) {
155 root.setPriority(Priority::CRIT);
158 else if (!strcmp(config,"ALERT")) {
159 root.setPriority(Priority::ALERT);
162 else if (!strcmp(config,"EMERG")) {
163 root.setPriority(Priority::EMERG);
166 else if (!strcmp(config,"FATAL")) {
167 root.setPriority(Priority::FATAL);
171 root.setAppender(new OstreamAppender("default",&cerr));
175 PropertyConfigurator::configure(m_pathResolver ? m_pathResolver->resolve(path, PathResolver::XMLTOOLING_CFG_FILE) : path);
178 catch (const ConfigureFailure& e) {
179 Category::getInstance(XMLTOOLING_LOGCAT".Logging").crit("failed to initialize log4cpp: %s", e.what());
186 #ifndef XMLTOOLING_LITE
187 void XMLToolingConfig::setReplayCache(ReplayCache* replayCache)
189 delete m_replayCache;
190 m_replayCache = replayCache;
194 void XMLToolingConfig::setPathResolver(PathResolver* pathResolver)
196 delete m_pathResolver;
197 m_pathResolver = pathResolver;
200 void XMLToolingConfig::setTemplateEngine(TemplateEngine* templateEngine)
202 delete m_templateEngine;
203 m_templateEngine = templateEngine;
206 void XMLToolingConfig::setURLEncoder(URLEncoder* urlEncoder)
209 m_urlEncoder = urlEncoder;
212 bool XMLToolingInternalConfig::init()
215 xmltooling::NDC ndc("init");
217 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
219 log.debug("library initialization started");
221 #ifndef XMLTOOLING_NO_XMLSEC
222 if (curl_global_init(CURL_GLOBAL_ALL)) {
223 log.fatal("failed to initialize libcurl, OpenSSL, or Winsock");
226 log.debug("libcurl %s initialization complete", LIBCURL_VERSION);
229 XMLPlatformUtils::Initialize();
230 log.debug("Xerces %s initialization complete", XERCES_FULLVERSIONDOT);
232 #ifndef XMLTOOLING_NO_XMLSEC
233 XSECPlatformUtils::Initialise();
234 m_xsecProvider=new XSECProvider();
235 log.debug("XML-Security %s initialization complete", XSEC_FULLVERSIONDOT);
238 m_parserPool=new ParserPool();
239 m_validatingPool=new ParserPool(true,true);
240 m_lock=XMLPlatformUtils::makeMutex();
242 // Load catalogs from path.
243 if (!catalog_path.empty()) {
244 char* catpath=strdup(catalog_path.c_str());
247 while (start && *start) {
248 sep=strchr(start,PATH_SEPARATOR_CHAR);
251 auto_ptr_XMLCh temp(start);
252 m_validatingPool->loadCatalog(temp.get());
253 start = sep ? sep + 1 : NULL;
258 // default registrations
259 XMLObjectBuilder::registerDefaultBuilder(new UnknownElementBuilder());
261 registerSOAPClasses();
263 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLParserException,xmltooling);
264 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLObjectException,xmltooling);
265 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MarshallingException,xmltooling);
266 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnmarshallingException,xmltooling);
267 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnknownElementException,xmltooling);
268 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnknownAttributeException,xmltooling);
269 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ValidationException,xmltooling);
270 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
272 #ifndef XMLTOOLING_NO_XMLSEC
273 XMLObjectBuilder::registerBuilder(QName(xmlconstants::XMLSIG_NS,Signature::LOCAL_NAME),new SignatureBuilder());
274 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLSecurityException,xmltooling);
275 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(SignatureException,xmlsignature);
276 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(EncryptionException,xmlencryption);
277 registerKeyInfoClasses();
278 registerEncryptionClasses();
279 registerKeyInfoResolvers();
280 registerCredentialResolvers();
281 registerTrustEngines();
282 registerXMLAlgorithms();
283 registerSOAPTransports();
284 initSOAPTransports();
285 registerStorageServices();
286 m_keyInfoResolver = KeyInfoResolverManager.newPlugin(INLINE_KEYINFO_RESOLVER,NULL);
289 m_pathResolver = new PathResolver();
290 m_urlEncoder = new URLEncoder();
292 // Register xml:id as an ID attribute.
293 static const XMLCh xmlid[] = UNICODE_LITERAL_2(i,d);
294 AttributeExtensibleXMLObject::registerIDAttribute(QName(xmlconstants::XML_NS, xmlid));
296 catch (const xercesc::XMLException&) {
297 log.fatal("caught exception while initializing Xerces");
298 #ifndef XMLTOOLING_NO_XMLSEC
299 curl_global_cleanup();
304 #ifndef XMLTOOLING_NO_XMLSEC
305 // Set up OpenSSL locking.
306 for (int i=0; i<CRYPTO_num_locks(); i++)
307 g_openssl_locks.push_back(Mutex::create());
308 CRYPTO_set_locking_callback(openssl_locking_callback);
310 CRYPTO_set_id_callback(openssl_thread_id);
314 log.info("%s library initialization complete", PACKAGE_STRING);
318 void XMLToolingInternalConfig::term()
320 #ifndef XMLTOOLING_NO_XMLSEC
321 CRYPTO_set_locking_callback(NULL);
322 for_each(g_openssl_locks.begin(), g_openssl_locks.end(), xmltooling::cleanup<Mutex>());
323 g_openssl_locks.clear();
326 SchemaValidators.destroyValidators();
327 XMLObjectBuilder::destroyBuilders();
328 XMLToolingException::deregisterFactories();
329 AttributeExtensibleXMLObject::deregisterIDAttributes();
331 #ifndef XMLTOOLING_NO_XMLSEC
332 StorageServiceManager.deregisterFactories();
333 termSOAPTransports();
334 SOAPTransportManager.deregisterFactories();
335 TrustEngineManager.deregisterFactories();
336 CredentialResolverManager.deregisterFactories();
337 KeyInfoResolverManager.deregisterFactories();
338 m_algorithmMap.clear();
340 delete m_keyInfoResolver;
341 m_keyInfoResolver = NULL;
343 delete m_replayCache;
344 m_replayCache = NULL;
347 delete m_pathResolver;
348 m_pathResolver = NULL;
350 delete m_templateEngine;
351 m_templateEngine = NULL;
356 for (vector<void*>::reverse_iterator i=m_libhandles.rbegin(); i!=m_libhandles.rend(); i++) {
358 FARPROC fn=GetProcAddress(static_cast<HMODULE>(*i),"xmltooling_extension_term");
361 FreeLibrary(static_cast<HMODULE>(*i));
362 #elif defined(HAVE_DLFCN_H)
363 void (*fn)()=(void (*)())dlsym(*i,"xmltooling_extension_term");
368 # error "Don't know about dynamic loading on this platform!"
371 m_libhandles.clear();
375 delete m_validatingPool;
376 m_validatingPool=NULL;
378 #ifndef XMLTOOLING_NO_XMLSEC
379 delete m_xsecProvider;
381 XSECPlatformUtils::Terminate();
384 XMLPlatformUtils::closeMutex(m_lock);
386 XMLPlatformUtils::Terminate();
388 #ifndef XMLTOOLING_NO_XMLSEC
389 curl_global_cleanup();
392 xmltooling::NDC ndc("term");
394 Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig").info("%s library shutdown complete", PACKAGE_STRING);
397 Lockable* XMLToolingInternalConfig::lock()
399 xercesc::XMLPlatformUtils::lockMutex(m_lock);
403 void XMLToolingInternalConfig::unlock()
405 xercesc::XMLPlatformUtils::unlockMutex(m_lock);
408 bool XMLToolingInternalConfig::load_library(const char* path, void* context)
411 xmltooling::NDC ndc("LoadLibrary");
413 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
414 log.info("loading extension: %s", path);
418 string resolved(path);
419 m_pathResolver->resolve(resolved, PathResolver::XMLTOOLING_LIB_FILE);
423 for (string::iterator i = resolved.begin(); i != resolved.end(); ++i)
427 UINT em=SetErrorMode(SEM_FAILCRITICALERRORS);
429 handle=LoadLibraryEx(resolved.c_str(),NULL,LOAD_WITH_ALTERED_SEARCH_PATH);
431 handle=LoadLibraryEx(resolved.c_str(),NULL,0);
433 throw runtime_error(string("unable to load extension library: ") + resolved);
434 FARPROC fn=GetProcAddress(handle,"xmltooling_extension_init");
436 throw runtime_error(string("unable to locate xmltooling_extension_init entry point: ") + resolved);
437 if (reinterpret_cast<int(*)(void*)>(fn)(context)!=0)
438 throw runtime_error(string("detected error in xmltooling_extension_init: ") + resolved);
448 #elif defined(HAVE_DLFCN_H)
449 void* handle=dlopen(resolved.c_str(),RTLD_LAZY);
451 throw runtime_error(string("unable to load extension library '") + resolved + "': " + dlerror());
452 int (*fn)(void*)=(int (*)(void*))(dlsym(handle,"xmltooling_extension_init"));
456 string("unable to locate xmltooling_extension_init entry point in '") + resolved + "': " +
457 (dlerror() ? dlerror() : "unknown error")
462 throw runtime_error(string("detected error in xmltooling_extension_init in ") + resolved);
470 # error "Don't know about dynamic loading on this platform!"
472 m_libhandles.push_back(handle);
473 log.info("loaded extension: %s", resolved.c_str());
477 #ifndef XMLTOOLING_NO_XMLSEC
478 void xmltooling::log_openssl()
484 unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
486 Category& log=Category::getInstance("OpenSSL");
487 log.errorStream() << "error code: " << code << " in " << file << ", line " << line << logging::eol;
488 if (data && (flags & ERR_TXT_STRING))
489 log.errorStream() << "error data: " << data << logging::eol;
490 code=ERR_get_error_line_data(&file,&line,&data,&flags);
494 XSECCryptoX509CRL* XMLToolingInternalConfig::X509CRL() const
496 return new OpenSSLCryptoX509CRL();
499 void XMLToolingInternalConfig::registerXMLAlgorithms()
501 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_MD5, "RSA", 0);
502 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA1, "RSA", 0);
503 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA224, "RSA", 0);
504 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA256, "RSA", 0);
505 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA384, "RSA", 0);
506 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA512, "RSA", 0);
508 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_1_5, "RSA", 0);
509 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_OAEP_MGFP1, "RSA", 0);
511 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIDSA_SHA1, "DSA", 0);
513 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA1, "HMAC", 0);
514 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA224, "HMAC", 0);
515 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA256, "HMAC", 0);
516 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA384, "HMAC", 0);
517 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA512, "HMAC", 0);
519 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURI3DES_CBC, "DESede", 192);
520 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_3DES, "DESede", 192);
522 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES128_CBC, "AES", 128);
523 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES128, "AES", 128);
525 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES192_CBC, "AES", 192);
526 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES192, "AES", 192);
528 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES256_CBC, "AES", 256);
529 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES256, "AES", 256);