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>
33 using namespace opensaml::saml2md;
34 using namespace xmltooling::logging;
35 using namespace xmltooling;
41 class SAML_DLLLOCAL EntityRoleMetadataFilter : public MetadataFilter
44 EntityRoleMetadataFilter(const DOMElement* e);
45 ~EntityRoleMetadataFilter() {}
47 const char* getId() const { return ENTITYROLE_METADATA_FILTER; }
48 void doFilter(XMLObject& xmlObject) const;
51 void doFilter(EntityDescriptor& entity) const;
52 void doFilter(EntitiesDescriptor& entities) const;
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;
59 MetadataFilter* SAML_DLLLOCAL EntityRoleMetadataFilterFactory(const DOMElement* const & e)
61 return new EntityRoleMetadataFilter(e);
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);
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)
76 e = XMLHelper::getFirstChildElement(e, RetainedRole);
78 auto_ptr<xmltooling::QName> q(XMLHelper::getNodeValueAsQName(e));
80 if (*q == IDPSSODescriptor::ELEMENT_QNAME)
82 else if (*q == SPSSODescriptor::ELEMENT_QNAME)
84 else if (*q == AuthnAuthorityDescriptor::ELEMENT_QNAME)
86 else if (*q == AttributeAuthorityDescriptor::ELEMENT_QNAME)
88 else if (*q == PDPDescriptor::ELEMENT_QNAME)
90 else if (*q == AuthnQueryDescriptorType::TYPE_QNAME)
92 else if (*q == AttributeQueryDescriptorType::TYPE_QNAME)
94 else if (*q == AuthzDecisionQueryDescriptorType::TYPE_QNAME)
99 e = XMLHelper::getNextSiblingElement(e, RetainedRole);
103 void EntityRoleMetadataFilter::doFilter(XMLObject& xmlObject) const
105 EntitiesDescriptor* group = dynamic_cast<EntitiesDescriptor*>(&xmlObject);
110 EntityDescriptor* entity = dynamic_cast<EntityDescriptor*>(&xmlObject);
115 throw MetadataFilterException(ENTITYROLE_METADATA_FILTER" MetadataFilter was given an improper metadata instance to filter.");
120 void EntityRoleMetadataFilter::doFilter(EntitiesDescriptor& entities) const
122 Category& log=Category::getInstance(SAML_LOGCAT".MetadataFilter."ENTITYROLE_METADATA_FILTER);
124 VectorOf(EntityDescriptor) v = entities.getEntityDescriptors();
125 for (VectorOf(EntityDescriptor)::size_type i = 0; i < v.size(); ) {
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);
147 VectorOf(EntitiesDescriptor) groups = entities.getEntitiesDescriptors();
148 for (VectorOf(EntitiesDescriptor)::size_type j = 0; j < groups.size(); ) {
149 EntitiesDescriptor* group = groups[j];
151 if (m_removeEmptyEntitiesDescriptors && group->getEntitiesDescriptors().empty() && group->getEntityDescriptors().empty()) {
152 auto_ptr_char temp(entities.getName());
153 auto_ptr_char temp2(group->getName());
155 "filtering out empty EntitiesDescriptor (%s) from EntitiesDescriptor (%s)",
156 temp2.get() ? temp2.get() : "unnamed",
157 temp.get() ? temp.get() : "unnamed"
159 groups.erase(groups.begin() + j);
167 void EntityRoleMetadataFilter::doFilter(EntityDescriptor& entity) const
170 entity.getIDPSSODescriptors().clear();
172 entity.getSPSSODescriptors().clear();
174 entity.getAuthnAuthorityDescriptors().clear();
176 entity.getAttributeAuthorityDescriptors().clear();
178 entity.getPDPDescriptors().clear();
180 entity.getAuthnQueryDescriptorTypes().clear();
182 entity.getAttributeQueryDescriptorTypes().clear();
184 entity.getAuthzDecisionQueryDescriptorTypes().clear();
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);