saml/saml2/metadata/impl/SignatureMetadataFilter.cpp

   1 /**
   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.
   6  *
   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
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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.
  19  */
  20
  21 /**
  22  * SignatureMetadataFilter.cpp
  23  *
  24  * Filters out unsigned or mis-signed elements.
  25  */
  26
  27 #include "internal.h"
  28 #include "saml2/metadata/Metadata.h"
  29 #include "saml2/metadata/MetadataFilter.h"
  30 #include "signature/SignatureProfileValidator.h"
  31
  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>
  41
  42 using namespace opensaml::saml2md;
  43 using namespace opensaml;
  44 using namespace xmlsignature;
  45 using namespace xmltooling::logging;
  46 using namespace xmltooling;
  47 using namespace std;
  48
  49 namespace opensaml {
  50     namespace saml2md {
  51
  52         class SAML_DLLLOCAL SignatureMetadataFilter : public MetadataFilter
  53         {
  54         public:
  55             SignatureMetadataFilter(const DOMElement* e);
  56             ~SignatureMetadataFilter() {}
  57
  58             const char* getId() const { return SIGNATURE_METADATA_FILTER; }
  59             void doFilter(XMLObject& xmlObject) const;
  60
  61         private:
  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;
  65
  66             bool m_verifyRoles,m_verifyName;
  67             auto_ptr<CredentialResolver> m_credResolver,m_dummyResolver;
  68             auto_ptr<SignatureTrustEngine> m_trust;
  69             SignatureProfileValidator m_profileValidator;
  70             Category& m_log;
  71         };
  72
  73         MetadataFilter* SAML_DLLLOCAL SignatureMetadataFilterFactory(const DOMElement* const & e)
  74         {
  75             return new SignatureMetadataFilter(e);
  76         }
  77
  78     };
  79 };
  80
  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);
  89
  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"))
  94 {
  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));
  98         return;
  99     }
 100
 101     DOMElement* sub = XMLHelper::getFirstChildElement(e, _CredentialResolver);
 102     if (sub) {
 103         string t = XMLHelper::getAttrString(sub, nullptr, type);
 104         if (!t.empty()) {
 105             m_credResolver.reset(XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.c_str(), sub));
 106             return;
 107         }
 108     }
 109
 110     sub = XMLHelper::getFirstChildElement(e, _TrustEngine);
 111     if (sub) {
 112         string t = XMLHelper::getAttrString(sub, nullptr, type);
 113         if (!t.empty()) {
 114             TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t.c_str(), sub);
 115             SignatureTrustEngine* sigTrust = dynamic_cast<SignatureTrustEngine*>(trust);
 116             if (!sigTrust) {
 117                 delete trust;
 118                 throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
 119             }
 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.");
 124             return;
 125         }
 126     }
 127
 128     throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
 129 }
 130
 131 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
 132 {
 133 #ifdef _DEBUG
 134     NDC ndc("doFilter");
 135 #endif
 136
 137     try {
 138         EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
 139         doFilter(entities, true);
 140         return;
 141     }
 142     catch (bad_cast&) {
 143     }
 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.");
 147     }
 148
 149     try {
 150         EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
 151         doFilter(entity, true);
 152         return;
 153     }
 154     catch (bad_cast&) {
 155     }
 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.");
 159     }
 160
 161     throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
 162 }
 163
 164 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
 165 {
 166     Signature* sig = entities.getSignature();
 167     if (!sig && rootObject)
 168         throw MetadataFilterException("Root metadata element was unsigned.");
 169     verifySignature(sig, entities.getName());
 170
 171     VectorOf(EntityDescriptor) v = entities.getEntityDescriptors();
 172     for (VectorOf(EntityDescriptor)::size_type i = 0; i < v.size(); ) {
 173         try {
 174             doFilter(*(v[i]));
 175             i++;
 176         }
 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);
 181         }
 182     }
 183
 184     VectorOf(EntitiesDescriptor) w = entities.getEntitiesDescriptors();
 185     for (VectorOf(EntitiesDescriptor)::size_type j = 0; j < w.size(); ) {
 186         try {
 187             doFilter(*w[j], false);
 188             j++;
 189         }
 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);
 194         }
 195     }
 196 }
 197
 198 void SignatureMetadataFilter::doFilter(EntityDescriptor& entity, bool rootObject) const
 199 {
 200     Signature* sig = entity.getSignature();
 201     if (!sig && rootObject)
 202         throw MetadataFilterException("Root metadata element was unsigned.");
 203     verifySignature(sig, entity.getEntityID());
 204
 205     if (!m_verifyRoles)
 206         return;
 207
 208     VectorOf(IDPSSODescriptor) idp = entity.getIDPSSODescriptors();
 209     for (VectorOf(IDPSSODescriptor)::size_type i = 0; i < idp.size(); ) {
 210         try {
 211             verifySignature(idp[i]->getSignature(), entity.getEntityID());
 212             i++;
 213         }
 214         catch (exception& e) {
 215             auto_ptr_char id(entity.getEntityID());
 216             m_log.warn(
 217                 "filtering out IDPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 218                 );
 219             idp.erase(idp.begin() + i);
 220         }
 221     }
 222
 223     VectorOf(SPSSODescriptor) sp = entity.getSPSSODescriptors();
 224     for (VectorOf(SPSSODescriptor)::size_type i = 0; i < sp.size(); ) {
 225         try {
 226             verifySignature(sp[i]->getSignature(), entity.getEntityID());
 227             i++;
 228         }
 229         catch (exception& e) {
 230             auto_ptr_char id(entity.getEntityID());
 231             m_log.warn(
 232                 "filtering out SPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 233                 );
 234             sp.erase(sp.begin() + i);
 235         }
 236     }
 237
 238     VectorOf(AuthnAuthorityDescriptor) authn = entity.getAuthnAuthorityDescriptors();
 239     for (VectorOf(AuthnAuthorityDescriptor)::size_type i = 0; i < authn.size(); ) {
 240         try {
 241             verifySignature(authn[i]->getSignature(), entity.getEntityID());
 242             i++;
 243         }
 244         catch (exception& e) {
 245             auto_ptr_char id(entity.getEntityID());
 246             m_log.warn(
 247                 "filtering out AuthnAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 248                 );
 249             authn.erase(authn.begin() + i);
 250         }
 251     }
 252
 253     VectorOf(AttributeAuthorityDescriptor) aa = entity.getAttributeAuthorityDescriptors();
 254     for (VectorOf(AttributeAuthorityDescriptor)::size_type i = 0; i < aa.size(); ) {
 255         try {
 256             verifySignature(aa[i]->getSignature(), entity.getEntityID());
 257             i++;
 258         }
 259         catch (exception& e) {
 260             auto_ptr_char id(entity.getEntityID());
 261             m_log.warn(
 262                 "filtering out AttributeAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 263                 );
 264             aa.erase(aa.begin() + i);
 265         }
 266     }
 267
 268     VectorOf(PDPDescriptor) pdp = entity.getPDPDescriptors();
 269     for (VectorOf(AuthnAuthorityDescriptor)::size_type i = 0; i < pdp.size(); ) {
 270         try {
 271             verifySignature(pdp[i]->getSignature(), entity.getEntityID());
 272             i++;
 273         }
 274         catch (exception& e) {
 275             auto_ptr_char id(entity.getEntityID());
 276             m_log.warn(
 277                 "filtering out PDPDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 278                 );
 279             pdp.erase(pdp.begin() + i);
 280         }
 281     }
 282
 283     VectorOf(AuthnQueryDescriptorType) authnq = entity.getAuthnQueryDescriptorTypes();
 284     for (VectorOf(AuthnQueryDescriptorType)::size_type i = 0; i < authnq.size(); ) {
 285         try {
 286             verifySignature(authnq[i]->getSignature(), entity.getEntityID());
 287             i++;
 288         }
 289         catch (exception& e) {
 290             auto_ptr_char id(entity.getEntityID());
 291             m_log.warn(
 292                 "filtering out AuthnQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
 293                 );
 294             authnq.erase(authnq.begin() + i);
 295         }
 296     }
 297
 298     VectorOf(AttributeQueryDescriptorType) attrq = entity.getAttributeQueryDescriptorTypes();
 299     for (VectorOf(AttributeQueryDescriptorType)::size_type i = 0; i < attrq.size(); ) {
 300         try {
 301             verifySignature(attrq[i]->getSignature(), entity.getEntityID());
 302             i++;
 303         }
 304         catch (exception& e) {
 305             auto_ptr_char id(entity.getEntityID());
 306             m_log.warn(
 307                 "filtering out AttributeQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
 308                 );
 309             attrq.erase(attrq.begin() + i);
 310         }
 311     }
 312
 313     VectorOf(AuthzDecisionQueryDescriptorType) authzq = entity.getAuthzDecisionQueryDescriptorTypes();
 314     for (VectorOf(AuthzDecisionQueryDescriptorType)::size_type i = 0; i < authzq.size(); ) {
 315         try {
 316             verifySignature(authzq[i]->getSignature(), entity.getEntityID());
 317             i++;
 318         }
 319         catch (exception& e) {
 320             auto_ptr_char id(entity.getEntityID());
 321             m_log.warn(
 322                 "filtering out AuthzDecisionQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
 323                 );
 324             authzq.erase(authzq.begin() + i);
 325         }
 326     }
 327
 328     VectorOf(RoleDescriptor) v = entity.getRoleDescriptors();
 329     for (VectorOf(RoleDescriptor)::size_type i = 0; i < v.size(); ) {
 330         try {
 331             verifySignature(v[i]->getSignature(), entity.getEntityID());
 332             i++;
 333         }
 334         catch (exception& e) {
 335             auto_ptr_char id(entity.getEntityID());
 336             m_log.warn(
 337                 "filtering out role (%s) for entity (%s) after failed signature check: %s",
 338                 v[i]->getElementQName().toString().c_str(), id.get(), e.what()
 339                 );
 340             v.erase(v.begin() + i);
 341         }
 342     }
 343
 344     if (entity.getAffiliationDescriptor()) {
 345         try {
 346             verifySignature(entity.getAffiliationDescriptor()->getSignature(), entity.getEntityID());
 347         }
 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);
 352         }
 353     }
 354 }
 355
 356 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
 357 {
 358     if (!sig)
 359         return;
 360
 361     m_profileValidator.validate(sig);
 362
 363     // Set up criteria.
 364     CredentialCriteria cc;
 365     cc.setUsage(Credential::SIGNING_CREDENTIAL);
 366     cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
 367
 368     if (m_credResolver.get()) {
 369         if (peerName) {
 370             auto_ptr_char pname(peerName);
 371             cc.setPeerName(pname.get());
 372         }
 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) {
 378                 try {
 379                     sigValidator.setCredential(*i);
 380                     sigValidator.validate(sig);
 381                     return; // success!
 382                 }
 383                 catch (exception&) {
 384                 }
 385             }
 386             throw MetadataFilterException("Unable to verify signature with supplied key(s).");
 387         }
 388         else {
 389             throw MetadataFilterException("CredentialResolver did not supply any candidate keys.");
 390         }
 391     }
 392     else if (m_trust.get()) {
 393         if (m_verifyName && peerName) {
 394             auto_ptr_char pname(peerName);
 395             cc.setPeerName(pname.get());
 396         }
 397         if (m_trust->validate(*sig, *m_dummyResolver, &cc))
 398             return;
 399         throw MetadataFilterException("TrustEngine unable to verify signature.");
 400     }
 401
 402     throw MetadataFilterException("Unable to verify signature.");
 403 }