3 * Copyright 2001-2007 Internet2
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
21 * Library configuration
25 #include "AccessControl.h"
26 #include "exceptions.h"
27 #include "RequestMapper.h"
28 #include "ServiceProvider.h"
29 #include "SessionCache.h"
31 #include "attribute/Attribute.h"
32 #include "handler/SessionInitiator.h"
33 #include "remoting/ListenerService.h"
36 # include "attribute/AttributeDecoder.h"
37 # include "attribute/filtering/AttributeFilter.h"
38 # include "attribute/filtering/MatchFunctor.h"
39 # include "attribute/resolver/AttributeExtractor.h"
40 # include "attribute/resolver/AttributeResolver.h"
41 # include "binding/ArtifactResolver.h"
42 # include "metadata/MetadataExt.h"
43 # include "security/PKIXTrustEngine.h"
44 # include <saml/SAMLConfig.h>
46 # include <xmltooling/XMLToolingConfig.h>
49 #include <log4cpp/Category.hh>
50 #include <xmltooling/util/NDC.h>
51 #include <xmltooling/util/TemplateEngine.h>
53 using namespace shibsp;
54 using namespace opensaml;
55 using namespace xmltooling;
56 using namespace log4cpp;
58 DECL_XMLTOOLING_EXCEPTION_FACTORY(AttributeException,shibsp);
59 DECL_XMLTOOLING_EXCEPTION_FACTORY(AttributeExtractionException,shibsp);
60 DECL_XMLTOOLING_EXCEPTION_FACTORY(AttributeFilteringException,shibsp);
61 DECL_XMLTOOLING_EXCEPTION_FACTORY(AttributeResolutionException,shibsp);
62 DECL_XMLTOOLING_EXCEPTION_FACTORY(ConfigurationException,shibsp);
63 DECL_XMLTOOLING_EXCEPTION_FACTORY(ListenerException,shibsp);
66 DECL_XMLTOOLING_EXCEPTION_FACTORY(MetadataException,opensaml::saml2md);
67 DECL_XMLTOOLING_EXCEPTION_FACTORY(SecurityPolicyException,opensaml);
68 DECL_XMLTOOLING_EXCEPTION_FACTORY(ProfileException,opensaml);
69 DECL_XMLTOOLING_EXCEPTION_FACTORY(FatalProfileException,opensaml);
70 DECL_XMLTOOLING_EXCEPTION_FACTORY(RetryableProfileException,opensaml);
74 SPInternalConfig g_config;
77 SPConfig& SPConfig::getConfig()
82 SPInternalConfig& SPInternalConfig::getInternalConfig()
87 void SPConfig::setServiceProvider(ServiceProvider* serviceProvider)
89 delete m_serviceProvider;
90 m_serviceProvider = serviceProvider;
93 bool SPInternalConfig::init(const char* catalog_path)
98 Category& log=Category::getInstance(SHIBSP_LOGCAT".Config");
99 log.debug("library initialization started");
101 const char* loglevel=getenv("SHIBSP_LOGGING");
103 loglevel = SHIBSP_LOGGING;
104 XMLToolingConfig::getConfig().log_config(loglevel);
107 catalog_path = getenv("SHIBSP_SCHEMAS");
109 catalog_path = SHIBSP_SCHEMAS;
110 XMLToolingConfig::getConfig().catalog_path = catalog_path;
113 if (!SAMLConfig::getConfig().init()) {
114 log.fatal("failed to initialize OpenSAML library");
118 if (!XMLToolingConfig::getConfig().init()) {
119 log.fatal("failed to initialize XMLTooling library");
124 XMLToolingConfig::getConfig().setTemplateEngine(new TemplateEngine());
125 XMLToolingConfig::getConfig().getTemplateEngine()->setTagPrefix("shibmlp");
127 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(AttributeException,shibsp);
128 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(AttributeExtractionException,shibsp);
129 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(AttributeFilteringException,shibsp);
130 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(AttributeResolutionException,shibsp);
131 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ConfigurationException,shibsp);
132 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ListenerException,shibsp);
135 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(SecurityPolicyException,opensaml);
136 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ProfileException,opensaml);
137 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(FatalProfileException,opensaml);
138 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(RetryableProfileException,opensaml);
139 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MetadataException,opensaml::saml2md);
143 if (isEnabled(Metadata))
144 registerMetadataExtClasses();
145 if (isEnabled(Trust))
146 registerPKIXTrustEngine();
149 registerAttributeFactories();
151 registerSessionInitiators();
152 registerServiceProviders();
155 if (isEnabled(AttributeResolution)) {
156 registerAttributeExtractors();
157 registerAttributeDecoders();
158 registerAttributeResolvers();
159 registerAttributeFilters();
160 registerMatchFunctors();
164 if (isEnabled(Listener))
165 registerListenerServices();
167 if (isEnabled(RequestMapping)) {
168 registerAccessControls();
169 registerRequestMappers();
172 if (isEnabled(Caching))
173 registerSessionCaches();
176 if (isEnabled(OutOfProcess))
177 m_artifactResolver = new ArtifactResolver();
180 log.info("library initialization complete");
184 void SPInternalConfig::term()
189 Category& log=Category::getInstance(SHIBSP_LOGCAT".Config");
190 log.info("shutting down the library");
192 setServiceProvider(NULL);
194 setArtifactResolver(NULL);
197 ArtifactResolutionServiceManager.deregisterFactories();
198 AssertionConsumerServiceManager.deregisterFactories();
199 LogoutInitiatorManager.deregisterFactories();
200 ManageNameIDServiceManager.deregisterFactories();
201 SessionInitiatorManager.deregisterFactories();
202 SingleLogoutServiceManager.deregisterFactories();
203 HandlerManager.deregisterFactories();
204 ServiceProviderManager.deregisterFactories();
205 Attribute::deregisterFactories();
208 if (isEnabled(AttributeResolution)) {
209 MatchFunctorManager.deregisterFactories();
210 AttributeFilterManager.deregisterFactories();
211 AttributeDecoderManager.deregisterFactories();
212 AttributeExtractorManager.deregisterFactories();
213 AttributeResolverManager.deregisterFactories();
217 if (isEnabled(Listener))
218 ListenerServiceManager.deregisterFactories();
220 if (isEnabled(RequestMapping)) {
221 AccessControlManager.deregisterFactories();
222 RequestMapperManager.deregisterFactories();
225 if (isEnabled(Caching))
226 SessionCacheManager.deregisterFactories();
229 SAMLConfig::getConfig().term();
231 XMLToolingConfig::getConfig().term();
233 log.info("library shutdown complete");