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