saml/saml2/metadata/MetadataFilter.h

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * @file saml/saml2/metadata/MetadataFilter.h
  19  *
  20  * Processes metadata after it's been unmarshalled.
  21  */
  22
  23 #include <saml/saml2/metadata/MetadataProvider.h>
  24
  25 #ifndef __saml2_metadatafilt_h__
  26 #define __saml2_metadatafilt_h__
  27
  28 namespace opensaml {
  29     namespace saml2md {
  30
  31         /**
  32          * A metadata filter is used to process metadata after resolution and unmarshalling.
  33          *
  34          * Some filters might remove everything but identity provider roles, decreasing the data a service provider
  35          * needs to work with, or a filter could be used to perform integrity checking on the retrieved metadata by
  36          * verifying a digital signature.
  37          */
  38         class SAML_API MetadataFilter
  39         {
  40             MAKE_NONCOPYABLE(MetadataFilter);
  41         protected:
  42             MetadataFilter();
  43         public:
  44             virtual ~MetadataFilter();
  45
  46             /**
  47              * Returns an identifying string for the filter.
  48              *
  49              * @return the ID string
  50              */
  51             virtual const char* getId() const=0;
  52
  53             /**
  54              * Filters the given metadata. Exceptions should generally not be thrown to
  55              * signal the removal of information, only for systemic processing failure.
  56              *
  57              * @param xmlObject the metadata to be filtered.
  58              */
  59             virtual void doFilter(xmltooling::XMLObject& xmlObject) const=0;
  60         };
  61
  62         /**
  63          * Registers MetadataFilter classes into the runtime.
  64          */
  65         void SAML_API registerMetadataFilters();
  66
  67         /** MetadataFilter that deletes blacklisted entities. */
  68         #define BLACKLIST_METADATA_FILTER  "Blacklist"
  69
  70         /** MetadataFilter that deletes all but whitelisted entities. */
  71         #define WHITELIST_METADATA_FILTER  "Whitelist"
  72
  73         /** MetadataFilter that verifies signatures and filters out any that don't pass. */
  74         #define SIGNATURE_METADATA_FILTER  "Signature"
  75
  76         /** MetadataFilter that enforces expiration requirements. */
  77         #define REQUIREVALIDUNTIL_METADATA_FILTER  "RequireValidUntil"
  78
  79         /** MetadataFilter that removes non-retained roles. */
  80         #define ENTITYROLE_METADATA_FILTER  "EntityRoleWhiteList"
  81
  82         DECL_XMLTOOLING_EXCEPTION(MetadataFilterException,SAML_EXCEPTIONAPI(SAML_API),opensaml::saml2md,MetadataException,Exceptions related to metadata filtering);
  83     };
  84 };
  85
  86 #endif /* __saml2_metadatafilt_h__ */