Add a Shibboleth version header to HTTP requests.
[shibboleth/sp.git] / shib-target / shib-config.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  * shib-config.cpp -- ShibTarget initialization and finalization routines
52  *
53  * Created By:  Derek Atkins <derek@ihtfp.com>
54  *
55  * $Id$
56  */
57
58 #include "internal.h"
59
60 #include <log4cpp/Category.hh>
61
62 using namespace std;
63 using namespace log4cpp;
64 using namespace saml;
65 using namespace shibboleth;
66 using namespace shibtarget;
67
68 namespace {
69     STConfig g_Config;
70 }
71
72 const XMLCh ShibTargetConfig::SHIBTARGET_NS[] = // urn:mace:shibboleth:target:config:1.0
73 { chLatin_u, chLatin_r, chLatin_n, chColon, chLatin_m, chLatin_a, chLatin_c, chLatin_e, chColon,
74   chLatin_s, chLatin_h, chLatin_i, chLatin_b, chLatin_b, chLatin_o, chLatin_l, chLatin_e, chLatin_t, chLatin_h, chColon,
75   chLatin_t, chLatin_a, chLatin_r, chLatin_g, chLatin_e, chLatin_t, chColon,
76   chLatin_c, chLatin_o, chLatin_n, chLatin_f, chLatin_i, chLatin_g, chColon,
77   chDigit_1, chPeriod, chDigit_0, chNull
78 };
79
80 // Factories for built-in plugins we can manufacture. Actual definitions
81 // will be with the actual object implementation.
82 #ifndef WIN32
83 PlugManager::Factory UnixListenerFactory;
84 #endif
85 PlugManager::Factory TCPListenerFactory;
86 PlugManager::Factory MemoryCacheFactory;
87 PlugManager::Factory XMLRequestMapFactory;
88 //PlugManager::Factory htaccessFactory;
89
90 ShibTargetConfig& ShibTargetConfig::getConfig()
91 {
92     return g_Config;
93 }
94
95 bool STConfig::init(const char* schemadir, const char* config)
96 {
97     saml::NDC ndc("init");
98     Category& log = Category::getInstance("shibtarget.STConfig");
99
100     if (!schemadir || !config) {
101         log.fatal("schema directory or config file not supplied");
102         return false;
103     }
104
105     // This will cause some extra console logging, but for now,
106     // initialize the underlying libraries.
107     SAMLConfig& samlConf=SAMLConfig::getConfig();
108     if (schemadir)
109         samlConf.schema_dir = schemadir;
110     SAMLSOAPBinding::version=string("Shibboleth: ") + PACKAGE_VERSION;
111     try {
112         if (!samlConf.init()) {
113             log.fatal("Failed to initialize SAML Library");
114             return false;
115         }
116     }
117     catch (...) {
118         log.fatal("Died initializing SAML Library");
119         return false;
120     }
121     
122     ShibConfig& shibConf=ShibConfig::getConfig();
123     try { 
124         if (!shibConf.init()) {
125             log.fatal("Failed to initialize Shib library");
126             samlConf.term();
127             return false;
128         }
129     }
130     catch (...) {
131         log.fatal("Died initializing Shib library.");
132         samlConf.term();
133         return false;
134     }
135
136     try {
137         // Register plugin types.
138 #ifndef WIN32
139         shibConf.m_plugMgr.regFactory(shibtarget::XML::UnixListenerType,&UnixListenerFactory);
140 #endif
141         shibConf.m_plugMgr.regFactory(shibtarget::XML::TCPListenerType,&TCPListenerFactory);
142         shibConf.m_plugMgr.regFactory(shibtarget::XML::MemorySessionCacheType,&MemoryCacheFactory);
143         shibConf.m_plugMgr.regFactory(shibtarget::XML::RequestMapType,&XMLRequestMapFactory);
144         //shibConf.m_plugMgr.regFactory(shibtarget::XML::htaccessType,&htaccessFactory);
145         saml::XML::registerSchema(ShibTargetConfig::SHIBTARGET_NS,shibtarget::XML::SHIBTARGET_SCHEMA_ID);
146         
147         log.info("loading configuration file: %s", config);
148         static const XMLCh uri[] = { chLatin_u, chLatin_r, chLatin_i, chNull };
149         DOMImplementation* impl=DOMImplementationRegistry::getDOMImplementation(NULL);
150         DOMDocument* dummydoc=impl->createDocument();
151         DOMElement* dummy = dummydoc->createElementNS(NULL,XML::Literals::ShibbolethTargetConfig);
152         auto_ptr_XMLCh src(config);
153         dummy->setAttributeNS(NULL,uri,src.get());
154         m_ini=ShibTargetConfigFactory(dummy);
155         dummydoc->release();
156     }
157     catch (...) {
158         log.fatal("caught exception while loading/initializing configuration");
159         shibConf.term();
160         samlConf.term();
161         return false;
162     }
163   
164     log.info("finished initializing");
165
166     return true;
167 }
168
169 void STConfig::shutdown()
170 {
171     delete m_ini;
172     ShibConfig::getConfig().term();
173     SAMLConfig::getConfig().term();
174 }