saml/saml2/metadata/impl/WhitelistMetadataFilter.cpp

   1 /**
   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.
   6  *
   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
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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.
  19  */
  20
  21 /**
  22  * WhitelistMetadataFilter.cpp
  23  *
  24  * Removes non-whitelisted entities from a metadata instance
  25  */
  26
  27 #include "internal.h"
  28 #include "saml2/metadata/Metadata.h"
  29 #include "saml2/metadata/MetadataFilter.h"
  30
  31 #include <xmltooling/logging.h>
  32 #include <xmltooling/util/NDC.h>
  33
  34 using namespace opensaml::saml2md;
  35 using namespace xmltooling::logging;
  36 using namespace xmltooling;
  37 using namespace std;
  38
  39 namespace opensaml {
  40     namespace saml2md {
  41
  42         class SAML_DLLLOCAL WhitelistMetadataFilter : public MetadataFilter
  43         {
  44         public:
  45             WhitelistMetadataFilter(const DOMElement* e);
  46             ~WhitelistMetadataFilter() {}
  47
  48             const char* getId() const { return WHITELIST_METADATA_FILTER; }
  49             void doFilter(XMLObject& xmlObject) const;
  50
  51         private:
  52             void doFilter(EntitiesDescriptor& entities) const;
  53
  54             bool found(const XMLCh* id) const {
  55                 if (!id)
  56                     return false;
  57                 return m_set.count(id)==1;
  58             }
  59
  60             set<xstring> m_set;
  61         };
  62
  63         MetadataFilter* SAML_DLLLOCAL WhitelistMetadataFilterFactory(const DOMElement* const & e)
  64         {
  65             return new WhitelistMetadataFilter(e);
  66         }
  67
  68     };
  69 };
  70
  71 static const XMLCh Include[] =  UNICODE_LITERAL_7(I,n,c,l,u,d,e);
  72
  73 WhitelistMetadataFilter::WhitelistMetadataFilter(const DOMElement* e)
  74 {
  75     e = XMLHelper::getFirstChildElement(e);
  76     while (e) {
  77         if (XMLString::equals(e->getLocalName(), Include) && e->hasChildNodes()) {
  78             m_set.insert(e->getFirstChild()->getNodeValue());
  79         }
  80         e = XMLHelper::getNextSiblingElement(e);
  81     }
  82 }
  83
  84 void WhitelistMetadataFilter::doFilter(XMLObject& xmlObject) const
  85 {
  86 #ifdef _DEBUG
  87     NDC ndc("doFilter");
  88 #endif
  89
  90     try {
  91         doFilter(dynamic_cast<EntitiesDescriptor&>(xmlObject));
  92         return;
  93     }
  94     catch (bad_cast) {
  95     }
  96
  97     try {
  98         EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
  99         if (!found(entity.getEntityID()))
 100             throw MetadataFilterException("WhitelistMetadataFilter instructed to filter the root/only entity in the metadata.");
 101         return;
 102     }
 103     catch (bad_cast) {
 104     }
 105
 106     throw MetadataFilterException("WhitelistMetadataFilter was given an improper metadata instance to filter.");
 107 }
 108
 109 void WhitelistMetadataFilter::doFilter(EntitiesDescriptor& entities) const
 110 {
 111     Category& log=Category::getInstance(SAML_LOGCAT".MetadataFilter.Whitelist");
 112
 113     VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
 114     for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
 115         const XMLCh* id=v[i]->getEntityID();
 116         if (!found(id)) {
 117             auto_ptr_char id2(id);
 118             log.info("filtering out non-whitelisted entity (%s)", id2.get());
 119             v.erase(v.begin() + i);
 120         }
 121         else {
 122             i++;
 123         }
 124     }
 125
 126     const vector<EntitiesDescriptor*>& groups=const_cast<const EntitiesDescriptor&>(entities).getEntitiesDescriptors();
 127     for (vector<EntitiesDescriptor*>::const_iterator j=groups.begin(); j!=groups.end(); j++)
 128         doFilter(*(*j));
 129 }