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;
  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
 101 SignatureMetadataFilter::SignatureMetadataFilter(const DOMElement* e)
 102     : m_verifyRoles(false), m_credResolver(NULL), m_trust(NULL), m_log(Category::getInstance(SAML_LOGCAT".MetadataFilter.Signature"))
 103 {
 104     const XMLCh* flag = e ? e->getAttributeNS(NULL,verifyRoles) : NULL;
 105     m_verifyRoles = (flag && (*flag == chLatin_t || *flag == chDigit_1));
 106
 107     if (e && e->hasAttributeNS(NULL,certificate)) {
 108         // Use a file-based credential resolver rooted here.
 109         m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(FILESYSTEM_CREDENTIAL_RESOLVER,e);
 110         return;
 111     }
 112
 113     DOMElement* sub = e ? XMLHelper::getFirstChildElement(e, _CredentialResolver) : NULL;
 114     auto_ptr_char t(sub ? sub->getAttributeNS(NULL,type) : NULL);
 115     if (t.get()) {
 116         m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.get(),sub);
 117         return;
 118     }
 119
 120     sub = e ? XMLHelper::getFirstChildElement(e, _TrustEngine) : NULL;
 121     auto_ptr_char t2(sub ? sub->getAttributeNS(NULL,type) : NULL);
 122     if (t2.get()) {
 123         TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t2.get(),sub);
 124         if (!(m_trust = dynamic_cast<SignatureTrustEngine*>(trust))) {
 125             delete trust;
 126             throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
 127         }
 128         return;
 129     }
 130
 131     throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
 132 }
 133
 134 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
 135 {
 136 #ifdef _DEBUG
 137     NDC ndc("doFilter");
 138 #endif
 139
 140     try {
 141         EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
 142         doFilter(entities, true);
 143         return;
 144     }
 145     catch (bad_cast) {
 146     }
 147     catch (exception& ex) {
 148         m_log.warn("filtering out group at root of instance after failed signature check: %s", ex.what());
 149         throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
 150     }
 151
 152     try {
 153         EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
 154         doFilter(entity, true);
 155         return;
 156     }
 157     catch (bad_cast) {
 158     }
 159     catch (exception& ex) {
 160         m_log.warn("filtering out entity at root of instance after failed signature check: %s", ex.what());
 161         throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
 162     }
 163
 164     throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
 165 }
 166
 167 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
 168 {
 169     Signature* sig = entities.getSignature();
 170     if (!sig && rootObject)
 171         throw MetadataFilterException("Root metadata element was unsigned.");
 172     verifySignature(sig, entities.getName());
 173
 174     VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
 175     for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
 176         try {
 177             doFilter(*(v[i]));
 178             i++;
 179         }
 180         catch (exception& e) {
 181             auto_ptr_char id(v[i]->getEntityID());
 182             m_log.warn("filtering out entity (%s) after failed signature check: %s", id.get(), e.what());
 183             v.erase(v.begin() + i);
 184         }
 185     }
 186
 187     VectorOf(EntitiesDescriptor) w=entities.getEntitiesDescriptors();
 188     for (VectorOf(EntitiesDescriptor)::size_type j=0; j<w.size(); ) {
 189         try {
 190             doFilter(*w[j], false);
 191             j++;
 192         }
 193         catch (exception& e) {
 194             auto_ptr_char name(w[j]->getName());
 195             m_log.warn("filtering out group (%s) after failed signature check: %s", name.get(), e.what());
 196             w.erase(w.begin() + j);
 197         }
 198     }
 199 }
 200
 201 void SignatureMetadataFilter::doFilter(EntityDescriptor& entity, bool rootObject) const
 202 {
 203     Signature* sig = entity.getSignature();
 204     if (!sig && rootObject)
 205         throw MetadataFilterException("Root metadata element was unsigned.");
 206     verifySignature(sig, entity.getEntityID());
 207
 208     if (!m_verifyRoles)
 209         return;
 210
 211     VectorOf(IDPSSODescriptor) idp=entity.getIDPSSODescriptors();
 212     for (VectorOf(IDPSSODescriptor)::size_type i=0; i<idp.size(); ) {
 213         try {
 214             verifySignature(idp[i]->getSignature(), entity.getEntityID());
 215             i++;
 216         }
 217         catch (exception& e) {
 218             auto_ptr_char id(entity.getEntityID());
 219             m_log.warn(
 220                 "filtering out IDPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 221                 );
 222             idp.erase(idp.begin() + i);
 223         }
 224     }
 225
 226     VectorOf(SPSSODescriptor) sp=entity.getSPSSODescriptors();
 227     for (VectorOf(SPSSODescriptor)::size_type i=0; i<sp.size(); ) {
 228         try {
 229             verifySignature(sp[i]->getSignature(), entity.getEntityID());
 230             i++;
 231         }
 232         catch (exception& e) {
 233             auto_ptr_char id(entity.getEntityID());
 234             m_log.warn(
 235                 "filtering out SPSSODescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 236                 );
 237             sp.erase(sp.begin() + i);
 238         }
 239     }
 240
 241     VectorOf(AuthnAuthorityDescriptor) authn=entity.getAuthnAuthorityDescriptors();
 242     for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<authn.size(); ) {
 243         try {
 244             verifySignature(authn[i]->getSignature(), entity.getEntityID());
 245             i++;
 246         }
 247         catch (exception& e) {
 248             auto_ptr_char id(entity.getEntityID());
 249             m_log.warn(
 250                 "filtering out AuthnAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 251                 );
 252             authn.erase(authn.begin() + i);
 253         }
 254     }
 255
 256     VectorOf(AttributeAuthorityDescriptor) aa=entity.getAttributeAuthorityDescriptors();
 257     for (VectorOf(AttributeAuthorityDescriptor)::size_type i=0; i<aa.size(); ) {
 258         try {
 259             verifySignature(aa[i]->getSignature(), entity.getEntityID());
 260             i++;
 261         }
 262         catch (exception& e) {
 263             auto_ptr_char id(entity.getEntityID());
 264             m_log.warn(
 265                 "filtering out AttributeAuthorityDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 266                 );
 267             aa.erase(aa.begin() + i);
 268         }
 269     }
 270
 271     VectorOf(PDPDescriptor) pdp=entity.getPDPDescriptors();
 272     for (VectorOf(AuthnAuthorityDescriptor)::size_type i=0; i<pdp.size(); ) {
 273         try {
 274             verifySignature(pdp[i]->getSignature(), entity.getEntityID());
 275             i++;
 276         }
 277         catch (exception& e) {
 278             auto_ptr_char id(entity.getEntityID());
 279             m_log.warn(
 280                 "filtering out PDPDescriptor for entity (%s) after failed signature check: %s", id.get(), e.what()
 281                 );
 282             pdp.erase(pdp.begin() + i);
 283         }
 284     }
 285
 286     VectorOf(AuthnQueryDescriptorType) authnq=entity.getAuthnQueryDescriptorTypes();
 287     for (VectorOf(AuthnQueryDescriptorType)::size_type i=0; i<authnq.size(); ) {
 288         try {
 289             verifySignature(authnq[i]->getSignature(), entity.getEntityID());
 290             i++;
 291         }
 292         catch (exception& e) {
 293             auto_ptr_char id(entity.getEntityID());
 294             m_log.warn(
 295                 "filtering out AuthnQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
 296                 );
 297             authnq.erase(authnq.begin() + i);
 298         }
 299     }
 300
 301     VectorOf(AttributeQueryDescriptorType) attrq=entity.getAttributeQueryDescriptorTypes();
 302     for (VectorOf(AttributeQueryDescriptorType)::size_type i=0; i<attrq.size(); ) {
 303         try {
 304             verifySignature(attrq[i]->getSignature(), entity.getEntityID());
 305             i++;
 306         }
 307         catch (exception& e) {
 308             auto_ptr_char id(entity.getEntityID());
 309             m_log.warn(
 310                 "filtering out AttributeQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
 311                 );
 312             attrq.erase(attrq.begin() + i);
 313         }
 314     }
 315
 316     VectorOf(AuthzDecisionQueryDescriptorType) authzq=entity.getAuthzDecisionQueryDescriptorTypes();
 317     for (VectorOf(AuthzDecisionQueryDescriptorType)::size_type i=0; i<authzq.size(); ) {
 318         try {
 319             verifySignature(authzq[i]->getSignature(), entity.getEntityID());
 320             i++;
 321         }
 322         catch (exception& e) {
 323             auto_ptr_char id(entity.getEntityID());
 324             m_log.warn(
 325                 "filtering out AuthzDecisionQueryDescriptorType for entity (%s) after failed signature check: %s", id.get(), e.what()
 326                 );
 327             authzq.erase(authzq.begin() + i);
 328         }
 329     }
 330
 331     VectorOf(RoleDescriptor) v=entity.getRoleDescriptors();
 332     for (VectorOf(RoleDescriptor)::size_type i=0; i<v.size(); ) {
 333         try {
 334             verifySignature(v[i]->getSignature(), entity.getEntityID());
 335             i++;
 336         }
 337         catch (exception& e) {
 338             auto_ptr_char id(entity.getEntityID());
 339             m_log.warn(
 340                 "filtering out role (%s) for entity (%s) after failed signature check: %s",
 341                 v[i]->getElementQName().toString().c_str(), id.get(), e.what()
 342                 );
 343             v.erase(v.begin() + i);
 344         }
 345     }
 346
 347     if (entity.getAffiliationDescriptor()) {
 348         try {
 349             verifySignature(entity.getAffiliationDescriptor()->getSignature(), entity.getEntityID());
 350         }
 351         catch (exception& e) {
 352             auto_ptr_char id(entity.getEntityID());
 353             m_log.warn("filtering out affiliation from entity (%s) after failed signature check: %s", id.get(), e.what());
 354             entity.setAffiliationDescriptor(NULL);
 355         }
 356     }
 357 }
 358
 359 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
 360 {
 361     if (!sig)
 362         return;
 363
 364     m_profileValidator.validate(sig);
 365
 366     // Set up criteria.
 367     CredentialCriteria cc;
 368     cc.setUsage(Credential::SIGNING_CREDENTIAL);
 369     cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
 370     if (peerName) {
 371         auto_ptr_char pname(peerName);
 372         cc.setPeerName(pname.get());
 373     }
 374
 375     if (m_credResolver) {
 376         Locker locker(m_credResolver);
 377         vector<const Credential*> creds;
 378         if (m_credResolver->resolve(creds,&cc)) {
 379             SignatureValidator sigValidator;
 380             for (vector<const Credential*>::const_iterator i = creds.begin(); i != creds.end(); ++i) {
 381                 try {
 382                     sigValidator.setCredential(*i);
 383                     sigValidator.validate(sig);
 384                     return; // success!
 385                 }
 386                 catch (exception&) {
 387                 }
 388             }
 389             throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
 390         }
 391         else {
 392             throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
 393         }
 394     }
 395     else if (m_trust) {
 396         DummyCredentialResolver dummy;
 397         if (m_trust->validate(*sig, dummy, &cc))
 398             return;
 399         throw MetadataFilterException("TrustEngine unable to verify signature.");
 400     }
 401
 402     throw MetadataFilterException("Unable to verify signature.");
 403 }