-/*
- * Copyright 2001-2007 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.
*/
/**
* AssertionConsumerService.cpp
- *
- * Base class for handlers that create sessions by consuming SSO protocol responses.
+ *
+ * Base class for handlers that create sessions by consuming SSO protocol responses.
*/
#include "internal.h"
-#include "Application.h"
#include "exceptions.h"
+#include "Application.h"
#include "ServiceProvider.h"
+#include "SPRequest.h"
#include "handler/AssertionConsumerService.h"
#include "util/SPConstants.h"
# include "attribute/resolver/AttributeExtractor.h"
# include "attribute/resolver/AttributeResolver.h"
# include "attribute/resolver/ResolutionContext.h"
+# include "metadata/MetadataProviderCriteria.h"
# include "security/SecurityPolicy.h"
+# include "security/SecurityPolicyProvider.h"
+# include <saml/exceptions.h>
# include <saml/SAMLConfig.h>
# include <saml/saml1/core/Assertions.h>
+# include <saml/saml2/metadata/Metadata.h>
# include <saml/util/CommonDomainCookie.h>
using namespace samlconstants;
+using opensaml::saml2md::MetadataProvider;
+using opensaml::saml2md::RoleDescriptor;
+using opensaml::saml2md::EntityDescriptor;
+using opensaml::saml2md::IDPSSODescriptor;
+using opensaml::saml2md::SPSSODescriptor;
#else
# include "lite/CommonDomainCookie.h"
#endif
using namespace xmltooling;
using namespace std;
-AssertionConsumerService::AssertionConsumerService(const DOMElement* e, const char* appId, Category& log)
- : AbstractHandler(e, log)
+AssertionConsumerService::AssertionConsumerService(
+ const DOMElement* e, const char* appId, Category& log, DOMNodeFilter* filter, const map<string,string>* remapper
+ ) : AbstractHandler(e, log, filter, remapper)
#ifndef SHIBSP_LITE
- ,m_decoder(NULL), m_role(samlconstants::SAML20MD_NS, opensaml::saml2md::IDPSSODescriptor::LOCAL_NAME)
+ ,m_decoder(nullptr), m_role(samlconstants::SAML20MD_NS, opensaml::saml2md::IDPSSODescriptor::LOCAL_NAME)
#endif
{
+ if (!e)
+ return;
string address(appId);
address += getString("Location").second;
setAddress(address.c_str());
#ifndef SHIBSP_LITE
if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
m_decoder = SAMLConfig::getConfig().MessageDecoderManager.newPlugin(
- getString("Binding").second,make_pair(e,shibspconstants::SHIB2SPCONFIG_NS)
+ getString("Binding").second, pair<const DOMElement*,const XMLCh*>(e,shibspconstants::SHIB2SPCONFIG_NS)
);
m_decoder->setArtifactResolver(SPConfig::getConfig().getArtifactResolver());
}
{
string relayState;
SPConfig& conf = SPConfig::getConfig();
-
- try {
- if (conf.isEnabled(SPConfig::OutOfProcess)) {
- // When out of process, we run natively and directly process the message.
- // RelayState will be fully handled during message processing.
- string entityID;
- string key = processMessage(request.getApplication(), request, entityID, relayState);
- return sendRedirect(request, key.c_str(), entityID.c_str(), relayState.c_str());
- }
- else {
- // When not out of process, we remote all the message processing.
- DDF out,in = wrap(request);
- DDFJanitor jin(in), jout(out);
-
- try {
- out=request.getServiceProvider().getListenerService()->send(in);
- }
- catch (XMLToolingException& ex) {
- // Try for RelayState recovery.
- if (ex.getProperty("RelayState"))
- relayState = ex.getProperty("RelayState");
- try {
- recoverRelayState(request.getApplication(), request, relayState);
- }
- catch (exception& ex2) {
- m_log.error("trapped an error during RelayState recovery while handling an error: %s", ex2.what());
- }
- throw;
- }
-
- // We invoke RelayState recovery one last time on this side of the boundary.
- if (out["RelayState"].isstring())
- relayState = out["RelayState"].string();
- recoverRelayState(request.getApplication(), request, relayState);
-
- // If it worked, we have a session key.
- if (!out["key"].isstring())
- throw FatalProfileException("Remote processing of SSO profile did not return a usable session key.");
-
- // Take care of cookie business and wrap it up.
- return sendRedirect(request, out["key"].string(), out["entity_id"].string(), relayState.c_str());
- }
+
+ if (conf.isEnabled(SPConfig::OutOfProcess)) {
+ // When out of process, we run natively and directly process the message.
+ return processMessage(request.getApplication(), request, request);
}
- catch (XMLToolingException& ex) {
- // Try and preserve RelayState.
- if (!relayState.empty())
- ex.addProperty("RelayState", relayState.c_str());
- throw;
+ else {
+ // When not out of process, we remote all the message processing.
+ vector<string> headers(1, "Cookie");
+ DDF out,in = wrap(request, &headers);
+ DDFJanitor jin(in), jout(out);
+ out=request.getServiceProvider().getListenerService()->send(in);
+ return unwrap(request, out);
}
}
{
// Find application.
const char* aid=in["application_id"].string();
- const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
+ const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : nullptr;
if (!app) {
// Something's horribly wrong.
m_log.error("couldn't find application (%s) for new session", aid ? aid : "(missing)");
throw ConfigurationException("Unable to locate application for new session, deleted?");
}
-
+
// Unpack the request.
- auto_ptr<HTTPRequest> http(getRequest(in));
-
- // Do the work.
- string relayState, entityID;
- try {
- string key = processMessage(*app, *http.get(), entityID, relayState);
-
- // Repack for return to caller.
- DDF ret=DDF(NULL).structure();
- DDFJanitor jret(ret);
- ret.addmember("key").string(key.c_str());
- if (!entityID.empty())
- ret.addmember("entity_id").string(entityID.c_str());
- if (!relayState.empty())
- ret.addmember("RelayState").string(relayState.c_str());
- out << ret;
- }
- catch (XMLToolingException& ex) {
- // Try and preserve RelayState if we can.
- if (!relayState.empty())
- ex.addProperty("RelayState", relayState.c_str());
- throw;
- }
+ auto_ptr<HTTPRequest> req(getRequest(in));
+
+ // Wrap a response shim.
+ DDF ret(nullptr);
+ DDFJanitor jout(ret);
+ auto_ptr<HTTPResponse> resp(getResponse(ret));
+
+ // Since we're remoted, the result should either be a throw, a false/0 return,
+ // which we just return as an empty structure, or a response/redirect,
+ // which we capture in the facade and send back.
+ processMessage(*app, *req.get(), *resp.get());
+ out << ret;
}
-string AssertionConsumerService::processMessage(
- const Application& application, HTTPRequest& httpRequest, string& entityID, string& relayState
+pair<bool,long> AssertionConsumerService::processMessage(
+ const Application& application, const HTTPRequest& httpRequest, HTTPResponse& httpResponse
) const
{
#ifndef SHIBSP_LITE
pair<bool,const char*> policyId = getString("policyId", m_configNS.get()); // namespace-qualified if inside handler element
if (!policyId.first)
policyId = application.getString("policyId"); // unqualified in Application(s) element
-
- // Access policy properties.
- const PropertySet* settings = application.getServiceProvider().getPolicySettings(policyId.second);
- pair<bool,bool> validate = settings->getBool("validate");
// Lock metadata for use by policy.
Locker metadataLocker(application.getMetadataProvider());
// Create the policy.
- shibsp::SecurityPolicy policy(application, &m_role, validate.first && validate.second);
-
- // Decode the message and process it in a protocol-specific way.
- auto_ptr<XMLObject> msg(m_decoder->decode(relayState, httpRequest, policy));
- if (!msg.get())
- throw BindingException("Failed to decode an SSO protocol response.");
- recoverRelayState(application, httpRequest, relayState);
- string key = implementProtocol(application, httpRequest, policy, settings, *msg.get());
-
- auto_ptr_char issuer(policy.getIssuer() ? policy.getIssuer()->getName() : NULL);
- if (issuer.get())
- entityID = issuer.get();
-
- return key;
+ auto_ptr<opensaml::SecurityPolicy> policy(
+ application.getServiceProvider().getSecurityPolicyProvider()->createSecurityPolicy(application, &m_role, policyId.second)
+ );
+
+ string relayState;
+ bool relayStateOK = true;
+ try {
+ // Decode the message and process it in a protocol-specific way.
+ auto_ptr<XMLObject> msg(m_decoder->decode(relayState, httpRequest, *(policy.get())));
+ if (!msg.get())
+ throw BindingException("Failed to decode an SSO protocol response.");
+ DDF postData = recoverPostData(application, httpRequest, httpResponse, relayState.c_str());
+ DDFJanitor postjan(postData);
+ recoverRelayState(application, httpRequest, httpResponse, relayState);
+ limitRelayState(m_log, application, httpRequest, relayState.c_str());
+ implementProtocol(application, httpRequest, httpResponse, *(policy.get()), NULL, *msg.get());
+
+ auto_ptr_char issuer(policy->getIssuer() ? policy->getIssuer()->getName() : nullptr);
+
+ // History cookie.
+ if (issuer.get() && *issuer.get())
+ maintainHistory(application, httpRequest, httpResponse, issuer.get());
+
+ // Now redirect to the state value. By now, it should be set to *something* usable.
+ // First check for POST data.
+ if (!postData.islist()) {
+ m_log.debug("ACS returning via redirect to: %s", relayState.c_str());
+ return make_pair(true, httpResponse.sendRedirect(relayState.c_str()));
+ }
+ else {
+ m_log.debug("ACS returning via POST to: %s", relayState.c_str());
+ return make_pair(true, sendPostResponse(application, httpResponse, relayState.c_str(), postData));
+ }
+ }
+ catch (XMLToolingException& ex) {
+ if (relayStateOK) {
+ // Check for isPassive error condition.
+ const char* sc2 = ex.getProperty("statusCode2");
+ if (sc2 && !strcmp(sc2, "urn:oasis:names:tc:SAML:2.0:status:NoPassive")) {
+ pair<bool,bool> ignore = getBool("ignoreNoPassive", m_configNS.get()); // namespace-qualified if inside handler element
+ if (ignore.first && ignore.second && !relayState.empty()) {
+ m_log.debug("ignoring SAML status of NoPassive and redirecting to resource...");
+ return make_pair(true, httpResponse.sendRedirect(relayState.c_str()));
+ }
+ }
+ }
+ if (!relayState.empty())
+ ex.addProperty("RelayState", relayState.c_str());
+ throw;
+ }
#else
throw ConfigurationException("Cannot process message using lite version of shibsp library.");
#endif
}
-pair<bool,long> AssertionConsumerService::sendRedirect(
- SPRequest& request, const char* key, const char* entityID, const char* relayState
- ) const
+void AssertionConsumerService::checkAddress(const Application& application, const HTTPRequest& httpRequest, const char* issuedTo) const
{
- // We've got a good session, so set the session cookie.
- pair<string,const char*> shib_cookie=request.getApplication().getCookieNameProps("_shibsession_");
- string k(key);
- k += shib_cookie.second;
- request.setCookie(shib_cookie.first.c_str(), k.c_str());
-
- // History cookie.
- maintainHistory(request, entityID, shib_cookie.second);
-
- // Now redirect to the state value. By now, it should be set to *something* usable.
- return make_pair(true, request.sendRedirect(relayState));
-}
+ if (!issuedTo || !*issuedTo)
+ return;
-void AssertionConsumerService::checkAddress(
- const Application& application, const HTTPRequest& httpRequest, const char* issuedTo
- ) const
-{
const PropertySet* props=application.getPropertySet("Sessions");
pair<bool,bool> checkAddress = props ? props->getBool("checkAddress") : make_pair(false,true);
if (!checkAddress.first)
#ifndef SHIBSP_LITE
+const XMLCh* AssertionConsumerService::getProtocolFamily() const
+{
+ return m_decoder ? m_decoder->getProtocolFamily() : nullptr;
+}
+
+const char* AssertionConsumerService::getType() const
+{
+ return "AssertionConsumerService";
+}
+
+void AssertionConsumerService::generateMetadata(SPSSODescriptor& role, const char* handlerURL) const
+{
+ // Initial guess at index to use.
+ pair<bool,unsigned int> ix = pair<bool,unsigned int>(false,0);
+ if (!strncmp(handlerURL, "https", 5))
+ ix = getUnsignedInt("sslIndex", shibspconstants::ASCII_SHIB2SPCONFIG_NS);
+ if (!ix.first)
+ ix = getUnsignedInt("index");
+ if (!ix.first)
+ ix.second = 1;
+
+ // Find maximum index in use and go one higher.
+ const vector<saml2md::AssertionConsumerService*>& services = const_cast<const SPSSODescriptor&>(role).getAssertionConsumerServices();
+ if (!services.empty() && ix.second <= services.back()->getIndex().second)
+ ix.second = services.back()->getIndex().second + 1;
+
+ const char* loc = getString("Location").second;
+ string hurl(handlerURL);
+ if (*loc != '/')
+ hurl += '/';
+ hurl += loc;
+ auto_ptr_XMLCh widen(hurl.c_str());
+
+ saml2md::AssertionConsumerService* ep = saml2md::AssertionConsumerServiceBuilder::buildAssertionConsumerService();
+ ep->setLocation(widen.get());
+ ep->setBinding(getXMLString("Binding").second);
+ ep->setIndex(ix.second);
+ role.getAssertionConsumerServices().push_back(ep);
+}
+
+opensaml::SecurityPolicy* AssertionConsumerService::createSecurityPolicy(
+ const Application& application, const xmltooling::QName* role, bool validate, const char* policyId
+ ) const
+{
+ return new SecurityPolicy(application, role, validate, policyId);
+}
+
class SHIBSP_DLLLOCAL DummyContext : public ResolutionContext
{
public:
const vector<const Assertion*>* tokens
) const
{
- const saml2md::EntityDescriptor* entity = issuer ? dynamic_cast<const saml2md::EntityDescriptor*>(issuer->getParent()) : NULL;
-
// First we do the extraction of any pushed information, including from metadata.
vector<Attribute*> resolvedAttributes;
AttributeExtractor* extractor = application.getAttributeExtractor();
if (extractor) {
Locker extlocker(extractor);
- if (entity) {\r
- pair<bool,const char*> prefix = application.getString("metadataAttributePrefix");\r
- if (prefix.first) {\r
- m_log.debug("extracting metadata-derived attributes...");\r
- try {\r
- extractor->extractAttributes(application, issuer, *entity, resolvedAttributes);\r
- for (vector<Attribute*>::iterator a = resolvedAttributes.begin(); a != resolvedAttributes.end(); ++a) {\r
- vector<string>& ids = (*a)->getAliases();\r
- for (vector<string>::iterator id = ids.begin(); id != ids.end(); ++id)\r
- *id = prefix.second + *id;\r
- }\r
- }\r
- catch (exception& ex) {\r
- m_log.error("caught exception extracting attributes: %s", ex.what());\r
- }\r
- }\r
+ if (issuer) {
+ pair<bool,const char*> mprefix = application.getString("metadataAttributePrefix");
+ if (mprefix.first) {
+ m_log.debug("extracting metadata-derived attributes...");
+ try {
+ // We pass nullptr for "issuer" because the IdP isn't the one asserting metadata-based attributes.
+ extractor->extractAttributes(application, nullptr, *issuer, resolvedAttributes);
+ for (vector<Attribute*>::iterator a = resolvedAttributes.begin(); a != resolvedAttributes.end(); ++a) {
+ vector<string>& ids = (*a)->getAliases();
+ for (vector<string>::iterator id = ids.begin(); id != ids.end(); ++id)
+ *id = mprefix.second + *id;
+ }
+ }
+ catch (exception& ex) {
+ m_log.error("caught exception extracting attributes: %s", ex.what());
+ }
+ }
}
m_log.debug("extracting pushed attributes...");
if (v1nameid) {
}
}
}
-
+ else {
+ m_log.warn("no AttributeExtractor plugin installed, check log during startup");
+ }
+
try {
AttributeResolver* resolver = application.getAttributeResolver();
if (resolver) {
auto_ptr<ResolutionContext> ctx(
resolver->createResolutionContext(
application,
- entity,
+ issuer ? dynamic_cast<const saml2md::EntityDescriptor*>(issuer->getParent()) : nullptr,
protocol,
nameid,
authncontext_class,
catch (exception& ex) {
m_log.error("attribute resolution failed: %s", ex.what());
}
-
+
if (!resolvedAttributes.empty())
return new DummyContext(resolvedAttributes);
- return NULL;
+ return nullptr;
+}
+
+void AssertionConsumerService::extractMessageDetails(const Assertion& assertion, const XMLCh* protocol, opensaml::SecurityPolicy& policy) const
+{
+ policy.setMessageID(assertion.getID());
+ policy.setIssueInstant(assertion.getIssueInstantEpoch());
+
+ if (XMLString::equals(assertion.getElementQName().getNamespaceURI(), samlconstants::SAML20_NS)) {
+ const saml2::Assertion* a2 = dynamic_cast<const saml2::Assertion*>(&assertion);
+ if (a2) {
+ m_log.debug("extracting issuer from SAML 2.0 assertion");
+ policy.setIssuer(a2->getIssuer());
+ }
+ }
+ else {
+ const saml1::Assertion* a1 = dynamic_cast<const saml1::Assertion*>(&assertion);
+ if (a1) {
+ m_log.debug("extracting issuer from SAML 1.x assertion");
+ policy.setIssuer(a1->getIssuer());
+ }
+ }
+
+ if (policy.getIssuer() && !policy.getIssuerMetadata() && policy.getMetadataProvider()) {
+ if (policy.getIssuer()->getFormat() && !XMLString::equals(policy.getIssuer()->getFormat(), saml2::NameIDType::ENTITY)) {
+ m_log.warn("non-system entity issuer, skipping metadata lookup");
+ return;
+ }
+ m_log.debug("searching metadata for assertion issuer...");
+ pair<const EntityDescriptor*,const RoleDescriptor*> entity;
+ MetadataProvider::Criteria& mc = policy.getMetadataProviderCriteria();
+ mc.entityID_unicode = policy.getIssuer()->getName();
+ mc.role = &IDPSSODescriptor::ELEMENT_QNAME;
+ mc.protocol = protocol;
+ entity = policy.getMetadataProvider()->getEntityDescriptor(mc);
+ if (!entity.first) {
+ auto_ptr_char iname(policy.getIssuer()->getName());
+ m_log.warn("no metadata found, can't establish identity of issuer (%s)", iname.get());
+ }
+ else if (!entity.second) {
+ m_log.warn("unable to find compatible IdP role in metadata");
+ }
+ else {
+ policy.setIssuerMetadata(entity.second);
+ }
+ }
}
+
#endif
-void AssertionConsumerService::maintainHistory(SPRequest& request, const char* entityID, const char* cookieProps) const
+void AssertionConsumerService::maintainHistory(
+ const Application& application, const HTTPRequest& request, HTTPResponse& response, const char* entityID
+ ) const
{
- if (!entityID)
- return;
-
- const PropertySet* sessionProps=request.getApplication().getPropertySet("Sessions");
+ static const char* defProps="; path=/";
+
+ const PropertySet* sessionProps=application.getPropertySet("Sessions");
pair<bool,bool> idpHistory=sessionProps->getBool("idpHistory");
- if (!idpHistory.first || idpHistory.second) {
+
+ if (idpHistory.first && idpHistory.second) {
+ pair<bool,const char*> cookieProps=sessionProps->getString("cookieProps");
+ if (!cookieProps.first)
+ cookieProps.second=defProps;
+
// Set an IdP history cookie locally (essentially just a CDC).
CommonDomainCookie cdc(request.getCookie(CommonDomainCookie::CDCName));
// Either leave in memory or set an expiration.
pair<bool,unsigned int> days=sessionProps->getUnsignedInt("idpHistoryDays");
if (!days.first || days.second==0) {
- string c = string(cdc.set(entityID)) + cookieProps;
- request.setCookie(CommonDomainCookie::CDCName, c.c_str());
+ string c = string(cdc.set(entityID)) + cookieProps.second;
+ response.setCookie(CommonDomainCookie::CDCName, c.c_str());
}
else {
- time_t now=time(NULL) + (days.second * 24 * 60 * 60);
+ time_t now=time(nullptr) + (days.second * 24 * 60 * 60);
#ifdef HAVE_GMTIME_R
struct tm res;
struct tm* ptime=gmtime_r(&now,&res);
#endif
char timebuf[64];
strftime(timebuf,64,"%a, %d %b %Y %H:%M:%S GMT",ptime);
- string c = string(cdc.set(entityID)) + cookieProps + "; expires=" + timebuf;
- request.setCookie(CommonDomainCookie::CDCName, c.c_str());
+ string c = string(cdc.set(entityID)) + cookieProps.second + "; expires=" + timebuf;
+ response.setCookie(CommonDomainCookie::CDCName, c.c_str());
}
}
}