X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=saml%2Fsaml2%2Fmetadata%2FMetadataProvider.h;h=1f9e2beb774f88d181ec4550b488d3c85be3735a;hb=9247fd98448d17c495f1d811ac1ba82571f7ef98;hp=7f5d38679ff4c7c9188d43c4990089ecac177a54;hpb=0b9c2825fb2fad1b6eadde350c799c10e31ace78;p=shibboleth%2Fcpp-opensaml.git diff --git a/saml/saml2/metadata/MetadataProvider.h b/saml/saml2/metadata/MetadataProvider.h index 7f5d386..1f9e2be 100644 --- a/saml/saml2/metadata/MetadataProvider.h +++ b/saml/saml2/metadata/MetadataProvider.h @@ -1,6 +1,6 @@ /* - * 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. * You may obtain a copy of the License at @@ -16,63 +16,79 @@ /** * @file saml/saml2/metadata/MetadataProvider.h - * + * * Supplies an individual source of metadata. */ #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. 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: /** - * 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: + * *
    - *
  • <MetadataFilter> elements with a type attribute + *
  • <MetadataFilter> elements with a type attribute and type-specific content *
  • <Exclude> elements representing a BlacklistMetadataFilter - *
  • <BlacklistMetadataFilter> element containing <Exclude> elements + *
  • <BlacklistMetadataFilter> element containing <Exclude> elements *
  • <Include> elements representing a WhitelistMetadataFilter - *
  • <WhitelistMetadataFilter> element containing <Include> elements + *
  • <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 DOMElement* e=NULL); - + MetadataProvider(const xercesc::DOMElement* e=NULL); + 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) { @@ -81,7 +97,7 @@ namespace opensaml { /** * Removes a metadata filter. The caller must delete the filter if necessary. - * + * * @param oldFilter metadata filter to remove * @return the old filter */ @@ -94,7 +110,7 @@ namespace opensaml { } return NULL; } - + /** * Should be called after instantiating provider and adding filters, but before * performing any lookup operations. Allows the provider to defer initialization @@ -103,58 +119,23 @@ namespace opensaml { * this method so as to report/log any errors that would affect later processing. */ virtual void init()=0; - + /** * 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 */ virtual const EntitiesDescriptor* getEntitiesDescriptor(const XMLCh* name, bool requireValidMetadata=true) const; @@ -163,61 +144,136 @@ namespace opensaml { * 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 */ - 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) { + } - /** - * 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=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() {} + + /** + * Restores the object to its default state. + */ + virtual void reset() { + entityID_unicode=NULL; + entityID_ascii=NULL; + artifact=NULL; + role=NULL; + protocol=NULL; + protocol2=NULL; + validOnly=true; + } + + /** 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 NULL if there is no qualifying metadata */ - virtual void index(EntitiesDescriptor* group, time_t validUntil); - + virtual std::pair 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 clearIndex(); - + void doFilters(xmltooling::XMLObject& xmlObject) const; + private: std::vector m_filters; - - typedef std::multimap sitemap_t; - typedef std::multimap 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); }; };