saml/saml2/metadata/impl/SignatureMetadataFilter.cpp

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