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 "shib-threads.h"
  67
  68 #include <openssl/err.h>
  69
  70 using namespace saml;
  71 using namespace shibboleth;
  72 using namespace log4cpp;
  73 using namespace std;
  74
  75
  76 SAML_EXCEPTION_FACTORY(ResourceAccessException);
  77 SAML_EXCEPTION_FACTORY(MetadataException);
  78 SAML_EXCEPTION_FACTORY(CredentialException);
  79 SAML_EXCEPTION_FACTORY(InvalidHandleException);
  80 SAML_EXCEPTION_FACTORY(InvalidSessionException);
  81
  82 namespace {
  83     ShibConfig g_config;
  84     vector<Mutex*> g_openssl_locks;
  85 }
  86
  87 extern "C" void openssl_locking_callback(int mode,int n,const char *file,int line)
  88 {
  89     if (mode & CRYPTO_LOCK)
  90         g_openssl_locks[n]->lock();
  91     else
  92         g_openssl_locks[n]->unlock();
  93 }
  94
  95 #ifndef WIN32
  96 extern "C" unsigned long openssl_thread_id(void)
  97 {
  98     return (unsigned long)(pthread_self());
  99 }
 100 #endif
 101
 102 bool ShibConfig::init()
 103 {
 104     REGISTER_EXCEPTION_FACTORY(ResourceAccessException);
 105     REGISTER_EXCEPTION_FACTORY(MetadataException);
 106     REGISTER_EXCEPTION_FACTORY(CredentialException);
 107     REGISTER_EXCEPTION_FACTORY(InvalidHandleException);
 108     REGISTER_EXCEPTION_FACTORY(InvalidSessionException);
 109
 110     // Set up OpenSSL locking.
 111         for (int i=0; i<CRYPTO_num_locks(); i++)
 112         g_openssl_locks.push_back(Mutex::create());
 113         CRYPTO_set_locking_callback(openssl_locking_callback);
 114 #ifndef WIN32
 115     CRYPTO_set_id_callback(openssl_thread_id);
 116 #endif
 117
 118     return true;
 119 }
 120
 121 void ShibConfig::term()
 122 {
 123     CRYPTO_set_locking_callback(NULL);
 124     for (vector<Mutex*>::iterator i=g_openssl_locks.begin(); i!=g_openssl_locks.end(); i++)
 125         delete (*i);
 126     g_openssl_locks.clear();
 127 }
 128
 129 ShibConfig& ShibConfig::getConfig()
 130 {
 131     return g_config;
 132 }
 133
 134 void shibboleth::log_openssl()
 135 {
 136     const char* file;
 137     const char* data;
 138     int flags,line;
 139
 140     unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
 141     while (code)
 142     {
 143         Category& log=Category::getInstance("OpenSSL");
 144         log.errorStream() << "error code: " << code << " in " << file << ", line " << line << CategoryStream::ENDLINE;
 145         if (data && (flags & ERR_TXT_STRING))
 146             log.errorStream() << "error data: " << data << CategoryStream::ENDLINE;
 147         code=ERR_get_error_line_data(&file,&line,&data,&flags);
 148     }
 149 }
 150
 151 void shibboleth::annotateException(SAMLException& e, const IEntityDescriptor* entity, bool rethrow)
 152 {
 153     if (entity) {
 154         auto_ptr_char id(entity->getId());
 155         e.addProperty("providerId",id.get());
 156         Iterator<const IRoleDescriptor*> roles=entity->getRoleDescriptors();
 157         while (roles.hasNext()) {
 158             const IRoleDescriptor* role=roles.next();
 159             if (role->isValid()) {
 160                 const char* temp=role->getErrorURL();
 161                 if (temp) {
 162                     e.addProperty("errorURL",temp);
 163                     break;
 164                 }
 165             }
 166         }
 167
 168         Iterator<const IContactPerson*> i=entity->getContactPersons();
 169         while (i.hasNext()) {
 170             const IContactPerson* c=i.next();
 171             if ((c->getType()==IContactPerson::technical || c->getType()==IContactPerson::support)) {
 172                 const char* fname=c->getGivenName();
 173                 const char* lname=c->getSurName();
 174                 if (fname && lname) {
 175                     string contact=string(fname) + ' ' + lname;
 176                     e.addProperty("contactName",contact.c_str());
 177                 }
 178                 else if (fname)
 179                     e.addProperty("contactName",fname);
 180                 else if (lname)
 181                     e.addProperty("contactName",lname);
 182                 Iterator<string> emails=c->getEmailAddresses();
 183                 if (emails.hasNext())
 184                     e.addProperty("contactEmail",emails.next().c_str());
 185                 break;
 186             }
 187         }
 188     }
 189
 190     if (rethrow)
 191         throw e;
 192 }
 193
 194 void shibboleth::annotateException(saml::SAMLException& e, const IRoleDescriptor* role, bool rethrow)
 195 {
 196     if (role) {
 197         auto_ptr_char id(role->getEntityDescriptor()->getId());
 198         e.addProperty("providerId",id.get());
 199         const char* temp=role->getErrorURL();
 200         if (role->getErrorURL())
 201             e.addProperty("errorURL",role->getErrorURL());
 202
 203         Iterator<const IContactPerson*> i=role->getContactPersons();
 204         while (i.hasNext()) {
 205             const IContactPerson* c=i.next();
 206             if ((c->getType()==IContactPerson::technical || c->getType()==IContactPerson::support)) {
 207                 const char* fname=c->getGivenName();
 208                 const char* lname=c->getSurName();
 209                 if (fname && lname) {
 210                     string contact=string(fname) + ' ' + lname;
 211                     e.addProperty("contactName",contact.c_str());
 212                 }
 213                 else if (fname)
 214                     e.addProperty("contactName",fname);
 215                 else if (lname)
 216                     e.addProperty("contactName",lname);
 217                 Iterator<string> emails=c->getEmailAddresses();
 218                 if (emails.hasNext())
 219                     e.addProperty("contactEmail",emails.next().c_str());
 220                 break;
 221             }
 222         }
 223     }
 224
 225     if (rethrow)
 226         throw e;
 227 }