/*
- * Copyright 2001-2006 Internet2
+ * Copyright 2001-2007 Internet2
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#ifndef __saml2_metadataprov_h__
#define __saml2_metadataprov_h__
-#include <xmltooling/Lockable.h>
-#include <saml/saml2/metadata/MetadataFilter.h>
+#include <saml/base.h>
+#include <xmltooling/exceptions.h>
+#include <xmltooling/XMLObject.h>
+#include <xmltooling/security/CredentialResolver.h>
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.
*
* 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. The following XML content is supported:
+ * 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.
+ *
+ * The following XML content is supported:
*
* <ul>
- * <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><Include> elements representing a WhitelistMetadataFilter
+ * <li><SignatureMetadataFilter> element containing a <KeyResolver> element
* <li><WhitelistMetadataFilter> element containing <Include> elements
* </ul>
*
*
* @param e DOM to supply configuration for provider
*/
- MetadataProvider(const DOMElement* e=NULL);
+ MetadataProvider(const xercesc::DOMElement* e=NULL);
public:
/**
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.
*
* @return the group's metadata or NULL if there is no metadata or no valid metadata
*/
- virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const;
+ virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const=0;
- protected:
/**
- * 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() : entityID_unicode(NULL), entityID_ascii(NULL), artifact(NULL), role(NULL), protocol(NULL), protocol2(NULL), validOnly(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 XMLCh* id, const xmltooling::QName* q=NULL, const XMLCh* prot=NULL, bool valid=true)
+ : entityID_unicode(id), entityID_ascii(NULL), artifact(NULL), role(q), protocol(prot), protocol2(NULL), validOnly(valid) {
+ }
+
+ /**
+ * 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=NULL, const XMLCh* prot=NULL, bool valid=true)
+ : entityID_unicode(NULL), entityID_ascii(id), artifact(NULL), role(q), protocol(prot), protocol2(NULL), validOnly(valid) {
+ }
+ /**
+ * 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=NULL, const XMLCh* prot=NULL, bool valid=true)
+ : entityID_unicode(NULL), entityID_ascii(NULL), artifact(a), role(q), protocol(prot), protocol2(NULL), validOnly(valid) {
+ }
+
+ virtual ~Criteria() {}
+
+ /** 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 an entity into the cache for faster lookup. This includes
- * processing known reverse lookup strategies for artifacts.
+ * 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
*
- * @param site entity definition
- * @param validUntil expiration time of the entity definition
+ * @return the entity's metadata (and optionally a role) or NULL if there is no qualifying metadata
*/
- virtual void index(EntityDescriptor* site, time_t validUntil);
+ virtual std::pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const=0;
+ protected:
/**
- * Loads a group of entities into the cache for faster lookup.
+ * Applies any installed filters to a metadata instance.
*
- * @param group group definition
- * @param validUntil expiration time of the group definition
- */
- virtual void index(EntitiesDescriptor* group, time_t validUntil);
-
- /**
- * Clear the cache of known entities and groups.
+ * @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);
};
};
projects / shibboleth / cpp-opensaml.git / blobdiff