2 * Copyright 2001-2010 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SignatureMetadataFilter.cpp
20 * Filters out unsigned or mis-signed elements.
24 #include "saml2/metadata/Metadata.h"
25 #include "saml2/metadata/MetadataFilter.h"
26 #include "signature/SignatureProfileValidator.h"
28 #include <xmltooling/logging.h>
29 #include <xmltooling/XMLToolingConfig.h>
30 #include <xmltooling/security/Credential.h>
31 #include <xmltooling/security/CredentialCriteria.h>
32 #include <xmltooling/security/CredentialResolver.h>
33 #include <xmltooling/security/SignatureTrustEngine.h>
34 #include <xmltooling/signature/Signature.h>
35 #include <xmltooling/signature/SignatureValidator.h>
36 #include <xmltooling/util/NDC.h>
38 using namespace opensaml::saml2md;
39 using namespace opensaml;
40 using namespace xmlsignature;
41 using namespace xmltooling::logging;
42 using namespace xmltooling;
48 class SAML_DLLLOCAL DummyCredentialResolver : public CredentialResolver
51 DummyCredentialResolver() {}
52 ~DummyCredentialResolver() {}
54 Lockable* lock() {return this;}
57 const Credential* resolve(const CredentialCriteria* criteria=nullptr) const {return nullptr;}
58 vector<const Credential*>::size_type resolve(
59 vector<const Credential*>& results, const CredentialCriteria* criteria=nullptr
63 class SAML_DLLLOCAL SignatureMetadataFilter : public MetadataFilter
66 SignatureMetadataFilter(const DOMElement* e);
67 ~SignatureMetadataFilter() {
68 delete m_credResolver;
72 const char* getId() const { return SIGNATURE_METADATA_FILTER; }
73 void doFilter(XMLObject& xmlObject) const;
76 void doFilter(EntitiesDescriptor& entities, bool rootObject=false) const;
77 void doFilter(EntityDescriptor& entity, bool rootObject=false) const;
78 void verifySignature(Signature* sig, const XMLCh* peerName) const;
80 bool m_verifyRoles,m_verifyName;
81 CredentialResolver* m_credResolver;
82 SignatureTrustEngine* m_trust;
83 SignatureProfileValidator m_profileValidator;
87 MetadataFilter* SAML_DLLLOCAL SignatureMetadataFilterFactory(const DOMElement* const & e)
89 return new SignatureMetadataFilter(e);
95 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
96 static const XMLCh _CredentialResolver[] = UNICODE_LITERAL_18(C,r,e,d,e,n,t,i,a,l,R,e,s,o,l,v,e,r);
97 static const XMLCh type[] = UNICODE_LITERAL_4(t,y,p,e);
98 static const XMLCh certificate[] = UNICODE_LITERAL_11(c,e,r,t,i,f,i,c,a,t,e);
99 static const XMLCh Certificate[] = UNICODE_LITERAL_11(C,e,r,t,i,f,i,c,a,t,e);
100 static const XMLCh Path[] = UNICODE_LITERAL_4(P,a,t,h);
101 static const XMLCh verifyRoles[] = UNICODE_LITERAL_11(v,e,r,i,f,y,R,o,l,e,s);
102 static const XMLCh verifyName[] = UNICODE_LITERAL_10(v,e,r,i,f,y,N,a,m,e);
104 SignatureMetadataFilter::SignatureMetadataFilter(const DOMElement* e)
105 : m_verifyRoles(XMLHelper::getAttrBool(e, false, verifyRoles)),
106 m_verifyName(XMLHelper::getAttrBool(e, true, verifyName)),
107 m_credResolver(nullptr), m_trust(nullptr),
108 m_log(Category::getInstance(SAML_LOGCAT".MetadataFilter.Signature"))
110 if (e && e->hasAttributeNS(nullptr,certificate)) {
111 // Use a file-based credential resolver rooted here.
112 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(FILESYSTEM_CREDENTIAL_RESOLVER, e);
116 DOMElement* sub = XMLHelper::getFirstChildElement(e, _CredentialResolver);
118 string t = XMLHelper::getAttrString(sub, nullptr, type);
120 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.c_str(), sub);
125 sub = XMLHelper::getFirstChildElement(e, _TrustEngine);
127 string t = XMLHelper::getAttrString(sub, nullptr, type);
129 TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t.c_str(), sub);
130 if (!(m_trust = dynamic_cast<SignatureTrustEngine*>(trust))) {
132 throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
138 throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
141 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
148 EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
149 doFilter(entities, true);
154 catch (exception& ex) {
155 m_log.warn("filtering out group at root of instance after failed signature check: %s", ex.what());
156 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
160 EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
161 doFilter(entity, true);
166 catch (exception& ex) {
167 m_log.warn("filtering out entity at root of instance after failed signature check: %s", ex.what());
168 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
171 throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
174 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
176 Signature* sig = entities.getSignature();
177 if (!sig && rootObject)
178 throw MetadataFilterException("Root metadata element was unsigned.");
179 verifySignature(sig, entities.getName());
181 VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
182 for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
187 catch (exception& e) {
188 auto_ptr_char id(v[i]->getEntityID());
189 m_log.warn("filtering out entity (%s) after failed signature check: %s", id.get(), e.what());
190 v.erase(v.begin() + i);
194 VectorOf(EntitiesDescriptor) w=entities.getEntitiesDescriptors();
195 for (VectorOf(EntitiesDescriptor)::size_type j=0; j<w.size(); ) {
197 doFilter(*w[j], false);
200 catch (exception& e) {
201 auto_ptr_char name(w[j]->getName());
202 m_log.warn("filtering out group (%s) after failed signature check: %s", name.get(), e.what());
203 w.erase(w.begin() + j);
208 void SignatureMetadataFilter::doFilter(EntityDescriptor& entity, bool rootObject) const
210 Signature* sig = entity.getSignature();
211 if (!sig && rootObject)
212 throw MetadataFilterException("Root metadata element was unsigned.");
213 verifySignature(sig, entity.getEntityID());
218 VectorOf(IDPSSODescriptor) idp=entity.getIDPSSODescriptors();
219 for (VectorOf(IDPSSODescriptor)::size_type i=0; i<idp.size(); ) {
221 verifySignature(idp[i]->getSignature(), entity.getEntityID());
224 catch (exception& e) {
225 auto_ptr_char id(entity.getEntityID());
227 "filtering out IDPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
229 idp.erase(idp.begin() + i);
233 VectorOf(SPSSODescriptor) sp=entity.getSPSSODescriptors();
234 for (VectorOf(SPSSODescriptor)::size_type i=0; i<sp.size(); ) {
236 verifySignature(sp[i]->getSignature(), entity.getEntityID());
239 catch (exception& e) {
240 auto_ptr_char id(entity.getEntityID());
242 "filtering out SPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
244 sp.erase(sp.begin() + i);
248 VectorOf(AuthnAuthorityDescriptor) authn=entity.getAuthnAuthorityDescriptors();
249 for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<authn.size(); ) {
251 verifySignature(authn[i]->getSignature(), entity.getEntityID());
254 catch (exception& e) {
255 auto_ptr_char id(entity.getEntityID());
257 "filtering out AuthnAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
259 authn.erase(authn.begin() + i);
263 VectorOf(AttributeAuthorityDescriptor) aa=entity.getAttributeAuthorityDescriptors();
264 for (VectorOf(AttributeAuthorityDescriptor)::size_type i=0; i<aa.size(); ) {
266 verifySignature(aa[i]->getSignature(), entity.getEntityID());
269 catch (exception& e) {
270 auto_ptr_char id(entity.getEntityID());
272 "filtering out AttributeAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
274 aa.erase(aa.begin() + i);
278 VectorOf(PDPDescriptor) pdp=entity.getPDPDescriptors();
279 for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<pdp.size(); ) {
281 verifySignature(pdp[i]->getSignature(), entity.getEntityID());
284 catch (exception& e) {
285 auto_ptr_char id(entity.getEntityID());
287 "filtering out PDPDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
289 pdp.erase(pdp.begin() + i);
293 VectorOf(AuthnQueryDescriptorType) authnq=entity.getAuthnQueryDescriptorTypes();
294 for (VectorOf(AuthnQueryDescriptorType)::size_type i=0; i<authnq.size(); ) {
296 verifySignature(authnq[i]->getSignature(), entity.getEntityID());
299 catch (exception& e) {
300 auto_ptr_char id(entity.getEntityID());
302 "filtering out AuthnQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
304 authnq.erase(authnq.begin() + i);
308 VectorOf(AttributeQueryDescriptorType) attrq=entity.getAttributeQueryDescriptorTypes();
309 for (VectorOf(AttributeQueryDescriptorType)::size_type i=0; i<attrq.size(); ) {
311 verifySignature(attrq[i]->getSignature(), entity.getEntityID());
314 catch (exception& e) {
315 auto_ptr_char id(entity.getEntityID());
317 "filtering out AttributeQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
319 attrq.erase(attrq.begin() + i);
323 VectorOf(AuthzDecisionQueryDescriptorType) authzq=entity.getAuthzDecisionQueryDescriptorTypes();
324 for (VectorOf(AuthzDecisionQueryDescriptorType)::size_type i=0; i<authzq.size(); ) {
326 verifySignature(authzq[i]->getSignature(), entity.getEntityID());
329 catch (exception& e) {
330 auto_ptr_char id(entity.getEntityID());
332 "filtering out AuthzDecisionQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
334 authzq.erase(authzq.begin() + i);
338 VectorOf(RoleDescriptor) v=entity.getRoleDescriptors();
339 for (VectorOf(RoleDescriptor)::size_type i=0; i<v.size(); ) {
341 verifySignature(v[i]->getSignature(), entity.getEntityID());
344 catch (exception& e) {
345 auto_ptr_char id(entity.getEntityID());
347 "filtering out role (%s) for entity (%s) after failed signature check: %s",
348 v[i]->getElementQName().toString().c_str(), id.get(), e.what()
350 v.erase(v.begin() + i);
354 if (entity.getAffiliationDescriptor()) {
356 verifySignature(entity.getAffiliationDescriptor()->getSignature(), entity.getEntityID());
358 catch (exception& e) {
359 auto_ptr_char id(entity.getEntityID());
360 m_log.warn("filtering out affiliation from entity (%s) after failed signature check: %s", id.get(), e.what());
361 entity.setAffiliationDescriptor(nullptr);
366 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
371 m_profileValidator.validate(sig);
374 CredentialCriteria cc;
375 cc.setUsage(Credential::SIGNING_CREDENTIAL);
376 cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
378 if (m_credResolver) {
380 auto_ptr_char pname(peerName);
381 cc.setPeerName(pname.get());
383 Locker locker(m_credResolver);
384 vector<const Credential*> creds;
385 if (m_credResolver->resolve(creds,&cc)) {
386 SignatureValidator sigValidator;
387 for (vector<const Credential*>::const_iterator i = creds.begin(); i != creds.end(); ++i) {
389 sigValidator.setCredential(*i);
390 sigValidator.validate(sig);
396 throw MetadataFilterException("Unable to verify signature with supplied key(s).");
399 throw MetadataFilterException("CredentialResolver did not supply any candidate keys.");
403 if (m_verifyName && peerName) {
404 auto_ptr_char pname(peerName);
405 cc.setPeerName(pname.get());
407 DummyCredentialResolver dummy;
408 if (m_trust->validate(*sig, dummy, &cc))
410 throw MetadataFilterException("TrustEngine unable to verify signature.");
413 throw MetadataFilterException("Unable to verify signature.");