X-Git-Url: http://www.project-moonshot.org/gitweb/?p=shibboleth%2Fcpp-opensaml.git;a=blobdiff_plain;f=saml%2Fsaml2%2Fmetadata%2FMetadataProvider.h;h=beced6ed1f1a4feea510b76791354cbc0182c609;hp=3f5f814bb2895179eb98ec59c070b50bb96f82c4;hb=003e73203da5cdf8c3d001a75a56b9e45ef6465b;hpb=b3aabf197d42b5766d2abcd745a66e3f6e00b7a2 diff --git a/saml/saml2/metadata/MetadataProvider.h b/saml/saml2/metadata/MetadataProvider.h index 3f5f814..beced6e 100644 --- a/saml/saml2/metadata/MetadataProvider.h +++ b/saml/saml2/metadata/MetadataProvider.h @@ -1,5 +1,5 @@ /* - * 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. @@ -15,7 +15,7 @@ */ /** - * @file MetadataProvider.h + * @file saml/saml2/metadata/MetadataProvider.h * * Supplies an individual source of metadata. */ @@ -23,57 +23,100 @@ #ifndef __saml2_metadataprov_h__ #define __saml2_metadataprov_h__ -#include -#include +#include +#include +#include +#include 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. + * dynamic lookup, can include local caching, etc. Providers + * MUST 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: - MetadataProvider() : m_filter(NULL) {} + /** + * 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: + * + *
    + *
  • <MetadataFilter> elements with a type attribute and type-specific content + *
  • <Exclude> elements representing a BlacklistMetadataFilter + *
  • <BlacklistMetadataFilter> element containing <Exclude> elements + *
  • <Include> elements representing a WhitelistMetadataFilter + *
  • <SignatureMetadataFilter> element containing a <KeyResolver> element + *
  • <WhitelistMetadataFilter> element containing <Include> elements + *
+ * + * XML namespaces are ignored in the processing of these elements. + * + * @param e DOM to supply configuration for provider + */ + MetadataProvider(const xercesc::DOMElement* e=NULL); public: - virtual ~MetadataProvider() { - delete m_filter; - } + /** + * Destructor will delete any installed filters. + */ + virtual ~MetadataProvider(); /** - * Gets the metadata filter applied to the resolved metadata. + * Adds a metadata filter to apply to any resolved metadata. Will not be applied + * to metadata that is already loaded. * - * @return the metadata filter applied to the resolved metadata + * @param newFilter metadata filter to add */ - const MetadataFilter* getMetadataFilter() const { - return m_filter; + virtual void addMetadataFilter(MetadataFilter* newFilter) { + m_filters.push_back(newFilter); } - + /** - * Sets the metadata filter applied to the resolved metadata. + * Removes a metadata filter. The caller must delete the filter if necessary. * - * @param newFilter the metadata filter applied to the resolved metadata + * @param oldFilter metadata filter to remove + * @return the old filter */ - void setMetadataFilter(MetadataFilter* newFilter) { - delete m_filter; - m_filter=newFilter; + virtual MetadataFilter* removeMetadataFilter(MetadataFilter* oldFilter) { + for (std::vector::iterator i=m_filters.begin(); i!=m_filters.end(); i++) { + if (oldFilter==(*i)) { + m_filters.erase(i); + return oldFilter; + } + } + return NULL; } /** - * Should be called after instantiating provider and setting filter, but before + * Should be called after instantiating provider and adding filters, but before * performing any lookup operations. Allows the provider to defer initialization * processes that are likely to result in exceptions until after the provider is * safely created. Providers SHOULD perform as much processing as possible in * this method so as to report/log any errors that would affect later processing. - * Also, any inputs supplied to the factory MUST persist until the completion of - * this method, but the caller is then free to modify or delete them. */ virtual void init()=0; @@ -86,30 +129,6 @@ namespace opensaml { 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=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 char* id, bool requireValidMetadata=true) const=0; - - /** * 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. @@ -119,7 +138,7 @@ namespace opensaml { * * @return the group's metadata or NULL if there is no metadata or no valid metadata */ - virtual const EntitiesDescriptor* getEntitiesDescriptor(const XMLCh* name, bool requireValidMetadata=true) const=0; + 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, @@ -133,17 +152,115 @@ namespace opensaml { */ virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const=0; + /** + * Batches up criteria for entity lookup. + */ + 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; + }; + + /** + * 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 NULL if there is no qualifying metadata + */ + virtual std::pair getEntityDescriptor(const Criteria& criteria) const=0; + protected: - MetadataFilter* m_filter; + /** + * Applies any installed filters to a metadata instance. + * + * @param xmlObject the metadata to be filtered + */ + void doFilters(xmltooling::XMLObject& xmlObject) const; + + private: + std::vector m_filters; }; - + +#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); }; };