-/*
- * Copyright 2001-2006 Internet2
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
*/
/**
* SimpleSigningRule.cpp
*
- * Blob-oriented signature checking SecurityPolicyRule
+ * Blob-oriented signature checking SecurityPolicyRule.
*/
#include "internal.h"
#include "exceptions.h"
-#include "binding/HTTPRequest.h"
-#include "binding/SimpleSigningRule.h"
+#include "binding/SecurityPolicy.h"
+#include "binding/SecurityPolicyRule.h"
#include "saml2/core/Assertions.h"
#include "saml2/metadata/Metadata.h"
+#include "saml2/metadata/MetadataCredentialCriteria.h"
#include "saml2/metadata/MetadataProvider.h"
-#include <log4cpp/Category.hh>
+#include <xercesc/util/Base64.hpp>
+#include <xmltooling/logging.h>
+#include <xmltooling/XMLToolingConfig.h>
+#include <xmltooling/io/HTTPRequest.h>
+#include <xmltooling/security/SignatureTrustEngine.h>
+#include <xmltooling/signature/KeyInfo.h>
+#include <xmltooling/signature/Signature.h>
+#include <xmltooling/util/ParserPool.h>
using namespace opensaml::saml2md;
using namespace opensaml;
+using namespace xmltooling::logging;
using namespace xmltooling;
-using namespace log4cpp;
using namespace std;
using xmlsignature::KeyInfo;
+using xmlsignature::SignatureException;
namespace opensaml {
+ class SAML_DLLLOCAL SimpleSigningRule : public SecurityPolicyRule
+ {
+ public:
+ SimpleSigningRule(const DOMElement* e);
+ virtual ~SimpleSigningRule() {}
+
+ const char* getType() const {
+ return SIMPLESIGNING_POLICY_RULE;
+ }
+ bool evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const;
+
+ private:
+ // Appends a raw parameter=value pair to the string.
+ static bool appendParameter(string& s, const char* data, const char* name);
+
+ bool m_errorFatal;
+ };
+
SecurityPolicyRule* SAML_DLLLOCAL SimpleSigningRuleFactory(const DOMElement* const & e)
{
return new SimpleSigningRule(e);
}
- // Appends a raw parameter=value pair to the string.
- static bool appendParameter(string& s, const char* data, const char* name)
- {
- const char* start = strstr(data,name);
- if (!start)
- return false;
- if (!s.empty())
- s += '&';
- const char* end = strchr(start,'&');
- if (end)
- s.append(start, end-start);
- else
- s.append(start);
- return true;
- }
+ static const XMLCh errorFatal[] = UNICODE_LITERAL_10(e,r,r,o,r,F,a,t,a,l);
};
+bool SimpleSigningRule::appendParameter(string& s, const char* data, const char* name)
+{
+ const char* start = strstr(data,name);
+ if (!start)
+ return false;
+ if (!s.empty())
+ s += '&';
+ const char* end = strchr(start,'&');
+ if (end)
+ s.append(start, end-start);
+ else
+ s.append(start);
+ return true;
+}
+
+SimpleSigningRule::SimpleSigningRule(const DOMElement* e) : m_errorFatal(XMLHelper::getAttrBool(e, false, errorFatal))
+{
+}
-void SimpleSigningRule::evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const
+bool SimpleSigningRule::evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const
{
- Category& log=Category::getInstance(SAML_LOGCAT".SecurityPolicyRule.SimpleSigning");
- log.debug("evaluating simple signing policy");
+ Category& log=Category::getInstance(SAML_LOGCAT ".SecurityPolicyRule.SimpleSigning");
if (!policy.getIssuerMetadata()) {
log.debug("ignoring message, no issuer metadata supplied");
- return;
+ return false;
}
- else if (!policy.getTrustEngine()) {
- log.debug("ignoring message, no TrustEngine supplied");
- return;
+
+ const SignatureTrustEngine* sigtrust;
+ if (!(sigtrust=dynamic_cast<const SignatureTrustEngine*>(policy.getTrustEngine()))) {
+ log.debug("ignoring message, no SignatureTrustEngine supplied");
+ return false;
}
const HTTPRequest* httpRequest = dynamic_cast<const HTTPRequest*>(request);
- if (!request || !httpRequest) {
- log.debug("ignoring message, no HTTP protocol request available");
- return;
- }
+ if (!request || !httpRequest)
+ return false;
const char* signature = request->getParameter("Signature");
- if (!signature) {
- log.debug("ignoring unsigned message");
- return;
- }
+ if (!signature)
+ return false;
const char* sigAlgorithm = request->getParameter("SigAlg");
if (!sigAlgorithm) {
log.error("SigAlg parameter not found, no way to verify the signature");
- return;
+ return false;
}
string input;
// We have to construct a string containing the signature input by accessing the
// request directly. We can't use the decoded parameters because we need the raw
// data and URL-encoding isn't canonical.
+
+ // NOTE: SimpleSign for GET means Redirect binding, which means we verify over the
+ // base64-encoded message directly.
+
pch = httpRequest->getQueryString();
if (!appendParameter(input, pch, "SAMLRequest="))
appendParameter(input, pch, "SAMLResponse=");
else {
// With POST, the input string is concatenated from the decoded form controls.
// GET should be this way too, but I messed up the spec, sorry.
+
+ // NOTE: SimpleSign for POST means POST binding, which means we verify over the
+ // base64-decoded XML. This sucks, because we have to decode the base64 directly.
+ // Serializing the XMLObject doesn't guarantee the signature will verify (this is
+ // why XMLSignature exists, and why this isn't really "simpler").
+
+ xsecsize_t x;
pch = httpRequest->getParameter("SAMLRequest");
- if (pch)
- input = string("SAMLRequest=") + pch;
+ if (pch) {
+ XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(pch),&x);
+ if (!decoded) {
+ log.warn("unable to decode base64 in POST binding message");
+ return false;
+ }
+ input = string("SAMLRequest=") + reinterpret_cast<const char*>(decoded);
+#ifdef OPENSAML_XERCESC_HAS_XMLBYTE_RELEASE
+ XMLString::release(&decoded);
+#else
+ XMLString::release((char**)&decoded);
+#endif
+ }
else {
pch = httpRequest->getParameter("SAMLResponse");
- input = string("SAMLResponse=") + pch;
+ XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(pch),&x);
+ if (!decoded) {
+ log.warn("unable to decode base64 in POST binding message");
+ return false;
+ }
+ input = string("SAMLResponse=") + reinterpret_cast<const char*>(decoded);
+#ifdef OPENSAML_XERCESC_HAS_XMLBYTE_RELEASE
+ XMLString::release(&decoded);
+#else
+ XMLString::release((char**)&decoded);
+#endif
}
+
pch = httpRequest->getParameter("RelayState");
if (pch)
input = input + "&RelayState=" + pch;
}
// Check for KeyInfo, but defensively (we might be able to run without it).
- KeyInfo* keyInfo=NULL;
+ KeyInfo* keyInfo=nullptr;
pch = request->getParameter("KeyInfo");
if (pch) {
- try {
- istringstream kstrm(pch);
- DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(kstrm);
- XercesJanitor<DOMDocument> janitor(doc);
- XMLObject* kxml = XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true);
- janitor.release();
- if (!(keyInfo=dynamic_cast<KeyInfo*>(kxml)))
- delete kxml;
+ xsecsize_t x;
+ XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(pch),&x);
+ if (decoded) {
+ try {
+ istringstream kstrm((char*)decoded);
+ DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(kstrm);
+ XercesJanitor<DOMDocument> janitor(doc);
+ XMLObject* kxml = XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true);
+ janitor.release();
+ if (!(keyInfo=dynamic_cast<KeyInfo*>(kxml)))
+ delete kxml;
+ }
+ catch (XMLToolingException& ex) {
+ log.warn("Failed to load KeyInfo from message: %s", ex.what());
+ }
+#ifdef OPENSAML_XERCESC_HAS_XMLBYTE_RELEASE
+ XMLString::release(&decoded);
+#else
+ XMLString::release((char**)&decoded);
+#endif
}
- catch (XMLToolingException& ex) {
- log.warn("Failed to load KeyInfo from message: %s", ex.what());
+ else {
+ log.warn("Failed to load KeyInfo from message: Unable to decode base64-encoded KeyInfo.");
}
}
auto_ptr<KeyInfo> kjanitor(keyInfo);
auto_ptr_XMLCh alg(sigAlgorithm);
-
- if (!policy.getTrustEngine()->validate(
- alg.get(), signature, keyInfo, input.c_str(), input.length(),
- *(policy.getIssuerMetadata()), policy.getMetadataProvider()->getKeyResolver()
- )) {
+
+ // Set up criteria object.
+ MetadataCredentialCriteria cc(*(policy.getIssuerMetadata()));
+ cc.setXMLAlgorithm(alg.get());
+
+ if (!sigtrust->validate(alg.get(), signature, keyInfo, input.c_str(), input.length(), *(policy.getMetadataProvider()), &cc)) {
log.error("unable to verify message signature with supplied trust engine");
- return;
+ if (m_errorFatal)
+ throw SecurityPolicyException("Message was signed, but signature could not be verified.");
+ return false;
}
log.debug("signature verified against message issuer");
+ policy.setAuthenticated(true);
+ return true;
}