saml/saml2/metadata/MetadataProvider.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file saml/saml2/metadata/MetadataProvider.h
  23  *
  24  * Supplies an individual source of metadata.
  25  */
  26
  27 #ifndef __saml2_metadataprov_h__
  28 #define __saml2_metadataprov_h__
  29
  30 #include <saml/base.h>
  31
  32 #include <vector>
  33 #include <iostream>
  34 #include <boost/ptr_container/ptr_vector.hpp>
  35 #include <xmltooling/exceptions.h>
  36 #include <xmltooling/security/CredentialResolver.h>
  37
  38 namespace xmltooling {
  39     class XMLTOOL_API QName;
  40     class XMLTOOL_API XMLObject;
  41 };
  42
  43 namespace opensaml {
  44
  45     class SAML_API SAMLArtifact;
  46
  47     namespace saml2md {
  48
  49         class SAML_API EntityDescriptor;
  50         class SAML_API EntitiesDescriptor;
  51         class SAML_API RoleDescriptor;
  52         class SAML_API MetadataCredentialResolver;
  53         class SAML_API MetadataFilter;
  54
  55 #if defined (_MSC_VER)
  56         #pragma warning( push )
  57         #pragma warning( disable : 4251 )
  58 #endif
  59
  60         /**
  61          * Supplies an individual source of metadata.
  62          *
  63          * The source can be a local file, remote service, or the result of a
  64          * dynamic lookup, can include local caching, etc. Providers
  65          * <strong>MUST</strong> be locked before any lookup operations.
  66          */
  67         class SAML_API MetadataProvider : public virtual xmltooling::CredentialResolver
  68         {
  69             MAKE_NONCOPYABLE(MetadataProvider);
  70         protected:
  71             /**
  72              * Constructor.
  73              *
  74              * If a DOM is supplied, a set of default logic will be used to identify
  75              * and build MetadataFilter plugins and install them into the provider.
  76              *
  77              * The following XML content is supported:
  78              *
  79              * <ul>
  80              *  <li>&lt;MetadataFilter&gt; elements with a type attribute and type-specific content
  81              *  <li>&lt;Exclude&gt; elements representing a BlacklistMetadataFilter
  82              *  <li>&lt;BlacklistMetadataFilter&gt; element containing &lt;Exclude&gt; elements
  83              *  <li>&lt;Include&gt; elements representing a WhitelistMetadataFilter
  84              *  <li>&lt;SignatureMetadataFilter&gt; element containing a &lt;KeyResolver&gt; element
  85              *  <li>&lt;WhitelistMetadataFilter&gt; element containing &lt;Include&gt; elements
  86              * </ul>
  87              *
  88              * XML namespaces are ignored in the processing of these elements.
  89              *
  90              * @param e DOM to supply configuration for provider
  91              */
  92             MetadataProvider(const xercesc::DOMElement* e=nullptr);
  93
  94         public:
  95             /**
  96              * Destructor will delete any installed filters.
  97              */
  98             virtual ~MetadataProvider();
  99
 100             /**
 101              * Returns an identifier for the provider for logging/status purposes.
 102              *
 103              * @return an identifier, or null
 104              */
 105             virtual const char* getId() const;
 106
 107             /**
 108              * Adds a metadata filter to apply to any resolved metadata. Will not be applied
 109              * to metadata that is already loaded.
 110              *
 111              * @param newFilter metadata filter to add
 112              */
 113             virtual void addMetadataFilter(MetadataFilter* newFilter);
 114
 115             /**
 116              * Removes a metadata filter. The caller must delete the filter if necessary.
 117              *
 118              * @param oldFilter metadata filter to remove
 119              * @return  the old filter
 120              */
 121             virtual MetadataFilter* removeMetadataFilter(MetadataFilter* oldFilter);
 122
 123             /**
 124              * Should be called after instantiating provider and adding filters, but before
 125              * performing any lookup operations. Allows the provider to defer initialization
 126              * processes that are likely to result in exceptions until after the provider is
 127              * safely created. Providers SHOULD perform as much processing as possible in
 128              * this method so as to report/log any errors that would affect later processing.
 129              */
 130             virtual void init()=0;
 131
 132             /**
 133              * Generate an XML representation of the provider's status. The XML must be
 134              * well-formed, but is otherwise arbitrary.
 135              *
 136              * @param os    stream to write status information to
 137              */
 138             virtual void outputStatus(std::ostream& os) const;
 139
 140             /**
 141              * Gets the entire metadata tree, after the registered filter has been applied.
 142              * The caller MUST unlock the provider when finished with the data.
 143              *
 144              * @return the entire metadata tree
 145              */
 146             virtual const xmltooling::XMLObject* getMetadata() const=0;
 147
 148             /**
 149              * Gets the metadata for a given group of entities. If a valid group is returned,
 150              * the resolver will be left in a locked state. The caller MUST unlock the
 151              * resolver when finished with the group.
 152              *
 153              * @param name                  the name of the group
 154              * @param requireValidMetadata  indicates whether the metadata for the group must be valid/current
 155              *
 156              * @return the group's metadata or nullptr if there is no metadata or no valid metadata
 157              */
 158             virtual const EntitiesDescriptor* getEntitiesDescriptor(const XMLCh* name, bool requireValidMetadata=true) const;
 159
 160             /**
 161              * Gets the metadata for a given group of entities. If a valid group is returned,
 162              * the resolver will be left in a locked state. The caller MUST unlock the
 163              * resolver when finished with the group.
 164              *
 165              * @param name                  the name of the group
 166              * @param requireValidMetadata  indicates whether the metadata for the group must be valid/current
 167              *
 168              * @return the group's metadata or nullptr if there is no metadata or no valid metadata
 169              */
 170             virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const=0;
 171
 172             /**
 173              * Batches up criteria for entity lookup.
 174              */
 175             struct SAML_API Criteria {
 176                 /**
 177                  * Default constructor.
 178                  */
 179                 Criteria();
 180
 181                 /**
 182                  * Constructor.
 183                  *
 184                  * @param id    entityID to lookup
 185                  * @param q     element/type of role, if any
 186                  * @param prot  protocol support constant, if any
 187                  * @param valid true iff stale metadata should be ignored
 188                  */
 189                 Criteria(const XMLCh* id, const xmltooling::QName* q=nullptr, const XMLCh* prot=nullptr, bool valid=true);
 190
 191                 /**
 192                  * Constructor.
 193                  *
 194                  * @param id    entityID to lookup
 195                  * @param q     element/type of role, if any
 196                  * @param prot  protocol support constant, if any
 197                  * @param valid true iff stale metadata should be ignored
 198                  */
 199                 Criteria(const char* id, const xmltooling::QName* q=nullptr, const XMLCh* prot=nullptr, bool valid=true);
 200
 201                 /**
 202                  * Constructor.
 203                  *
 204                  * @param a     artifact to lookup
 205                  * @param q     element/type of role, if any
 206                  * @param prot  protocol support constant, if any
 207                  * @param valid true iff stale metadata should be ignored
 208                  */
 209                 Criteria(const SAMLArtifact* a, const xmltooling::QName* q=nullptr, const XMLCh* prot=nullptr, bool valid=true);
 210
 211                 virtual ~Criteria();
 212
 213                 /**
 214                  * Restores the object to its default state.
 215                  */
 216                 virtual void reset();
 217
 218                 /** Unique ID of entity. */
 219                 const XMLCh* entityID_unicode;
 220                 /** Unique ID of entity. */
 221                 const char* entityID_ascii;
 222                 /** SAML artifact */
 223                 const SAMLArtifact* artifact;
 224                 /** Element or schema type QName of metadata role. */
 225                 const xmltooling::QName* role;
 226                 /** Protocol support constant. */
 227                 const XMLCh* protocol;
 228                 /** Backup protocol support constant. */
 229                 const XMLCh* protocol2;
 230                 /** Controls whether stale metadata is ignored. */
 231                 bool validOnly;
 232             };
 233
 234             /**
 235              * Gets entity metadata based on supplied criteria. If a valid entity is returned,
 236              * the provider will be left in a locked state. The caller MUST unlock the
 237              * provider when finished with the entity.
 238              *
 239              * @param criteria  lookup criteria
 240              *
 241              * @return the entity's metadata (and optionally a role) or nullptr if there is no qualifying metadata
 242              */
 243             virtual std::pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const=0;
 244
 245         protected:
 246             /**
 247              * Applies any installed filters to a metadata instance.
 248              *
 249              * @param xmlObject the metadata to be filtered
 250              */
 251             void doFilters(xmltooling::XMLObject& xmlObject) const;
 252
 253         private:
 254             boost::ptr_vector<MetadataFilter> m_filters;
 255         };
 256
 257 #if defined (_MSC_VER)
 258         #pragma warning( pop )
 259 #endif
 260
 261         /**
 262          * Registers MetadataProvider classes into the runtime.
 263          */
 264         void SAML_API registerMetadataProviders();
 265
 266         /** MetadataProvider based on local or remote XML file */
 267         #define XML_METADATA_PROVIDER  "XML"
 268
 269         /** MetadataProvider based on dynamic resolution */
 270         #define DYNAMIC_METADATA_PROVIDER  "Dynamic"
 271
 272         /** MetadataProvider that wraps a sequence of metadata providers. */
 273         #define CHAINING_METADATA_PROVIDER  "Chaining"
 274
 275         /** MetadataProvider that loads a directory of files. */
 276         #define FOLDER_METADATA_PROVIDER  "Folder"
 277
 278         /** MetadataProvider that returns an empty "dummy" entity descriptor. */
 279         #define NULL_METADATA_PROVIDER  "Null"
 280
 281         DECL_XMLTOOLING_EXCEPTION(MetadataException,SAML_EXCEPTIONAPI(SAML_API),opensaml::saml2md,xmltooling::XMLToolingException,Exceptions related to metadata use);
 282     };
 283 };
 284
 285 #endif /* __saml2_metadataprov_h__ */