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             }
  68
  69             const char* getId() const { return SIGNATURE_METADATA_FILTER; }
  70             void doFilter(XMLObject& xmlObject) const;
  71
  72         private:
  73             void doFilter(EntitiesDescriptor& entities, bool rootObject=false) const;
  74             void doFilter(EntityDescriptor& entity, bool rootObject=false) const;
  75             void verifySignature(Signature* sig, const XMLCh* peerName) const;
  76
  77             CredentialResolver* m_credResolver;
  78             SignatureTrustEngine* m_trust;
  79             SignatureProfileValidator m_profileValidator;
  80             Category& m_log;
  81         };
  82
  83         MetadataFilter* SAML_DLLLOCAL SignatureMetadataFilterFactory(const DOMElement* const & e)
  84         {
  85             return new SignatureMetadataFilter(e);
  86         }
  87
  88     };
  89 };
  90
  91 static const XMLCh _TrustEngine[] =         UNICODE_LITERAL_11(T,r,u,s,t,E,n,g,i,n,e);
  92 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);
  93 static const XMLCh type[] =                 UNICODE_LITERAL_4(t,y,p,e);
  94 static const XMLCh certificate[] =          UNICODE_LITERAL_11(c,e,r,t,i,f,i,c,a,t,e);
  95 static const XMLCh Certificate[] =          UNICODE_LITERAL_11(C,e,r,t,i,f,i,c,a,t,e);
  96 static const XMLCh Path[] =                 UNICODE_LITERAL_4(P,a,t,h);
  97
  98 SignatureMetadataFilter::SignatureMetadataFilter(const DOMElement* e)
  99     : m_credResolver(NULL), m_trust(NULL), m_log(Category::getInstance(SAML_LOGCAT".MetadataFilter.Signature"))
 100 {
 101     if (e && e->hasAttributeNS(NULL,certificate)) {
 102         // Use a file-based credential resolver rooted here.
 103         m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(FILESYSTEM_CREDENTIAL_RESOLVER,e);
 104         return;
 105     }
 106
 107     DOMElement* sub = e ? XMLHelper::getFirstChildElement(e, _CredentialResolver) : NULL;
 108     auto_ptr_char t(sub ? sub->getAttributeNS(NULL,type) : NULL);
 109     if (t.get()) {
 110         m_credResolver = XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(t.get(),sub);
 111         return;
 112     }
 113
 114     sub = e ? XMLHelper::getFirstChildElement(e, _TrustEngine) : NULL;
 115     auto_ptr_char t2(sub ? sub->getAttributeNS(NULL,type) : NULL);
 116     if (t2.get()) {
 117         TrustEngine* trust = XMLToolingConfig::getConfig().TrustEngineManager.newPlugin(t2.get(),sub);
 118         if (!(m_trust = dynamic_cast<SignatureTrustEngine*>(trust))) {
 119             delete trust;
 120             throw MetadataFilterException("TrustEngine-based SignatureMetadataFilter requires a SignatureTrustEngine plugin.");
 121         }
 122         return;
 123     }
 124
 125     throw MetadataFilterException("SignatureMetadataFilter configuration requires <CredentialResolver> or <TrustEngine> element.");
 126 }
 127
 128 void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
 129 {
 130 #ifdef _DEBUG
 131     NDC ndc("doFilter");
 132 #endif
 133
 134     try {
 135         EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
 136         doFilter(entities, true);
 137         return;
 138     }
 139     catch (bad_cast) {
 140     }
 141     catch (exception& ex) {
 142         m_log.warn("filtering out group at root of instance after failed signature check: %s", ex.what());
 143         throw MetadataFilterException("SignatureMetadataFilter unable to verify signature at root of metadata instance.");
 144     }
 145
 146     try {
 147         EntityDescriptor& entity = dynamic_cast<EntityDescriptor&>(xmlObject);
 148         doFilter(entity, true);
 149         return;
 150     }
 151     catch (bad_cast) {
 152     }
 153     catch (exception& ex) {
 154         m_log.warn("filtering out entity 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     throw MetadataFilterException("SignatureMetadataFilter was given an improper metadata instance to filter.");
 159 }
 160
 161 void SignatureMetadataFilter::doFilter(EntitiesDescriptor& entities, bool rootObject) const
 162 {
 163     Signature* sig = entities.getSignature();
 164     if (!sig && rootObject)
 165         throw MetadataFilterException("Root metadata element was unsigned.");
 166     verifySignature(sig, entities.getName());
 167
 168     VectorOf(EntityDescriptor) v=entities.getEntityDescriptors();
 169     for (VectorOf(EntityDescriptor)::size_type i=0; i<v.size(); ) {
 170         try {
 171             doFilter(*(v[i]));
 172             i++;
 173         }
 174         catch (exception& e) {
 175             auto_ptr_char id(v[i]->getEntityID());
 176             m_log.warn("filtering out entity (%s) after failed signature check: %s", id.get(), e.what());
 177             v.erase(v.begin() + i);
 178         }
 179     }
 180
 181     VectorOf(EntitiesDescriptor) w=entities.getEntitiesDescriptors();
 182     for (VectorOf(EntitiesDescriptor)::size_type j=0; j<w.size(); ) {
 183         try {
 184             doFilter(*w[j], false);
 185             j++;
 186         }
 187         catch (exception& e) {
 188             auto_ptr_char name(w[j]->getName());
 189             m_log.warn("filtering out group (%s) after failed signature check: %s", name.get(), e.what());
 190             w.erase(w.begin() + j);
 191         }
 192     }
 193 }
 194
 195 void SignatureMetadataFilter::doFilter(EntityDescriptor& entity, bool rootObject) const
 196 {
 197     Signature* sig = entity.getSignature();
 198     if (!sig && rootObject)
 199         throw MetadataFilterException("Root metadata element was unsigned.");
 200     verifySignature(sig, entity.getEntityID());
 201
 202     VectorOf(RoleDescriptor) v=entity.getRoleDescriptors();
 203     for (VectorOf(RoleDescriptor)::size_type i=0; i<v.size(); ) {
 204         try {
 205             verifySignature(v[i]->getSignature(), entity.getEntityID());
 206             i++;
 207         }
 208         catch (exception& e) {
 209             auto_ptr_char id(entity.getEntityID());
 210             m_log.warn(
 211                 "filtering out role (%s) for entity (%s) after failed signature check: %s",
 212                 v[i]->getElementQName().toString().c_str(), id.get(), e.what()
 213                 );
 214             v.erase(v.begin() + i);
 215         }
 216     }
 217
 218     if (entity.getAffiliationDescriptor()) {
 219         try {
 220             verifySignature(entity.getAffiliationDescriptor()->getSignature(), entity.getEntityID());
 221         }
 222         catch (exception& e) {
 223             auto_ptr_char id(entity.getEntityID());
 224             m_log.warn("filtering out affiliation from entity (%s) after failed signature check: %s", id.get(), e.what());
 225             entity.setAffiliationDescriptor(NULL);
 226         }
 227     }
 228 }
 229
 230 void SignatureMetadataFilter::verifySignature(Signature* sig, const XMLCh* peerName) const
 231 {
 232     if (!sig)
 233         return;
 234
 235     m_profileValidator.validate(sig);
 236
 237     // Set up criteria.
 238     CredentialCriteria cc;
 239     cc.setUsage(Credential::SIGNING_CREDENTIAL);
 240     cc.setSignature(*sig, CredentialCriteria::KEYINFO_EXTRACTION_KEY);
 241     if (peerName) {
 242         auto_ptr_char pname(peerName);
 243         cc.setPeerName(pname.get());
 244     }
 245
 246     if (m_credResolver) {
 247         Locker locker(m_credResolver);
 248         vector<const Credential*> creds;
 249         if (m_credResolver->resolve(creds,&cc)) {
 250             SignatureValidator sigValidator;
 251             for (vector<const Credential*>::const_iterator i = creds.begin(); i != creds.end(); ++i) {
 252                 try {
 253                     sigValidator.setCredential(*i);
 254                     sigValidator.validate(sig);
 255                     return; // success!
 256                 }
 257                 catch (exception&) {
 258                 }
 259             }
 260             throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
 261         }
 262         else {
 263             throw MetadataFilterException("CredentialResolver did not supply a successful verification key.");
 264         }
 265     }
 266     else if (m_trust) {
 267         DummyCredentialResolver dummy;
 268         if (m_trust->validate(*sig, dummy, &cc))
 269             return;
 270         throw MetadataFilterException("TrustEngine unable to verify signature.");
 271     }
 272
 273     throw MetadataFilterException("Unable to verify signature.");
 274 }