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