/*
+ * Copyright 2001-2005 Internet2
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
* shib-config.cpp -- ShibTarget initialization and finalization routines
*
* Created By: Derek Atkins <derek@ihtfp.com>
* $Id$
*/
-#include "shib-target.h"
-#include <shib/shib-threads.h>
+#include "internal.h"
+#include <shibsp/SPConfig.h>
+#include <xmltooling/XMLToolingConfig.h>
-#include <log4cpp/PropertyConfigurator.hh>
-#include <log4cpp/Category.hh>
+#include <log4cpp/OstreamAppender.hh>
-using namespace saml;
-using namespace shibboleth;
+using namespace shibsp;
using namespace shibtarget;
+using namespace shibboleth;
+using namespace saml;
+using namespace log4cpp;
using namespace std;
-#ifndef SHIBTARGET_INIFILE
-#define SHIBTARGET_INIFILE "/opt/shibboleth/etc/shibboleth/shibboleth.ini"
-#endif
-
-class STConfig : public ShibTargetConfig
-{
-public:
- STConfig(const char* app_name, const char* inifile);
- ~STConfig();
- void shutdown();
- ShibINI& getINI() { return *ini; }
-
- Iterator<const XMLCh*> getPolicies() { return Iterator<const XMLCh*>(policies); }
-
- void ref();
-private:
- SAMLConfig& samlConf;
- ShibConfig& shibConf;
- ShibINI* ini;
- int refcount;
- vector<const XMLCh*> policies;
-};
+using xmltooling::XMLToolingConfig;
+using xmltooling::PluginManager;
namespace {
- STConfig * g_Config = NULL;
- Mutex * g_lock = NULL;
+ STConfig g_Config;
}
-CCache* shibtarget::g_shibTargetCCache = NULL;
-
-/****************************************************************************/
-// External Interface
+// Factories for built-in plugins we can manufacture. Actual definitions
+// will be with the actual object implementation.
+#ifndef WIN32
+PlugManager::Factory UnixListenerFactory;
+#endif
+PlugManager::Factory TCPListenerFactory;
+//PlugManager::Factory MemoryListenerFactory;
+PluginManager<SessionCache,const DOMElement*>::Factory MemoryCacheFactory;
+PluginManager<Handler,const DOMElement*>::Factory ShibSessionInitiatorFactory;
+PluginManager<Handler,const DOMElement*>::Factory SAML1POSTFactory;
+PluginManager<Handler,const DOMElement*>::Factory SAML1ArtifactFactory;
+PluginManager<Handler,const DOMElement*>::Factory ShibLogoutFactory;
-void ShibTargetConfig::preinit()
+ShibTargetConfig& ShibTargetConfig::getConfig()
{
- if (g_lock) return;
- g_lock = Mutex::create();
+ return g_Config;
}
-ShibTargetConfig& ShibTargetConfig::init(const char* app_name, const char* inifile)
+bool STConfig::init(const char* schemadir)
{
- if (!g_lock)
- throw runtime_error ("ShibTargetConfig not pre-initialized");
+#ifdef _DEBUG
+ xmltooling::NDC ndc("init");
+#endif
+ Category& log = Category::getInstance(SHIBT_LOGCAT".Config");
- if (!app_name)
- throw runtime_error ("No Application name");
+ if (!schemadir) {
+ log.fatal("XML schema directory not supplied");
+ return false;
+ }
- Lock lock(g_lock);
+ // This will cause some extra console logging, but for now,
+ // initialize the underlying libraries.
+ SAMLConfig& samlConf=SAMLConfig::getConfig();
+ if (schemadir)
+ samlConf.schema_dir = schemadir;
+ if (!samlConf.init()) {
+ log.fatal("failed to initialize OpenSAML1 library");
+ return false;
+ }
+
+ ShibConfig& shibConf=ShibConfig::getConfig();
+ if (!shibConf.init()) {
+ log.fatal("Failed to initialize Shib library");
+ samlConf.term();
+ return false;
+ }
+
+ SPConfig& conf=SPConfig::getConfig();
+ if (!SPConfig::getConfig().init(NULL)) {
+ log.fatal("Failed to initialize SP library");
+ shibConf.term();
+ samlConf.term();
+ return false;
+ }
- if (g_Config) {
- g_Config->ref();
- return *g_Config;
- }
+ // Register built-in plugin types.
+ conf.ServiceProviderManager.registerFactory(XML_SERVICE_PROVIDER, XMLServiceProviderFactory);
- g_Config = new STConfig(app_name, inifile);
- return *g_Config;
+ conf.SessionInitiatorManager.registerFactory(shibspconstants::SHIB1_SESSIONINIT_PROFILE_URI,&ShibSessionInitiatorFactory);
+ conf.AssertionConsumerServiceManager.registerFactory(samlconstants::SAML1_PROFILE_BROWSER_POST,&SAML1POSTFactory);
+ conf.AssertionConsumerServiceManager.registerFactory(samlconstants::SAML1_PROFILE_BROWSER_ARTIFACT,&SAML1ArtifactFactory);
+ conf.SingleLogoutServiceManager.registerFactory(shibspconstants::SHIB1_LOGOUT_PROFILE_URI,&ShibLogoutFactory);
+
+ conf.SessionCacheManager.registerFactory(MEMORY_SESSIONCACHE,&MemoryCacheFactory);
+
+ log.info("finished initializing");
+ return true;
}
-ShibTargetConfig& ShibTargetConfig::getConfig()
+bool STConfig::load(const char* config)
{
- if (!g_Config)
- throw SAMLException("ShibTargetConfig::getConfig() called with NULL configuration");
- return *g_Config;
-}
-
+#ifdef _DEBUG
+ xmltooling::NDC ndc("load");
+#endif
+ Category& log = Category::getInstance(SHIBT_LOGCAT".Config");
-/****************************************************************************/
-// STConfig
+ if (!config) {
+ log.fatal("path to configuration file not supplied");
+ shutdown();
+ return false;
+ }
-STConfig::STConfig(const char* app_name, const char* inifile)
- : samlConf(SAMLConfig::getConfig()), shibConf(ShibConfig::getConfig())
-{
- try {
- ini = new ShibINI((inifile ? inifile : SHIBTARGET_INIFILE));
- } catch (...) {
- cerr << "Unable to load the INI file: " <<
- (inifile ? inifile : SHIBTARGET_INIFILE) << endl;
- throw;
- }
-
- string app = app_name;
- string tag;
-
- // Initialize Log4cpp
- if (ini->get_tag (app, SHIBTARGET_TAG_LOGGER, true, &tag)) {
- cerr << "Trying to load logger configuration: " << tag << "\n";
try {
- log4cpp::PropertyConfigurator::configure(tag);
- } catch (log4cpp::ConfigureFailure& e) {
- cerr << "Error reading configuration: " << e.what() << "\n";
+ log.info("loading configuration file: %s", config);
+ static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
+ DOMImplementation* impl=DOMImplementationRegistry::getDOMImplementation(NULL);
+ DOMDocument* dummydoc=impl->createDocument();
+ xmltooling::XercesJanitor<DOMDocument> docjanitor(dummydoc);
+ DOMElement* dummy = dummydoc->createElementNS(NULL,path);
+
+ auto_ptr_XMLCh src(config);
+ dummy->setAttributeNS(NULL,path,src.get());
+
+ auto_ptr<ServiceProvider> sp(SPConfig::getConfig().ServiceProviderManager.newPlugin(XML_SERVICE_PROVIDER,dummy));
+ sp->init();
+
+ pair<bool,unsigned int> skew=sp->getUnsignedInt("clockSkew");
+ SAMLConfig::getConfig().clock_skew_secs=skew.first ? skew.second : 180;
+ if (skew.first)
+ XMLToolingConfig::getConfig().clock_skew_secs=skew.second;
+ SPConfig::getConfig().setServiceProvider(sp.release());
+
+ m_tranLog=new FixedContextCategory(SHIBTRAN_LOGCAT);
+ m_tranLog->info("opened transaction log");
+ m_tranLogLock = xmltooling::Mutex::create();
}
- } else {
- log4cpp::Category& category = log4cpp::Category::getRoot();
- category.setPriority(log4cpp::Priority::DEBUG);
- cerr << "No logger configuration found\n";
- }
-
- log4cpp::Category& log = log4cpp::Category::getInstance("shibtarget.STConfig");
-
- // Init SAML
- if (ini->get_tag (app, SHIBTARGET_TAG_SCHEMAS, true, &tag))
- samlConf.schema_dir = tag;
- if (ini->get_tag (app, SHIBTARGET_TAG_CERTFILE, true, &tag))
- samlConf.ssl_certfile = tag;
- if (ini->get_tag (app, SHIBTARGET_TAG_KEYFILE, true, &tag))
- samlConf.ssl_keyfile = tag;
- if (ini->get_tag (app, SHIBTARGET_TAG_KEYPASS, true, &tag))
- samlConf.ssl_keypass = tag;
- if (ini->get_tag (app, SHIBTARGET_TAG_CALIST, true, &tag))
- samlConf.ssl_calist = tag;
-
- try {
- if (!samlConf.init()) {
- log.fatal ("Failed to initialize SAML Library");
- throw runtime_error ("Failed to initialize SAML Library");
- } else
- log.debug ("SAML Initialized");
- } catch (...) {
- log.crit ("Died initializing SAML Library");
- throw;
- }
-
- // Init Shib
- if (! ini->get_tag (app, SHIBTARGET_TAG_SITES, true, &tag)) {
- log.fatal("No Sites File found in configuration");
- throw runtime_error ("No Sites File found in configuration");
- }
-
- string sitesFile = tag;
- X509Certificate* verifyKey = NULL;
-
- try {
- if (ini->get_tag (app, SHIBTARGET_TAG_SITESCERT, true, &tag)) {
- verifyKey = new X509Certificate (X509Certificate::PEM, tag.c_str());
+ catch (SAMLException& ex) {
+ log.fatal("caught exception while loading/initializing configuration: %s",ex.what());
+ shutdown();
+ return false;
}
- } catch (...) {
- log.crit ("Can not read the x509 certificate.");
- throw;
- }
-
- try
- {
- shibConf.origin_mapper = new XMLOriginSiteMapper(sitesFile.c_str(),
- samlConf.ssl_calist.c_str(),
- verifyKey);
- }
- catch (SAMLException& ex)
- {
- log.fatal("Failed to initialize OriginSiteMapper");
- throw runtime_error(string("Failed to initialize OriginSiteMapper: ") + ex.what());
- }
-
- if (verifyKey)
- delete verifyKey;
-
- try {
- if (!shibConf.init()) {
- log.fatal ("Failed to initialize Shib library");
- throw runtime_error ("Failed to initialize Shib Library");
- } else
- log.debug ("Shib Initialized");
- } catch (...) {
- log.crit ("Failed initializing Shib library.");
- throw;
- }
-
- // Initialize the SHAR Cache
- if (!strcmp (app_name, SHIBTARGET_SHAR))
- g_shibTargetCCache = CCache::getInstance(NULL);
-
- // Load any SAML extensions
- string ext = "extensions:saml";
- if (ini->exists(ext)) {
- saml::NDC ndc("load extensions");
- ShibINI::Iterator* iter = ini->tag_iterator(ext);
-
- for (const string* str = iter->begin(); str; str = iter->next()) {
- string file = ini->get(ext, *str);
- try
- {
- samlConf.saml_register_extension(file.c_str(),ini);
- log.debug("%s: loading %s", str->c_str(), file.c_str());
- }
- catch (SAMLException& e)
- {
- log.crit("%s: %s", str->c_str(), e.what());
- }
+#ifndef _DEBUG
+ catch (...) {
+ log.fatal("caught exception while loading/initializing configuration");
+ shutdown();
+ return false;
}
- delete iter;
- }
-
- // Load SAML policies.
- if (ini->exists(ext)) {
- log.debug("loading SAML policies");
- ShibINI::Iterator* iter = ini->tag_iterator(SHIBTARGET_POLICIES);
-
- for (const string* str = iter->begin(); str; str = iter->next()) {
- policies.push_back(XMLString::transcode(ini->get(ext, *str).c_str()));
- }
- delete iter;
- }
-
- ref();
- log.debug("finished");
-}
-
-STConfig::~STConfig()
-{
- for (vector<const XMLCh*>::iterator i=policies.begin(); i!=policies.end(); i++)
- delete const_cast<XMLCh*>(*i);
-
- if (ini) delete ini;
-
- if (g_shibTargetCCache)
- delete g_shibTargetCCache;
-
- delete shibConf.origin_mapper;
- shibConf.term();
- samlConf.term();
-}
+#endif
-void STConfig::ref()
-{
- refcount++;
+ log.info("finished loading configuration");
+ return true;
}
void STConfig::shutdown()
{
- refcount--;
- if (!refcount) {
- delete g_Config;
- g_Config = NULL;
- }
+#ifdef _DEBUG
+ xmltooling::NDC ndc("shutdown");
+#endif
+ Category& log = Category::getInstance(SHIBT_LOGCAT".Config");
+ log.info("shutting down the library");
+ delete m_tranLogLock;
+ m_tranLogLock = NULL;
+ //delete m_tranLog; // This is crashing for some reason, but we're shutting down anyway.
+ SPConfig::getConfig().term();
+ ShibConfig::getConfig().term();
+ SAMLConfig::getConfig().term();
+ log.info("library shutdown complete");
}