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"
25 #include "XMLToolingConfig.h"
26 #include "encryption/Encryption.h"
27 #include "encryption/Encrypter.h"
28 #include "impl/UnknownElement.h"
29 #include "security/TrustEngine.h"
30 #include "security/OpenSSLCryptoX509CRL.h"
31 #include "security/CredentialResolver.h"
32 #include "security/KeyInfoResolver.h"
33 #include "signature/Signature.h"
34 #include "soap/SOAP.h"
35 #include "soap/SOAPTransport.h"
37 #include "util/ReplayCache.h"
38 #include "util/StorageService.h"
39 #include "util/TemplateEngine.h"
40 #include "util/URLEncoder.h"
41 #include "util/XMLConstants.h"
42 #include "validation/ValidatorSuite.h"
49 #include <curl/curl.h>
50 #include <log4cpp/Category.hh>
51 #include <log4cpp/PropertyConfigurator.hh>
52 #include <log4cpp/OstreamAppender.hh>
53 #include <xercesc/util/PlatformUtils.hpp>
54 #ifndef XMLTOOLING_NO_XMLSEC
55 #include <xsec/framework/XSECProvider.hpp>
56 #include <openssl/err.h>
59 using namespace soap11;
60 using namespace xmlencryption;
61 using namespace xmlsignature;
62 using namespace xmltooling;
63 using namespace log4cpp;
66 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLParserException,xmltooling);
67 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLObjectException,xmltooling);
68 DECL_XMLTOOLING_EXCEPTION_FACTORY(MarshallingException,xmltooling);
69 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnmarshallingException,xmltooling);
70 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnknownElementException,xmltooling);
71 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnknownAttributeException,xmltooling);
72 DECL_XMLTOOLING_EXCEPTION_FACTORY(UnknownExtensionException,xmltooling);
73 DECL_XMLTOOLING_EXCEPTION_FACTORY(ValidationException,xmltooling);
74 DECL_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
76 #ifndef XMLTOOLING_NO_XMLSEC
77 DECL_XMLTOOLING_EXCEPTION_FACTORY(XMLSecurityException,xmltooling);
78 DECL_XMLTOOLING_EXCEPTION_FACTORY(SignatureException,xmlsignature);
79 DECL_XMLTOOLING_EXCEPTION_FACTORY(EncryptionException,xmlencryption);
82 namespace xmltooling {
83 static XMLToolingInternalConfig g_config;
84 #ifndef XMLTOOLING_NO_XMLSEC
85 static vector<Mutex*> g_openssl_locks;
87 extern "C" void openssl_locking_callback(int mode,int n,const char *file,int line)
89 if (mode & CRYPTO_LOCK)
90 g_openssl_locks[n]->lock();
92 g_openssl_locks[n]->unlock();
96 extern "C" unsigned long openssl_thread_id(void)
98 return (unsigned long)(pthread_self());
104 XMLToolingConfig& XMLToolingConfig::getConfig()
109 XMLToolingInternalConfig& XMLToolingInternalConfig::getInternalConfig()
114 bool XMLToolingInternalConfig::log_config(const char* config)
117 if (!config || !*config)
118 config=getenv("XMLTOOLING_LOG_CONFIG");
119 if (!config || !*config)
123 Category& root = Category::getRoot();
124 if (!strcmp(config,"DEBUG")) {
125 root.setPriority(Priority::DEBUG);
128 else if (!strcmp(config,"INFO")) {
129 root.setPriority(Priority::INFO);
132 else if (!strcmp(config,"NOTICE")) {
133 root.setPriority(Priority::NOTICE);
136 else if (!strcmp(config,"WARN")) {
137 root.setPriority(Priority::WARN);
140 else if (!strcmp(config,"ERROR")) {
141 root.setPriority(Priority::ERROR);
144 else if (!strcmp(config,"CRIT")) {
145 root.setPriority(Priority::CRIT);
148 else if (!strcmp(config,"ALERT")) {
149 root.setPriority(Priority::ALERT);
152 else if (!strcmp(config,"EMERG")) {
153 root.setPriority(Priority::EMERG);
156 else if (!strcmp(config,"FATAL")) {
157 root.setPriority(Priority::FATAL);
161 root.setAppender(new OstreamAppender("default",&cerr));
163 PropertyConfigurator::configure(config);
165 catch (const ConfigureFailure& e) {
166 Category::getInstance(XMLTOOLING_LOGCAT".Logging").crit("failed to initialize log4cpp: %s", e.what());
173 void XMLToolingConfig::setReplayCache(ReplayCache* replayCache)
175 delete m_replayCache;
176 m_replayCache = replayCache;
179 void XMLToolingConfig::setTemplateEngine(TemplateEngine* templateEngine)
181 delete m_templateEngine;
182 m_templateEngine = templateEngine;
185 void XMLToolingConfig::setURLEncoder(URLEncoder* urlEncoder)
188 m_urlEncoder = urlEncoder;
191 bool XMLToolingInternalConfig::init()
194 xmltooling::NDC ndc("init");
196 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
198 log.debug("library initialization started");
200 if (curl_global_init(CURL_GLOBAL_ALL)) {
201 log.fatal("failed to initialize libcurl, OpenSSL, or Winsock");
204 log.debug("libcurl %s initialization complete", LIBCURL_VERSION);
206 XMLPlatformUtils::Initialize();
207 log.debug("Xerces initialization complete");
209 #ifndef XMLTOOLING_NO_XMLSEC
210 XSECPlatformUtils::Initialise();
211 m_xsecProvider=new XSECProvider();
212 log.debug("XMLSec initialization complete");
215 m_parserPool=new ParserPool();
216 m_validatingPool=new ParserPool(true,true);
217 m_lock=XMLPlatformUtils::makeMutex();
219 // Load catalogs from path.
220 if (!catalog_path.empty()) {
221 char* catpath=strdup(catalog_path.c_str());
224 while (start && *start) {
225 sep=strchr(start,PATH_SEPARATOR_CHAR);
228 auto_ptr_XMLCh temp(start);
229 m_validatingPool->loadCatalog(temp.get());
230 start = sep ? sep + 1 : NULL;
235 // default registrations
236 XMLObjectBuilder::registerDefaultBuilder(new UnknownElementBuilder());
238 registerKeyInfoClasses();
239 registerEncryptionClasses();
240 registerSOAPClasses();
242 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLParserException,xmltooling);
243 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLObjectException,xmltooling);
244 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MarshallingException,xmltooling);
245 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnmarshallingException,xmltooling);
246 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnknownElementException,xmltooling);
247 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(UnknownAttributeException,xmltooling);
248 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ValidationException,xmltooling);
249 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(IOException,xmltooling);
251 #ifndef XMLTOOLING_NO_XMLSEC
252 XMLObjectBuilder::registerBuilder(QName(xmlconstants::XMLSIG_NS,Signature::LOCAL_NAME),new SignatureBuilder());
253 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(XMLSecurityException,xmltooling);
254 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(SignatureException,xmlsignature);
255 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(EncryptionException,xmlencryption);
256 registerKeyInfoResolvers();
257 registerCredentialResolvers();
258 registerTrustEngines();
259 registerXMLAlgorithms();
261 registerSOAPTransports();
262 initSOAPTransports();
263 registerStorageServices();
265 m_urlEncoder = new URLEncoder();
266 #ifndef XMLTOOLING_NO_XMLSEC
267 m_keyInfoResolver = KeyInfoResolverManager.newPlugin(INLINE_KEYINFO_RESOLVER,NULL);
270 // Register xml:id as an ID attribute.
271 static const XMLCh xmlid[] = UNICODE_LITERAL_2(i,d);
272 AttributeExtensibleXMLObject::registerIDAttribute(QName(xmlconstants::XML_NS, xmlid));
274 catch (const xercesc::XMLException&) {
275 log.fatal("caught exception while initializing Xerces");
276 curl_global_cleanup();
280 #ifndef XMLTOOLING_NO_XMLSEC
281 // Set up OpenSSL locking.
282 for (int i=0; i<CRYPTO_num_locks(); i++)
283 g_openssl_locks.push_back(Mutex::create());
284 CRYPTO_set_locking_callback(openssl_locking_callback);
286 CRYPTO_set_id_callback(openssl_thread_id);
290 log.info("library initialization complete");
294 void XMLToolingInternalConfig::term()
296 #ifndef XMLTOOLING_NO_XMLSEC
297 CRYPTO_set_locking_callback(NULL);
298 for_each(g_openssl_locks.begin(), g_openssl_locks.end(), xmltooling::cleanup<Mutex>());
299 g_openssl_locks.clear();
302 SchemaValidators.destroyValidators();
303 XMLObjectBuilder::destroyBuilders();
304 XMLToolingException::deregisterFactories();
305 AttributeExtensibleXMLObject::deregisterIDAttributes();
307 StorageServiceManager.deregisterFactories();
308 termSOAPTransports();
309 SOAPTransportManager.deregisterFactories();
311 #ifndef XMLTOOLING_NO_XMLSEC
312 TrustEngineManager.deregisterFactories();
313 CredentialResolverManager.deregisterFactories();
314 KeyInfoResolverManager.deregisterFactories();
315 m_algorithmMap.clear();
317 delete m_keyInfoResolver;
318 m_keyInfoResolver = NULL;
321 delete m_replayCache;
322 m_replayCache = NULL;
324 delete m_templateEngine;
325 m_templateEngine = NULL;
330 for (vector<void*>::reverse_iterator i=m_libhandles.rbegin(); i!=m_libhandles.rend(); i++) {
332 FARPROC fn=GetProcAddress(static_cast<HMODULE>(*i),"xmltooling_extension_term");
335 FreeLibrary(static_cast<HMODULE>(*i));
336 #elif defined(HAVE_DLFCN_H)
337 void (*fn)()=(void (*)())dlsym(*i,"xmltooling_extension_term");
342 # error "Don't know about dynamic loading on this platform!"
345 m_libhandles.clear();
349 delete m_validatingPool;
350 m_validatingPool=NULL;
352 #ifndef XMLTOOLING_NO_XMLSEC
353 delete m_xsecProvider;
355 XSECPlatformUtils::Terminate();
358 XMLPlatformUtils::closeMutex(m_lock);
360 XMLPlatformUtils::Terminate();
362 curl_global_cleanup();
365 xmltooling::NDC ndc("term");
367 Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig").info("library shutdown complete");
370 Lockable* XMLToolingInternalConfig::lock()
372 xercesc::XMLPlatformUtils::lockMutex(m_lock);
376 void XMLToolingInternalConfig::unlock()
378 xercesc::XMLPlatformUtils::unlockMutex(m_lock);
381 bool XMLToolingInternalConfig::load_library(const char* path, void* context)
384 xmltooling::NDC ndc("LoadLibrary");
386 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".XMLToolingConfig");
387 log.info("loading extension: %s", path);
393 char* fixed=const_cast<char*>(path);
394 if (strchr(fixed,'/')) {
397 while (p=strchr(p,'/'))
401 UINT em=SetErrorMode(SEM_FAILCRITICALERRORS);
403 handle=LoadLibraryEx(fixed,NULL,LOAD_WITH_ALTERED_SEARCH_PATH);
405 handle=LoadLibraryEx(fixed,NULL,0);
407 throw runtime_error(string("unable to load extension library: ") + fixed);
408 FARPROC fn=GetProcAddress(handle,"xmltooling_extension_init");
410 throw runtime_error(string("unable to locate xmltooling_extension_init entry point: ") + fixed);
411 if (reinterpret_cast<int(*)(void*)>(fn)(context)!=0)
412 throw runtime_error(string("detected error in xmltooling_extension_init: ") + fixed);
417 catch(runtime_error& e) {
427 #elif defined(HAVE_DLFCN_H)
428 void* handle=dlopen(path,RTLD_LAZY);
430 throw runtime_error(string("unable to load extension library '") + path + "': " + dlerror());
431 int (*fn)(void*)=(int (*)(void*))(dlsym(handle,"xmltooling_extension_init"));
435 string("unable to locate xmltooling_extension_init entry point in '") + path + "': " +
436 (dlerror() ? dlerror() : "unknown error")
441 throw runtime_error(string("detected error in xmltooling_extension_init in ") + path);
443 catch(runtime_error& e) {
450 # error "Don't know about dynamic loading on this platform!"
452 m_libhandles.push_back(handle);
453 log.info("loaded extension: %s", path);
457 #ifndef XMLTOOLING_NO_XMLSEC
458 void xmltooling::log_openssl()
464 unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
466 Category& log=Category::getInstance("OpenSSL");
467 log.errorStream() << "error code: " << code << " in " << file << ", line " << line << CategoryStream::ENDLINE;
468 if (data && (flags & ERR_TXT_STRING))
469 log.errorStream() << "error data: " << data << CategoryStream::ENDLINE;
470 code=ERR_get_error_line_data(&file,&line,&data,&flags);
474 XSECCryptoX509CRL* XMLToolingInternalConfig::X509CRL() const
476 return new OpenSSLCryptoX509CRL();
479 void XMLToolingInternalConfig::registerXMLAlgorithms()
481 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_MD5, "RSA", 0);
482 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA1, "RSA", 0);
483 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA224, "RSA", 0);
484 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA256, "RSA", 0);
485 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA384, "RSA", 0);
486 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_SHA512, "RSA", 0);
488 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_1_5, "RSA", 0);
489 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIRSA_OAEP_MGFP1, "RSA", 0);
491 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIDSA_SHA1, "DSA", 0);
493 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA1, "HMAC", 0);
494 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA224, "HMAC", 0);
495 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA256, "HMAC", 0);
496 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA384, "HMAC", 0);
497 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIHMAC_SHA512, "HMAC", 0);
499 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURI3DES_CBC, "DESede", 192);
500 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_3DES, "DESede", 192);
502 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES128_CBC, "AES", 128);
503 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES128, "AES", 128);
505 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES192_CBC, "AES", 192);
506 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES192, "AES", 192);
508 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIAES256_CBC, "AES", 256);
509 registerXMLAlgorithm(DSIGConstants::s_unicodeStrURIKW_AES256, "AES", 256);