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.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * EntityRoleMetadataFilter.cpp
24 * Removes non-whitelisted roles from a metadata instance.
28 #include "saml2/metadata/Metadata.h"
29 #include "saml2/metadata/MetadataFilter.h"
31 #include <xmltooling/logging.h>
32 #include <xmltooling/util/NDC.h>
34 using namespace opensaml::saml2md;
35 using namespace xmltooling::logging;
36 using namespace xmltooling;
42 class SAML_DLLLOCAL EntityRoleMetadataFilter : public MetadataFilter
45 EntityRoleMetadataFilter(const DOMElement* e);
46 ~EntityRoleMetadataFilter() {}
48 const char* getId() const { return ENTITYROLE_METADATA_FILTER; }
49 void doFilter(XMLObject& xmlObject) const;
52 void doFilter(EntityDescriptor& entity) const;
53 void doFilter(EntitiesDescriptor& entities) const;
55 bool m_removeRolelessEntityDescriptors, m_removeEmptyEntitiesDescriptors;
56 set<xmltooling::QName> m_roles;
57 bool m_idp, m_sp, m_authn, m_attr, m_pdp, m_authnq, m_attrq, m_authzq;
60 MetadataFilter* SAML_DLLLOCAL EntityRoleMetadataFilterFactory(const DOMElement* const & e)
62 return new EntityRoleMetadataFilter(e);
68 static const XMLCh RetainedRole[] = UNICODE_LITERAL_12(R,e,t,a,i,n,e,d,R,o,l,e);
69 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);
70 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);
72 EntityRoleMetadataFilter::EntityRoleMetadataFilter(const DOMElement* e)
73 : m_removeRolelessEntityDescriptors(XMLHelper::getAttrBool(e, true, removeRolelessEntityDescriptors)),
74 m_removeEmptyEntitiesDescriptors(XMLHelper::getAttrBool(e, true, removeEmptyEntitiesDescriptors)),
75 m_idp(false), m_sp(false), m_authn(false), m_attr(false), m_pdp(false), m_authnq(false), m_attrq(false), m_authzq(false)
77 e = XMLHelper::getFirstChildElement(e, RetainedRole);
79 auto_ptr<xmltooling::QName> q(XMLHelper::getNodeValueAsQName(e));
81 if (*q == IDPSSODescriptor::ELEMENT_QNAME)
83 else if (*q == SPSSODescriptor::ELEMENT_QNAME)
85 else if (*q == AuthnAuthorityDescriptor::ELEMENT_QNAME)
87 else if (*q == AttributeAuthorityDescriptor::ELEMENT_QNAME)
89 else if (*q == PDPDescriptor::ELEMENT_QNAME)
91 else if (*q == AuthnQueryDescriptorType::TYPE_QNAME)
93 else if (*q == AttributeQueryDescriptorType::TYPE_QNAME)
95 else if (*q == AuthzDecisionQueryDescriptorType::TYPE_QNAME)
98 m_roles.insert(*q.get());
100 e = XMLHelper::getNextSiblingElement(e, RetainedRole);
104 void EntityRoleMetadataFilter::doFilter(XMLObject& xmlObject) const
111 doFilter(dynamic_cast<EntitiesDescriptor&>(xmlObject));
118 doFilter(dynamic_cast<EntityDescriptor&>(xmlObject));
124 throw MetadataFilterException("EntityRoleWhiteList MetadataFilter was given an improper metadata instance to filter.");
127 void EntityRoleMetadataFilter::doFilter(EntitiesDescriptor& entities) const
129 Category& log=Category::getInstance(SAML_LOGCAT".MetadataFilter.EntityRoleWhiteList");
131 VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
132 for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
134 if (m_removeRolelessEntityDescriptors) {
135 const EntityDescriptor& e = const_cast<const EntityDescriptor&>(*v[i]);
136 if (e.getIDPSSODescriptors().empty() &&
137 e.getSPSSODescriptors().empty() &&
138 e.getAuthnAuthorityDescriptors().empty() &&
139 e.getAttributeAuthorityDescriptors().empty() &&
140 e.getPDPDescriptors().empty() &&
141 e.getAuthnQueryDescriptorTypes().empty() &&
142 e.getAttributeQueryDescriptorTypes().empty() &&
143 e.getAuthzDecisionQueryDescriptorTypes().empty() &&
144 e.getRoleDescriptors().empty()) {
145 auto_ptr_char temp(e.getEntityID());
146 log.debug("filtering out role-less entity (%s)", temp.get());
147 v.erase(v.begin() + i);
154 VectorOf(EntitiesDescriptor) groups=entities.getEntitiesDescriptors();
155 for (VectorOf(EntitiesDescriptor)::size_type j=0; j<groups.size(); ) {
156 EntitiesDescriptor* group = groups[j];
158 if (m_removeEmptyEntitiesDescriptors && group->getEntitiesDescriptors().empty() && group->getEntityDescriptors().empty()) {
159 auto_ptr_char temp(entities.getName());
160 auto_ptr_char temp2(group->getName());
162 "filtering out empty EntitiesDescriptor (%s) from EntitiesDescriptor (%s)",
163 temp2.get() ? temp2.get() : "unnamed",
164 temp.get() ? temp.get() : "unnamed"
166 groups.erase(groups.begin() + j);
174 void EntityRoleMetadataFilter::doFilter(EntityDescriptor& entity) const
177 entity.getIDPSSODescriptors().clear();
179 entity.getSPSSODescriptors().clear();
181 entity.getAuthnAuthorityDescriptors().clear();
183 entity.getAttributeAuthorityDescriptors().clear();
185 entity.getPDPDescriptors().clear();
187 entity.getAuthnQueryDescriptorTypes().clear();
189 entity.getAttributeQueryDescriptorTypes().clear();
191 entity.getAuthzDecisionQueryDescriptorTypes().clear();
193 VectorOf(RoleDescriptor) v = entity.getRoleDescriptors();
194 for (VectorOf(RoleDescriptor)::size_type i=0; i<v.size(); ) {
195 const xmltooling::QName* type = v[i]->getSchemaType();
196 if (!type || m_roles.find(*type) != m_roles.end())
197 v.erase(v.begin() + i);