2 * Copyright 2001-2008 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/security/Credential.h>
30 #include <xmltooling/security/CredentialCriteria.h>
31 #include <xmltooling/security/CredentialResolver.h>
32 #include <xmltooling/security/SignatureTrustEngine.h>
33 #include <xmltooling/signature/SignatureValidator.h>
34 #include <xmltooling/util/NDC.h>
36 using namespace opensaml::saml2md;
37 using namespace opensaml;
38 using namespace xmlsignature;
39 using namespace xmltooling::logging;
40 using namespace xmltooling;
46 class SAML_DLLLOCAL DummyCredentialResolver : public CredentialResolver
49 DummyCredentialResolver() {}
50 ~DummyCredentialResolver() {}
52 Lockable* lock() {return this;}
55 const Credential* resolve(const CredentialCriteria* criteria=NULL) const {return NULL;}
56 vector<const Credential*>::size_type resolve(
57 vector<const Credential*>& results, const CredentialCriteria* criteria=NULL
61 class SAML_DLLLOCAL SignatureMetadataFilter : public MetadataFilter
64 SignatureMetadataFilter(const DOMElement* e);
65 ~SignatureMetadataFilter() {
66 delete m_credResolver;
70 const char* getId() const { return SIGNATURE_METADATA_FILTER; }
71 void doFilter(XMLObject& xmlObject) const;
74 void doFilter(EntitiesDescriptor& entities, bool rootObject=false) const;
75 void doFilter(EntityDescriptor& entity, bool rootObject=false) const;
76 void verifySignature(Signature* sig, const XMLCh* peerName) const;
78 bool m_verifyRoles,m_verifyName;
79 CredentialResolver* m_credResolver;
80 SignatureTrustEngine* m_trust;
81 SignatureProfileValidator m_profileValidator;
85 MetadataFilter* SAML_DLLLOCAL SignatureMetadataFilterFactory(const DOMElement* const & e)
87 return new SignatureMetadataFilter(e);
93 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
94 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);
95 static const XMLCh type[] = UNICODE_LITERAL_4(t,y,p,e);
96 static const XMLCh certificate[] = UNICODE_LITERAL_11(c,e,r,t,i,f,i,c,a,t,e);
97 static const XMLCh Certificate[] = UNICODE_LITERAL_11(C,e,r,t,i,f,i,c,a,t,e);
98 static const XMLCh Path[] = UNICODE_LITERAL_4(P,a,t,h);
99 static const XMLCh verifyRoles[] = UNICODE_LITERAL_11(v,e,r,i,f,y,R,o,l,e,s);
100 static const XMLCh verifyName[] = UNICODE_LITERAL_10(v,e,r,i,f,y,N,a,m,e);
102 SignatureMetadataFilter::SignatureMetadataFilter(const DOMElement* e)
103 : m_verifyRoles(false), m_verifyName(true), m_credResolver(NULL), m_trust(NULL), m_log(Category::getInstance(SAML_LOGCAT".MetadataFilter.Signature"))
105 const XMLCh* flag = e ? e->getAttributeNS(NULL,verifyRoles) : NULL;
106 m_verifyRoles = (flag && (*flag == chLatin_t || *flag == chDigit_1));
108 flag = e ? e->getAttributeNS(NULL,verifyName) : NULL;
109 m_verifyName = !(flag && (*flag == chLatin_f || *flag == chDigit_0));
111 if (e && e->hasAttributeNS(NULL,certificate)) {
112 // Use a file-based credential resolver rooted here.
113 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(FILESYSTEM_CREDENTIAL_RESOLVER,e);
117 DOMElement* sub = e ? XMLHelper::getFirstChildElement(e, _CredentialResolver) : NULL;
118 auto_ptr_char t(sub ? sub->getAttributeNS(NULL,type) : NULL);
120 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.get(),sub);
124 sub = e ? XMLHelper::getFirstChildElement(e, _TrustEngine) : NULL;
125 auto_ptr_char t2(sub ? sub->getAttributeNS(NULL,type) : NULL);
127 TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t2.get(),sub);
128 if (!(m_trust = dynamic_cast<SignatureTrustEngine*>(trust))) {
130 throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
135 throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
138 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
145 EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
146 doFilter(entities, true);
151 catch (exception& ex) {
152 m_log.warn("filtering out group at root of instance after failed signature check: %s", ex.what());
153 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
157 EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
158 doFilter(entity, true);
163 catch (exception& ex) {
164 m_log.warn("filtering out entity at root of instance after failed signature check: %s", ex.what());
165 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
168 throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
171 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
173 Signature* sig = entities.getSignature();
174 if (!sig && rootObject)
175 throw MetadataFilterException("Root metadata element was unsigned.");
176 verifySignature(sig, entities.getName());
178 VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
179 for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
184 catch (exception& e) {
185 auto_ptr_char id(v[i]->getEntityID());
186 m_log.warn("filtering out entity (%s) after failed signature check: %s", id.get(), e.what());
187 v.erase(v.begin() + i);
191 VectorOf(EntitiesDescriptor) w=entities.getEntitiesDescriptors();
192 for (VectorOf(EntitiesDescriptor)::size_type j=0; j<w.size(); ) {
194 doFilter(*w[j], false);
197 catch (exception& e) {
198 auto_ptr_char name(w[j]->getName());
199 m_log.warn("filtering out group (%s) after failed signature check: %s", name.get(), e.what());
200 w.erase(w.begin() + j);
205 void SignatureMetadataFilter::doFilter(EntityDescriptor& entity, bool rootObject) const
207 Signature* sig = entity.getSignature();
208 if (!sig && rootObject)
209 throw MetadataFilterException("Root metadata element was unsigned.");
210 verifySignature(sig, entity.getEntityID());
215 VectorOf(IDPSSODescriptor) idp=entity.getIDPSSODescriptors();
216 for (VectorOf(IDPSSODescriptor)::size_type i=0; i<idp.size(); ) {
218 verifySignature(idp[i]->getSignature(), entity.getEntityID());
221 catch (exception& e) {
222 auto_ptr_char id(entity.getEntityID());
224 "filtering out IDPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
226 idp.erase(idp.begin() + i);
230 VectorOf(SPSSODescriptor) sp=entity.getSPSSODescriptors();
231 for (VectorOf(SPSSODescriptor)::size_type i=0; i<sp.size(); ) {
233 verifySignature(sp[i]->getSignature(), entity.getEntityID());
236 catch (exception& e) {
237 auto_ptr_char id(entity.getEntityID());
239 "filtering out SPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
241 sp.erase(sp.begin() + i);
245 VectorOf(AuthnAuthorityDescriptor) authn=entity.getAuthnAuthorityDescriptors();
246 for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<authn.size(); ) {
248 verifySignature(authn[i]->getSignature(), entity.getEntityID());
251 catch (exception& e) {
252 auto_ptr_char id(entity.getEntityID());
254 "filtering out AuthnAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
256 authn.erase(authn.begin() + i);
260 VectorOf(AttributeAuthorityDescriptor) aa=entity.getAttributeAuthorityDescriptors();
261 for (VectorOf(AttributeAuthorityDescriptor)::size_type i=0; i<aa.size(); ) {
263 verifySignature(aa[i]->getSignature(), entity.getEntityID());
266 catch (exception& e) {
267 auto_ptr_char id(entity.getEntityID());
269 "filtering out AttributeAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
271 aa.erase(aa.begin() + i);
275 VectorOf(PDPDescriptor) pdp=entity.getPDPDescriptors();
276 for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<pdp.size(); ) {
278 verifySignature(pdp[i]->getSignature(), entity.getEntityID());
281 catch (exception& e) {
282 auto_ptr_char id(entity.getEntityID());
284 "filtering out PDPDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
286 pdp.erase(pdp.begin() + i);
290 VectorOf(AuthnQueryDescriptorType) authnq=entity.getAuthnQueryDescriptorTypes();
291 for (VectorOf(AuthnQueryDescriptorType)::size_type i=0; i<authnq.size(); ) {
293 verifySignature(authnq[i]->getSignature(), entity.getEntityID());
296 catch (exception& e) {
297 auto_ptr_char id(entity.getEntityID());
299 "filtering out AuthnQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
301 authnq.erase(authnq.begin() + i);
305 VectorOf(AttributeQueryDescriptorType) attrq=entity.getAttributeQueryDescriptorTypes();
306 for (VectorOf(AttributeQueryDescriptorType)::size_type i=0; i<attrq.size(); ) {
308 verifySignature(attrq[i]->getSignature(), entity.getEntityID());
311 catch (exception& e) {
312 auto_ptr_char id(entity.getEntityID());
314 "filtering out AttributeQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
316 attrq.erase(attrq.begin() + i);
320 VectorOf(AuthzDecisionQueryDescriptorType) authzq=entity.getAuthzDecisionQueryDescriptorTypes();
321 for (VectorOf(AuthzDecisionQueryDescriptorType)::size_type i=0; i<authzq.size(); ) {
323 verifySignature(authzq[i]->getSignature(), entity.getEntityID());
326 catch (exception& e) {
327 auto_ptr_char id(entity.getEntityID());
329 "filtering out AuthzDecisionQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
331 authzq.erase(authzq.begin() + i);
335 VectorOf(RoleDescriptor) v=entity.getRoleDescriptors();
336 for (VectorOf(RoleDescriptor)::size_type i=0; i<v.size(); ) {
338 verifySignature(v[i]->getSignature(), entity.getEntityID());
341 catch (exception& e) {
342 auto_ptr_char id(entity.getEntityID());
344 "filtering out role (%s) for entity (%s) after failed signature check: %s",
345 v[i]->getElementQName().toString().c_str(), id.get(), e.what()
347 v.erase(v.begin() + i);
351 if (entity.getAffiliationDescriptor()) {
353 verifySignature(entity.getAffiliationDescriptor()->getSignature(), entity.getEntityID());
355 catch (exception& e) {
356 auto_ptr_char id(entity.getEntityID());
357 m_log.warn("filtering out affiliation from entity (%s) after failed signature check: %s", id.get(), e.what());
358 entity.setAffiliationDescriptor(NULL);
363 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
368 m_profileValidator.validate(sig);
371 CredentialCriteria cc;
372 cc.setUsage(Credential::SIGNING_CREDENTIAL);
373 cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
375 if (m_credResolver) {
377 auto_ptr_char pname(peerName);
378 cc.setPeerName(pname.get());
380 Locker locker(m_credResolver);
381 vector<const Credential*> creds;
382 if (m_credResolver->resolve(creds,&cc)) {
383 SignatureValidator sigValidator;
384 for (vector<const Credential*>::const_iterator i = creds.begin(); i != creds.end(); ++i) {
386 sigValidator.setCredential(*i);
387 sigValidator.validate(sig);
393 throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
396 throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
400 if (m_verifyName && peerName) {
401 auto_ptr_char pname(peerName);
402 cc.setPeerName(pname.get());
404 DummyCredentialResolver dummy;
405 if (m_trust->validate(*sig, dummy, &cc))
407 throw MetadataFilterException("TrustEngine unable to verify signature.");
410 throw MetadataFilterException("Unable to verify signature.");