-/*
- * Copyright 2001-2010 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
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you 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
+ * 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.
+ * 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.
*/
/**
#include "exceptions.h"
#include "saml/binding/SAMLArtifact.h"
#include "saml2/metadata/Metadata.h"
+#include "saml2/metadata/DiscoverableMetadataProvider.h"
#include "saml2/metadata/ObservableMetadataProvider.h"
#include "saml2/metadata/MetadataCredentialCriteria.h"
#include <memory>
+#include <functional>
+#include <boost/bind.hpp>
+#include <boost/ptr_container/ptr_vector.hpp>
#include <xercesc/util/XMLUniDefs.hpp>
#include <xmltooling/logging.h>
#include <xmltooling/util/Threads.h>
using namespace xmlsignature;
using namespace xmltooling::logging;
using namespace xmltooling;
+using namespace boost;
using namespace std;
namespace opensaml {
struct SAML_DLLLOCAL tracker_t;
class SAML_DLLLOCAL ChainingMetadataProvider
- : public ObservableMetadataProvider, public ObservableMetadataProvider::Observer {
+ : public DiscoverableMetadataProvider, public ObservableMetadataProvider, public ObservableMetadataProvider::Observer {
public:
ChainingMetadataProvider(const xercesc::DOMElement* e=nullptr);
virtual ~ChainingMetadataProvider();
Lockable* lock();
void unlock();
+ void setContext(const MetadataFilterContext*);
void init();
+ void outputStatus(ostream&) const;
const XMLObject* getMetadata() const;
- const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const;
- pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const;
- void onEvent(const ObservableMetadataProvider& provider) const;
+ const EntitiesDescriptor* getEntitiesDescriptor(const char*, bool requireValidMetadata=true) const;
+ pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria&) const;
const Credential* resolve(const CredentialCriteria* criteria=nullptr) const;
- vector<const Credential*>::size_type resolve(vector<const Credential*>& results, const CredentialCriteria* criteria=nullptr) const;
+ vector<const Credential*>::size_type resolve(vector<const Credential*>&, const CredentialCriteria* criteria=nullptr) const;
+
+ string getCacheTag() const {
+ Lock lock(m_trackerLock);
+ return m_feedTag;
+ }
+
+ void outputFeed(ostream& os, bool& first, bool wrapArray=true) const {
+ if (wrapArray)
+ os << '[';
+ // Lock each provider in turn and suck in its feed.
+ for (ptr_vector<MetadataProvider>::iterator m = m_providers.begin(); m != m_providers.end(); ++m) {
+ DiscoverableMetadataProvider* d = dynamic_cast<DiscoverableMetadataProvider*>(&(*m));
+ if (d) {
+ Locker locker(d);
+ d->outputFeed(os, first, false);
+ }
+ }
+ if (wrapArray)
+ os << "\n]";
+ }
+
+ void onEvent(const ObservableMetadataProvider& provider) const {
+ // Reset the cache tag for the feed.
+ Lock lock(m_trackerLock);
+ SAMLConfig::getConfig().generateRandomBytes(m_feedTag, 4);
+ m_feedTag = SAMLArtifact::toHex(m_feedTag);
+ emitChangeEvent();
+ }
+
+ protected:
+ void generateFeed() {
+ // No-op.
+ }
private:
bool m_firstMatch;
- mutable Mutex* m_trackerLock;
- ThreadKey* m_tlsKey;
- vector<MetadataProvider*> m_providers;
+ mutable auto_ptr<Mutex> m_trackerLock;
+ auto_ptr<ThreadKey> m_tlsKey;
+ mutable ptr_vector<MetadataProvider> m_providers;
mutable set<tracker_t*> m_trackers;
static void tracker_cleanup(void*);
Category& m_log;
static const XMLCh _MetadataProvider[] = UNICODE_LITERAL_16(M,e,t,a,d,a,t,a,P,r,o,v,i,d,e,r);
static const XMLCh precedence[] = UNICODE_LITERAL_10(p,r,e,c,e,d,e,n,c,e);
static const XMLCh last[] = UNICODE_LITERAL_4(l,a,s,t);
- static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
+ static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
};
};
}
ChainingMetadataProvider::ChainingMetadataProvider(const DOMElement* e)
- : ObservableMetadataProvider(e), m_firstMatch(true), m_trackerLock(nullptr), m_tlsKey(nullptr),
- m_log(Category::getInstance(SAML_LOGCAT".Metadata.Chaining"))
+ : ObservableMetadataProvider(e), m_firstMatch(true), m_trackerLock(Mutex::create()), m_tlsKey(ThreadKey::create(tracker_cleanup)),
+ m_log(Category::getInstance(SAML_LOGCAT ".Metadata.Chaining"))
{
if (XMLString::equals(e ? e->getAttributeNS(nullptr, precedence) : nullptr, last))
m_firstMatch = false;
- e = e ? XMLHelper::getFirstChildElement(e, _MetadataProvider) : nullptr;
+ e = XMLHelper::getFirstChildElement(e, _MetadataProvider);
while (e) {
- auto_ptr_char temp(e->getAttributeNS(nullptr, _type));
- if (temp.get() && *temp.get()) {
+ string t = XMLHelper::getAttrString(e, nullptr, _type);
+ if (!t.empty()) {
try {
- m_log.info("building MetadataProvider of type %s", temp.get());
- auto_ptr<MetadataProvider> provider(SAMLConfig::getConfig().MetadataProviderManager.newPlugin(temp.get(), e));
+ m_log.info("building MetadataProvider of type %s", t.c_str());
+ auto_ptr<MetadataProvider> provider(SAMLConfig::getConfig().MetadataProviderManager.newPlugin(t.c_str(), e));
ObservableMetadataProvider* obs = dynamic_cast<ObservableMetadataProvider*>(provider.get());
if (obs)
obs->addObserver(this);
m_providers.push_back(provider.get());
provider.release();
}
- catch (exception& ex) {
+ catch (std::exception& ex) {
m_log.error("error building MetadataProvider: %s", ex.what());
}
}
+ else {
+ m_log.error("MetadataProvider element missing type attribute");
+ }
e = XMLHelper::getNextSiblingElement(e, _MetadataProvider);
}
- m_trackerLock = Mutex::create();
- m_tlsKey = ThreadKey::create(tracker_cleanup);
}
ChainingMetadataProvider::~ChainingMetadataProvider()
{
- delete m_tlsKey;
- delete m_trackerLock;
+ m_tlsKey.reset(); // need to free this ahead of trackers in a command line case
for_each(m_trackers.begin(), m_trackers.end(), xmltooling::cleanup<tracker_t>());
- for_each(m_providers.begin(), m_providers.end(), xmltooling::cleanup<MetadataProvider>());
}
-void ChainingMetadataProvider::onEvent(const ObservableMetadataProvider& provider) const
+void ChainingMetadataProvider::setContext(const MetadataFilterContext* ctx)
{
- emitChangeEvent();
+ for_each(m_providers.begin(), m_providers.end(), boost::bind(&MetadataProvider::setContext, _1, ctx));
}
void ChainingMetadataProvider::init()
{
- for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
+ for (ptr_vector<MetadataProvider>::iterator i = m_providers.begin(); i != m_providers.end(); ++i) {
try {
- (*i)->init();
+ i->init();
}
- catch (exception& ex) {
+ catch (std::exception& ex) {
m_log.crit("failure initializing MetadataProvider: %s", ex.what());
}
}
+
+ // Set an initial cache tag for the state of the plugins.
+ SAMLConfig::getConfig().generateRandomBytes(m_feedTag, 4);
+ m_feedTag = SAMLArtifact::toHex(m_feedTag);
+}
+
+void ChainingMetadataProvider::outputStatus(ostream& os) const
+{
+ for_each(m_providers.begin(), m_providers.end(), boost::bind(&MetadataProvider::outputStatus, _1, boost::ref(os)));
}
Lockable* ChainingMetadataProvider::lock()
void* ptr=m_tlsKey->getData();
if (ptr) {
tracker_t* t = reinterpret_cast<tracker_t*>(ptr);
- for_each(t->m_locked.begin(), t->m_locked.end(), mem_fun<void,Lockable>(&Lockable::unlock));
+ for_each(t->m_locked.begin(), t->m_locked.end(), mem_fun(&Lockable::unlock));
t->m_locked.clear();
t->m_objectMap.clear();
}
MetadataProvider* held = nullptr;
const EntitiesDescriptor* ret = nullptr;
const EntitiesDescriptor* cur = nullptr;
- for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
- tracker->lock_if(*i);
- if (cur=(*i)->getEntitiesDescriptor(name,requireValidMetadata)) {
+ for (ptr_vector<MetadataProvider>::iterator i = m_providers.begin(); i != m_providers.end(); ++i) {
+ tracker->lock_if(&(*i));
+ if ((cur = i->getEntitiesDescriptor(name,requireValidMetadata))) {
// Are we using a first match policy?
if (m_firstMatch) {
// Save locked provider.
- tracker->remember(*i);
+ tracker->remember(&(*i));
return cur;
}
}
// Save off the latest match.
- held = *i;
+ held = &(*i);
ret = cur;
}
else {
// No match, so just unlock this one and move on.
- tracker->unlock_if(*i);
+ tracker->unlock_if(&(*i));
}
}
MetadataProvider* held = nullptr;
pair<const EntityDescriptor*,const RoleDescriptor*> ret = pair<const EntityDescriptor*,const RoleDescriptor*>(nullptr,nullptr);
pair<const EntityDescriptor*,const RoleDescriptor*> cur = ret;
- for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
- tracker->lock_if(*i);
- cur = (*i)->getEntityDescriptor(criteria);
+ for (ptr_vector<MetadataProvider>::iterator i = m_providers.begin(); i != m_providers.end(); ++i) {
+ tracker->lock_if(&(*i));
+ cur = i->getEntityDescriptor(criteria);
if (cur.first) {
if (criteria.role) {
// We want a role also. Did we find one?
if (held)
tracker->unlock_if(held);
// Save locked provider and role mapping.
- tracker->remember(*i, cur.first);
+ tracker->remember(&(*i), cur.first);
return cur;
}
}
// Save off the latest match.
- held = *i;
+ held = &(*i);
ret = cur;
}
else {
// but save this one if we didn't have the role yet.
if (ret.second) {
// We already had a role, so let's stick with that.
- tracker->unlock_if(*i);
+ tracker->unlock_if(&(*i));
}
else {
// This is at least as good, so toss anything we had and keep it.
if (held)
tracker->unlock_if(held);
- held = *i;
+ held = &(*i);
ret = cur;
}
}
tracker->unlock_if(held);
// Save locked provider.
- tracker->remember(*i, cur.first);
+ tracker->remember(&(*i), cur.first);
return cur;
}
}
// Save off the latest match.
- held = *i;
+ held = &(*i);
ret = cur;
}
}
else {
// No match, so just unlock this one and move on.
- tracker->unlock_if(*i);
+ tracker->unlock_if(&(*i));
}
}
projects / shibboleth / cpp-opensaml.git / blobdiff