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