shib-target/shib-config.cpp

   1 /*
   2  * The Shibboleth License, Version 1.
   3  * Copyright (c) 2002
   4  * University Corporation for Advanced Internet Development, Inc.
   5  * All rights reserved
   6  *
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * Redistributions of source code must retain the above copyright notice, this
  12  * list of conditions and the following disclaimer.
  13  *
  14  * Redistributions in binary form must reproduce the above copyright notice,
  15  * this list of conditions and the following disclaimer in the documentation
  16  * and/or other materials provided with the distribution, if any, must include
  17  * the following acknowledgment: "This product includes software developed by
  18  * the University Corporation for Advanced Internet Development
  19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
  20  * may appear in the software itself, if and wherever such third-party
  21  * acknowledgments normally appear.
  22  *
  23  * Neither the name of Shibboleth nor the names of its contributors, nor
  24  * Internet2, nor the University Corporation for Advanced Internet Development,
  25  * Inc., nor UCAID may be used to endorse or promote products derived from this
  26  * software without specific prior written permission. For written permission,
  27  * please contact shibboleth@shibboleth.org
  28  *
  29  * Products derived from this software may not be called Shibboleth, Internet2,
  30  * UCAID, or the University Corporation for Advanced Internet Development, nor
  31  * may Shibboleth appear in their name, without prior written permission of the
  32  * University Corporation for Advanced Internet Development.
  33  *
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
  39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
  40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
  41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
  42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  48  */
  49
  50 /*
  51  * shib-config.cpp -- ShibTarget initialization and finalization routines
  52  *
  53  * Created By:  Derek Atkins <derek@ihtfp.com>
  54  *
  55  * $Id$
  56  */
  57
  58 #include "internal.h"
  59
  60 #include <log4cpp/OstreamAppender.hh>
  61
  62 using namespace std;
  63 using namespace log4cpp;
  64 using namespace saml;
  65 using namespace shibboleth;
  66 using namespace shibtarget;
  67
  68 namespace {
  69     STConfig g_Config;
  70 }
  71
  72 // Factories for built-in plugins we can manufacture. Actual definitions
  73 // will be with the actual object implementation.
  74 #ifndef WIN32
  75 PlugManager::Factory UnixListenerFactory;
  76 #endif
  77 PlugManager::Factory TCPListenerFactory;
  78 PlugManager::Factory MemoryListenerFactory;
  79 PlugManager::Factory MemoryCacheFactory;
  80 PlugManager::Factory XMLRequestMapFactory;
  81 //PlugManager::Factory htaccessFactory;
  82
  83 SAML_EXCEPTION_FACTORY(ListenerException);
  84 SAML_EXCEPTION_FACTORY(ConfigurationException);
  85
  86 ShibTargetConfig& ShibTargetConfig::getConfig()
  87 {
  88     return g_Config;
  89 }
  90
  91 bool STConfig::init(const char* schemadir)
  92 {
  93     // With new build of log4cpp, we need to establish a "default"
  94     // logging appender to stderr up front.
  95     const char* loglevel=getenv("SHIB_LOGGING");
  96     if (!loglevel)
  97         loglevel = SHIB_LOGGING;
  98     Category& root = Category::getRoot();
  99     if (!strcmp(loglevel,"DEBUG"))
 100         root.setPriority(Priority::DEBUG);
 101     else if (!strcmp(loglevel,"INFO"))
 102         root.setPriority(Priority::INFO);
 103     else if (!strcmp(loglevel,"NOTICE"))
 104         root.setPriority(Priority::NOTICE);
 105     else if (!strcmp(loglevel,"WARN"))
 106         root.setPriority(Priority::WARN);
 107     else if (!strcmp(loglevel,"ERROR"))
 108         root.setPriority(Priority::ERROR);
 109     else if (!strcmp(loglevel,"CRIT"))
 110         root.setPriority(Priority::CRIT);
 111     else if (!strcmp(loglevel,"ALERT"))
 112         root.setPriority(Priority::ALERT);
 113     else if (!strcmp(loglevel,"EMERG"))
 114         root.setPriority(Priority::EMERG);
 115     else if (!strcmp(loglevel,"FATAL"))
 116         root.setPriority(Priority::FATAL);
 117     root.setAppender(new OstreamAppender("default",&cerr));
 118
 119 #ifdef _DEBUG
 120     saml::NDC ndc("init");
 121 #endif
 122     Category& log = Category::getInstance("shibtarget.Config");
 123
 124     if (!schemadir) {
 125         log.fatal("XML schema directory not supplied");
 126         return false;
 127     }
 128
 129     // This will cause some extra console logging, but for now,
 130     // initialize the underlying libraries.
 131     SAMLConfig& samlConf=SAMLConfig::getConfig();
 132     if (schemadir)
 133         samlConf.schema_dir = schemadir;
 134     try {
 135         if (!samlConf.init()) {
 136             log.fatal("Failed to initialize SAML Library");
 137             return false;
 138         }
 139     }
 140     catch (...) {
 141         log.fatal("Died initializing SAML Library");
 142         return false;
 143     }
 144
 145     ShibConfig& shibConf=ShibConfig::getConfig();
 146     try {
 147         if (!shibConf.init()) {
 148             log.fatal("Failed to initialize Shib library");
 149             samlConf.term();
 150             return false;
 151         }
 152     }
 153     catch (...) {
 154         log.fatal("Died initializing Shib library.");
 155         samlConf.term();
 156         return false;
 157     }
 158
 159     // Register built-in plugin types.
 160     REGISTER_EXCEPTION_FACTORY(ListenerException);
 161     REGISTER_EXCEPTION_FACTORY(ConfigurationException);
 162 #ifndef WIN32
 163     samlConf.getPlugMgr().regFactory(shibtarget::XML::UnixListenerType,&UnixListenerFactory);
 164 #endif
 165     samlConf.getPlugMgr().regFactory(shibtarget::XML::TCPListenerType,&TCPListenerFactory);
 166     samlConf.getPlugMgr().regFactory(shibtarget::XML::MemoryListenerType,&MemoryListenerFactory);
 167     samlConf.getPlugMgr().regFactory(shibtarget::XML::MemorySessionCacheType,&MemoryCacheFactory);
 168     samlConf.getPlugMgr().regFactory(shibtarget::XML::LegacyRequestMapType,&XMLRequestMapFactory);
 169     samlConf.getPlugMgr().regFactory(shibtarget::XML::XMLRequestMapType,&XMLRequestMapFactory);
 170     samlConf.getPlugMgr().regFactory(shibtarget::XML::NativeRequestMapType,&XMLRequestMapFactory);
 171
 172     saml::XML::registerSchema(shibtarget::XML::SHIBTARGET_NS,shibtarget::XML::SHIBTARGET_SCHEMA_ID);
 173     saml::XML::registerSchema(shibtarget::XML::SAML2META_NS,shibtarget::XML::SAML2META_SCHEMA_ID);
 174     saml::XML::registerSchema(shibtarget::XML::SAML2ASSERT_NS,shibtarget::XML::SAML2ASSERT_SCHEMA_ID);
 175     saml::XML::registerSchema(shibtarget::XML::XMLENC_NS,shibtarget::XML::XMLENC_SCHEMA_ID);
 176
 177     log.info("finished initializing");
 178     return true;
 179 }
 180
 181 bool STConfig::load(const char* config)
 182 {
 183 #ifdef _DEBUG
 184     saml::NDC ndc("load");
 185 #endif
 186     Category& log = Category::getInstance("shibtarget.Config");
 187
 188     if (!config) {
 189         log.fatal("path to configuration file not supplied");
 190         shutdown();
 191         return false;
 192     }
 193
 194     try {
 195         log.info("loading configuration file: %s", config);
 196         static const XMLCh uri[] = { chLatin_u, chLatin_r, chLatin_i, chNull };
 197         DOMImplementation* impl=DOMImplementationRegistry::getDOMImplementation(NULL);
 198         DOMDocument* dummydoc=impl->createDocument();
 199         DOMElement* dummy = dummydoc->createElementNS(NULL,XML::Literals::ShibbolethTargetConfig);
 200         auto_ptr_XMLCh src(config);
 201         dummy->setAttributeNS(NULL,uri,src.get());
 202         m_ini=ShibTargetConfigFactory(dummy);
 203         dummydoc->release();
 204
 205         pair<bool,unsigned int> skew=m_ini->getUnsignedInt("clockSkew");
 206         SAMLConfig::getConfig().clock_skew_secs=skew.first ? skew.second : 180;
 207
 208         m_tranLog=new FixedContextCategory(SHIBTRAN_LOGCAT);
 209         m_tranLog->info("opened transaction log");
 210         m_tranLogLock = Mutex::create();
 211     }
 212     catch (SAMLException& ex) {
 213         log.fatal("caught exception while loading/initializing configuration: %s",ex.what());
 214         shutdown();
 215         return false;
 216     }
 217 #ifndef _DEBUG
 218     catch (...) {
 219         log.fatal("caught exception while loading/initializing configuration");
 220         shutdown();
 221         return false;
 222     }
 223 #endif
 224
 225     log.info("finished loading configuration");
 226     return true;
 227 }
 228
 229 void STConfig::shutdown()
 230 {
 231 #ifdef _DEBUG
 232     saml::NDC ndc("shutdown");
 233 #endif
 234     Category& log = Category::getInstance("shibtarget.Config");
 235     log.info("shutting down the library");
 236     delete m_tranLogLock;
 237     m_tranLogLock = NULL;
 238     //delete m_tranLog; // This is crashing for some reason, but we're shutting down anyway.
 239     delete m_ini;
 240     m_ini = NULL;
 241     ShibConfig::getConfig().term();
 242     SAMLConfig::getConfig().term();
 243     log.info("library shutdown complete");
 244 }