xmlproviders/XMLCredentials.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 /* XMLCredentials.cpp - a credentials implementation that uses an XML file
  51
  52    Scott Cantor
  53    9/27/02
  54
  55    $History:$
  56 */
  57
  58 #include "internal.h"
  59
  60 #include <sys/types.h>
  61 #include <sys/stat.h>
  62
  63 #include <log4cpp/Category.hh>
  64
  65 using namespace shibboleth;
  66 using namespace saml;
  67 using namespace log4cpp;
  68 using namespace std;
  69
  70 namespace {
  71
  72     class XMLCredentialsImpl : public ReloadableXMLFileImpl
  73     {
  74     public:
  75         XMLCredentialsImpl(const char* pathname) : ReloadableXMLFileImpl(pathname) { init(); }
  76         XMLCredentialsImpl(const DOMElement* e) : ReloadableXMLFileImpl(e) { init(); }
  77         void init();
  78         ~XMLCredentialsImpl();
  79
  80         typedef map<string,ICredResolver*> resolvermap_t;
  81         resolvermap_t m_resolverMap;
  82     };
  83
  84     class XMLCredentials : public ICredentials, public ReloadableXMLFile
  85     {
  86     public:
  87         XMLCredentials(const DOMElement* e) : ReloadableXMLFile(e) {}
  88         ~XMLCredentials() {}
  89
  90         const ICredResolver* lookup(const char* id) const;
  91
  92     protected:
  93         virtual ReloadableXMLFileImpl* newImplementation(const char* pathname, bool first=true) const;
  94         virtual ReloadableXMLFileImpl* newImplementation(const DOMElement* e, bool first=true) const;
  95     };
  96
  97 }
  98
  99 IPlugIn* XMLCredentialsFactory(const DOMElement* e)
 100 {
 101     auto_ptr<XMLCredentials> creds(new XMLCredentials(e));
 102     creds->getImplementation();
 103     return creds.release();
 104 }
 105
 106 ReloadableXMLFileImpl* XMLCredentials::newImplementation(const char* pathname, bool first) const
 107 {
 108     return new XMLCredentialsImpl(pathname);
 109 }
 110
 111 ReloadableXMLFileImpl* XMLCredentials::newImplementation(const DOMElement* e, bool first) const
 112 {
 113     return new XMLCredentialsImpl(e);
 114 }
 115
 116 void XMLCredentialsImpl::init()
 117 {
 118 #ifdef _DEBUG
 119     saml::NDC ndc("init");
 120 #endif
 121     Category& log=Category::getInstance(XMLPROVIDERS_LOGCAT".Credentials");
 122
 123     try {
 124         if (!saml::XML::isElementNamed(m_root,::XML::CREDS_NS,SHIB_L(Credentials))) {
 125             log.error("Construction requires a valid creds file: (creds:Credentials as root element)");
 126             throw CredentialException("Construction requires a valid creds file: (creds:Credentials as root element)");
 127         }
 128
 129         DOMElement* child=saml::XML::getFirstChildElement(m_root);
 130         while (child) {
 131             string cr_type;
 132             auto_ptr<char> id(XMLString::transcode(child->getAttributeNS(NULL,SHIB_L(Id))));
 133
 134             if (saml::XML::isElementNamed(child,::XML::CREDS_NS,SHIB_L(FileResolver)))
 135                 cr_type="edu.internet2.middleware.shibboleth.common.Credentials.FileCredentialResolver";
 136             else if (saml::XML::isElementNamed(child,::XML::CREDS_NS,SHIB_L(CustomResolver))) {
 137                 auto_ptr_char c(child->getAttributeNS(NULL,SHIB_L(Class)));
 138                 cr_type=c.get();
 139             }
 140
 141             if (!cr_type.empty()) {
 142                 try {
 143                     IPlugIn* plugin=SAMLConfig::getConfig().getPlugMgr().newPlugin(cr_type.c_str(),child);
 144                     ICredResolver* cr=dynamic_cast<ICredResolver*>(plugin);
 145                     if (cr)
 146                         m_resolverMap[id.get()]=cr;
 147                     else {
 148                         log.error("plugin was not a credential resolver");
 149                         throw UnsupportedExtensionException("plugin was not a credential resolver");
 150                     }
 151                 }
 152                 catch (SAMLException& e) {
 153                     log.error("failed to instantiate credential resolver (%s): %s", id.get(), e.what());
 154                     throw;
 155                 }
 156             }
 157             else {
 158                 log.error("unknown or unimplemented type of credential resolver (%s)", id.get());
 159                 throw CredentialException("Unknown or unimplemented type of credential resolver");
 160             }
 161
 162             child=saml::XML::getNextSiblingElement(child);
 163         }
 164     }
 165     catch (SAMLException& e) {
 166         log.errorStream() << "Error while parsing creds configuration: " << e.what() << CategoryStream::ENDLINE;
 167         this->~XMLCredentialsImpl();
 168         throw;
 169     }
 170 #ifndef _DEBUG
 171     catch (...) {
 172         log.error("Unexpected error while parsing creds configuration");
 173         this->~XMLCredentialsImpl();
 174         throw;
 175     }
 176 #endif
 177 }
 178
 179 XMLCredentialsImpl::~XMLCredentialsImpl()
 180 {
 181     for (resolvermap_t::iterator j=m_resolverMap.begin(); j!=m_resolverMap.end(); j++)
 182         delete j->second;
 183 }
 184
 185 const ICredResolver* XMLCredentials::lookup(const char* id) const
 186 {
 187     if (id) {
 188         XMLCredentialsImpl* impl=dynamic_cast<XMLCredentialsImpl*>(getImplementation());
 189         XMLCredentialsImpl::resolvermap_t::const_iterator i=impl->m_resolverMap.find(id);
 190         if (i!=impl->m_resolverMap.end())
 191             return i->second;
 192     }
 193     return NULL;
 194 }