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 SignatureMetadataFilter : public MetadataFilter
55 SignatureMetadataFilter(const DOMElement* e);
56 ~SignatureMetadataFilter() {}
58 const char* getId() const { return SIGNATURE_METADATA_FILTER; }
59 void doFilter(XMLObject& xmlObject) const;
62 void doFilter(EntitiesDescriptor& entities, bool rootObject=false) const;
63 void doFilter(EntityDescriptor& entity, bool rootObject=false) const;
64 void verifySignature(Signature* sig, const XMLCh* peerName) const;
66 bool m_verifyRoles,m_verifyName;
67 auto_ptr<CredentialResolver> m_credResolver,m_dummyResolver;
68 auto_ptr<SignatureTrustEngine> m_trust;
69 SignatureProfileValidator m_profileValidator;
73 MetadataFilter* SAML_DLLLOCAL SignatureMetadataFilterFactory(const DOMElement* const & e)
75 return new SignatureMetadataFilter(e);
81 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
82 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);
83 static const XMLCh type[] = UNICODE_LITERAL_4(t,y,p,e);
84 static const XMLCh certificate[] = UNICODE_LITERAL_11(c,e,r,t,i,f,i,c,a,t,e);
85 static const XMLCh Certificate[] = UNICODE_LITERAL_11(C,e,r,t,i,f,i,c,a,t,e);
86 static const XMLCh Path[] = UNICODE_LITERAL_4(P,a,t,h);
87 static const XMLCh verifyRoles[] = UNICODE_LITERAL_11(v,e,r,i,f,y,R,o,l,e,s);
88 static const XMLCh verifyName[] = UNICODE_LITERAL_10(v,e,r,i,f,y,N,a,m,e);
90 SignatureMetadataFilter::SignatureMetadataFilter(const DOMElement* e)
91 : m_verifyRoles(XMLHelper::getAttrBool(e, false, verifyRoles)),
92 m_verifyName(XMLHelper::getAttrBool(e, true, verifyName)),
93 m_log(Category::getInstance(SAML_LOGCAT ".MetadataFilter.Signature"))
95 if (e && e->hasAttributeNS(nullptr,certificate)) {
96 // Use a file-based credential resolver rooted here.
97 m_credResolver.reset(XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(FILESYSTEM_CREDENTIAL_RESOLVER, e));
101 DOMElement* sub = XMLHelper::getFirstChildElement(e, _CredentialResolver);
103 string t = XMLHelper::getAttrString(sub, nullptr, type);
105 m_credResolver.reset(XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.c_str(), sub));
110 sub = XMLHelper::getFirstChildElement(e, _TrustEngine);
112 string t = XMLHelper::getAttrString(sub, nullptr, type);
114 TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t.c_str(), sub);
115 SignatureTrustEngine* sigTrust = dynamic_cast<SignatureTrustEngine*>(trust);
118 throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
120 m_trust.reset(sigTrust);
121 m_dummyResolver.reset(XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(DUMMY_CREDENTIAL_RESOLVER, nullptr));
122 if (!m_dummyResolver.get())
123 throw MetadataFilterException("Error creating dummy CredentialResolver.");
128 throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
131 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
138 EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
139 doFilter(entities, true);
144 catch (exception& ex) {
145 m_log.warn("filtering out group at root of instance after failed signature check: %s", ex.what());
146 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
150 EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
151 doFilter(entity, true);
156 catch (exception& ex) {
157 m_log.warn("filtering out entity at root of instance after failed signature check: %s", ex.what());
158 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
161 throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
164 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
166 Signature* sig = entities.getSignature();
167 if (!sig && rootObject)
168 throw MetadataFilterException("Root metadata element was unsigned.");
169 verifySignature(sig, entities.getName());
171 VectorOf(EntityDescriptor) v = entities.getEntityDescriptors();
172 for (VectorOf(EntityDescriptor)::size_type i = 0; i < v.size(); ) {
177 catch (exception& e) {
178 auto_ptr_char id(v[i]->getEntityID());
179 m_log.warn("filtering out entity (%s) after failed signature check: %s", id.get(), e.what());
180 v.erase(v.begin() + i);
184 VectorOf(EntitiesDescriptor) w = entities.getEntitiesDescriptors();
185 for (VectorOf(EntitiesDescriptor)::size_type j = 0; j < w.size(); ) {
187 doFilter(*w[j], false);
190 catch (exception& e) {
191 auto_ptr_char name(w[j]->getName());
192 m_log.warn("filtering out group (%s) after failed signature check: %s", name.get(), e.what());
193 w.erase(w.begin() + j);
198 void SignatureMetadataFilter::doFilter(EntityDescriptor& entity, bool rootObject) const
200 Signature* sig = entity.getSignature();
201 if (!sig && rootObject)
202 throw MetadataFilterException("Root metadata element was unsigned.");
203 verifySignature(sig, entity.getEntityID());
208 VectorOf(IDPSSODescriptor) idp = entity.getIDPSSODescriptors();
209 for (VectorOf(IDPSSODescriptor)::size_type i = 0; i < idp.size(); ) {
211 verifySignature(idp[i]->getSignature(), entity.getEntityID());
214 catch (exception& e) {
215 auto_ptr_char id(entity.getEntityID());
217 "filtering out IDPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
219 idp.erase(idp.begin() + i);
223 VectorOf(SPSSODescriptor) sp = entity.getSPSSODescriptors();
224 for (VectorOf(SPSSODescriptor)::size_type i = 0; i < sp.size(); ) {
226 verifySignature(sp[i]->getSignature(), entity.getEntityID());
229 catch (exception& e) {
230 auto_ptr_char id(entity.getEntityID());
232 "filtering out SPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
234 sp.erase(sp.begin() + i);
238 VectorOf(AuthnAuthorityDescriptor) authn = entity.getAuthnAuthorityDescriptors();
239 for (VectorOf(AuthnAuthorityDescriptor)::size_type i = 0; i < authn.size(); ) {
241 verifySignature(authn[i]->getSignature(), entity.getEntityID());
244 catch (exception& e) {
245 auto_ptr_char id(entity.getEntityID());
247 "filtering out AuthnAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
249 authn.erase(authn.begin() + i);
253 VectorOf(AttributeAuthorityDescriptor) aa = entity.getAttributeAuthorityDescriptors();
254 for (VectorOf(AttributeAuthorityDescriptor)::size_type i = 0; i < aa.size(); ) {
256 verifySignature(aa[i]->getSignature(), entity.getEntityID());
259 catch (exception& e) {
260 auto_ptr_char id(entity.getEntityID());
262 "filtering out AttributeAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
264 aa.erase(aa.begin() + i);
268 VectorOf(PDPDescriptor) pdp = entity.getPDPDescriptors();
269 for (VectorOf(AuthnAuthorityDescriptor)::size_type i = 0; i < pdp.size(); ) {
271 verifySignature(pdp[i]->getSignature(), entity.getEntityID());
274 catch (exception& e) {
275 auto_ptr_char id(entity.getEntityID());
277 "filtering out PDPDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
279 pdp.erase(pdp.begin() + i);
283 VectorOf(AuthnQueryDescriptorType) authnq = entity.getAuthnQueryDescriptorTypes();
284 for (VectorOf(AuthnQueryDescriptorType)::size_type i = 0; i < authnq.size(); ) {
286 verifySignature(authnq[i]->getSignature(), entity.getEntityID());
289 catch (exception& e) {
290 auto_ptr_char id(entity.getEntityID());
292 "filtering out AuthnQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
294 authnq.erase(authnq.begin() + i);
298 VectorOf(AttributeQueryDescriptorType) attrq = entity.getAttributeQueryDescriptorTypes();
299 for (VectorOf(AttributeQueryDescriptorType)::size_type i = 0; i < attrq.size(); ) {
301 verifySignature(attrq[i]->getSignature(), entity.getEntityID());
304 catch (exception& e) {
305 auto_ptr_char id(entity.getEntityID());
307 "filtering out AttributeQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
309 attrq.erase(attrq.begin() + i);
313 VectorOf(AuthzDecisionQueryDescriptorType) authzq = entity.getAuthzDecisionQueryDescriptorTypes();
314 for (VectorOf(AuthzDecisionQueryDescriptorType)::size_type i = 0; i < authzq.size(); ) {
316 verifySignature(authzq[i]->getSignature(), entity.getEntityID());
319 catch (exception& e) {
320 auto_ptr_char id(entity.getEntityID());
322 "filtering out AuthzDecisionQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
324 authzq.erase(authzq.begin() + i);
328 VectorOf(RoleDescriptor) v = entity.getRoleDescriptors();
329 for (VectorOf(RoleDescriptor)::size_type i = 0; i < v.size(); ) {
331 verifySignature(v[i]->getSignature(), entity.getEntityID());
334 catch (exception& e) {
335 auto_ptr_char id(entity.getEntityID());
337 "filtering out role (%s) for entity (%s) after failed signature check: %s",
338 v[i]->getElementQName().toString().c_str(), id.get(), e.what()
340 v.erase(v.begin() + i);
344 if (entity.getAffiliationDescriptor()) {
346 verifySignature(entity.getAffiliationDescriptor()->getSignature(), entity.getEntityID());
348 catch (exception& e) {
349 auto_ptr_char id(entity.getEntityID());
350 m_log.warn("filtering out affiliation from entity (%s) after failed signature check: %s", id.get(), e.what());
351 entity.setAffiliationDescriptor(nullptr);
356 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
361 m_profileValidator.validate(sig);
364 CredentialCriteria cc;
365 cc.setUsage(Credential::SIGNING_CREDENTIAL);
366 cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
368 if (m_credResolver.get()) {
370 auto_ptr_char pname(peerName);
371 cc.setPeerName(pname.get());
373 Locker locker(m_credResolver.get());
374 vector<const Credential*> creds;
375 if (m_credResolver->resolve(creds,&cc)) {
376 SignatureValidator sigValidator;
377 for (vector<const Credential*>::const_iterator i = creds.begin(); i != creds.end(); ++i) {
379 sigValidator.setCredential(*i);
380 sigValidator.validate(sig);
386 throw MetadataFilterException("Unable to verify signature with supplied key(s).");
389 throw MetadataFilterException("CredentialResolver did not supply any candidate keys.");
392 else if (m_trust.get()) {
393 if (m_verifyName && peerName) {
394 auto_ptr_char pname(peerName);
395 cc.setPeerName(pname.get());
397 if (m_trust->validate(*sig, *m_dummyResolver, &cc))
399 throw MetadataFilterException("TrustEngine unable to verify signature.");
402 throw MetadataFilterException("Unable to verify signature.");