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(false), m_verifyName(true), m_credResolver(nullptr), m_trust(nullptr), m_log(Category::getInstance(SAML_LOGCAT".MetadataFilter.Signature"))
107 const XMLCh* flag = e ? e->getAttributeNS(nullptr,verifyRoles) : nullptr;
108 m_verifyRoles = (flag && (*flag == chLatin_t || *flag == chDigit_1));
110 flag = e ? e->getAttributeNS(nullptr,verifyName) : nullptr;
111 m_verifyName = !(flag && (*flag == chLatin_f || *flag == chDigit_0));
113 if (e && e->hasAttributeNS(nullptr,certificate)) {
114 // Use a file-based credential resolver rooted here.
115 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(FILESYSTEM_CREDENTIAL_RESOLVER,e);
119 DOMElement* sub = e ? XMLHelper::getFirstChildElement(e, _CredentialResolver) : nullptr;
120 auto_ptr_char t(sub ? sub->getAttributeNS(nullptr,type) : nullptr);
122 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.get(),sub);
126 sub = e ? XMLHelper::getFirstChildElement(e, _TrustEngine) : nullptr;
127 auto_ptr_char t2(sub ? sub->getAttributeNS(nullptr,type) : nullptr);
129 TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t2.get(),sub);
130 if (!(m_trust = dynamic_cast<SignatureTrustEngine*>(trust))) {
132 throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
137 throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
140 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
147 EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
148 doFilter(entities, true);
153 catch (exception& ex) {
154 m_log.warn("filtering out group at root of instance after failed signature check: %s", ex.what());
155 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
159 EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
160 doFilter(entity, true);
165 catch (exception& ex) {
166 m_log.warn("filtering out entity at root of instance after failed signature check: %s", ex.what());
167 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
170 throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
173 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
175 Signature* sig = entities.getSignature();
176 if (!sig && rootObject)
177 throw MetadataFilterException("Root metadata element was unsigned.");
178 verifySignature(sig, entities.getName());
180 VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
181 for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
186 catch (exception& e) {
187 auto_ptr_char id(v[i]->getEntityID());
188 m_log.warn("filtering out entity (%s) after failed signature check: %s", id.get(), e.what());
189 v.erase(v.begin() + i);
193 VectorOf(EntitiesDescriptor) w=entities.getEntitiesDescriptors();
194 for (VectorOf(EntitiesDescriptor)::size_type j=0; j<w.size(); ) {
196 doFilter(*w[j], false);
199 catch (exception& e) {
200 auto_ptr_char name(w[j]->getName());
201 m_log.warn("filtering out group (%s) after failed signature check: %s", name.get(), e.what());
202 w.erase(w.begin() + j);
207 void SignatureMetadataFilter::doFilter(EntityDescriptor& entity, bool rootObject) const
209 Signature* sig = entity.getSignature();
210 if (!sig && rootObject)
211 throw MetadataFilterException("Root metadata element was unsigned.");
212 verifySignature(sig, entity.getEntityID());
217 VectorOf(IDPSSODescriptor) idp=entity.getIDPSSODescriptors();
218 for (VectorOf(IDPSSODescriptor)::size_type i=0; i<idp.size(); ) {
220 verifySignature(idp[i]->getSignature(), entity.getEntityID());
223 catch (exception& e) {
224 auto_ptr_char id(entity.getEntityID());
226 "filtering out IDPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
228 idp.erase(idp.begin() + i);
232 VectorOf(SPSSODescriptor) sp=entity.getSPSSODescriptors();
233 for (VectorOf(SPSSODescriptor)::size_type i=0; i<sp.size(); ) {
235 verifySignature(sp[i]->getSignature(), entity.getEntityID());
238 catch (exception& e) {
239 auto_ptr_char id(entity.getEntityID());
241 "filtering out SPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
243 sp.erase(sp.begin() + i);
247 VectorOf(AuthnAuthorityDescriptor) authn=entity.getAuthnAuthorityDescriptors();
248 for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<authn.size(); ) {
250 verifySignature(authn[i]->getSignature(), entity.getEntityID());
253 catch (exception& e) {
254 auto_ptr_char id(entity.getEntityID());
256 "filtering out AuthnAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
258 authn.erase(authn.begin() + i);
262 VectorOf(AttributeAuthorityDescriptor) aa=entity.getAttributeAuthorityDescriptors();
263 for (VectorOf(AttributeAuthorityDescriptor)::size_type i=0; i<aa.size(); ) {
265 verifySignature(aa[i]->getSignature(), entity.getEntityID());
268 catch (exception& e) {
269 auto_ptr_char id(entity.getEntityID());
271 "filtering out AttributeAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
273 aa.erase(aa.begin() + i);
277 VectorOf(PDPDescriptor) pdp=entity.getPDPDescriptors();
278 for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<pdp.size(); ) {
280 verifySignature(pdp[i]->getSignature(), entity.getEntityID());
283 catch (exception& e) {
284 auto_ptr_char id(entity.getEntityID());
286 "filtering out PDPDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
288 pdp.erase(pdp.begin() + i);
292 VectorOf(AuthnQueryDescriptorType) authnq=entity.getAuthnQueryDescriptorTypes();
293 for (VectorOf(AuthnQueryDescriptorType)::size_type i=0; i<authnq.size(); ) {
295 verifySignature(authnq[i]->getSignature(), entity.getEntityID());
298 catch (exception& e) {
299 auto_ptr_char id(entity.getEntityID());
301 "filtering out AuthnQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
303 authnq.erase(authnq.begin() + i);
307 VectorOf(AttributeQueryDescriptorType) attrq=entity.getAttributeQueryDescriptorTypes();
308 for (VectorOf(AttributeQueryDescriptorType)::size_type i=0; i<attrq.size(); ) {
310 verifySignature(attrq[i]->getSignature(), entity.getEntityID());
313 catch (exception& e) {
314 auto_ptr_char id(entity.getEntityID());
316 "filtering out AttributeQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
318 attrq.erase(attrq.begin() + i);
322 VectorOf(AuthzDecisionQueryDescriptorType) authzq=entity.getAuthzDecisionQueryDescriptorTypes();
323 for (VectorOf(AuthzDecisionQueryDescriptorType)::size_type i=0; i<authzq.size(); ) {
325 verifySignature(authzq[i]->getSignature(), entity.getEntityID());
328 catch (exception& e) {
329 auto_ptr_char id(entity.getEntityID());
331 "filtering out AuthzDecisionQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
333 authzq.erase(authzq.begin() + i);
337 VectorOf(RoleDescriptor) v=entity.getRoleDescriptors();
338 for (VectorOf(RoleDescriptor)::size_type i=0; i<v.size(); ) {
340 verifySignature(v[i]->getSignature(), entity.getEntityID());
343 catch (exception& e) {
344 auto_ptr_char id(entity.getEntityID());
346 "filtering out role (%s) for entity (%s) after failed signature check: %s",
347 v[i]->getElementQName().toString().c_str(), id.get(), e.what()
349 v.erase(v.begin() + i);
353 if (entity.getAffiliationDescriptor()) {
355 verifySignature(entity.getAffiliationDescriptor()->getSignature(), entity.getEntityID());
357 catch (exception& e) {
358 auto_ptr_char id(entity.getEntityID());
359 m_log.warn("filtering out affiliation from entity (%s) after failed signature check: %s", id.get(), e.what());
360 entity.setAffiliationDescriptor(nullptr);
365 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
370 m_profileValidator.validate(sig);
373 CredentialCriteria cc;
374 cc.setUsage(Credential::SIGNING_CREDENTIAL);
375 cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
377 if (m_credResolver) {
379 auto_ptr_char pname(peerName);
380 cc.setPeerName(pname.get());
382 Locker locker(m_credResolver);
383 vector<const Credential*> creds;
384 if (m_credResolver->resolve(creds,&cc)) {
385 SignatureValidator sigValidator;
386 for (vector<const Credential*>::const_iterator i = creds.begin(); i != creds.end(); ++i) {
388 sigValidator.setCredential(*i);
389 sigValidator.validate(sig);
395 throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
398 throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
402 if (m_verifyName && peerName) {
403 auto_ptr_char pname(peerName);
404 cc.setPeerName(pname.get());
406 DummyCredentialResolver dummy;
407 if (m_trust->validate(*sig, dummy, &cc))
409 throw MetadataFilterException("TrustEngine unable to verify signature.");
412 throw MetadataFilterException("Unable to verify signature.");