2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file saml/saml2/metadata/MetadataProvider.h
20 * Supplies an individual source of metadata.
23 #ifndef __saml2_metadataprov_h__
24 #define __saml2_metadataprov_h__
26 #include <saml/base.h>
27 #include <xmltooling/exceptions.h>
28 #include <xmltooling/XMLObject.h>
29 #include <xmltooling/security/CredentialResolver.h>
33 class SAML_API SAMLArtifact;
37 class SAML_API EntityDescriptor;
38 class SAML_API EntitiesDescriptor;
39 class SAML_API RoleDescriptor;
40 class SAML_API MetadataCredentialResolver;
41 class SAML_API MetadataFilter;
43 #if defined (_MSC_VER)
44 #pragma warning( push )
45 #pragma warning( disable : 4251 )
49 * Supplies an individual source of metadata.
51 * The source can be a local file, remote service, or the result of a
52 * dynamic lookup, can include local caching, etc. Providers
53 * <strong>MUST</strong> be locked before any lookup operations.
55 class SAML_API MetadataProvider : public virtual xmltooling::CredentialResolver
57 MAKE_NONCOPYABLE(MetadataProvider);
62 * If a DOM is supplied, a set of default logic will be used to identify
63 * and build MetadataFilter plugins and install them into the provider.
65 * The following XML content is supported:
68 * <li><MetadataFilter> elements with a type attribute and type-specific content
69 * <li><Exclude> elements representing a BlacklistMetadataFilter
70 * <li><BlacklistMetadataFilter> element containing <Exclude> elements
71 * <li><Include> elements representing a WhitelistMetadataFilter
72 * <li><SignatureMetadataFilter> element containing a <KeyResolver> element
73 * <li><WhitelistMetadataFilter> element containing <Include> elements
76 * XML namespaces are ignored in the processing of these elements.
78 * @param e DOM to supply configuration for provider
80 MetadataProvider(const xercesc::DOMElement* e=NULL);
84 * Destructor will delete any installed filters.
86 virtual ~MetadataProvider();
89 * Adds a metadata filter to apply to any resolved metadata. Will not be applied
90 * to metadata that is already loaded.
92 * @param newFilter metadata filter to add
94 virtual void addMetadataFilter(MetadataFilter* newFilter) {
95 m_filters.push_back(newFilter);
99 * Removes a metadata filter. The caller must delete the filter if necessary.
101 * @param oldFilter metadata filter to remove
102 * @return the old filter
104 virtual MetadataFilter* removeMetadataFilter(MetadataFilter* oldFilter) {
105 for (std::vector<MetadataFilter*>::iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
106 if (oldFilter==(*i)) {
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 NULL 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 NULL 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.
162 Criteria() : entityID_unicode(NULL), entityID_ascii(NULL), artifact(NULL), role(NULL), protocol(NULL), protocol2(NULL), validOnly(true) {
168 * @param id entityID to lookup
169 * @param q element/type of role, if any
170 * @param prot protocol support constant, if any
171 * @param valid true iff stale metadata should be ignored
173 Criteria(const XMLCh* id, const xmltooling::QName* q=NULL, const XMLCh* prot=NULL, bool valid=true)
174 : entityID_unicode(id), entityID_ascii(NULL), artifact(NULL), role(q), protocol(prot), protocol2(NULL), validOnly(valid) {
180 * @param id entityID to lookup
181 * @param q element/type of role, if any
182 * @param prot protocol support constant, if any
183 * @param valid true iff stale metadata should be ignored
185 Criteria(const char* id, const xmltooling::QName* q=NULL, const XMLCh* prot=NULL, bool valid=true)
186 : entityID_unicode(NULL), entityID_ascii(id), artifact(NULL), role(q), protocol(prot), protocol2(NULL), validOnly(valid) {
192 * @param a artifact to lookup
193 * @param q element/type of role, if any
194 * @param prot protocol support constant, if any
195 * @param valid true iff stale metadata should be ignored
197 Criteria(const SAMLArtifact* a, const xmltooling::QName* q=NULL, const XMLCh* prot=NULL, bool valid=true)
198 : entityID_unicode(NULL), entityID_ascii(NULL), artifact(a), role(q), protocol(prot), protocol2(NULL), validOnly(valid) {
201 virtual ~Criteria() {}
203 /** Unique ID of entity. */
204 const XMLCh* entityID_unicode;
205 /** Unique ID of entity. */
206 const char* entityID_ascii;
208 const SAMLArtifact* artifact;
209 /** Element or schema type QName of metadata role. */
210 const xmltooling::QName* role;
211 /** Protocol support constant. */
212 const XMLCh* protocol;
213 /** Backup protocol support constant. */
214 const XMLCh* protocol2;
215 /** Controls whether stale metadata is ignored. */
220 * Gets entity metadata based on supplied criteria. If a valid entity is returned,
221 * the provider will be left in a locked state. The caller MUST unlock the
222 * provider when finished with the entity.
224 * @param criteria lookup criteria
226 * @return the entity's metadata (and optionally a role) or NULL if there is no qualifying metadata
228 virtual std::pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const=0;
232 * Applies any installed filters to a metadata instance.
234 * @param xmlObject the metadata to be filtered
236 void doFilters(xmltooling::XMLObject& xmlObject) const;
239 std::vector<MetadataFilter*> m_filters;
242 #if defined (_MSC_VER)
243 #pragma warning( pop )
247 * Registers MetadataProvider classes into the runtime.
249 void SAML_API registerMetadataProviders();
251 /** MetadataProvider based on local or remote XML file */
252 #define XML_METADATA_PROVIDER "XML"
254 /** MetadataProvider based on dynamic resolution */
255 #define DYNAMIC_METADATA_PROVIDER "Dynamic"
257 /** MetadataProvider that wraps a sequence of metadata providers. */
258 #define CHAINING_METADATA_PROVIDER "Chaining"
260 /** MetadataProvider that returns an empty "dummy" entity descriptor. */
261 #define NULL_METADATA_PROVIDER "Null"
263 DECL_XMLTOOLING_EXCEPTION(MetadataException,SAML_EXCEPTIONAPI(SAML_API),opensaml::saml2md,xmltooling::XMLToolingException,Exceptions related to metadata use);
267 #endif /* __saml2_metadataprov_h__ */