-/*
- * 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.
+ *
+ * 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
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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.
+ * 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 "RootObject.h"
-#include "binding/HTTPRequest.h"
-#include "binding/SimpleSigningRule.h"
-#include "saml2/core/Protocols.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 "security/TrustEngine.h"
-#include <log4cpp/Category.hh>
-#include <xmltooling/util/NDC.h>
-#include <xmltooling/util/ReplayCache.h>
-#include <xsec/enc/XSECCryptoException.hpp>
-#include <xsec/enc/XSECCryptoProvider.hpp>
-#include <xsec/framework/XSECException.hpp>
+#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))
+{
+}
-pair<saml2::Issuer*,const saml2md::RoleDescriptor*> SimpleSigningRule::evaluate(
- const GenericRequest& request,
- const XMLObject& message,
- const MetadataProvider* metadataProvider,
- const QName* role,
- const opensaml::TrustEngine* trustEngine
- ) 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");
-
- pair<saml2::Issuer*,const RoleDescriptor*> ret = pair<saml2::Issuer*,const RoleDescriptor*>(NULL,NULL);
+ Category& log=Category::getInstance(SAML_LOGCAT ".SecurityPolicyRule.SimpleSigning");
- if (!metadataProvider || !role || !trustEngine) {
- log.debug("ignoring message, no metadata supplied");
- return ret;
+ if (!policy.getIssuerMetadata()) {
+ log.debug("ignoring message, no issuer metadata supplied");
+ return false;
}
-
- const char* signature = request.getParameter("Signature");
- if (!signature) {
- log.debug("ignoring unsigned message");
- return ret;
+
+ 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)
+ return false;
+
+ const char* signature = request->getParameter("Signature");
+ if (!signature)
+ return false;
- const char* sigAlgorithm = request.getParameter("SigAlg");
+ const char* sigAlgorithm = request->getParameter("SigAlg");
if (!sigAlgorithm) {
log.error("SigAlg parameter not found, no way to verify the signature");
- return ret;
+ return false;
}
- try {
- log.debug("extracting issuer from message");
- pair<saml2::Issuer*,const XMLCh*> issuerInfo = getIssuerAndProtocol(message);
-
- auto_ptr<saml2::Issuer> issuer(issuerInfo.first);
- if (!issuerInfo.first || !issuerInfo.second ||
- (issuer->getFormat() && !XMLString::equals(issuer->getFormat(), saml2::NameIDType::ENTITY))) {
- log.warn("issuer identity not estabished, or was not an entityID");
- return ret;
+ string input;
+ const char* pch;
+ if (!strcmp(httpRequest->getMethod(), "GET")) {
+ // 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=");
+ appendParameter(input, pch, "RelayState=");
+ appendParameter(input, pch, "SigAlg=");
+ }
+ 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) {
+ 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
}
-
- log.debug("searching metadata for message issuer...");
- const EntityDescriptor* entity = metadataProvider->getEntityDescriptor(issuer->getName());
- if (!entity) {
- auto_ptr_char temp(issuer->getName());
- log.warn("no metadata found, can't establish identity of issuer (%s)", temp.get());
- return ret;
+ else {
+ pch = httpRequest->getParameter("SAMLResponse");
+ 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
}
- log.debug("matched assertion issuer against metadata, searching for applicable role...");
- const RoleDescriptor* roledesc=entity->getRoleDescriptor(*role, issuerInfo.second);
- if (!roledesc) {
- log.warn("unable to find compatible role (%s) in metadata", role->toString().c_str());
- return ret;
- }
+ pch = httpRequest->getParameter("RelayState");
+ if (pch)
+ input = input + "&RelayState=" + pch;
+ input = input + "&SigAlg=" + sigAlgorithm;
+ }
- // 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.
- string input;
- const HTTPRequest& httpRequest = dynamic_cast<const HTTPRequest&>(request);
- const char* raw =
- (!strcmp(httpRequest.getMethod(), "GET")) ? httpRequest.getQueryString() : httpRequest.getRequestBody();
- if (!appendParameter(input, raw, "SAMLRequest="))
- appendParameter(input, raw, "SAMLResponse=");
- appendParameter(input, raw, "RelayState=");
- appendParameter(input, raw, "SigAlg=");
-
- // Check for KeyInfo, but defensively (we might be able to run without it).
- KeyInfo* keyInfo=NULL;
- const char* k = request.getParameter("KeyInfo");
- if (k) {
+ // Check for KeyInfo, but defensively (we might be able to run without it).
+ KeyInfo* keyInfo=nullptr;
+ pch = request->getParameter("KeyInfo");
+ if (pch) {
+ xsecsize_t x;
+ XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(pch),&x);
+ if (decoded) {
try {
- istringstream kstrm(k);
+ istringstream kstrm((char*)decoded);
DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(kstrm);
XercesJanitor<DOMDocument> janitor(doc);
XMLObject* kxml = XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true);
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
}
-
- auto_ptr<KeyInfo> kjanitor(keyInfo);
- auto_ptr_XMLCh alg(sigAlgorithm);
-
- if (!trustEngine->validate(alg.get(), signature, keyInfo, input.c_str(), input.length(), *roledesc, metadataProvider->getKeyResolver())) {
- log.error("unable to verify signature on message with supplied trust engine");
- return ret;
- }
-
- if (log.isDebugEnabled()) {
- auto_ptr_char iname(entity->getEntityID());
- log.debug("message from (%s), signature verified", iname.get());
+ else {
+ log.warn("Failed to load KeyInfo from message: Unable to decode base64-encoded KeyInfo.");
}
-
- ret.first = issuer.release();
- ret.second = roledesc;
}
- catch (bad_cast&) {
- // Just trap it.
- log.warn("caught a bad_cast while extracting issuer");
+
+ auto_ptr<KeyInfo> kjanitor(keyInfo);
+ auto_ptr_XMLCh alg(sigAlgorithm);
+
+ // 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");
+ if (m_errorFatal)
+ throw SecurityPolicyException("Message was signed, but signature could not be verified.");
+ return false;
}
- return ret;
-}
-pair<saml2::Issuer*,const XMLCh*> SimpleSigningRule::getIssuerAndProtocol(const XMLObject& message) const
-{
- // We just let any bad casts throw here.
-
- // Shortcuts some of the casting.
- const XMLCh* ns = message.getElementQName().getNamespaceURI();
- if (ns) {
- if (XMLString::equals(ns, samlconstants::SAML20P_NS) || XMLString::equals(ns, samlconstants::SAML20_NS)) {
- // 2.0 namespace should be castable to a specialized 2.0 root.
- const saml2::RootObject& root = dynamic_cast<const saml2::RootObject&>(message);
- saml2::Issuer* issuer = root.getIssuer();
- if (issuer && issuer->getName()) {
- return make_pair(issuer->cloneIssuer(), samlconstants::SAML20P_NS);
- }
-
- // No issuer in the message, so we have to try the Response approach.
- const vector<saml2::Assertion*>& assertions = dynamic_cast<const saml2p::Response&>(message).getAssertions();
- if (!assertions.empty()) {
- issuer = assertions.front()->getIssuer();
- if (issuer && issuer->getName())
- return make_pair(issuer->cloneIssuer(), samlconstants::SAML20P_NS);
- }
- }
- }
- return pair<saml2::Issuer*,const XMLCh*>(NULL,NULL);
+ log.debug("signature verified against message issuer");
+ policy.setAuthenticated(true);
+ return true;
}
projects / shibboleth / cpp-opensaml.git / blobdiff