2 * Copyright 2001-2007 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;
69 const char* getId() const { return SIGNATURE_METADATA_FILTER; }
70 void doFilter(XMLObject& xmlObject) const;
73 void doFilter(EntitiesDescriptor& entities, bool rootObject=false) const;
74 void verifySignature(Signature* sig, const XMLCh* peerName) const;
76 CredentialResolver* m_credResolver;
77 SignatureTrustEngine* m_trust;
78 SignatureProfileValidator m_profileValidator;
82 MetadataFilter* SAML_DLLLOCAL SignatureMetadataFilterFactory(const DOMElement* const & e)
84 return new SignatureMetadataFilter(e);
90 static const XMLCh _TrustEngine[] = UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
91 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);
92 static const XMLCh type[] = UNICODE_LITERAL_4(t,y,p,e);
93 static const XMLCh certificate[] = UNICODE_LITERAL_11(c,e,r,t,i,f,i,c,a,t,e);
94 static const XMLCh Certificate[] = UNICODE_LITERAL_11(C,e,r,t,i,f,i,c,a,t,e);
95 static const XMLCh Path[] = UNICODE_LITERAL_4(P,a,t,h);
97 SignatureMetadataFilter::SignatureMetadataFilter(const DOMElement* e)
98 : m_credResolver(NULL), m_trust(NULL), m_log(Category::getInstance(SAML_LOGCAT".MetadataFilter.Signature"))
100 if (e && e->hasAttributeNS(NULL,certificate)) {
101 // Use a file-based credential resolver rooted here.
102 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(FILESYSTEM_CREDENTIAL_RESOLVER,e);
106 DOMElement* sub = e ? XMLHelper::getFirstChildElement(e, _CredentialResolver) : NULL;
107 auto_ptr_char t(sub ? sub->getAttributeNS(NULL,type) : NULL);
109 m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.get(),sub);
113 sub = e ? XMLHelper::getFirstChildElement(e, _TrustEngine) : NULL;
114 auto_ptr_char t2(sub ? sub->getAttributeNS(NULL,type) : NULL);
116 TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t2.get(),sub);
117 if (!(m_trust = dynamic_cast<SignatureTrustEngine*>(trust))) {
119 throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
124 throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
127 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
134 EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
135 doFilter(entities, true);
140 catch (exception& ex) {
141 m_log.warn("filtering out group at root of instance after failed signature check: ", ex.what());
142 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
146 EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
147 if (!entity.getSignature())
148 throw MetadataFilterException("Root metadata element was unsigned.");
149 verifySignature(entity.getSignature(), entity.getEntityID());
153 catch (exception& ex) {
154 m_log.warn("filtering out entity at root of instance after failed signature check: ", ex.what());
155 throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
158 throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
161 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
163 Signature* sig = entities.getSignature();
164 if (!sig && rootObject)
165 throw MetadataFilterException("Root metadata element was unsigned.");
166 verifySignature(sig, entities.getName());
168 VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
169 for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
171 verifySignature(v[i]->getSignature(), v[i]->getEntityID());
174 catch (exception& e) {
175 auto_ptr_char id(v[i]->getEntityID());
176 m_log.warn("filtering out entity (%s) after failed signature check: ", id.get(), e.what());
177 v.erase(v.begin() + i);
181 VectorOf(EntitiesDescriptor) w=entities.getEntitiesDescriptors();
182 for (VectorOf(EntitiesDescriptor)::size_type j=0; j<w.size(); ) {
184 verifySignature(w[j]->getSignature(), w[j]->getName());
187 catch (exception& e) {
188 auto_ptr_char name(w[j]->getName());
189 m_log.warn("filtering out group (%s) after failed signature check: ", name.get(), e.what());
190 w.erase(w.begin() + j);
195 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
200 m_profileValidator.validate(sig);
203 CredentialCriteria cc;
204 cc.setUsage(Credential::SIGNING_CREDENTIAL);
205 cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
207 auto_ptr_char pname(peerName);
208 cc.setPeerName(pname.get());
211 if (m_credResolver) {
212 Locker locker(m_credResolver);
213 vector<const Credential*> creds;
214 if (m_credResolver->resolve(creds,&cc)) {
215 SignatureValidator sigValidator;
216 for (vector<const Credential*>::const_iterator i = creds.begin(); i != creds.end(); ++i) {
218 sigValidator.setCredential(*i);
219 sigValidator.validate(sig);
225 throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
228 throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
232 DummyCredentialResolver dummy;
233 if (m_trust->validate(*sig, dummy, &cc))
235 throw MetadataFilterException("TrustEngine unable to verify signature.");
238 throw MetadataFilterException("Unable to verify signature.");