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 <sys/types.h>
  61 #include <sys/stat.h>
  62
  63 #define SHIB_INSTANTIATE
  64
  65 #include "internal.h"
  66 #include <log4cpp/Category.hh>
  67 #include <openssl/err.h>
  68
  69 using namespace saml;
  70 using namespace shibboleth;
  71 using namespace log4cpp;
  72 using namespace std;
  73
  74 SAML_EXCEPTION_FACTORY(UnsupportedProtocolException);
  75 SAML_EXCEPTION_FACTORY(MetadataException);
  76
  77 namespace {
  78     ShibInternalConfig g_config;
  79 }
  80
  81 ShibConfig::~ShibConfig() {}
  82
  83 extern "C" IMetadata* XMLMetadataFactory(const char* source)
  84 {
  85     return new XMLMetadata(source);
  86 }
  87
  88 extern "C" ITrust* XMLTrustFactory(const char* source)
  89 {
  90     return new XMLTrust(source);
  91 }
  92
  93 bool ShibInternalConfig::init()
  94 {
  95     saml::NDC ndc("init");
  96
  97     REGISTER_EXCEPTION_FACTORY(edu.internet2.middleware.shibboleth.common,UnsupportedProtocolException);
  98     REGISTER_EXCEPTION_FACTORY(edu.internet2.middleware.shibboleth.common,MetadataException);
  99
 100     // Register extension schema.
 101     saml::XML::registerSchema(XML::SHIB_NS,XML::SHIB_SCHEMA_ID);
 102
 103     if (!aapFile.empty())
 104     {
 105         try
 106         {
 107             m_AAP=new AAP(aapFile.c_str());
 108         }
 109         catch(SAMLException& e)
 110         {
 111             Category::getInstance(SHIB_LOGCAT".ShibConfig").fatal("init: failed to initialize AAP: %s", e.what());
 112             return false;
 113         }
 114     }
 115
 116     regFactory("edu.internet2.middleware.shibboleth.metadata.XML",&XMLMetadataFactory);
 117     regFactory("edu.internet2.middleware.shibboleth.trust.XML",&XMLTrustFactory);
 118
 119     return true;
 120 }
 121
 122 void ShibInternalConfig::term()
 123 {
 124     for (vector<IMetadata*>::iterator i=m_providers.begin(); i!=m_providers.end(); i++)
 125         delete *i;
 126     delete m_AAP;
 127 }
 128
 129 void ShibInternalConfig::regFactory(const char* type, MetadataFactory* factory)
 130 {
 131     if (type && factory)
 132         m_metadataFactoryMap[type]=factory;
 133 }
 134
 135 void ShibInternalConfig::regFactory(const char* type, TrustFactory* factory)
 136 {
 137     if (type && factory)
 138         m_trustFactoryMap[type]=factory;
 139 }
 140
 141 void ShibInternalConfig::unregFactory(const char* type)
 142 {
 143     if (type)
 144     {
 145         m_metadataFactoryMap.erase(type);
 146         m_trustFactoryMap.erase(type);
 147     }
 148 }
 149
 150 bool ShibInternalConfig::addMetadata(const char* type, const char* source)
 151 {
 152     saml::NDC ndc("addMetadata");
 153
 154     bool ret=false;
 155     try
 156     {
 157         MetadataFactoryMap::const_iterator i=m_metadataFactoryMap.find(type);
 158         if (i!=m_metadataFactoryMap.end())
 159         {
 160             m_providers.push_back((i->second)(source));
 161             ret=true;
 162         }
 163         else
 164         {
 165             TrustFactoryMap::const_iterator j=m_trustFactoryMap.find(type);
 166             if (j!=m_trustFactoryMap.end())
 167             {
 168                 m_trust_providers.push_back((j->second)(source));
 169                 ret=true;
 170             }
 171             else
 172                 throw MetadataException("ShibConfig::addMetadata() unable to locate a metadata factory of the requested type");
 173         }
 174     }
 175     catch (SAMLException& e)
 176     {
 177         Category::getInstance(SHIB_LOGCAT".ShibConfig").error(
 178             "failed to add %s provider to system using source '%s': %s", type, source, e.what()
 179             );
 180     }
 181     catch (...)
 182     {
 183         Category::getInstance(SHIB_LOGCAT".ShibConfig").error(
 184             "failed to add %s provider to system using source '%s': unknown exception", type, source
 185             );
 186     }
 187     return ret;
 188 }
 189
 190 ShibConfig& ShibConfig::getConfig()
 191 {
 192     return g_config;
 193 }
 194
 195 void shibboleth::log_openssl()
 196 {
 197     const char* file;
 198     const char* data;
 199     int flags,line;
 200
 201     unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
 202     while (code)
 203     {
 204         Category& log=Category::getInstance("OpenSSL");
 205         log.errorStream() << "error code: " << code << " in " << file << ", line " << line << CategoryStream::ENDLINE;
 206         if (data && (flags & ERR_TXT_STRING))
 207             log.errorStream() << "error data: " << data << CategoryStream::ENDLINE;
 208         code=ERR_get_error_line_data(&file,&line,&data,&flags);
 209     }
 210 }
 211
 212 X509* shibboleth::B64_to_X509(const char* buf)
 213 {
 214         BIO* bmem = BIO_new_mem_buf((void*)buf,-1);
 215         BIO* b64 = BIO_new(BIO_f_base64());
 216         b64 = BIO_push(b64, bmem);
 217     X509* x=NULL;
 218     d2i_X509_bio(b64,&x);
 219     if (!x)
 220         log_openssl();
 221     BIO_free_all(b64);
 222     return x;
 223 }