Interim redesign to DOM-based config factories
[shibboleth/sp.git] / 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 // Metadata Factories
84 extern "C" IMetadata* XMLMetadataFactory(const DOMElement* source);
85 extern "C" ITrust* XMLTrustFactory(const DOMElement* source);
86 extern "C" ICredentials* XMLCredentialsFactory(const DOMElement* source);
87 extern "C" ICredResolver* FileCredResolverFactory(const DOMElement* e);
88 extern "C" ICredResolver* KeyInfoResolverFactory(const DOMElement* e);
89 extern "C" IAAP* XMLAAPFactory(const DOMElement* source);
90 extern "C" IAAP* XMLAAPDOMFactory(const DOMElement* source);
91
92 extern "C" SAMLAttribute* ShibAttributeFactory(DOMElement* e)
93 {
94     DOMNode* n=e->getFirstChild();
95     while (n && n->getNodeType()!=DOMNode::ELEMENT_NODE)
96         n=n->getNextSibling();
97     if (n && static_cast<DOMElement*>(n)->hasAttributeNS(NULL,SHIB_L(Scope)))
98         return new ScopedAttribute(e);
99     return new SAMLAttribute(e);
100 }
101
102
103 bool ShibInternalConfig::init()
104 {
105     saml::NDC ndc("init");
106
107     REGISTER_EXCEPTION_FACTORY(edu.internet2.middleware.shibboleth.common,UnsupportedProtocolException);
108     REGISTER_EXCEPTION_FACTORY(edu.internet2.middleware.shibboleth.common,MetadataException);
109
110     // Register extension schema.
111     saml::XML::registerSchema(XML::SHIB_NS,XML::SHIB_SCHEMA_ID);
112
113     SAMLAttribute::setFactory(&ShibAttributeFactory);
114
115     // Register metadata factories
116     regFactory("edu.internet2.middleware.shibboleth.metadata.provider.XML",&XMLMetadataFactory);
117     regFactory("edu.internet2.middleware.shibboleth.trust.provider.XML",&XMLTrustFactory);
118     regFactory("edu.internet2.middleware.shibboleth.creds.provider.XML",&XMLCredentialsFactory);
119     regFactory("edu.internet2.middleware.shibboleth.creds.provider.FileCredResolver",&FileCredResolverFactory);
120     regFactory("edu.internet2.middleware.shibboleth.creds.provider.KeyInfoResolver",&KeyInfoResolverFactory);
121     regFactory("edu.internet2.middleware.shibboleth.target.AAP.provider.XML",&XMLAAPFactory);
122
123     return true;
124 }
125
126 void ShibInternalConfig::regFactory(const char* type, MetadataFactory* factory)
127 {
128     if (type && factory)
129         m_metadataFactoryMap[type]=factory;
130 }
131
132 void ShibInternalConfig::regFactory(const char* type, TrustFactory* factory)
133 {
134     if (type && factory)
135         m_trustFactoryMap[type]=factory;
136 }
137
138 void ShibInternalConfig::regFactory(const char* type, CredentialsFactory* factory)
139 {
140     if (type && factory)
141     {
142         m_credFactoryMap[type]=factory;
143         SAMLConfig::getConfig().binding_defaults.ssl_ctx_callback=ssl_ctx_callback;
144     }
145 }
146
147 void ShibInternalConfig::regFactory(const char* type, CredResolverFactory* factory)
148 {
149     if (type && factory)
150         m_credResolverFactoryMap[type]=factory;
151 }
152
153 void ShibInternalConfig::regFactory(const char* type, AAPFactory* factory)
154 {
155     if (type && factory)
156         m_aapFactoryMap[type]=factory;
157 }
158
159 void ShibInternalConfig::unregFactory(const char* type)
160 {
161     if (type)
162     {
163         m_metadataFactoryMap.erase(type);
164         m_trustFactoryMap.erase(type);
165         m_credFactoryMap.erase(type);
166         m_credResolverFactoryMap.erase(type);
167         m_aapFactoryMap.erase(type);
168     }
169 }
170
171 IMetadata* ShibInternalConfig::newMetadata(const char* type, const DOMElement* source) const
172 {
173     MetadataFactoryMap::const_iterator i=m_metadataFactoryMap.find(type);
174     if (i==m_metadataFactoryMap.end())
175     {
176         NDC ndc("newMetadata");
177         Category::getInstance(SHIB_LOGCAT".ShibInternalConfig").error("unknown metadata type: %s",type);
178         return NULL;
179     }
180     return i->second(source);
181 }
182
183 ITrust* ShibInternalConfig::newTrust(const char* type, const DOMElement* source) const
184 {
185     TrustFactoryMap::const_iterator i=m_trustFactoryMap.find(type);
186     if (i==m_trustFactoryMap.end())
187     {
188         NDC ndc("newTrust");
189         Category::getInstance(SHIB_LOGCAT".ShibInternalConfig").error("unknown trust type: %s",type);
190         return NULL;
191     }
192     return i->second(source);
193 }
194
195 ICredentials* ShibInternalConfig::newCredentials(const char* type, const DOMElement* source) const
196 {
197     CredentialsFactoryMap::const_iterator i=m_credFactoryMap.find(type);
198     if (i==m_credFactoryMap.end())
199     {
200         NDC ndc("newCredentials");
201         Category::getInstance(SHIB_LOGCAT".ShibInternalConfig").error("unknown credentials type: %s",type);
202         return NULL;
203     }
204     return i->second(source);
205 }
206
207 IAAP* ShibInternalConfig::newAAP(const char* type, const DOMElement* source) const
208 {
209     AAPFactoryMap::const_iterator i=m_aapFactoryMap.find(type);
210     if (i==m_aapFactoryMap.end())
211     {
212         NDC ndc("newAAP");
213         Category::getInstance(SHIB_LOGCAT".ShibInternalConfig").error("unknown AAP type: %s",type);
214         return NULL;
215     }
216     return i->second(source);
217 }
218
219 ICredResolver* ShibInternalConfig::newCredResolver(const char* type, const DOMElement* source) const
220 {
221     CredResolverFactoryMap::const_iterator i=m_credResolverFactoryMap.find(type);
222     if (i==m_credResolverFactoryMap.end())
223     {
224         NDC ndc("newCredResolver");
225         Category::getInstance(SHIB_LOGCAT".ShibInternalConfig").error("unknown cred resolver type: %s",type);
226         return NULL;
227     }
228     return i->second(source);
229 }
230
231 ShibConfig& ShibConfig::getConfig()
232 {
233     return g_config;
234 }
235
236 void shibboleth::log_openssl()
237 {
238     const char* file;
239     const char* data;
240     int flags,line;
241
242     unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
243     while (code)
244     {
245         Category& log=Category::getInstance("OpenSSL");
246         log.errorStream() << "error code: " << code << " in " << file << ", line " << line << CategoryStream::ENDLINE;
247         if (data && (flags & ERR_TXT_STRING))
248             log.errorStream() << "error data: " << data << CategoryStream::ENDLINE;
249         code=ERR_get_error_line_data(&file,&line,&data,&flags);
250     }
251 }
252
253 X509* shibboleth::B64_to_X509(const char* buf)
254 {
255         BIO* bmem = BIO_new_mem_buf((void*)buf,-1);
256         BIO* b64 = BIO_new(BIO_f_base64());
257         b64 = BIO_push(b64, bmem);
258     X509* x=NULL;
259     d2i_X509_bio(b64,&x);
260     if (!x)
261         log_openssl();
262     BIO_free_all(b64);
263     return x;
264 }