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 * SignatureMetadataFilter.cpp
24 * Filters out unsigned or mis-signed elements.
28 #include "saml2/metadata/Metadata.h"
29 #include "saml2/metadata/MetadataFilter.h"
30 #include "signature/SignatureProfileValidator.h"
32 #include <xmltooling/logging.h>
33 #include <xmltooling/XMLToolingConfig.h>
34 #include <xmltooling/security/Credential.h>
35 #include <xmltooling/security/CredentialCriteria.h>
36 #include <xmltooling/security/CredentialResolver.h>
37 #include <xmltooling/security/SignatureTrustEngine.h>
38 #include <xmltooling/signature/Signature.h>
39 #include <xmltooling/signature/SignatureValidator.h>
40 #include <xmltooling/util/NDC.h>
42 using namespace opensaml::saml2md;
43 using namespace opensaml;
44 using namespace xmlsignature;
45 using namespace xmltooling::logging;
46 using namespace xmltooling;
52 class SAML_DLLLOCAL DummyCredentialResolver : public CredentialResolver
55 DummyCredentialResolver() {}
56 ~DummyCredentialResolver() {}
58 Lockable* lock() {return this;}
61 const Credential* resolve(const CredentialCriteria* criteria=nullptr) const {return nullptr;}
62 vector<const Credential*>::size_type resolve(
63 vector<const Credential*>& results, const CredentialCriteria* criteria=nullptr
67 class SAML_DLLLOCAL SignatureMetadataFilter : public MetadataFilter
70 SignatureMetadataFilter(const DOMElement* e);
71 ~SignatureMetadataFilter() {
72 delete m_credResolver;
76 const char* getId() const { return SIGNATURE_METADATA_FILTER; }
77 void doFilter(XMLObject& xmlObject) const;
80 void doFilter(EntitiesDescriptor& entities, bool rootObject=false) const;
81 void doFilter(EntityDescriptor& entity, bool rootObject=false) const;
82 void verifySignature(Signature* sig, const XMLCh* peerName) const;
84 bool m_verifyRoles,m_verifyName;
85 CredentialResolver* m_credResolver;
86 SignatureTrustEngine* m_trust;
87 SignatureProfileValidator m_profileValidator;
91 MetadataFilter* SAML_DLLLOCAL SignatureMetadataFilterFactory(const DOMElement* const & e)
93 return new SignatureMetadataFilter(e);
99 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
100 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);
101 static const XMLCh type[] = UNICODE_LITERAL_4(t,y,p,e);
102 static const XMLCh certificate[] = UNICODE_LITERAL_11(c,e,r,t,i,f,i,c,a,t,e);
103 static const XMLCh Certificate[] = UNICODE_LITERAL_11(C,e,r,t,i,f,i,c,a,t,e);
104 static const XMLCh Path[] = UNICODE_LITERAL_4(P,a,t,h);
105 static const XMLCh verifyRoles[] = UNICODE_LITERAL_11(v,e,r,i,f,y,R,o,l,e,s);
106 static const XMLCh verifyName[] = UNICODE_LITERAL_10(v,e,r,i,f,y,N,a,m,e);
108 SignatureMetadataFilter::SignatureMetadataFilter(const DOMElement* e)
109 : m_verifyRoles(XMLHelper::getAttrBool(e, false, verifyRoles)),
110 m_verifyName(XMLHelper::getAttrBool(e, true, verifyName)),
111 m_credResolver(nullptr), m_trust(nullptr),
112 m_log(Category::getInstance(SAML_LOGCAT".MetadataFilter.Signature"))
114 if (e && e->hasAttributeNS(nullptr,certificate)) {
115 // Use a file-based credential resolver rooted here.
116 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(FILESYSTEM_CREDENTIAL_RESOLVER, e);
120 DOMElement* sub = XMLHelper::getFirstChildElement(e, _CredentialResolver);
122 string t = XMLHelper::getAttrString(sub, nullptr, type);
124 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.c_str(), sub);
129 sub = XMLHelper::getFirstChildElement(e, _TrustEngine);
131 string t = XMLHelper::getAttrString(sub, nullptr, type);
133 TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t.c_str(), sub);
134 if (!(m_trust = dynamic_cast<SignatureTrustEngine*>(trust))) {
136 throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
142 throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
145 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
152 EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
153 doFilter(entities, true);
158 catch (exception& ex) {
159 m_log.warn("filtering out group at root of instance after failed signature check: %s", ex.what());
160 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
164 EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
165 doFilter(entity, true);
170 catch (exception& ex) {
171 m_log.warn("filtering out entity at root of instance after failed signature check: %s", ex.what());
172 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
175 throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
178 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
180 Signature* sig = entities.getSignature();
181 if (!sig && rootObject)
182 throw MetadataFilterException("Root metadata element was unsigned.");
183 verifySignature(sig, entities.getName());
185 VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
186 for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
191 catch (exception& e) {
192 auto_ptr_char id(v[i]->getEntityID());
193 m_log.warn("filtering out entity (%s) after failed signature check: %s", id.get(), e.what());
194 v.erase(v.begin() + i);
198 VectorOf(EntitiesDescriptor) w=entities.getEntitiesDescriptors();
199 for (VectorOf(EntitiesDescriptor)::size_type j=0; j<w.size(); ) {
201 doFilter(*w[j], false);
204 catch (exception& e) {
205 auto_ptr_char name(w[j]->getName());
206 m_log.warn("filtering out group (%s) after failed signature check: %s", name.get(), e.what());
207 w.erase(w.begin() + j);
212 void SignatureMetadataFilter::doFilter(EntityDescriptor& entity, bool rootObject) const
214 Signature* sig = entity.getSignature();
215 if (!sig && rootObject)
216 throw MetadataFilterException("Root metadata element was unsigned.");
217 verifySignature(sig, entity.getEntityID());
222 VectorOf(IDPSSODescriptor) idp=entity.getIDPSSODescriptors();
223 for (VectorOf(IDPSSODescriptor)::size_type i=0; i<idp.size(); ) {
225 verifySignature(idp[i]->getSignature(), entity.getEntityID());
228 catch (exception& e) {
229 auto_ptr_char id(entity.getEntityID());
231 "filtering out IDPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
233 idp.erase(idp.begin() + i);
237 VectorOf(SPSSODescriptor) sp=entity.getSPSSODescriptors();
238 for (VectorOf(SPSSODescriptor)::size_type i=0; i<sp.size(); ) {
240 verifySignature(sp[i]->getSignature(), entity.getEntityID());
243 catch (exception& e) {
244 auto_ptr_char id(entity.getEntityID());
246 "filtering out SPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
248 sp.erase(sp.begin() + i);
252 VectorOf(AuthnAuthorityDescriptor) authn=entity.getAuthnAuthorityDescriptors();
253 for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<authn.size(); ) {
255 verifySignature(authn[i]->getSignature(), entity.getEntityID());
258 catch (exception& e) {
259 auto_ptr_char id(entity.getEntityID());
261 "filtering out AuthnAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
263 authn.erase(authn.begin() + i);
267 VectorOf(AttributeAuthorityDescriptor) aa=entity.getAttributeAuthorityDescriptors();
268 for (VectorOf(AttributeAuthorityDescriptor)::size_type i=0; i<aa.size(); ) {
270 verifySignature(aa[i]->getSignature(), entity.getEntityID());
273 catch (exception& e) {
274 auto_ptr_char id(entity.getEntityID());
276 "filtering out AttributeAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
278 aa.erase(aa.begin() + i);
282 VectorOf(PDPDescriptor) pdp=entity.getPDPDescriptors();
283 for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<pdp.size(); ) {
285 verifySignature(pdp[i]->getSignature(), entity.getEntityID());
288 catch (exception& e) {
289 auto_ptr_char id(entity.getEntityID());
291 "filtering out PDPDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
293 pdp.erase(pdp.begin() + i);
297 VectorOf(AuthnQueryDescriptorType) authnq=entity.getAuthnQueryDescriptorTypes();
298 for (VectorOf(AuthnQueryDescriptorType)::size_type i=0; i<authnq.size(); ) {
300 verifySignature(authnq[i]->getSignature(), entity.getEntityID());
303 catch (exception& e) {
304 auto_ptr_char id(entity.getEntityID());
306 "filtering out AuthnQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
308 authnq.erase(authnq.begin() + i);
312 VectorOf(AttributeQueryDescriptorType) attrq=entity.getAttributeQueryDescriptorTypes();
313 for (VectorOf(AttributeQueryDescriptorType)::size_type i=0; i<attrq.size(); ) {
315 verifySignature(attrq[i]->getSignature(), entity.getEntityID());
318 catch (exception& e) {
319 auto_ptr_char id(entity.getEntityID());
321 "filtering out AttributeQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
323 attrq.erase(attrq.begin() + i);
327 VectorOf(AuthzDecisionQueryDescriptorType) authzq=entity.getAuthzDecisionQueryDescriptorTypes();
328 for (VectorOf(AuthzDecisionQueryDescriptorType)::size_type i=0; i<authzq.size(); ) {
330 verifySignature(authzq[i]->getSignature(), entity.getEntityID());
333 catch (exception& e) {
334 auto_ptr_char id(entity.getEntityID());
336 "filtering out AuthzDecisionQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
338 authzq.erase(authzq.begin() + i);
342 VectorOf(RoleDescriptor) v=entity.getRoleDescriptors();
343 for (VectorOf(RoleDescriptor)::size_type i=0; i<v.size(); ) {
345 verifySignature(v[i]->getSignature(), entity.getEntityID());
348 catch (exception& e) {
349 auto_ptr_char id(entity.getEntityID());
351 "filtering out role (%s) for entity (%s) after failed signature check: %s",
352 v[i]->getElementQName().toString().c_str(), id.get(), e.what()
354 v.erase(v.begin() + i);
358 if (entity.getAffiliationDescriptor()) {
360 verifySignature(entity.getAffiliationDescriptor()->getSignature(), entity.getEntityID());
362 catch (exception& e) {
363 auto_ptr_char id(entity.getEntityID());
364 m_log.warn("filtering out affiliation from entity (%s) after failed signature check: %s", id.get(), e.what());
365 entity.setAffiliationDescriptor(nullptr);
370 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
375 m_profileValidator.validate(sig);
378 CredentialCriteria cc;
379 cc.setUsage(Credential::SIGNING_CREDENTIAL);
380 cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
382 if (m_credResolver) {
384 auto_ptr_char pname(peerName);
385 cc.setPeerName(pname.get());
387 Locker locker(m_credResolver);
388 vector<const Credential*> creds;
389 if (m_credResolver->resolve(creds,&cc)) {
390 SignatureValidator sigValidator;
391 for (vector<const Credential*>::const_iterator i = creds.begin(); i != creds.end(); ++i) {
393 sigValidator.setCredential(*i);
394 sigValidator.validate(sig);
400 throw MetadataFilterException("Unable to verify signature with supplied key(s).");
403 throw MetadataFilterException("CredentialResolver did not supply any candidate keys.");
407 if (m_verifyName && peerName) {
408 auto_ptr_char pname(peerName);
409 cc.setPeerName(pname.get());
411 DummyCredentialResolver dummy;
412 if (m_trust->validate(*sig, dummy, &cc))
414 throw MetadataFilterException("TrustEngine unable to verify signature.");
417 throw MetadataFilterException("Unable to verify signature.");