saml/saml2/metadata/MetadataProvider.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file saml/saml2/metadata/MetadataProvider.h
  19  *
  20  * Supplies an individual source of metadata.
  21  */
  22
  23 #ifndef __saml2_metadataprov_h__
  24 #define __saml2_metadataprov_h__
  25
  26 #include <saml/saml2/metadata/MetadataFilter.h>
  27
  28 #include <xmltooling/Lockable.h>
  29 #include <xmltooling/security/KeyResolver.h>
  30
  31 namespace opensaml {
  32
  33     class SAML_API SAMLArtifact;
  34
  35     namespace saml2md {
  36
  37         class SAML_API EntityDescriptor;
  38         class SAML_API EntitiesDescriptor;
  39
  40         /**
  41          * Supplies an individual source of metadata.
  42          *
  43          * The source can be a local file, remote service, or the result of a
  44          * dynamic lookup, can include local caching, etc. Providers
  45          * <strong>MUST</strong> be locked before any lookup operations.
  46          */
  47         class SAML_API MetadataProvider : public virtual xmltooling::Lockable
  48         {
  49             MAKE_NONCOPYABLE(MetadataProvider);
  50
  51         protected:
  52             /**
  53              * Constructor.
  54              *
  55              * If a DOM is supplied, a set of default logic will be used to identify
  56              * and build MetadataFilter plugins and install them into the provider.
  57              *
  58              * The following XML content is supported:
  59              *
  60              * <ul>
  61              *  <li>&lt;MetadataFilter&gt; elements with a type attribute and type-specific content
  62              *  <li>&lt;Exclude&gt; elements representing a BlacklistMetadataFilter
  63              *  <li>&lt;BlacklistMetadataFilter&gt; element containing &lt;Exclude&gt; elements
  64              *  <li>&lt;Include&gt; elements representing a WhitelistMetadataFilter
  65              *  <li>&lt;SignatureMetadataFilter&gt; element containing a &lt;KeyResolver&gt; element
  66              *  <li>&lt;WhitelistMetadataFilter&gt; element containing &lt;Include&gt; elements
  67              * </ul>
  68              *
  69              * XML namespaces are ignored in the processing of these elements.
  70              *
  71              * @param e DOM to supply configuration for provider
  72              */
  73             MetadataProvider(const DOMElement* e=NULL);
  74
  75         public:
  76             /**
  77              * Destructor will delete any installed filters.
  78              */
  79             virtual ~MetadataProvider();
  80
  81             /**
  82              * Adds a metadata filter to apply to any resolved metadata. Will not be applied
  83              * to metadata that is already loaded.
  84              *
  85              * @param newFilter metadata filter to add
  86              */
  87             virtual void addMetadataFilter(MetadataFilter* newFilter) {
  88                 m_filters.push_back(newFilter);
  89             }
  90
  91             /**
  92              * Removes a metadata filter. The caller must delete the filter if necessary.
  93              *
  94              * @param oldFilter metadata filter to remove
  95              * @return  the old filter
  96              */
  97             virtual MetadataFilter* removeMetadataFilter(MetadataFilter* oldFilter) {
  98                 for (std::vector<MetadataFilter*>::iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
  99                     if (oldFilter==(*i)) {
 100                         m_filters.erase(i);
 101                         return oldFilter;
 102                     }
 103                 }
 104                 return NULL;
 105             }
 106
 107             /**
 108              * Should be called after instantiating provider and adding filters, but before
 109              * performing any lookup operations. Allows the provider to defer initialization
 110              * processes that are likely to result in exceptions until after the provider is
 111              * safely created. Providers SHOULD perform as much processing as possible in
 112              * this method so as to report/log any errors that would affect later processing.
 113              */
 114             virtual void init()=0;
 115
 116             /**
 117              * Returns a KeyResolver associated with this metadata provider, if any.
 118              *
 119              * @return an associated KeyResolver, or NULL
 120              */
 121             virtual const xmltooling::KeyResolver* getKeyResolver() const=0;
 122
 123             /**
 124              * Gets the entire metadata tree, after the registered filter has been applied.
 125              * The caller MUST unlock the provider when finished with the data.
 126              *
 127              * @return the entire metadata tree
 128              */
 129             virtual const xmltooling::XMLObject* getMetadata() const=0;
 130
 131             /**
 132              * Gets the metadata for a given entity. If a valid entity is returned,
 133              * the provider will be left in a locked state. The caller MUST unlock the
 134              * provider when finished with the entity.
 135              *
 136              * @param id                    the ID of the entity
 137              * @param requireValidMetadata  indicates whether the metadata for the entity must be valid/current
 138              *
 139              * @return the entity's metadata or NULL if there is no metadata or no valid metadata
 140              */
 141             virtual const EntityDescriptor* getEntityDescriptor(const XMLCh* id, bool requireValidMetadata=true) const;
 142
 143             /**
 144              * Gets the metadata for a given entity. If a valid entity is returned,
 145              * the provider will be left in a locked state. The caller MUST unlock the
 146              * provider when finished with the entity.
 147              *
 148              * @param id                    the ID of the entity
 149              * @param requireValidMetadata  indicates whether the metadata for the entity must be valid/current
 150              *
 151              * @return the entity's metadata or NULL if there is no metadata or no valid metadata
 152              */
 153             virtual const EntityDescriptor* getEntityDescriptor(const char* id, bool requireValidMetadata=true) const=0;
 154
 155             /**
 156              * Gets the metadata for an entity that issued a SAML artifact. If a valid entity is returned,
 157              * the provider will be left in a locked state. The caller MUST unlock the
 158              * provider when finished with the entity.
 159              *
 160              * @param artifact              a SAML artifact to find the issuer of
 161              *
 162              * @return the entity's metadata or NULL if there is no valid metadata
 163              */
 164             virtual const EntityDescriptor* getEntityDescriptor(const SAMLArtifact* artifact) const=0;
 165
 166             /**
 167              * Gets the metadata for a given group of entities. If a valid group is returned,
 168              * the resolver will be left in a locked state. The caller MUST unlock the
 169              * resolver when finished with the group.
 170              *
 171              * @param name                  the name of the group
 172              * @param requireValidMetadata  indicates whether the metadata for the group must be valid/current
 173              *
 174              * @return the group's metadata or NULL if there is no metadata or no valid metadata
 175              */
 176             virtual const EntitiesDescriptor* getEntitiesDescriptor(const XMLCh* name, bool requireValidMetadata=true) const;
 177
 178             /**
 179              * Gets the metadata for a given group of entities. If a valid group is returned,
 180              * the resolver will be left in a locked state. The caller MUST unlock the
 181              * resolver when finished with the group.
 182              *
 183              * @param name                  the name of the group
 184              * @param requireValidMetadata  indicates whether the metadata for the group must be valid/current
 185              *
 186              * @return the group's metadata or NULL if there is no metadata or no valid metadata
 187              */
 188             virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const=0;
 189
 190         protected:
 191             /**
 192              * Applies any installed filters to a metadata instance.
 193              *
 194              * @param xmlObject the metadata to be filtered
 195              */
 196             void doFilters(xmltooling::XMLObject& xmlObject) const;
 197
 198         private:
 199             std::vector<MetadataFilter*> m_filters;
 200         };
 201
 202         /**
 203          * Registers MetadataProvider classes into the runtime.
 204          */
 205         void SAML_API registerMetadataProviders();
 206
 207         /** MetadataProvider based on local or remote XML file */
 208         #define XML_METADATA_PROVIDER  "XML"
 209
 210         /** MetadataProvider that wraps a sequence of metadata providers. */
 211         #define CHAINING_METADATA_PROVIDER  "Chaining"
 212     };
 213 };
 214
 215 #endif /* __saml2_metadataprov_h__ */