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 ShibSessionInitiatorFactory;
  82 PlugManager::Factory SAML1POSTFactory;
  83 PlugManager::Factory SAML1ArtifactFactory;
  84 PlugManager::Factory ShibLogoutFactory;
  85 //PlugManager::Factory htaccessFactory;
  86
  87 SAML_EXCEPTION_FACTORY(ListenerException);
  88 SAML_EXCEPTION_FACTORY(ConfigurationException);
  89
  90 ShibTargetConfig& ShibTargetConfig::getConfig()
  91 {
  92     return g_Config;
  93 }
  94
  95 bool STConfig::init(const char* schemadir)
  96 {
  97     // With new build of log4cpp, we need to establish a "default"
  98     // logging appender to stderr up front.
  99     const char* loglevel=getenv("SHIB_LOGGING");
 100     if (!loglevel)
 101         loglevel = SHIB_LOGGING;
 102     Category& root = Category::getRoot();
 103     if (!strcmp(loglevel,"DEBUG"))
 104         root.setPriority(Priority::DEBUG);
 105     else if (!strcmp(loglevel,"INFO"))
 106         root.setPriority(Priority::INFO);
 107     else if (!strcmp(loglevel,"NOTICE"))
 108         root.setPriority(Priority::NOTICE);
 109     else if (!strcmp(loglevel,"WARN"))
 110         root.setPriority(Priority::WARN);
 111     else if (!strcmp(loglevel,"ERROR"))
 112         root.setPriority(Priority::ERROR);
 113     else if (!strcmp(loglevel,"CRIT"))
 114         root.setPriority(Priority::CRIT);
 115     else if (!strcmp(loglevel,"ALERT"))
 116         root.setPriority(Priority::ALERT);
 117     else if (!strcmp(loglevel,"EMERG"))
 118         root.setPriority(Priority::EMERG);
 119     else if (!strcmp(loglevel,"FATAL"))
 120         root.setPriority(Priority::FATAL);
 121     root.setAppender(new OstreamAppender("default",&cerr));
 122
 123 #ifdef _DEBUG
 124     saml::NDC ndc("init");
 125 #endif
 126     Category& log = Category::getInstance("shibtarget.Config");
 127
 128     if (!schemadir) {
 129         log.fatal("XML schema directory not supplied");
 130         return false;
 131     }
 132
 133     // This will cause some extra console logging, but for now,
 134     // initialize the underlying libraries.
 135     SAMLConfig& samlConf=SAMLConfig::getConfig();
 136     if (schemadir)
 137         samlConf.schema_dir = schemadir;
 138     try {
 139         if (!samlConf.init()) {
 140             log.fatal("Failed to initialize SAML Library");
 141             return false;
 142         }
 143     }
 144     catch (...) {
 145         log.fatal("Died initializing SAML Library");
 146         return false;
 147     }
 148
 149     ShibConfig& shibConf=ShibConfig::getConfig();
 150     try {
 151         if (!shibConf.init()) {
 152             log.fatal("Failed to initialize Shib library");
 153             samlConf.term();
 154             return false;
 155         }
 156     }
 157     catch (...) {
 158         log.fatal("Died initializing Shib library.");
 159         samlConf.term();
 160         return false;
 161     }
 162
 163     // Register built-in plugin types.
 164     REGISTER_EXCEPTION_FACTORY(ListenerException);
 165     REGISTER_EXCEPTION_FACTORY(ConfigurationException);
 166 #ifndef WIN32
 167     samlConf.getPlugMgr().regFactory(shibtarget::XML::UnixListenerType,&UnixListenerFactory);
 168 #endif
 169     samlConf.getPlugMgr().regFactory(shibtarget::XML::TCPListenerType,&TCPListenerFactory);
 170     samlConf.getPlugMgr().regFactory(shibtarget::XML::MemoryListenerType,&MemoryListenerFactory);
 171     samlConf.getPlugMgr().regFactory(shibtarget::XML::MemorySessionCacheType,&MemoryCacheFactory);
 172     samlConf.getPlugMgr().regFactory(shibtarget::XML::LegacyRequestMapType,&XMLRequestMapFactory);
 173     samlConf.getPlugMgr().regFactory(shibtarget::XML::XMLRequestMapType,&XMLRequestMapFactory);
 174     samlConf.getPlugMgr().regFactory(shibtarget::XML::NativeRequestMapType,&XMLRequestMapFactory);
 175
 176     auto_ptr_char temp1(Constants::SHIB_SESSIONINIT_PROFILE_URI);
 177     samlConf.getPlugMgr().regFactory(temp1.get(),&ShibSessionInitiatorFactory);
 178     auto_ptr_char temp2(SAMLBrowserProfile::BROWSER_POST);
 179     samlConf.getPlugMgr().regFactory(temp2.get(),&SAML1POSTFactory);
 180     auto_ptr_char temp3(SAMLBrowserProfile::BROWSER_ARTIFACT);
 181     samlConf.getPlugMgr().regFactory(temp3.get(),&SAML1ArtifactFactory);
 182     auto_ptr_char temp4(Constants::SHIB_LOGOUT_PROFILE_URI);
 183     samlConf.getPlugMgr().regFactory(temp4.get(),&ShibLogoutFactory);
 184
 185     saml::XML::registerSchema(shibtarget::XML::SHIBTARGET_NS,shibtarget::XML::SHIBTARGET_SCHEMA_ID);
 186     saml::XML::registerSchema(shibtarget::XML::SAML2META_NS,shibtarget::XML::SAML2META_SCHEMA_ID);
 187     saml::XML::registerSchema(shibtarget::XML::SAML2ASSERT_NS,shibtarget::XML::SAML2ASSERT_SCHEMA_ID);
 188     saml::XML::registerSchema(shibtarget::XML::XMLENC_NS,shibtarget::XML::XMLENC_SCHEMA_ID);
 189
 190     log.info("finished initializing");
 191     return true;
 192 }
 193
 194 bool STConfig::load(const char* config)
 195 {
 196 #ifdef _DEBUG
 197     saml::NDC ndc("load");
 198 #endif
 199     Category& log = Category::getInstance("shibtarget.Config");
 200
 201     if (!config) {
 202         log.fatal("path to configuration file not supplied");
 203         shutdown();
 204         return false;
 205     }
 206
 207     try {
 208         log.info("loading configuration file: %s", config);
 209         static const XMLCh uri[] = { chLatin_u, chLatin_r, chLatin_i, chNull };
 210         DOMImplementation* impl=DOMImplementationRegistry::getDOMImplementation(NULL);
 211         DOMDocument* dummydoc=impl->createDocument();
 212         DOMElement* dummy = dummydoc->createElementNS(NULL,XML::Literals::ShibbolethTargetConfig);
 213         auto_ptr_XMLCh src(config);
 214         dummy->setAttributeNS(NULL,uri,src.get());
 215         m_ini=ShibTargetConfigFactory(dummy);
 216         dummydoc->release();
 217
 218         pair<bool,unsigned int> skew=m_ini->getUnsignedInt("clockSkew");
 219         SAMLConfig::getConfig().clock_skew_secs=skew.first ? skew.second : 180;
 220
 221         m_tranLog=new FixedContextCategory(SHIBTRAN_LOGCAT);
 222         m_tranLog->info("opened transaction log");
 223         m_tranLogLock = Mutex::create();
 224     }
 225     catch (SAMLException& ex) {
 226         log.fatal("caught exception while loading/initializing configuration: %s",ex.what());
 227         shutdown();
 228         return false;
 229     }
 230 #ifndef _DEBUG
 231     catch (...) {
 232         log.fatal("caught exception while loading/initializing configuration");
 233         shutdown();
 234         return false;
 235     }
 236 #endif
 237
 238     log.info("finished loading configuration");
 239     return true;
 240 }
 241
 242 void STConfig::shutdown()
 243 {
 244 #ifdef _DEBUG
 245     saml::NDC ndc("shutdown");
 246 #endif
 247     Category& log = Category::getInstance("shibtarget.Config");
 248     log.info("shutting down the library");
 249     delete m_tranLogLock;
 250     m_tranLogLock = NULL;
 251     //delete m_tranLog; // This is crashing for some reason, but we're shutting down anyway.
 252     delete m_ini;
 253     m_ini = NULL;
 254     ShibConfig::getConfig().term();
 255     SAMLConfig::getConfig().term();
 256     log.info("library shutdown complete");
 257 }