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 extern "C" ICredentials* XMLCredentialsFactory(const char* source)
  94 {
  95     return new XMLCredentials(source);
  96 }
  97
  98 extern "C" IAAP* XMLAAPFactory(const char* source)
  99 {
 100     return new XMLAAP(source);
 101 }
 102
 103 extern "C" SAMLAttribute* ShibAttributeFactory(DOMElement* e)
 104 {
 105     DOMNode* n=e->getFirstChild();
 106     while (n && n->getNodeType()!=DOMNode::ELEMENT_NODE)
 107         n=n->getNextSibling();
 108     if (n && static_cast<DOMElement*>(n)->hasAttributeNS(NULL,SHIB_L(Scope)))
 109         return new ScopedAttribute(e);
 110     return new SimpleAttribute(e);
 111 }
 112
 113
 114 bool ShibInternalConfig::init()
 115 {
 116     saml::NDC ndc("init");
 117
 118     REGISTER_EXCEPTION_FACTORY(edu.internet2.middleware.shibboleth.common,UnsupportedProtocolException);
 119     REGISTER_EXCEPTION_FACTORY(edu.internet2.middleware.shibboleth.common,MetadataException);
 120
 121     // Register extension schema.
 122     saml::XML::registerSchema(XML::SHIB_NS,XML::SHIB_SCHEMA_ID);
 123
 124     regFactory("edu.internet2.middleware.shibboleth.metadata.XML",&XMLMetadataFactory);
 125     regFactory("edu.internet2.middleware.shibboleth.trust.XML",&XMLTrustFactory);
 126     regFactory("edu.internet2.middleware.shibboleth.creds.XML",&XMLCredentialsFactory);
 127     regFactory("edu.internet2.middleware.shibboleth.target.AAP.XML",&XMLAAPFactory);
 128     regFactory("edu.internet2.middleware.shibboleth.target.AttributeFactory",&ShibAttributeFactory);
 129
 130     return true;
 131 }
 132
 133 void ShibInternalConfig::term()
 134 {
 135     for (vector<IMetadata*>::iterator i=m_providers.begin(); i!=m_providers.end(); i++)
 136         delete *i;
 137     for (vector<ITrust*>::iterator j=m_trust_providers.begin(); j!=m_trust_providers.end(); j++)
 138         delete *j;
 139     for (vector<ICredentials*>::iterator k=m_cred_providers.begin(); k!=m_cred_providers.end(); k++)
 140         delete *k;
 141     for (vector<IAAP*>::iterator l=m_aap_providers.begin(); l!=m_aap_providers.end(); l++)
 142         delete *l;
 143 }
 144
 145 void ShibInternalConfig::regFactory(const char* type, MetadataFactory* factory)
 146 {
 147     if (type && factory)
 148         m_metadataFactoryMap[type]=factory;
 149 }
 150
 151 void ShibInternalConfig::regFactory(const char* type, TrustFactory* factory)
 152 {
 153     if (type && factory)
 154         m_trustFactoryMap[type]=factory;
 155 }
 156
 157 void ShibInternalConfig::regFactory(const char* type, CredentialsFactory* factory)
 158 {
 159     if (type && factory)
 160     {
 161         m_credFactoryMap[type]=factory;
 162         SAMLConfig::getConfig().binding_defaults.ssl_ctx_callback=ssl_ctx_callback;
 163     }
 164 }
 165
 166 void ShibInternalConfig::regFactory(const char* type, AAPFactory* factory)
 167 {
 168     if (type && factory)
 169         m_aapFactoryMap[type]=factory;
 170 }
 171
 172 void ShibInternalConfig::regFactory(const char* type, SAMLAttributeFactory* factory)
 173 {
 174     if (type && factory)
 175         m_attrFactoryMap[type]=factory;
 176 }
 177
 178 void ShibInternalConfig::unregFactory(const char* type)
 179 {
 180     if (type)
 181     {
 182         m_metadataFactoryMap.erase(type);
 183         m_trustFactoryMap.erase(type);
 184         m_credFactoryMap.erase(type);
 185         m_aapFactoryMap.erase(type);
 186     }
 187 }
 188
 189 SAMLAttributeFactory* ShibInternalConfig::getAttributeFactory(const char* type) const
 190 {
 191     AttributeFactoryMap::const_iterator i =
 192         m_attrFactoryMap.find((type && *type) ? type : "edu.internet2.middleware.shibboleth.target.AttributeFactory");
 193     if (i==m_attrFactoryMap.end())
 194     {
 195         saml::NDC ndc("getAttributeFactory");
 196         Category::getInstance(SHIB_LOGCAT".ShibInternalConfig").error("unknown attribute factory: %s",type);
 197         return NULL;
 198     }
 199     return i->second;
 200 }
 201
 202 bool ShibInternalConfig::addMetadata(const char* type, const char* source)
 203 {
 204     saml::NDC ndc("addMetadata");
 205
 206     bool ret=false;
 207     try
 208     {
 209         MetadataFactoryMap::const_iterator i=m_metadataFactoryMap.find(type);
 210         if (i!=m_metadataFactoryMap.end())
 211         {
 212             m_providers.push_back((i->second)(source));
 213             ret=true;
 214         }
 215         else
 216         {
 217             TrustFactoryMap::const_iterator j=m_trustFactoryMap.find(type);
 218             if (j!=m_trustFactoryMap.end())
 219             {
 220                 m_trust_providers.push_back((j->second)(source));
 221                 ret=true;
 222             }
 223             else
 224             {
 225                 CredentialsFactoryMap::const_iterator k=m_credFactoryMap.find(type);
 226                 if (k!=m_credFactoryMap.end())
 227                 {
 228                     m_cred_providers.push_back((k->second)(source));
 229                     ret=true;
 230                 }
 231                 else
 232                 {
 233                     AAPFactoryMap::const_iterator l=m_aapFactoryMap.find(type);
 234                     if (l!=m_aapFactoryMap.end())
 235                     {
 236                         m_aap_providers.push_back((l->second)(source));
 237                         ret=true;
 238                     }
 239                     else
 240                         throw MetadataException("ShibConfig::addMetadata() unable to locate a metadata factory of the requested type");
 241                 }
 242             }
 243         }
 244     }
 245     catch (SAMLException& e)
 246     {
 247         Category::getInstance(SHIB_LOGCAT".ShibConfig").error(
 248             "failed to add %s provider to system using source '%s': %s", type, source, e.what()
 249             );
 250     }
 251     catch (...)
 252     {
 253         Category::getInstance(SHIB_LOGCAT".ShibConfig").error(
 254             "failed to add %s provider to system using source '%s': unknown exception", type, source
 255             );
 256     }
 257     return ret;
 258 }
 259
 260 ShibConfig& ShibConfig::getConfig()
 261 {
 262     return g_config;
 263 }
 264
 265 void shibboleth::log_openssl()
 266 {
 267     const char* file;
 268     const char* data;
 269     int flags,line;
 270
 271     unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
 272     while (code)
 273     {
 274         Category& log=Category::getInstance("OpenSSL");
 275         log.errorStream() << "error code: " << code << " in " << file << ", line " << line << CategoryStream::ENDLINE;
 276         if (data && (flags & ERR_TXT_STRING))
 277             log.errorStream() << "error data: " << data << CategoryStream::ENDLINE;
 278         code=ERR_get_error_line_data(&file,&line,&data,&flags);
 279     }
 280 }
 281
 282 X509* shibboleth::B64_to_X509(const char* buf)
 283 {
 284         BIO* bmem = BIO_new_mem_buf((void*)buf,-1);
 285         BIO* b64 = BIO_new(BIO_f_base64());
 286         b64 = BIO_push(b64, bmem);
 287     X509* x=NULL;
 288     d2i_X509_bio(b64,&x);
 289     if (!x)
 290         log_openssl();
 291     BIO_free_all(b64);
 292     return x;
 293 }