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/MetadataFilter.h
20 * Processes metadata after it's been unmarshalled.
23 #include <saml/base.h>
24 #include <saml/exceptions.h>
25 #include <saml/saml2/metadata/MetadataProvider.h>
27 #include <xmltooling/XMLObject.h>
29 #ifndef __saml2_metadatafilt_h__
30 #define __saml2_metadatafilt_h__
37 * A metadata filter is used to process metadata after resolution and unmarshalling.
39 * Some filters might remove everything but identity provider roles, decreasing the data a service provider
40 * needs to work with, or a filter could be used to perform integrity checking on the retrieved metadata by
41 * verifying a digital signature.
43 class SAML_API MetadataFilter
45 MAKE_NONCOPYABLE(MetadataFilter);
49 virtual ~MetadataFilter() {}
52 * Returns an identifying string for the filter.
54 * @return the ID string
56 virtual const char* getId() const=0;
59 * Filters the given metadata. Exceptions should generally not be thrown to
60 * signal the removal of information, only for systemic processing failure.
62 * @param xmlObject the metadata to be filtered.
64 virtual void doFilter(xmltooling::XMLObject& xmlObject) const=0;
68 * Registers MetadataFilter classes into the runtime.
70 void SAML_API registerMetadataFilters();
72 /** MetadataFilter that deletes blacklisted entities. */
73 #define BLACKLIST_METADATA_FILTER "Blacklist"
75 /** MetadataFilter that deletes all but whitelisted entities. */
76 #define WHITELIST_METADATA_FILTER "Whitelist"
78 /** MetadataFilter that verifies signatures and filters out any that don't pass. */
79 #define SIGNATURE_METADATA_FILTER "Signature"
81 DECL_XMLTOOLING_EXCEPTION(MetadataFilterException,SAML_EXCEPTIONAPI(SAML_API),opensaml::saml2md,MetadataException,Exceptions related to metadata filtering);
85 #endif /* __saml2_metadatafilt_h__ */