shib/ShibConfig.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 /* ShibConfig.cpp - Shibboleth runtime configuration
  52
  53    Scott Cantor
  54    6/4/02
  55
  56    $History:$
  57 */
  58
  59 #include <time.h>
  60 #include <signal.h>
  61
  62 #define SHIB_INSTANTIATE
  63
  64 #include "internal.h"
  65 #include <log4cpp/Category.hh>
  66
  67 using namespace saml;
  68 using namespace shibboleth;
  69
  70 SAML_EXCEPTION_FACTORY(UnsupportedProtocolException);
  71 SAML_EXCEPTION_FACTORY(OriginSiteMapperException);
  72
  73 extern "C" SAMLAttribute* ScopedFactory(DOMElement* e)
  74 {
  75     return new ScopedAttribute(e);
  76 }
  77
  78 extern "C" SAMLAttribute* SimpleFactory(DOMElement* e)
  79 {
  80     return new SimpleAttribute(e);
  81 }
  82
  83 namespace {
  84     ShibInternalConfig g_config;
  85 }
  86
  87 ShibConfig::~ShibConfig() {}
  88
  89 bool ShibInternalConfig::init()
  90 {
  91     saml::NDC ndc("init");
  92
  93     REGISTER_EXCEPTION_FACTORY(edu.internet2.middleware.shibboleth.common,UnsupportedProtocolException);
  94     REGISTER_EXCEPTION_FACTORY(edu.internet2.middleware.shibboleth.common,OriginSiteMapperException);
  95
  96     // Register extension schema.
  97     saml::XML::registerSchema(XML::SHIB_NS,XML::SHIB_SCHEMA_ID);
  98
  99     if (!aapURL.empty())
 100     {
 101         try
 102         {
 103             m_AAP=new AAP(aapURL.c_str());
 104         }
 105         catch(SAMLException& e)
 106         {
 107             log4cpp::Category::getInstance(SHIB_LOGCAT".ShibConfig").fatal("init: failed to initialize AAP: %s", e.what());
 108             return false;
 109         }
 110     }
 111
 112     m_lock=RWLock::create();
 113     m_shutdown_wait = CondWait::create();
 114     if (!m_lock || !m_shutdown_wait)
 115     {
 116         log4cpp::Category::getInstance(SHIB_LOGCAT".ShibConfig").fatal("init: failed to create mapper locks");
 117         delete m_lock;
 118         delete m_shutdown_wait;
 119         delete m_AAP;
 120         return false;
 121     }
 122
 123     try
 124     {
 125         m_mapper=new XMLOriginSiteMapper(mapperURL.c_str(),SAMLConfig::getConfig().ssl_calist.c_str(),mapperCert);
 126     }
 127     catch(SAMLException& e)
 128     {
 129         log4cpp::Category::getInstance(SHIB_LOGCAT".ShibConfig").fatal("init: failed to initialize origin site mapper: %s", e.what());
 130         delete m_lock;
 131         delete m_shutdown_wait;
 132         delete m_AAP;
 133         return false;
 134     }
 135
 136     m_manager=xmlSecSimpleKeysMngrCreate();
 137     const char* roots=m_mapper->getTrustedRoots();
 138     if (roots && *roots && xmlSecSimpleKeysMngrLoadPemCert(m_manager,roots,true) < 0)
 139     {
 140         log4cpp::Category::getInstance(SHIB_LOGCAT".ShibConfig").fatal("init: failed to load CAs into simple key manager");
 141         xmlSecSimpleKeysMngrDestroy(m_manager);
 142         delete m_mapper;
 143         delete m_lock;
 144         delete m_shutdown_wait;
 145         delete m_AAP;
 146         return false;
 147     }
 148     SAMLConfig::getConfig().xmlsig_ptr=m_manager;
 149     if (mapperRefreshInterval)
 150         m_refresh_thread = Thread::create(&refresh_fn, (void*)this);
 151
 152     return true;
 153 }
 154
 155 void ShibInternalConfig::term()
 156 {
 157     // Shut down the refresh thread and let it know...
 158     if (m_refresh_thread)
 159     {
 160         m_shutdown = true;
 161         m_shutdown_wait->signal();
 162         m_refresh_thread->join(NULL);
 163     }
 164
 165     delete m_mapper;
 166     if (m_manager)
 167         xmlSecSimpleKeysMngrDestroy(m_manager);
 168     delete mapperCert;
 169     delete m_lock;
 170     delete m_shutdown_wait;
 171     delete m_AAP;
 172 }
 173
 174 IOriginSiteMapper* ShibInternalConfig::getMapper()
 175 {
 176     m_lock->rdlock();
 177     return m_mapper;
 178 }
 179
 180 void ShibInternalConfig::releaseMapper(IOriginSiteMapper* mapper)
 181 {
 182     m_lock->unlock();
 183 }
 184
 185 ShibConfig& ShibConfig::getConfig()
 186 {
 187     return g_config;
 188 }
 189
 190 void* ShibInternalConfig::refresh_fn(void* config_p)
 191 {
 192   ShibInternalConfig* config = reinterpret_cast<ShibInternalConfig*>(config_p);
 193
 194   // First, let's block all signals
 195   sigset_t sigmask;
 196   sigfillset(&sigmask);
 197   Thread::mask_signals(SIG_BLOCK, &sigmask, NULL);
 198
 199   // Now run the refresh process.
 200   config->refresh();
 201 }
 202
 203 void ShibInternalConfig::refresh()
 204 {
 205     Mutex* mutex = Mutex::create();
 206     saml::NDC ndc("refresh");
 207     log4cpp::Category& log=log4cpp::Category::getInstance(SHIB_LOGCAT".ShibConfig");
 208
 209     mutex->lock();
 210
 211     log.debug("XMLMapper refresh thread started...");
 212
 213     while (!m_shutdown)
 214     {
 215         struct timespec ts;
 216         memset (&ts, 0, sizeof(ts));
 217         ts.tv_sec = time(NULL) + mapperRefreshInterval;
 218
 219         m_shutdown_wait->timedwait(mutex, &ts);
 220
 221         if (m_shutdown)
 222             break;
 223
 224         log.info("Refresh thread running...");
 225
 226         // To refresh the mapper, we basically build a new one in the background and if it works,
 227         // we grab the write lock and replace the official pointer with the new one.
 228         try
 229         {
 230             IOriginSiteMapper* new_mapper=new XMLOriginSiteMapper(mapperURL.c_str(),SAMLConfig::getConfig().ssl_calist.c_str(),mapperCert);
 231             m_lock->wrlock();
 232             delete m_mapper;
 233             m_mapper=new_mapper;
 234             m_lock->unlock();
 235         }
 236         catch(SAMLException& e)
 237         {
 238             log.error("failed to build a refreshed origin site mapper, sticking with what we have: %s", e.what());
 239         }
 240         catch(...)
 241         {
 242             log.error("caught an unknown exception, sticking with what we have");
 243         }
 244     }
 245
 246     mutex->unlock();
 247     delete mutex;
 248     Thread::exit(NULL);
 249 }