saml/saml2/metadata/impl/EntityRoleMetadataFilter.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  * EntityRoleMetadataFilter.cpp
  23  *
  24  * Removes non-whitelisted roles 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
  33 using namespace opensaml::saml2md;
  34 using namespace xmltooling::logging;
  35 using namespace xmltooling;
  36 using namespace std;
  37
  38 namespace opensaml {
  39     namespace saml2md {
  40
  41         class SAML_DLLLOCAL EntityRoleMetadataFilter : public MetadataFilter
  42         {
  43         public:
  44             EntityRoleMetadataFilter(const DOMElement* e);
  45             ~EntityRoleMetadataFilter() {}
  46
  47             const char* getId() const { return ENTITYROLE_METADATA_FILTER; }
  48             void doFilter(XMLObject& xmlObject) const;
  49
  50         private:
  51             void doFilter(EntityDescriptor& entity) const;
  52             void doFilter(EntitiesDescriptor& entities) const;
  53
  54             bool m_removeRolelessEntityDescriptors, m_removeEmptyEntitiesDescriptors;
  55             set<xmltooling::QName> m_roles;
  56             bool m_idp, m_sp, m_authn, m_attr, m_pdp, m_authnq, m_attrq, m_authzq;
  57         };
  58
  59         MetadataFilter* SAML_DLLLOCAL EntityRoleMetadataFilterFactory(const DOMElement* const & e)
  60         {
  61             return new EntityRoleMetadataFilter(e);
  62         }
  63
  64     };
  65 };
  66
  67 static const XMLCh RetainedRole[] =                     UNICODE_LITERAL_12(R,e,t,a,i,n,e,d,R,o,l,e);
  68 static const XMLCh removeRolelessEntityDescriptors[] =  UNICODE_LITERAL_31(r,e,m,o,v,e,R,o,l,e,l,e,s,s,E,n,t,i,t,y,D,e,s,c,r,i,p,t,o,r,s);
  69 static const XMLCh removeEmptyEntitiesDescriptors[] =   UNICODE_LITERAL_30(r,e,m,o,v,e,E,m,p,t,y,E,n,t,i,t,i,e,s,D,e,s,c,r,i,p,t,o,r,s);
  70
  71 EntityRoleMetadataFilter::EntityRoleMetadataFilter(const DOMElement* e)
  72     : m_removeRolelessEntityDescriptors(XMLHelper::getAttrBool(e, true, removeRolelessEntityDescriptors)),
  73         m_removeEmptyEntitiesDescriptors(XMLHelper::getAttrBool(e, true, removeEmptyEntitiesDescriptors)),
  74         m_idp(false), m_sp(false), m_authn(false), m_attr(false), m_pdp(false), m_authnq(false), m_attrq(false), m_authzq(false)
  75 {
  76     e = XMLHelper::getFirstChildElement(e, RetainedRole);
  77     while (e) {
  78         auto_ptr<xmltooling::QName> q(XMLHelper::getNodeValueAsQName(e));
  79         if (q.get()) {
  80             if (*q == IDPSSODescriptor::ELEMENT_QNAME)
  81                 m_idp = true;
  82             else if (*q == SPSSODescriptor::ELEMENT_QNAME)
  83                 m_sp = true;
  84             else if (*q == AuthnAuthorityDescriptor::ELEMENT_QNAME)
  85                 m_authn = true;
  86             else if (*q == AttributeAuthorityDescriptor::ELEMENT_QNAME)
  87                 m_attr = true;
  88             else if (*q == PDPDescriptor::ELEMENT_QNAME)
  89                 m_pdp = true;
  90             else if (*q == AuthnQueryDescriptorType::TYPE_QNAME)
  91                 m_authnq = true;
  92             else if (*q == AttributeQueryDescriptorType::TYPE_QNAME)
  93                 m_attrq = true;
  94             else if (*q == AuthzDecisionQueryDescriptorType::TYPE_QNAME)
  95                 m_authzq = true;
  96             else
  97                 m_roles.insert(*q);
  98         }
  99         e = XMLHelper::getNextSiblingElement(e, RetainedRole);
 100     }
 101 }
 102
 103 void EntityRoleMetadataFilter::doFilter(XMLObject& xmlObject) const
 104 {
 105     EntitiesDescriptor* group = dynamic_cast<EntitiesDescriptor*>(&xmlObject);
 106     if (group) {
 107         doFilter(*group);
 108     }
 109     else {
 110         EntityDescriptor* entity = dynamic_cast<EntityDescriptor*>(&xmlObject);
 111         if (entity) {
 112             doFilter(*entity);
 113         }
 114         else {
 115             throw MetadataFilterException(ENTITYROLE_METADATA_FILTER " MetadataFilter was given an improper metadata instance to filter.");
 116         }
 117     }
 118 }
 119
 120 void EntityRoleMetadataFilter::doFilter(EntitiesDescriptor& entities) const
 121 {
 122     Category& log=Category::getInstance(SAML_LOGCAT ".MetadataFilter." ENTITYROLE_METADATA_FILTER);
 123
 124     VectorOf(EntityDescriptor) v = entities.getEntityDescriptors();
 125     for (VectorOf(EntityDescriptor)::size_type i = 0; i < v.size(); ) {
 126         doFilter(*v[i]);
 127         if (m_removeRolelessEntityDescriptors) {
 128             const EntityDescriptor& e = const_cast<const EntityDescriptor&>(*v[i]);
 129             if (e.getIDPSSODescriptors().empty() &&
 130                     e.getSPSSODescriptors().empty() &&
 131                     e.getAuthnAuthorityDescriptors().empty() &&
 132                     e.getAttributeAuthorityDescriptors().empty() &&
 133                     e.getPDPDescriptors().empty() &&
 134                     e.getAuthnQueryDescriptorTypes().empty() &&
 135                     e.getAttributeQueryDescriptorTypes().empty() &&
 136                     e.getAuthzDecisionQueryDescriptorTypes().empty() &&
 137                     e.getRoleDescriptors().empty()) {
 138                 auto_ptr_char temp(e.getEntityID());
 139                 log.debug("filtering out role-less entity (%s)", temp.get());
 140                 v.erase(v.begin() + i);
 141                 continue;
 142             }
 143         }
 144         i++;
 145     }
 146
 147     VectorOf(EntitiesDescriptor) groups = entities.getEntitiesDescriptors();
 148     for (VectorOf(EntitiesDescriptor)::size_type j = 0; j < groups.size(); ) {
 149         EntitiesDescriptor* group = groups[j];
 150         doFilter(*group);
 151         if (m_removeEmptyEntitiesDescriptors && group->getEntitiesDescriptors().empty() && group->getEntityDescriptors().empty()) {
 152             auto_ptr_char temp(entities.getName());
 153             auto_ptr_char temp2(group->getName());
 154             log.debug(
 155                 "filtering out empty EntitiesDescriptor (%s) from EntitiesDescriptor (%s)",
 156                 temp2.get() ? temp2.get() : "unnamed",
 157                 temp.get() ? temp.get() : "unnamed"
 158                 );
 159             groups.erase(groups.begin() + j);
 160         }
 161         else {
 162             j++;
 163         }
 164     }
 165 }
 166
 167 void EntityRoleMetadataFilter::doFilter(EntityDescriptor& entity) const
 168 {
 169     if (!m_idp)
 170         entity.getIDPSSODescriptors().clear();
 171     if (!m_sp)
 172         entity.getSPSSODescriptors().clear();
 173     if (!m_authn)
 174         entity.getAuthnAuthorityDescriptors().clear();
 175     if (!m_attr)
 176         entity.getAttributeAuthorityDescriptors().clear();
 177     if (!m_pdp)
 178         entity.getPDPDescriptors().clear();
 179     if (!m_authnq)
 180         entity.getAuthnQueryDescriptorTypes().clear();
 181     if (!m_attrq)
 182         entity.getAttributeQueryDescriptorTypes().clear();
 183     if (!m_authzq)
 184         entity.getAuthzDecisionQueryDescriptorTypes().clear();
 185
 186     VectorOf(RoleDescriptor) v = entity.getRoleDescriptors();
 187     for (VectorOf(RoleDescriptor)::size_type i = 0; i < v.size(); ) {
 188         const xmltooling::QName* type = v[i]->getSchemaType();
 189         if (!type || m_roles.find(*type) != m_roles.end())
 190             v.erase(v.begin() + i);
 191         else
 192             i++;
 193     }
 194 }