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.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * @file saml/saml2/metadata/MetadataProvider.h
24 * Supplies an individual source of metadata.
27 #ifndef __saml2_metadataprov_h__
28 #define __saml2_metadataprov_h__
30 #include <saml/base.h>
33 #include <xmltooling/exceptions.h>
34 #include <xmltooling/security/CredentialResolver.h>
36 namespace xmltooling {
37 class XMLTOOL_API QName;
38 class XMLTOOL_API XMLObject;
43 class SAML_API SAMLArtifact;
47 class SAML_API EntityDescriptor;
48 class SAML_API EntitiesDescriptor;
49 class SAML_API RoleDescriptor;
50 class SAML_API MetadataCredentialResolver;
51 class SAML_API MetadataFilter;
53 #if defined (_MSC_VER)
54 #pragma warning( push )
55 #pragma warning( disable : 4251 )
59 * Supplies an individual source of metadata.
61 * The source can be a local file, remote service, or the result of a
62 * dynamic lookup, can include local caching, etc. Providers
63 * <strong>MUST</strong> be locked before any lookup operations.
65 class SAML_API MetadataProvider : public virtual xmltooling::CredentialResolver
67 MAKE_NONCOPYABLE(MetadataProvider);
72 * If a DOM is supplied, a set of default logic will be used to identify
73 * and build MetadataFilter plugins and install them into the provider.
75 * The following XML content is supported:
78 * <li><MetadataFilter> elements with a type attribute and type-specific content
79 * <li><Exclude> elements representing a BlacklistMetadataFilter
80 * <li><BlacklistMetadataFilter> element containing <Exclude> elements
81 * <li><Include> elements representing a WhitelistMetadataFilter
82 * <li><SignatureMetadataFilter> element containing a <KeyResolver> element
83 * <li><WhitelistMetadataFilter> element containing <Include> elements
86 * XML namespaces are ignored in the processing of these elements.
88 * @param e DOM to supply configuration for provider
90 MetadataProvider(const xercesc::DOMElement* e=nullptr);
94 * Destructor will delete any installed filters.
96 virtual ~MetadataProvider();
99 * Adds a metadata filter to apply to any resolved metadata. Will not be applied
100 * to metadata that is already loaded.
102 * @param newFilter metadata filter to add
104 virtual void addMetadataFilter(MetadataFilter* newFilter);
107 * Removes a metadata filter. The caller must delete the filter if necessary.
109 * @param oldFilter metadata filter to remove
110 * @return the old filter
112 virtual MetadataFilter* removeMetadataFilter(MetadataFilter* oldFilter);
115 * Should be called after instantiating provider and adding filters, but before
116 * performing any lookup operations. Allows the provider to defer initialization
117 * processes that are likely to result in exceptions until after the provider is
118 * safely created. Providers SHOULD perform as much processing as possible in
119 * this method so as to report/log any errors that would affect later processing.
121 virtual void init()=0;
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.
127 * @return the entire metadata tree
129 virtual const xmltooling::XMLObject* getMetadata() const=0;
132 * Gets the metadata for a given group of entities. If a valid group is returned,
133 * the resolver will be left in a locked state. The caller MUST unlock the
134 * resolver when finished with the group.
136 * @param name the name of the group
137 * @param requireValidMetadata indicates whether the metadata for the group must be valid/current
139 * @return the group's metadata or nullptr if there is no metadata or no valid metadata
141 virtual const EntitiesDescriptor* getEntitiesDescriptor(const XMLCh* name, bool requireValidMetadata=true) const;
144 * Gets the metadata for a given group of entities. If a valid group is returned,
145 * the resolver will be left in a locked state. The caller MUST unlock the
146 * resolver when finished with the group.
148 * @param name the name of the group
149 * @param requireValidMetadata indicates whether the metadata for the group must be valid/current
151 * @return the group's metadata or nullptr if there is no metadata or no valid metadata
153 virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const=0;
156 * Batches up criteria for entity lookup.
158 struct SAML_API Criteria {
160 * Default constructor.
167 * @param id entityID to lookup
168 * @param q element/type of role, if any
169 * @param prot protocol support constant, if any
170 * @param valid true iff stale metadata should be ignored
172 Criteria(const XMLCh* id, const xmltooling::QName* q=nullptr, const XMLCh* prot=nullptr, bool valid=true);
177 * @param id entityID to lookup
178 * @param q element/type of role, if any
179 * @param prot protocol support constant, if any
180 * @param valid true iff stale metadata should be ignored
182 Criteria(const char* id, const xmltooling::QName* q=nullptr, const XMLCh* prot=nullptr, bool valid=true);
187 * @param a artifact to lookup
188 * @param q element/type of role, if any
189 * @param prot protocol support constant, if any
190 * @param valid true iff stale metadata should be ignored
192 Criteria(const SAMLArtifact* a, const xmltooling::QName* q=nullptr, const XMLCh* prot=nullptr, bool valid=true);
197 * Restores the object to its default state.
199 virtual void reset();
201 /** Unique ID of entity. */
202 const XMLCh* entityID_unicode;
203 /** Unique ID of entity. */
204 const char* entityID_ascii;
206 const SAMLArtifact* artifact;
207 /** Element or schema type QName of metadata role. */
208 const xmltooling::QName* role;
209 /** Protocol support constant. */
210 const XMLCh* protocol;
211 /** Backup protocol support constant. */
212 const XMLCh* protocol2;
213 /** Controls whether stale metadata is ignored. */
218 * Gets entity metadata based on supplied criteria. If a valid entity is returned,
219 * the provider will be left in a locked state. The caller MUST unlock the
220 * provider when finished with the entity.
222 * @param criteria lookup criteria
224 * @return the entity's metadata (and optionally a role) or nullptr if there is no qualifying metadata
226 virtual std::pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const=0;
230 * Applies any installed filters to a metadata instance.
232 * @param xmlObject the metadata to be filtered
234 void doFilters(xmltooling::XMLObject& xmlObject) const;
237 std::vector<MetadataFilter*> m_filters;
240 #if defined (_MSC_VER)
241 #pragma warning( pop )
245 * Registers MetadataProvider classes into the runtime.
247 void SAML_API registerMetadataProviders();
249 /** MetadataProvider based on local or remote XML file */
250 #define XML_METADATA_PROVIDER "XML"
252 /** MetadataProvider based on dynamic resolution */
253 #define DYNAMIC_METADATA_PROVIDER "Dynamic"
255 /** MetadataProvider that wraps a sequence of metadata providers. */
256 #define CHAINING_METADATA_PROVIDER "Chaining"
258 /** MetadataProvider that returns an empty "dummy" entity descriptor. */
259 #define NULL_METADATA_PROVIDER "Null"
261 DECL_XMLTOOLING_EXCEPTION(MetadataException,SAML_EXCEPTIONAPI(SAML_API),opensaml::saml2md,xmltooling::XMLToolingException,Exceptions related to metadata use);
265 #endif /* __saml2_metadataprov_h__ */