2 * Copyright 2001-2006 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/saml2/metadata/MetadataFilter.h>
28 #include <xmltooling/Lockable.h>
29 #include <xmltooling/signature/KeyResolver.h>
33 class SAML_API SAMLArtifact;
37 class SAML_API EntityDescriptor;
38 class SAML_API EntitiesDescriptor;
41 * Supplies an individual source of metadata.
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.
47 class SAML_API MetadataProvider : public virtual xmltooling::Lockable
49 MAKE_NONCOPYABLE(MetadataProvider);
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 * A KeyResolver can also be supplied, or a default resolver will be used.
59 * The following XML content is supported:
62 * <li><KeyResolver> elements with a type attribute
63 * <li><MetadataFilter> elements with a type attribute and type-specific content
64 * <li><Exclude> elements representing a BlacklistMetadataFilter
65 * <li><BlacklistMetadataFilter> element containing <Exclude> elements
66 * <li><Include> elements representing a WhitelistMetadataFilter
67 * <li><SignatureMetadataFilter> element containing a <KeyResolver> element
68 * <li><WhitelistMetadataFilter> element containing <Include> elements
71 * XML namespaces are ignored in the processing of these elements.
73 * @param e DOM to supply configuration for provider
75 MetadataProvider(const DOMElement* e=NULL);
79 * Destructor will delete any installed filters.
81 virtual ~MetadataProvider();
84 * Adds a metadata filter to apply to any resolved metadata. Will not be applied
85 * to metadata that is already loaded.
87 * @param newFilter metadata filter to add
89 virtual void addMetadataFilter(MetadataFilter* newFilter) {
90 m_filters.push_back(newFilter);
94 * Removes a metadata filter. The caller must delete the filter if necessary.
96 * @param oldFilter metadata filter to remove
97 * @return the old filter
99 virtual MetadataFilter* removeMetadataFilter(MetadataFilter* oldFilter) {
100 for (std::vector<MetadataFilter*>::iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
101 if (oldFilter==(*i)) {
110 * Should be called after instantiating provider and adding filters, but before
111 * performing any lookup operations. Allows the provider to defer initialization
112 * processes that are likely to result in exceptions until after the provider is
113 * safely created. Providers SHOULD perform as much processing as possible in
114 * this method so as to report/log any errors that would affect later processing.
116 virtual void init()=0;
119 * Returns a KeyResolver associated with this metadata provider, if any.
121 * @return an associated KeyResolver, or NULL
123 virtual const xmlsignature::KeyResolver* getKeyResolver() const {
128 * Gets the entire metadata tree, after the registered filter has been applied.
129 * The caller MUST unlock the provider when finished with the data.
131 * @return the entire metadata tree
133 virtual const xmltooling::XMLObject* getMetadata() const=0;
136 * Gets the metadata for a given entity. If a valid entity is returned,
137 * the provider will be left in a locked state. The caller MUST unlock the
138 * provider when finished with the entity.
140 * @param id the ID of the entity
141 * @param requireValidMetadata indicates whether the metadata for the entity must be valid/current
143 * @return the entity's metadata or NULL if there is no metadata or no valid metadata
145 virtual const EntityDescriptor* getEntityDescriptor(const XMLCh* id, bool requireValidMetadata=true) const;
148 * Gets the metadata for a given entity. If a valid entity is returned,
149 * the provider will be left in a locked state. The caller MUST unlock the
150 * provider when finished with the entity.
152 * @param id the ID of the entity
153 * @param requireValidMetadata indicates whether the metadata for the entity must be valid/current
155 * @return the entity's metadata or NULL if there is no metadata or no valid metadata
157 virtual const EntityDescriptor* getEntityDescriptor(const char* id, bool requireValidMetadata=true) const;
160 * Gets the metadata for an entity that issued a SAML artifact. If a valid entity is returned,
161 * the provider will be left in a locked state. The caller MUST unlock the
162 * provider when finished with the entity.
164 * @param artifact a SAML artifact to find the issuer of
166 * @return the entity's metadata or NULL if there is no valid metadata
168 virtual const EntityDescriptor* getEntityDescriptor(const SAMLArtifact* artifact) const;
171 * Gets the metadata for a given group of entities. If a valid group is returned,
172 * the resolver will be left in a locked state. The caller MUST unlock the
173 * resolver when finished with the group.
175 * @param name the name of the group
176 * @param requireValidMetadata indicates whether the metadata for the group must be valid/current
178 * @return the group's metadata or NULL if there is no metadata or no valid metadata
180 virtual const EntitiesDescriptor* getEntitiesDescriptor(const XMLCh* name, bool requireValidMetadata=true) const;
183 * Gets the metadata for a given group of entities. If a valid group is returned,
184 * the resolver will be left in a locked state. The caller MUST unlock the
185 * resolver when finished with the group.
187 * @param name the name of the group
188 * @param requireValidMetadata indicates whether the metadata for the group must be valid/current
190 * @return the group's metadata or NULL if there is no metadata or no valid metadata
192 virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const;
195 /** Embedded KeyResolver instance. */
196 xmlsignature::KeyResolver* m_resolver;
199 * Applies any installed filters to a metadata instance.
201 * @param xmlObject the metadata to be filtered
203 void doFilters(xmltooling::XMLObject& xmlObject) const;
206 * Loads an entity into the cache for faster lookup. This includes
207 * processing known reverse lookup strategies for artifacts.
209 * @param site entity definition
210 * @param validUntil expiration time of the entity definition
212 virtual void index(EntityDescriptor* site, time_t validUntil);
215 * Loads a group of entities into the cache for faster lookup.
217 * @param group group definition
218 * @param validUntil expiration time of the group definition
220 virtual void index(EntitiesDescriptor* group, time_t validUntil);
223 * Clear the cache of known entities and groups.
225 virtual void clearDescriptorIndex();
228 std::vector<MetadataFilter*> m_filters;
230 typedef std::multimap<std::string,const EntityDescriptor*> sitemap_t;
231 typedef std::multimap<std::string,const EntitiesDescriptor*> groupmap_t;
238 * Registers MetadataProvider classes into the runtime.
240 void SAML_API registerMetadataProviders();
242 /** MetadataProvider based on local XML files */
243 #define FILESYSTEM_METADATA_PROVIDER "org.opensaml.saml2.metadata.provider.FilesystemMetadataProvider"
247 #endif /* __saml2_metadataprov_h__ */