saml/binding/impl/XMLSigningRule.cpp

   1 /*
   2  *  Copyright 2001-2007 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  * XMLSigningRule.cpp
  19  *
  20  * XML Signature checking SecurityPolicyRule
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "binding/SecurityPolicyRule.h"
  26 #include "saml2/core/Assertions.h"
  27 #include "saml2/metadata/Metadata.h"
  28 #include "saml2/metadata/MetadataCredentialCriteria.h"
  29 #include "saml2/metadata/MetadataProvider.h"
  30 #include "signature/SignatureProfileValidator.h"
  31
  32 #include <xmltooling/logging.h>
  33 #include <xmltooling/security/SignatureTrustEngine.h>
  34
  35 using namespace opensaml::saml2md;
  36 using namespace opensaml;
  37 using namespace xmltooling::logging;
  38 using namespace xmltooling;
  39 using namespace std;
  40
  41 using xmlsignature::SignatureException;
  42
  43 namespace opensaml {
  44     class SAML_DLLLOCAL XMLSigningRule : public SecurityPolicyRule
  45     {
  46     public:
  47         XMLSigningRule(const DOMElement* e);
  48         virtual ~XMLSigningRule() {}
  49
  50         void evaluate(const xmltooling::XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const;
  51
  52     private:
  53         bool m_errorsFatal;
  54     };
  55
  56     SecurityPolicyRule* SAML_DLLLOCAL XMLSigningRuleFactory(const DOMElement* const & e)
  57     {
  58         return new XMLSigningRule(e);
  59     }
  60
  61     static const XMLCh errorsFatal[] = UNICODE_LITERAL_11(e,r,r,o,r,s,F,a,t,a,l);
  62 };
  63
  64 XMLSigningRule::XMLSigningRule(const DOMElement* e) : m_errorsFatal(false)
  65 {
  66     if (e) {
  67         const XMLCh* flag = e->getAttributeNS(NULL, errorsFatal);
  68         m_errorsFatal = (flag && (*flag==chLatin_t || *flag==chDigit_1));
  69     }
  70 }
  71
  72 void XMLSigningRule::evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const
  73 {
  74     Category& log=Category::getInstance(SAML_LOGCAT".SecurityPolicyRule.XMLSigning");
  75
  76     if (!policy.getIssuerMetadata()) {
  77         log.debug("ignoring message, no issuer metadata supplied");
  78         return;
  79     }
  80
  81     const SignatureTrustEngine* sigtrust;
  82     if (!(sigtrust=dynamic_cast<const SignatureTrustEngine*>(policy.getTrustEngine()))) {
  83         log.debug("ignoring message, no SignatureTrustEngine supplied");
  84         return;
  85     }
  86
  87     const SignableObject* signable = dynamic_cast<const SignableObject*>(&message);
  88     if (!signable || !signable->getSignature())
  89         return;
  90
  91     log.debug("validating signature profile");
  92     try {
  93         SignatureProfileValidator sigval;
  94         sigval.validateSignature(*(signable->getSignature()));
  95     }
  96     catch (ValidationException& ve) {
  97         log.error("signature profile failed to validate: %s", ve.what());
  98         if (m_errorsFatal)
  99             throw;
 100         return;
 101     }
 102
 103     // Set up criteria object.
 104     MetadataCredentialCriteria cc(*(policy.getIssuerMetadata()));
 105
 106     if (!sigtrust->validate(*(signable->getSignature()), *(policy.getMetadataProvider()), &cc)) {
 107         log.error("unable to verify message signature with supplied trust engine");
 108         if (m_errorsFatal)
 109             throw SignatureException("Message was signed, but signature could not be verified.");
 110         return;
 111     }
 112
 113     log.debug("signature verified against message issuer");
 114     policy.setSecure(true);
 115 }