Next integration phase, metadata and trust conversion.
[shibboleth/cpp-sp.git] / shib / ShibConfig.cpp
index e47b615..3f5460b 100644 (file)
@@ -1,53 +1,19 @@
 /*
- * The Shibboleth License, Version 1.
- * Copyright (c) 2002
- * University Corporation for Advanced Internet Development, Inc.
- * All rights reserved
+ *  Copyright 2001-2005 Internet2
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
+ *     http://www.apache.org/licenses/LICENSE-2.0
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright notice, this
- * list of conditions and the following disclaimer.
- *
- * Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution, if any, must include
- * the following acknowledgment: "This product includes software developed by
- * the University Corporation for Advanced Internet Development
- * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
- * may appear in the software itself, if and wherever such third-party
- * acknowledgments normally appear.
- *
- * Neither the name of Shibboleth nor the names of its contributors, nor
- * Internet2, nor the University Corporation for Advanced Internet Development,
- * Inc., nor UCAID may be used to endorse or promote products derived from this
- * software without specific prior written permission. For written permission,
- * please contact shibboleth@shibboleth.org
- *
- * Products derived from this software may not be called Shibboleth, Internet2,
- * UCAID, or the University Corporation for Advanced Internet Development, nor
- * may Shibboleth appear in their name, without prior written permission of the
- * University Corporation for Advanced Internet Development.
- *
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
- * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
- * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
- * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
- * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 
-
 /* ShibConfig.cpp - Shibboleth runtime configuration
 
    Scott Cantor
 */
 
 #include <time.h>
-#include <signal.h>
+#include <sys/types.h>
+#include <sys/stat.h>
 
 #define SHIB_INSTANTIATE
 
 #include "internal.h"
-#include <log4cpp/Category.hh>
+
+#include <openssl/err.h>
 
 using namespace saml;
 using namespace shibboleth;
+using namespace xmltooling;
+using namespace log4cpp;
+using namespace std;
 
-SAML_EXCEPTION_FACTORY(UnsupportedProtocolException);
-SAML_EXCEPTION_FACTORY(OriginSiteMapperException);
 
 namespace {
-    ShibInternalConfig g_config;
+    ShibConfig g_config;
+    vector<Mutex*> g_openssl_locks;
+#ifdef HAVE_GOOD_STL
+    map<xmltooling::xstring,const IAttributeFactory*> attrMap;
+#else
+    map<XMLCh*,const IAttributeFactory*> attrMap;
+#endif
 }
 
-ShibConfig::~ShibConfig() {}
-
-bool ShibInternalConfig::init()
+extern "C" SAMLAttribute* ShibAttributeFactory(DOMElement* e)
 {
-    saml::NDC ndc("init");
-
-    REGISTER_EXCEPTION_FACTORY("edu.internet2.middleware.shibboleth.common",UnsupportedProtocolException);
-    REGISTER_EXCEPTION_FACTORY("edu.internet2.middleware.shibboleth.common",OriginSiteMapperException);
-
-    // Register extension schema.
-    saml::XML::registerSchema(XML::SHIB_NS,XML::SHIB_SCHEMA_ID);
-
-    m_lock=RWLock::create();
-    m_shutdown_wait = CondWait::create();
-    if (!m_lock || !m_shutdown_wait)
-    {
-        log4cpp::Category::getInstance(SHIB_LOGCAT".ShibConfig").fatal("init: failed to create mapper locks");
-        delete m_lock;
-        delete m_shutdown_wait;
-        return false;
-    }
+    // First check for an explicit factory.
+#ifdef HAVE_GOOD_STL
+    map<xmltooling::xstring,const IAttributeFactory*>::const_iterator i=attrMap.find(e->getAttributeNS(NULL,L(AttributeName)));
+#else
+    const XMLCh* aname=e->getAttributeNS(NULL,L(AttributeName));
+    map<XMLCh*,const IAttributeFactory*>::const_iterator i;
+    for (i=attrMap.begin(); i!=attrMap.end(); i++)
+        if (!XMLString::compareString(aname,i->first))
+            break;
+#endif
+    if (i!=attrMap.end())
+        return i->second->build(e);
+
+    // Now check for a Scope attribute to ensure proper value handling whenever possible.
+    DOMElement* n=saml::XML::getFirstChildElement(e,saml::XML::SAML_NS,L(AttributeValue));
+    if (n && n->hasAttributeNS(NULL,ScopedAttribute::Scope))
+        return new ScopedAttribute(e);
+        
+    // Just use the default class.
+    return new SAMLAttribute(e);
+}
 
-    try
-    {
-        m_mapper=new XMLOriginSiteMapper(mapperURL.c_str(),SAMLConfig::getConfig().ssl_calist.c_str(),mapperCert);
-    }
-    catch(SAMLException& e)
-    {
-        log4cpp::Category::getInstance(SHIB_LOGCAT".ShibConfig").fatal("init: failed to initialize origin site mapper: %s", e.what());
-        delete m_lock;
-        delete m_shutdown_wait;
-        return false;
+void ShibConfig::regAttributeMapping(const XMLCh* name, const IAttributeFactory* factory)
+{
+    if (name && factory) {
+#ifdef HAVE_GOOD_STL
+        attrMap[name]=factory;
+#else
+        attrMap.insert(make_pair(XMLString::replicate(name),factory));
+#endif
     }
+}
 
-    m_manager=xmlSecSimpleKeysMngrCreate();
-    const char* roots=m_mapper->getTrustedRoots();
-    if (roots && *roots && xmlSecSimpleKeysMngrLoadPemCert(m_manager,roots,true) < 0)
-    {
-        log4cpp::Category::getInstance(SHIB_LOGCAT".ShibConfig").fatal("init: failed to load CAs into simple key manager");
-        xmlSecSimpleKeysMngrDestroy(m_manager);
-        delete m_mapper;
-        delete m_lock;
-        delete m_shutdown_wait;
-        return false;
+void ShibConfig::unregAttributeMapping(const XMLCh* name)
+{
+    if (name) {
+#ifdef HAVE_GOOD_STL
+        attrMap.erase(name);
+#else
+        for (map<XMLCh*,const IAttributeFactory*>::iterator i=attrMap.begin(); i!=attrMap.end(); i++) {
+            if (!XMLString::compareString(name,i->first)) {
+                XMLCh* temp=i->first;
+                XMLString::release(&temp);
+                attrMap.erase(i);
+                break;
+            }
+        }
+#endif
     }
-    SAMLConfig::getConfig().xmlsig_ptr=m_manager;
-    if (mapperRefreshInterval)
-        m_refresh_thread = Thread::create(&refresh_fn, (void*)this);
-
-    return true;
 }
 
-void ShibInternalConfig::term()
+void ShibConfig::clearAttributeMappings()
 {
-    // Shut down the refresh thread and let it know...
-    if (m_refresh_thread)
-    {
-        m_shutdown = true;
-        m_shutdown_wait->signal();
-        m_refresh_thread->join(NULL);
+#ifndef HAVE_GOOD_STL
+    for (map<XMLCh*,const IAttributeFactory*>::iterator i=attrMap.begin(); i!=attrMap.end(); i++) {
+        XMLCh* temp=i->first;
+        XMLString::release(&temp);
     }
-
-    delete m_mapper;
-    if (m_manager)
-        xmlSecSimpleKeysMngrDestroy(m_manager);
-    delete mapperCert;
-    delete m_lock;
-    delete m_shutdown_wait;
+#endif
+    attrMap.clear();
 }
 
-IOriginSiteMapper* ShibInternalConfig::getMapper()
+extern "C" void openssl_locking_callback(int mode,int n,const char *file,int line)
 {
-    m_lock->rdlock();
-    return m_mapper;
+    if (mode & CRYPTO_LOCK)
+        g_openssl_locks[n]->lock();
+    else
+        g_openssl_locks[n]->unlock();
 }
 
-void ShibInternalConfig::releaseMapper(IOriginSiteMapper* mapper)
+#ifndef WIN32
+extern "C" unsigned long openssl_thread_id(void)
 {
-    m_lock->unlock();
+    return (unsigned long)(pthread_self());
 }
+#endif
 
-ShibConfig& ShibConfig::getConfig()
+bool ShibConfig::init()
 {
-    return g_config;
+    // Set up OpenSSL locking.
+       for (int i=0; i<CRYPTO_num_locks(); i++)
+        g_openssl_locks.push_back(Mutex::create());
+       CRYPTO_set_locking_callback(openssl_locking_callback);
+#ifndef WIN32
+    CRYPTO_set_id_callback(openssl_thread_id);
+#endif
+
+    SAMLAttribute::setFactory(&ShibAttributeFactory);
+    return true;
 }
 
-void* ShibInternalConfig::refresh_fn(void* config_p)
+void ShibConfig::term()
 {
-  ShibInternalConfig* config = reinterpret_cast<ShibInternalConfig*>(config_p);
-
-  // First, let's block all signals
-  sigset_t sigmask;
-  sigfillset(&sigmask);
-  Thread::mask_signals(SIG_BLOCK, &sigmask, NULL);
-
-  // Now run the cleanup process.
-  config->refresh();
+    SAMLAttribute::setFactory(NULL);
+    clearAttributeMappings();
+   
+    CRYPTO_set_locking_callback(NULL);
+    for (vector<Mutex*>::iterator j=g_openssl_locks.begin(); j!=g_openssl_locks.end(); j++)
+        delete (*j);
+    g_openssl_locks.clear();
 }
 
-void ShibInternalConfig::refresh()
+ShibConfig& ShibConfig::getConfig()
 {
-    Mutex* mutex = Mutex::create();
-    saml::NDC ndc("cleanup");
-    log4cpp::Category& log=log4cpp::Category::getInstance(SHIB_LOGCAT".ShibConfig");
-
-    mutex->lock();
-
-    log.debug("XMLMapper refresh thread started...");
-
-    while (!m_shutdown)
-    {
-        struct timespec ts;
-        memset (&ts, 0, sizeof(ts));
-        ts.tv_sec = time(NULL) + mapperRefreshInterval;
-
-        m_shutdown_wait->timedwait(mutex, &ts);
-
-        if (m_shutdown)
-            break;
-
-        log.info("Refresh thread running...");
-
-        // To refresh the mapper, we basically build a new one in the background and if it works,
-        // we grab the write lock and replace the official pointer with the new one.
-        try
-        {
-            IOriginSiteMapper* new_mapper=new XMLOriginSiteMapper(mapperURL.c_str(),SAMLConfig::getConfig().ssl_calist.c_str(),mapperCert);
-            m_lock->wrlock();
-            delete m_mapper;
-            m_mapper=new_mapper;
-            m_lock->unlock();
-        }
-        catch(SAMLException& e)
-        {
-            log.error("failed to build a refreshed origin site mapper, sticking with what we have: %s", e.what());
-        }
-        catch(...)
-        {
-            log.error("caught an unknown exception, sticking with what we have");
-        }
-    }
-
-    mutex->unlock();
-    delete mutex;
-    Thread::exit(NULL);
+    return g_config;
 }