/*
- * Copyright 2001-2006 Internet2
- *
+ * 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
/**
* @file saml/saml2/metadata/MetadataProvider.h
- *
+ *
* Supplies an individual source of metadata.
*/
#ifndef __saml2_metadataprov_h__
#define __saml2_metadataprov_h__
-#include <saml/saml2/metadata/MetadataFilter.h>
+#include <saml/base.h>
-#include <xmltooling/Lockable.h>
-#include <xmltooling/signature/KeyResolver.h>
+#include <vector>
+#include <xmltooling/exceptions.h>
+#include <xmltooling/security/CredentialResolver.h>
+
+namespace xmltooling {
+ class XMLTOOL_API QName;
+ class XMLTOOL_API XMLObject;
+};
namespace opensaml {
-
+
class SAML_API SAMLArtifact;
namespace saml2md {
-
+
+ class SAML_API EntityDescriptor;
+ class SAML_API EntitiesDescriptor;
+ class SAML_API RoleDescriptor;
+ class SAML_API MetadataCredentialResolver;
+ class SAML_API MetadataFilter;
+
+#if defined (_MSC_VER)
+ #pragma warning( push )
+ #pragma warning( disable : 4251 )
+#endif
+
/**
* Supplies an individual source of metadata.
- *
+ *
* The source can be a local file, remote service, or the result of a
* dynamic lookup, can include local caching, etc. Providers
* <strong>MUST</strong> be locked before any lookup operations.
*/
- class SAML_API MetadataProvider : public virtual xmltooling::Lockable
+ class SAML_API MetadataProvider : public virtual xmltooling::CredentialResolver
{
MAKE_NONCOPYABLE(MetadataProvider);
-
protected:
/**
* Constructor.
- *
+ *
* If a DOM is supplied, a set of default logic will be used to identify
* and build MetadataFilter plugins and install them into the provider.
- * A KeyResolver can also be supplied, or a default resolver will be used.
- *
+ *
* The following XML content is supported:
- *
+ *
* <ul>
- * <li><KeyResolver> elements with a type attribute
- * <li><MetadataFilter> elements with a type attribute
+ * <li><MetadataFilter> elements with a type attribute and type-specific content
* <li><Exclude> elements representing a BlacklistMetadataFilter
- * <li><BlacklistMetadataFilter> element containing <Exclude> elements
+ * <li><BlacklistMetadataFilter> element containing <Exclude> elements
* <li><Include> elements representing a WhitelistMetadataFilter
- * <li><WhitelistMetadataFilter> element containing <Include> elements
+ * <li><SignatureMetadataFilter> element containing a <KeyResolver> element
+ * <li><WhitelistMetadataFilter> element containing <Include> elements
* </ul>
- *
+ *
* XML namespaces are ignored in the processing of these elements.
- *
+ *
* @param e DOM to supply configuration for provider
*/
- MetadataProvider(const DOMElement* e=NULL);
-
+ MetadataProvider(const xercesc::DOMElement* e=nullptr);
+
public:
/**
* Destructor will delete any installed filters.
*/
virtual ~MetadataProvider();
-
+
/**
* Adds a metadata filter to apply to any resolved metadata. Will not be applied
* to metadata that is already loaded.
- *
+ *
* @param newFilter metadata filter to add
*/
- virtual void addMetadataFilter(MetadataFilter* newFilter) {
- m_filters.push_back(newFilter);
- }
+ virtual void addMetadataFilter(MetadataFilter* newFilter);
/**
* Removes a metadata filter. The caller must delete the filter if necessary.
- *
+ *
* @param oldFilter metadata filter to remove
* @return the old filter
*/
- virtual MetadataFilter* removeMetadataFilter(MetadataFilter* oldFilter) {
- for (std::vector<MetadataFilter*>::iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
- if (oldFilter==(*i)) {
- m_filters.erase(i);
- return oldFilter;
- }
- }
- return NULL;
- }
-
+ virtual MetadataFilter* removeMetadataFilter(MetadataFilter* oldFilter);
+
/**
* Should be called after instantiating provider and adding filters, but before
* performing any lookup operations. Allows the provider to defer initialization
* this method so as to report/log any errors that would affect later processing.
*/
virtual void init()=0;
-
- /**
- * Returns a KeyResolver associated with this metadata provider, if any.
- *
- * @return an associated KeyResolver, or NULL
- */
- virtual const xmlsignature::KeyResolver* getKeyResolver() const {
- return m_resolver;
- }
-
+
/**
* Gets the entire metadata tree, after the registered filter has been applied.
* The caller MUST unlock the provider when finished with the data.
- *
+ *
* @return the entire metadata tree
*/
virtual const xmltooling::XMLObject* getMetadata() const=0;
-
- /**
- * Gets the metadata for a given entity. If a valid entity is returned,
- * the provider will be left in a locked state. The caller MUST unlock the
- * provider when finished with the entity.
- *
- * @param id the ID of the entity
- * @param requireValidMetadata indicates whether the metadata for the entity must be valid/current
- *
- * @return the entity's metadata or NULL if there is no metadata or no valid metadata
- */
- virtual const EntityDescriptor* getEntityDescriptor(const XMLCh* id, bool requireValidMetadata=true) const;
-
- /**
- * Gets the metadata for a given entity. If a valid entity is returned,
- * the provider will be left in a locked state. The caller MUST unlock the
- * provider when finished with the entity.
- *
- * @param id the ID of the entity
- * @param requireValidMetadata indicates whether the metadata for the entity must be valid/current
- *
- * @return the entity's metadata or NULL if there is no metadata or no valid metadata
- */
- virtual const EntityDescriptor* getEntityDescriptor(const char* id, bool requireValidMetadata=true) const;
-
- /**
- * Gets the metadata for an entity that issued a SAML artifact. If a valid entity is returned,
- * the provider will be left in a locked state. The caller MUST unlock the
- * provider when finished with the entity.
- *
- * @param artifact a SAML artifact to find the issuer of
- *
- * @return the entity's metadata or NULL if there is no valid metadata
- */
- virtual const EntityDescriptor* getEntityDescriptor(const SAMLArtifact* artifact) const;
/**
* Gets the metadata for a given group of entities. If a valid group is returned,
* the resolver will be left in a locked state. The caller MUST unlock the
* resolver when finished with the group.
- *
+ *
* @param name the name of the group
* @param requireValidMetadata indicates whether the metadata for the group must be valid/current
- *
- * @return the group's metadata or NULL if there is no metadata or no valid metadata
+ *
+ * @return the group's metadata or nullptr if there is no metadata or no valid metadata
*/
virtual const EntitiesDescriptor* getEntitiesDescriptor(const XMLCh* name, bool requireValidMetadata=true) const;
* Gets the metadata for a given group of entities. If a valid group is returned,
* the resolver will be left in a locked state. The caller MUST unlock the
* resolver when finished with the group.
- *
+ *
* @param name the name of the group
* @param requireValidMetadata indicates whether the metadata for the group must be valid/current
- *
- * @return the group's metadata or NULL if there is no metadata or no valid metadata
+ *
+ * @return the group's metadata or nullptr if there is no metadata or no valid metadata
*/
- virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const;
-
- protected:
- /** Embedded KeyResolver instance. */
- xmlsignature::KeyResolver* m_resolver;
+ virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const=0;
/**
- * Applies any installed filters to a metadata instance.
- *
- * @param xmlObject the metadata to be filtered
+ * Batches up criteria for entity lookup.
*/
- void doFilters(xmltooling::XMLObject& xmlObject) const;
+ struct SAML_API Criteria {
+ /**
+ * Default constructor.
+ */
+ Criteria();
- /**
- * Loads an entity into the cache for faster lookup. This includes
- * processing known reverse lookup strategies for artifacts.
- *
- * @param site entity definition
- * @param validUntil expiration time of the entity definition
- */
- virtual void index(EntityDescriptor* site, time_t validUntil);
+ /**
+ * Constructor.
+ *
+ * @param id entityID to lookup
+ * @param q element/type of role, if any
+ * @param prot protocol support constant, if any
+ * @param valid true iff stale metadata should be ignored
+ */
+ Criteria(const XMLCh* id, const xmltooling::QName* q=nullptr, const XMLCh* prot=nullptr, bool valid=true);
+
+ /**
+ * Constructor.
+ *
+ * @param id entityID to lookup
+ * @param q element/type of role, if any
+ * @param prot protocol support constant, if any
+ * @param valid true iff stale metadata should be ignored
+ */
+ Criteria(const char* id, const xmltooling::QName* q=nullptr, const XMLCh* prot=nullptr, bool valid=true);
+
+ /**
+ * Constructor.
+ *
+ * @param a artifact to lookup
+ * @param q element/type of role, if any
+ * @param prot protocol support constant, if any
+ * @param valid true iff stale metadata should be ignored
+ */
+ Criteria(const SAMLArtifact* a, const xmltooling::QName* q=nullptr, const XMLCh* prot=nullptr, bool valid=true);
+
+ virtual ~Criteria();
+
+ /**
+ * Restores the object to its default state.
+ */
+ virtual void reset();
+
+ /** Unique ID of entity. */
+ const XMLCh* entityID_unicode;
+ /** Unique ID of entity. */
+ const char* entityID_ascii;
+ /** SAML artifact */
+ const SAMLArtifact* artifact;
+ /** Element or schema type QName of metadata role. */
+ const xmltooling::QName* role;
+ /** Protocol support constant. */
+ const XMLCh* protocol;
+ /** Backup protocol support constant. */
+ const XMLCh* protocol2;
+ /** Controls whether stale metadata is ignored. */
+ bool validOnly;
+ };
/**
- * Loads a group of entities into the cache for faster lookup.
- *
- * @param group group definition
- * @param validUntil expiration time of the group definition
+ * Gets entity metadata based on supplied criteria. If a valid entity is returned,
+ * the provider will be left in a locked state. The caller MUST unlock the
+ * provider when finished with the entity.
+ *
+ * @param criteria lookup criteria
+ *
+ * @return the entity's metadata (and optionally a role) or nullptr if there is no qualifying metadata
*/
- virtual void index(EntitiesDescriptor* group, time_t validUntil);
-
+ virtual std::pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const=0;
+
+ protected:
/**
- * Clear the cache of known entities and groups.
+ * Applies any installed filters to a metadata instance.
+ *
+ * @param xmlObject the metadata to be filtered
*/
- virtual void clearDescriptorIndex();
-
+ void doFilters(xmltooling::XMLObject& xmlObject) const;
+
private:
std::vector<MetadataFilter*> m_filters;
-
- typedef std::multimap<std::string,const EntityDescriptor*> sitemap_t;
- typedef std::multimap<std::string,const EntitiesDescriptor*> groupmap_t;
- sitemap_t m_sites;
- sitemap_t m_sources;
- groupmap_t m_groups;
};
-
+
+#if defined (_MSC_VER)
+ #pragma warning( pop )
+#endif
+
/**
* Registers MetadataProvider classes into the runtime.
*/
void SAML_API registerMetadataProviders();
-
- /** MetadataProvider based on local XML files */
- #define FILESYSTEM_METADATA_PROVIDER "org.opensaml.saml2.metadata.provider.FilesystemMetadataProvider"
+
+ /** MetadataProvider based on local or remote XML file */
+ #define XML_METADATA_PROVIDER "XML"
+
+ /** MetadataProvider based on dynamic resolution */
+ #define DYNAMIC_METADATA_PROVIDER "Dynamic"
+
+ /** MetadataProvider that wraps a sequence of metadata providers. */
+ #define CHAINING_METADATA_PROVIDER "Chaining"
+
+ /** MetadataProvider that returns an empty "dummy" entity descriptor. */
+ #define NULL_METADATA_PROVIDER "Null"
+
+ DECL_XMLTOOLING_EXCEPTION(MetadataException,SAML_EXCEPTIONAPI(SAML_API),opensaml::saml2md,xmltooling::XMLToolingException,Exceptions related to metadata use);
};
};