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