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