saml/binding/impl/SimpleSigningRule.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  * SimpleSigningRule.cpp
  19  *
  20  * Blob-oriented signature checking SecurityPolicyRule.
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "binding/SecurityPolicy.h"
  26 #include "binding/SecurityPolicyRule.h"
  27 #include "saml2/core/Assertions.h"
  28 #include "saml2/metadata/Metadata.h"
  29 #include "saml2/metadata/MetadataCredentialCriteria.h"
  30 #include "saml2/metadata/MetadataProvider.h"
  31
  32 #include <xercesc/util/Base64.hpp>
  33 #include <xmltooling/logging.h>
  34 #include <xmltooling/XMLToolingConfig.h>
  35 #include <xmltooling/io/HTTPRequest.h>
  36 #include <xmltooling/security/SignatureTrustEngine.h>
  37 #include <xmltooling/signature/KeyInfo.h>
  38 #include <xmltooling/signature/Signature.h>
  39 #include <xmltooling/util/ParserPool.h>
  40
  41 using namespace opensaml::saml2md;
  42 using namespace opensaml;
  43 using namespace xmltooling::logging;
  44 using namespace xmltooling;
  45 using namespace std;
  46
  47 using xmlsignature::KeyInfo;
  48 using xmlsignature::SignatureException;
  49
  50 namespace opensaml {
  51     class SAML_DLLLOCAL SimpleSigningRule : public SecurityPolicyRule
  52     {
  53     public:
  54         SimpleSigningRule(const DOMElement* e);
  55         virtual ~SimpleSigningRule() {}
  56
  57         const char* getType() const {
  58             return SIMPLESIGNING_POLICY_RULE;
  59         }
  60         bool evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const;
  61
  62     private:
  63         // Appends a raw parameter=value pair to the string.
  64         static bool appendParameter(string& s, const char* data, const char* name);
  65
  66         bool m_errorFatal;
  67     };
  68
  69     SecurityPolicyRule* SAML_DLLLOCAL SimpleSigningRuleFactory(const DOMElement* const & e)
  70     {
  71         return new SimpleSigningRule(e);
  72     }
  73
  74     static const XMLCh errorFatal[] = UNICODE_LITERAL_10(e,r,r,o,r,F,a,t,a,l);
  75 };
  76
  77 bool SimpleSigningRule::appendParameter(string& s, const char* data, const char* name)
  78 {
  79     const char* start = strstr(data,name);
  80     if (!start)
  81         return false;
  82     if (!s.empty())
  83         s += '&';
  84     const char* end = strchr(start,'&');
  85     if (end)
  86         s.append(start, end-start);
  87     else
  88         s.append(start);
  89     return true;
  90 }
  91
  92 SimpleSigningRule::SimpleSigningRule(const DOMElement* e) : m_errorFatal(false)
  93 {
  94     if (e) {
  95         const XMLCh* flag = e->getAttributeNS(nullptr, errorFatal);
  96         m_errorFatal = (flag && (*flag==chLatin_t || *flag==chDigit_1));
  97     }
  98 }
  99
 100 bool SimpleSigningRule::evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const
 101 {
 102     Category& log=Category::getInstance(SAML_LOGCAT".SecurityPolicyRule.SimpleSigning");
 103
 104     if (!policy.getIssuerMetadata()) {
 105         log.debug("ignoring message, no issuer metadata supplied");
 106         return false;
 107     }
 108
 109     const SignatureTrustEngine* sigtrust;
 110     if (!(sigtrust=dynamic_cast<const SignatureTrustEngine*>(policy.getTrustEngine()))) {
 111         log.debug("ignoring message, no SignatureTrustEngine supplied");
 112         return false;
 113     }
 114
 115     const HTTPRequest* httpRequest = dynamic_cast<const HTTPRequest*>(request);
 116     if (!request || !httpRequest)
 117         return false;
 118
 119     const char* signature = request->getParameter("Signature");
 120     if (!signature)
 121         return false;
 122
 123     const char* sigAlgorithm = request->getParameter("SigAlg");
 124     if (!sigAlgorithm) {
 125         log.error("SigAlg parameter not found, no way to verify the signature");
 126         return false;
 127     }
 128
 129     string input;
 130     const char* pch;
 131     if (!strcmp(httpRequest->getMethod(), "GET")) {
 132         // We have to construct a string containing the signature input by accessing the
 133         // request directly. We can't use the decoded parameters because we need the raw
 134         // data and URL-encoding isn't canonical.
 135
 136         // NOTE: SimpleSign for GET means Redirect binding, which means we verify over the
 137         // base64-encoded message directly.
 138
 139         pch = httpRequest->getQueryString();
 140         if (!appendParameter(input, pch, "SAMLRequest="))
 141             appendParameter(input, pch, "SAMLResponse=");
 142         appendParameter(input, pch, "RelayState=");
 143         appendParameter(input, pch, "SigAlg=");
 144     }
 145     else {
 146         // With POST, the input string is concatenated from the decoded form controls.
 147         // GET should be this way too, but I messed up the spec, sorry.
 148
 149         // NOTE: SimpleSign for POST means POST binding, which means we verify over the
 150         // base64-decoded XML. This sucks, because we have to decode the base64 directly.
 151         // Serializing the XMLObject doesn't guarantee the signature will verify (this is
 152         // why XMLSignature exists, and why this isn't really "simpler").
 153
 154         xsecsize_t x;
 155         pch = httpRequest->getParameter("SAMLRequest");
 156         if (pch) {
 157             XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(pch),&x);
 158             if (!decoded) {
 159                 log.warn("unable to decode base64 in POST binding message");
 160                 return false;
 161             }
 162             input = string("SAMLRequest=") + reinterpret_cast<const char*>(decoded);
 163 #ifdef OPENSAML_XERCESC_HAS_XMLBYTE_RELEASE
 164             XMLString::release(&decoded);
 165 #else
 166             XMLString::release((char**)&decoded);
 167 #endif
 168         }
 169         else {
 170             pch = httpRequest->getParameter("SAMLResponse");
 171             XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(pch),&x);
 172             if (!decoded) {
 173                 log.warn("unable to decode base64 in POST binding message");
 174                 return false;
 175             }
 176             input = string("SAMLResponse=") + reinterpret_cast<const char*>(decoded);
 177 #ifdef OPENSAML_XERCESC_HAS_XMLBYTE_RELEASE
 178             XMLString::release(&decoded);
 179 #else
 180             XMLString::release((char**)&decoded);
 181 #endif
 182         }
 183
 184         pch = httpRequest->getParameter("RelayState");
 185         if (pch)
 186             input = input + "&RelayState=" + pch;
 187         input = input + "&SigAlg=" + sigAlgorithm;
 188     }
 189
 190     // Check for KeyInfo, but defensively (we might be able to run without it).
 191     KeyInfo* keyInfo=nullptr;
 192     pch = request->getParameter("KeyInfo");
 193     if (pch) {
 194         xsecsize_t x;
 195         XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(pch),&x);
 196         if (decoded) {
 197             try {
 198                 istringstream kstrm((char*)decoded);
 199                 DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(kstrm);
 200                 XercesJanitor<DOMDocument> janitor(doc);
 201                 XMLObject* kxml = XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true);
 202                 janitor.release();
 203                 if (!(keyInfo=dynamic_cast<KeyInfo*>(kxml)))
 204                     delete kxml;
 205             }
 206             catch (XMLToolingException& ex) {
 207                 log.warn("Failed to load KeyInfo from message: %s", ex.what());
 208             }
 209 #ifdef OPENSAML_XERCESC_HAS_XMLBYTE_RELEASE
 210             XMLString::release(&decoded);
 211 #else
 212             XMLString::release((char**)&decoded);
 213 #endif
 214         }
 215         else {
 216             log.warn("Failed to load KeyInfo from message: Unable to decode base64-encoded KeyInfo.");
 217         }
 218     }
 219
 220     auto_ptr<KeyInfo> kjanitor(keyInfo);
 221     auto_ptr_XMLCh alg(sigAlgorithm);
 222
 223     // Set up criteria object.
 224     MetadataCredentialCriteria cc(*(policy.getIssuerMetadata()));
 225     cc.setXMLAlgorithm(alg.get());
 226
 227     if (!sigtrust->validate(alg.get(), signature, keyInfo, input.c_str(), input.length(), *(policy.getMetadataProvider()), &cc)) {
 228         log.error("unable to verify message signature with supplied trust engine");
 229         if (m_errorFatal)
 230             throw SecurityPolicyException("Message was signed, but signature could not be verified.");
 231         return false;
 232     }
 233
 234     log.debug("signature verified against message issuer");
 235     policy.setAuthenticated(true);
 236     return true;
 237 }