saml/saml2/metadata/impl/SignatureMetadataFilter.cpp

   1 /*
   2  *  Copyright 2001-2008 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * SignatureMetadataFilter.cpp
  19  *
  20  * Filters out unsigned or mis-signed elements.
  21  */
  22
  23 #include "internal.h"
  24 #include "saml2/metadata/Metadata.h"
  25 #include "saml2/metadata/MetadataFilter.h"
  26 #include "signature/SignatureProfileValidator.h"
  27
  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>
  35
  36 using namespace opensaml::saml2md;
  37 using namespace opensaml;
  38 using namespace xmlsignature;
  39 using namespace xmltooling::logging;
  40 using namespace xmltooling;
  41 using namespace std;
  42
  43 namespace opensaml {
  44     namespace saml2md {
  45
  46         class SAML_DLLLOCAL DummyCredentialResolver : public CredentialResolver
  47         {
  48         public:
  49             DummyCredentialResolver() {}
  50             ~DummyCredentialResolver() {}
  51
  52             Lockable* lock() {return this;}
  53             void unlock() {}
  54
  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
  58                 ) const {return 0;}
  59         };
  60
  61         class SAML_DLLLOCAL SignatureMetadataFilter : public MetadataFilter
  62         {
  63         public:
  64             SignatureMetadataFilter(const DOMElement* e);
  65             ~SignatureMetadataFilter() {
  66                 delete m_credResolver;
  67                 delete m_trust;
  68             }
  69
  70             const char* getId() const { return SIGNATURE_METADATA_FILTER; }
  71             void doFilter(XMLObject& xmlObject) const;
  72
  73         private:
  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;
  77
  78             bool m_verifyRoles,m_verifyName;
  79             CredentialResolver* m_credResolver;
  80             SignatureTrustEngine* m_trust;
  81             SignatureProfileValidator m_profileValidator;
  82             Category& m_log;
  83         };
  84
  85         MetadataFilter* SAML_DLLLOCAL SignatureMetadataFilterFactory(const DOMElement* const & e)
  86         {
  87             return new SignatureMetadataFilter(e);
  88         }
  89
  90     };
  91 };
  92
  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);
 101
 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"))
 104 {
 105     const XMLCh* flag = e ? e->getAttributeNS(NULL,verifyRoles) : NULL;
 106     m_verifyRoles = (flag && (*flag == chLatin_t || *flag == chDigit_1));
 107
 108     flag = e ? e->getAttributeNS(NULL,verifyName) : NULL;
 109     m_verifyName = !(flag && (*flag == chLatin_f || *flag == chDigit_0));
 110
 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);
 114         return;
 115     }
 116
 117     DOMElement* sub = e ? XMLHelper::getFirstChildElement(e, _CredentialResolver) : NULL;
 118     auto_ptr_char t(sub ? sub->getAttributeNS(NULL,type) : NULL);
 119     if (t.get()) {
 120         m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.get(),sub);
 121         return;
 122     }
 123
 124     sub = e ? XMLHelper::getFirstChildElement(e, _TrustEngine) : NULL;
 125     auto_ptr_char t2(sub ? sub->getAttributeNS(NULL,type) : NULL);
 126     if (t2.get()) {
 127         TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t2.get(),sub);
 128         if (!(m_trust = dynamic_cast<SignatureTrustEngine*>(trust))) {
 129             delete trust;
 130             throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
 131         }
 132         return;
 133     }
 134
 135     throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
 136 }
 137
 138 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
 139 {
 140 #ifdef _DEBUG
 141     NDC ndc("doFilter");
 142 #endif
 143
 144     try {
 145         EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
 146         doFilter(entities, true);
 147         return;
 148     }
 149     catch (bad_cast) {
 150     }
 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.");
 154     }
 155
 156     try {
 157         EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
 158         doFilter(entity, true);
 159         return;
 160     }
 161     catch (bad_cast) {
 162     }
 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.");
 166     }
 167
 168     throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
 169 }
 170
 171 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
 172 {
 173     Signature* sig = entities.getSignature();
 174     if (!sig && rootObject)
 175         throw MetadataFilterException("Root metadata element was unsigned.");
 176     verifySignature(sig, entities.getName());
 177
 178     VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
 179     for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
 180         try {
 181             doFilter(*(v[i]));
 182             i++;
 183         }
 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);
 188         }
 189     }
 190
 191     VectorOf(EntitiesDescriptor) w=entities.getEntitiesDescriptors();
 192     for (VectorOf(EntitiesDescriptor)::size_type j=0; j<w.size(); ) {
 193         try {
 194             doFilter(*w[j], false);
 195             j++;
 196         }
 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);
 201         }
 202     }
 203 }
 204
 205 void SignatureMetadataFilter::doFilter(EntityDescriptor& entity, bool rootObject) const
 206 {
 207     Signature* sig = entity.getSignature();
 208     if (!sig && rootObject)
 209         throw MetadataFilterException("Root metadata element was unsigned.");
 210     verifySignature(sig, entity.getEntityID());
 211
 212     if (!m_verifyRoles)
 213         return;
 214
 215     VectorOf(IDPSSODescriptor) idp=entity.getIDPSSODescriptors();
 216     for (VectorOf(IDPSSODescriptor)::size_type i=0; i<idp.size(); ) {
 217         try {
 218             verifySignature(idp[i]->getSignature(), entity.getEntityID());
 219             i++;
 220         }
 221         catch (exception& e) {
 222             auto_ptr_char id(entity.getEntityID());
 223             m_log.warn(
 224                 "filtering out IDPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 225                 );
 226             idp.erase(idp.begin() + i);
 227         }
 228     }
 229
 230     VectorOf(SPSSODescriptor) sp=entity.getSPSSODescriptors();
 231     for (VectorOf(SPSSODescriptor)::size_type i=0; i<sp.size(); ) {
 232         try {
 233             verifySignature(sp[i]->getSignature(), entity.getEntityID());
 234             i++;
 235         }
 236         catch (exception& e) {
 237             auto_ptr_char id(entity.getEntityID());
 238             m_log.warn(
 239                 "filtering out SPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 240                 );
 241             sp.erase(sp.begin() + i);
 242         }
 243     }
 244
 245     VectorOf(AuthnAuthorityDescriptor) authn=entity.getAuthnAuthorityDescriptors();
 246     for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<authn.size(); ) {
 247         try {
 248             verifySignature(authn[i]->getSignature(), entity.getEntityID());
 249             i++;
 250         }
 251         catch (exception& e) {
 252             auto_ptr_char id(entity.getEntityID());
 253             m_log.warn(
 254                 "filtering out AuthnAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 255                 );
 256             authn.erase(authn.begin() + i);
 257         }
 258     }
 259
 260     VectorOf(AttributeAuthorityDescriptor) aa=entity.getAttributeAuthorityDescriptors();
 261     for (VectorOf(AttributeAuthorityDescriptor)::size_type i=0; i<aa.size(); ) {
 262         try {
 263             verifySignature(aa[i]->getSignature(), entity.getEntityID());
 264             i++;
 265         }
 266         catch (exception& e) {
 267             auto_ptr_char id(entity.getEntityID());
 268             m_log.warn(
 269                 "filtering out AttributeAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 270                 );
 271             aa.erase(aa.begin() + i);
 272         }
 273     }
 274
 275     VectorOf(PDPDescriptor) pdp=entity.getPDPDescriptors();
 276     for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<pdp.size(); ) {
 277         try {
 278             verifySignature(pdp[i]->getSignature(), entity.getEntityID());
 279             i++;
 280         }
 281         catch (exception& e) {
 282             auto_ptr_char id(entity.getEntityID());
 283             m_log.warn(
 284                 "filtering out PDPDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 285                 );
 286             pdp.erase(pdp.begin() + i);
 287         }
 288     }
 289
 290     VectorOf(AuthnQueryDescriptorType) authnq=entity.getAuthnQueryDescriptorTypes();
 291     for (VectorOf(AuthnQueryDescriptorType)::size_type i=0; i<authnq.size(); ) {
 292         try {
 293             verifySignature(authnq[i]->getSignature(), entity.getEntityID());
 294             i++;
 295         }
 296         catch (exception& e) {
 297             auto_ptr_char id(entity.getEntityID());
 298             m_log.warn(
 299                 "filtering out AuthnQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
 300                 );
 301             authnq.erase(authnq.begin() + i);
 302         }
 303     }
 304
 305     VectorOf(AttributeQueryDescriptorType) attrq=entity.getAttributeQueryDescriptorTypes();
 306     for (VectorOf(AttributeQueryDescriptorType)::size_type i=0; i<attrq.size(); ) {
 307         try {
 308             verifySignature(attrq[i]->getSignature(), entity.getEntityID());
 309             i++;
 310         }
 311         catch (exception& e) {
 312             auto_ptr_char id(entity.getEntityID());
 313             m_log.warn(
 314                 "filtering out AttributeQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
 315                 );
 316             attrq.erase(attrq.begin() + i);
 317         }
 318     }
 319
 320     VectorOf(AuthzDecisionQueryDescriptorType) authzq=entity.getAuthzDecisionQueryDescriptorTypes();
 321     for (VectorOf(AuthzDecisionQueryDescriptorType)::size_type i=0; i<authzq.size(); ) {
 322         try {
 323             verifySignature(authzq[i]->getSignature(), entity.getEntityID());
 324             i++;
 325         }
 326         catch (exception& e) {
 327             auto_ptr_char id(entity.getEntityID());
 328             m_log.warn(
 329                 "filtering out AuthzDecisionQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
 330                 );
 331             authzq.erase(authzq.begin() + i);
 332         }
 333     }
 334
 335     VectorOf(RoleDescriptor) v=entity.getRoleDescriptors();
 336     for (VectorOf(RoleDescriptor)::size_type i=0; i<v.size(); ) {
 337         try {
 338             verifySignature(v[i]->getSignature(), entity.getEntityID());
 339             i++;
 340         }
 341         catch (exception& e) {
 342             auto_ptr_char id(entity.getEntityID());
 343             m_log.warn(
 344                 "filtering out role (%s) for entity (%s) after failed signature check: %s",
 345                 v[i]->getElementQName().toString().c_str(), id.get(), e.what()
 346                 );
 347             v.erase(v.begin() + i);
 348         }
 349     }
 350
 351     if (entity.getAffiliationDescriptor()) {
 352         try {
 353             verifySignature(entity.getAffiliationDescriptor()->getSignature(), entity.getEntityID());
 354         }
 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);
 359         }
 360     }
 361 }
 362
 363 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
 364 {
 365     if (!sig)
 366         return;
 367
 368     m_profileValidator.validate(sig);
 369
 370     // Set up criteria.
 371     CredentialCriteria cc;
 372     cc.setUsage(Credential::SIGNING_CREDENTIAL);
 373     cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
 374
 375     if (m_credResolver) {
 376         if (peerName) {
 377             auto_ptr_char pname(peerName);
 378             cc.setPeerName(pname.get());
 379         }
 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) {
 385                 try {
 386                     sigValidator.setCredential(*i);
 387                     sigValidator.validate(sig);
 388                     return; // success!
 389                 }
 390                 catch (exception&) {
 391                 }
 392             }
 393             throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
 394         }
 395         else {
 396             throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
 397         }
 398     }
 399     else if (m_trust) {
 400         if (m_verifyName && peerName) {
 401             auto_ptr_char pname(peerName);
 402             cc.setPeerName(pname.get());
 403         }
 404         DummyCredentialResolver dummy;
 405         if (m_trust->validate(*sig, dummy, &cc))
 406             return;
 407         throw MetadataFilterException("TrustEngine unable to verify signature.");
 408     }
 409
 410     throw MetadataFilterException("Unable to verify signature.");
 411 }