/*
+ * 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 <log4cpp/PropertyConfigurator.hh>
-#include <log4cpp/Category.hh>
+#include <log4cpp/OstreamAppender.hh>
+using namespace std;
+using namespace log4cpp;
using namespace saml;
using namespace shibboleth;
using namespace shibtarget;
-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();
- void init();
- ShibINI& getINI() { return *ini; }
-
- Iterator<const XMLCh*> getPolicies() { return Iterator<const XMLCh*>(policies); }
-
- void ref();
-private:
- SAMLConfig& samlConf;
- ShibConfig& shibConf;
- ShibINI* ini;
- string m_app_name;
- int refcount;
- vector<const XMLCh*> policies;
-};
namespace {
- STConfig * g_Config = NULL;
- Mutex * g_lock = NULL;
-}
-
-CCache* shibtarget::g_shibTargetCCache = NULL;
-
-/****************************************************************************/
-// External Interface
-
-
-void ShibTargetConfig::preinit()
-{
- if (g_lock) return;
- g_lock = Mutex::create();
+ STConfig g_Config;
}
-ShibTargetConfig& ShibTargetConfig::init(const char* app_name, const char* inifile)
-{
- if (!g_lock)
- throw runtime_error ("ShibTargetConfig not pre-initialized");
-
- if (!app_name)
- throw runtime_error ("No Application name");
- Lock lock(g_lock);
-
- if (g_Config) {
- g_Config->ref();
- return *g_Config;
- }
-
- g_Config = new STConfig(app_name, inifile);
- g_Config->init();
- return *g_Config;
-}
+// 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;
+PlugManager::Factory MemoryCacheFactory;
+PlugManager::Factory XMLRequestMapFactory;
+PlugManager::Factory ShibSessionInitiatorFactory;
+PlugManager::Factory SAML1POSTFactory;
+PlugManager::Factory SAML1ArtifactFactory;
+PlugManager::Factory ShibLogoutFactory;
+//PlugManager::Factory htaccessFactory;
+
+SAML_EXCEPTION_FACTORY(ListenerException);
+SAML_EXCEPTION_FACTORY(ConfigurationException);
ShibTargetConfig& ShibTargetConfig::getConfig()
{
- if (!g_Config)
- throw SAMLException("ShibTargetConfig::getConfig() called with NULL configuration");
- return *g_Config;
+ return g_Config;
}
-ShibTargetConfig::~ShibTargetConfig()
+bool STConfig::init(const char* schemadir)
{
-#ifdef WIN32
-#else
- if (m_SocketName) free(m_SocketName);
+ // With new build of log4cpp, we need to establish a "default"
+ // logging appender to stderr up front.
+ const char* loglevel=getenv("SHIB_LOGGING");
+ if (!loglevel)
+ loglevel = SHIB_LOGGING;
+ Category& root = Category::getRoot();
+ if (!strcmp(loglevel,"DEBUG"))
+ root.setPriority(Priority::DEBUG);
+ else if (!strcmp(loglevel,"INFO"))
+ root.setPriority(Priority::INFO);
+ else if (!strcmp(loglevel,"NOTICE"))
+ root.setPriority(Priority::NOTICE);
+ else if (!strcmp(loglevel,"WARN"))
+ root.setPriority(Priority::WARN);
+ else if (!strcmp(loglevel,"ERROR"))
+ root.setPriority(Priority::ERROR);
+ else if (!strcmp(loglevel,"CRIT"))
+ root.setPriority(Priority::CRIT);
+ else if (!strcmp(loglevel,"ALERT"))
+ root.setPriority(Priority::ALERT);
+ else if (!strcmp(loglevel,"EMERG"))
+ root.setPriority(Priority::EMERG);
+ else if (!strcmp(loglevel,"FATAL"))
+ root.setPriority(Priority::FATAL);
+ root.setAppender(new OstreamAppender("default",&cerr));
+
+#ifdef _DEBUG
+ saml::NDC ndc("init");
#endif
-}
-
-/****************************************************************************/
-// STConfig
-
-STConfig::STConfig(const char* app_name, const char* inifile)
- : samlConf(SAMLConfig::getConfig()), shibConf(ShibConfig::getConfig()),
- m_app_name(app_name)
-{
- try {
- ini = new ShibINI((inifile ? inifile : SHIBTARGET_INIFILE));
- } catch (...) {
- cerr << "Unable to load the INI file: " <<
- (inifile ? inifile : SHIBTARGET_INIFILE) << endl;
- throw;
- }
-}
+ Category& log = Category::getInstance("shibtarget.Config");
-extern "C" SAMLAttribute* ScopedFactory(DOMElement* e)
-{
- return new ScopedAttribute(e);
-}
-
-extern "C" SAMLAttribute* SimpleFactory(DOMElement* e)
-{
- return new SimpleAttribute(e);
-}
-
-void STConfig::init()
-{
- string app = m_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";
+ if (!schemadir) {
+ log.fatal("XML schema directory not supplied");
+ return false;
}
- } 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");
-
- saml::NDC ndc("STConfig::init");
-
- // 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_AAP, true, &tag))
- shibConf.aapURL=tag;
-
- 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");
- }
-
- shibConf.mapperURL=tag;
- try {
- if (ini->get_tag (app, SHIBTARGET_TAG_SITESCERT, true, &tag)) {
- shibConf.mapperCert = new X509Certificate (X509Certificate::PEM, tag.c_str());
+ // This will cause some extra console logging, but for now,
+ // initialize the underlying libraries.
+ SAMLConfig& samlConf=SAMLConfig::getConfig();
+ if (schemadir)
+ samlConf.schema_dir = schemadir;
+ try {
+ if (!samlConf.init()) {
+ log.fatal("Failed to initialize SAML Library");
+ return false;
+ }
}
- } catch (...) {
- log.crit ("Can not read the x509 certificate.");
- throw;
- }
-
- try {
- if (ini->get_tag (app, SHIBTARGET_TAG_SITESREFRESH, true, &tag)) {
- shibConf.mapperRefreshInterval = atoi(tag.c_str());
+ catch (...) {
+ log.fatal("Died initializing SAML Library");
+ return false;
}
- } catch (...) {
- log.crit ("Can not read the mapper refresh interval.");
- throw;
- }
-
- 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.c_str(), SHIBTARGET_SHAR)) {
- const char * cache_type = NULL;
- if (ini->get_tag (app, SHIBTARGET_TAG_CACHETYPE, true, &tag))
- cache_type = tag.c_str();
-
- g_shibTargetCCache = CCache::getInstance(cache_type);
- }
-
- // 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());
- }
- }
- delete iter;
- }
-
- // Register attributes based on built-in classes.
- if (ini->exists("attributes")) {
- ShibINI::Iterator* iter=ini->tag_iterator("attributes");
- for (const string* attrname=iter->begin(); attrname; attrname=iter->next())
- {
- const string factory=ini->get("attributes",*attrname);
- if (factory=="scoped")
- {
- auto_ptr<XMLCh> temp(XMLString::transcode(attrname->c_str()));
- SAMLAttribute::regFactory(temp.get(),shibboleth::Constants::SHIB_ATTRIBUTE_NAMESPACE_URI,&ScopedFactory);
- }
- else if (factory=="simple")
- {
- auto_ptr<XMLCh> temp(XMLString::transcode(attrname->c_str()));
- SAMLAttribute::regFactory(temp.get(),shibboleth::Constants::SHIB_ATTRIBUTE_NAMESPACE_URI,&SimpleFactory);
+
+ ShibConfig& shibConf=ShibConfig::getConfig();
+ try {
+ if (!shibConf.init()) {
+ log.fatal("Failed to initialize Shib library");
+ samlConf.term();
+ return false;
}
}
- delete iter;
- }
-
- // Load SAML policies.
- if (ini->exists(SHIBTARGET_POLICIES)) {
- 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(SHIBTARGET_POLICIES, *str).c_str()));
+ catch (...) {
+ log.fatal("Died initializing Shib library.");
+ samlConf.term();
+ return false;
}
- delete iter;
- }
-
- string sockname=ini->get(SHIBTARGET_GENERAL, "sharsocket");
-#ifdef WIN32
- if (sockname.length()>0)
- m_SocketName=atoi(sockname.c_str());
- else
- m_SocketName=SHIB_SHAR_SOCKET;
-#else
- if (sockname.length()>0)
- m_SocketName=strdup(sockname.c_str());
- else
- m_SocketName=strdup(SHIB_SHAR_SOCKET);
-#endif
- ref();
- log.debug("finished");
+ // Register built-in plugin types.
+ REGISTER_EXCEPTION_FACTORY(ListenerException);
+ REGISTER_EXCEPTION_FACTORY(ConfigurationException);
+#ifndef WIN32
+ samlConf.getPlugMgr().regFactory(shibtarget::XML::UnixListenerType,&UnixListenerFactory);
+#endif
+ samlConf.getPlugMgr().regFactory(shibtarget::XML::TCPListenerType,&TCPListenerFactory);
+ samlConf.getPlugMgr().regFactory(shibtarget::XML::MemoryListenerType,&MemoryListenerFactory);
+ samlConf.getPlugMgr().regFactory(shibtarget::XML::MemorySessionCacheType,&MemoryCacheFactory);
+ samlConf.getPlugMgr().regFactory(shibtarget::XML::LegacyRequestMapType,&XMLRequestMapFactory);
+ samlConf.getPlugMgr().regFactory(shibtarget::XML::XMLRequestMapType,&XMLRequestMapFactory);
+ samlConf.getPlugMgr().regFactory(shibtarget::XML::NativeRequestMapType,&XMLRequestMapFactory);
+
+ auto_ptr_char temp1(Constants::SHIB_SESSIONINIT_PROFILE_URI);
+ samlConf.getPlugMgr().regFactory(temp1.get(),&ShibSessionInitiatorFactory);
+ auto_ptr_char temp2(SAMLBrowserProfile::BROWSER_POST);
+ samlConf.getPlugMgr().regFactory(temp2.get(),&SAML1POSTFactory);
+ auto_ptr_char temp3(SAMLBrowserProfile::BROWSER_ARTIFACT);
+ samlConf.getPlugMgr().regFactory(temp3.get(),&SAML1ArtifactFactory);
+ auto_ptr_char temp4(Constants::SHIB_LOGOUT_PROFILE_URI);
+ samlConf.getPlugMgr().regFactory(temp4.get(),&ShibLogoutFactory);
+
+ saml::XML::registerSchema(shibtarget::XML::SHIBTARGET_NS,shibtarget::XML::SHIBTARGET_SCHEMA_ID,NULL,false);
+ saml::XML::registerSchema(shibtarget::XML::SAML2META_NS,shibtarget::XML::SAML2META_SCHEMA_ID,NULL,false);
+ saml::XML::registerSchema(shibtarget::XML::SAML2ASSERT_NS,shibtarget::XML::SAML2ASSERT_SCHEMA_ID,NULL,false);
+ saml::XML::registerSchema(shibtarget::XML::XMLENC_NS,shibtarget::XML::XMLENC_SCHEMA_ID,NULL,false);
+
+ log.info("finished initializing");
+ return true;
}
-STConfig::~STConfig()
+bool STConfig::load(const char* config)
{
- for (vector<const XMLCh*>::iterator i=policies.begin(); i!=policies.end(); i++)
- delete const_cast<XMLCh*>(*i);
-
- // Unregister attributes based on built-in classes.
- if (ini && ini->exists("attributes")) {
- ShibINI::Iterator* iter=ini->tag_iterator("attributes");
- for (const string* attrname=iter->begin(); attrname; attrname=iter->next())
- {
- const string factory=ini->get("attributes",*attrname);
- if (factory=="scoped")
- {
- auto_ptr<XMLCh> temp(XMLString::transcode(attrname->c_str()));
- SAMLAttribute::unregFactory(temp.get(),shibboleth::Constants::SHIB_ATTRIBUTE_NAMESPACE_URI);
- }
- else if (factory=="simple")
- {
- auto_ptr<XMLCh> temp(XMLString::transcode(attrname->c_str()));
- SAMLAttribute::unregFactory(temp.get(),shibboleth::Constants::SHIB_ATTRIBUTE_NAMESPACE_URI);
- }
- }
- delete iter;
- }
+#ifdef _DEBUG
+ saml::NDC ndc("load");
+#endif
+ Category& log = Category::getInstance("shibtarget.Config");
- if (ini) delete ini;
-
- if (g_shibTargetCCache)
- delete g_shibTargetCCache;
+ if (!config) {
+ log.fatal("path to configuration file not supplied");
+ shutdown();
+ return false;
+ }
- shibConf.term();
- samlConf.term();
-}
+ try {
+ log.info("loading configuration file: %s", config);
+ static const XMLCh uri[] = { chLatin_u, chLatin_r, chLatin_i, chNull };
+ DOMImplementation* impl=DOMImplementationRegistry::getDOMImplementation(NULL);
+ DOMDocument* dummydoc=impl->createDocument();
+ DOMElement* dummy = dummydoc->createElementNS(NULL,XML::Literals::ShibbolethTargetConfig);
+ auto_ptr_XMLCh src(config);
+ dummy->setAttributeNS(NULL,uri,src.get());
+ m_ini=ShibTargetConfigFactory(dummy);
+ dummydoc->release();
+
+ pair<bool,unsigned int> skew=m_ini->getUnsignedInt("clockSkew");
+ SAMLConfig::getConfig().clock_skew_secs=skew.first ? skew.second : 180;
+
+ m_tranLog=new FixedContextCategory(SHIBTRAN_LOGCAT);
+ m_tranLog->info("opened transaction log");
+ m_tranLogLock = Mutex::create();
+ }
+ catch (SAMLException& ex) {
+ log.fatal("caught exception while loading/initializing configuration: %s",ex.what());
+ shutdown();
+ return false;
+ }
+#ifndef _DEBUG
+ catch (...) {
+ log.fatal("caught exception while loading/initializing configuration");
+ shutdown();
+ return false;
+ }
+#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
+ saml::NDC ndc("shutdown");
+#endif
+ Category& log = Category::getInstance("shibtarget.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.
+ delete m_ini;
+ m_ini = NULL;
+ ShibConfig::getConfig().term();
+ SAMLConfig::getConfig().term();
+ log.info("library shutdown complete");
}
projects / shibboleth / sp.git / blobdiff