2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 * SAML 2.0 assertion consumer service
24 #include "handler/AssertionConsumerService.h"
27 # include "exceptions.h"
28 # include "Application.h"
29 # include "ServiceProvider.h"
30 # include "SessionCache.h"
31 # include "attribute/resolver/ResolutionContext.h"
32 # include <saml/saml2/core/Protocols.h>
33 # include <saml/saml2/profile/BrowserSSOProfileValidator.h>
34 # include <saml/saml2/metadata/Metadata.h>
35 # include <saml/saml2/metadata/MetadataCredentialCriteria.h>
36 using namespace opensaml::saml2;
37 using namespace opensaml::saml2p;
38 using namespace opensaml::saml2md;
39 using namespace opensaml;
41 # define min(a,b) (((a) < (b)) ? (a) : (b))
45 using namespace shibsp;
46 using namespace xmltooling;
51 #if defined (_MSC_VER)
52 #pragma warning( push )
53 #pragma warning( disable : 4250 )
56 class SHIBSP_DLLLOCAL SAML2Consumer : public AssertionConsumerService
59 SAML2Consumer(const DOMElement* e, const char* appId)
60 : AssertionConsumerService(e, appId, Category::getInstance(SHIBSP_LOGCAT".SSO.SAML2")) {
62 virtual ~SAML2Consumer() {}
66 string implementProtocol(
67 const Application& application,
68 const HTTPRequest& httpRequest,
69 SecurityPolicy& policy,
70 const PropertySet* settings,
71 const XMLObject& xmlObject
76 #if defined (_MSC_VER)
77 #pragma warning( pop )
80 Handler* SHIBSP_DLLLOCAL SAML2ConsumerFactory(const pair<const DOMElement*,const char*>& p)
82 return new SAML2Consumer(p.first, p.second);
89 string SAML2Consumer::implementProtocol(
90 const Application& application,
91 const HTTPRequest& httpRequest,
92 SecurityPolicy& policy,
93 const PropertySet* settings,
94 const XMLObject& xmlObject
97 // Implementation of SAML 2.0 SSO profile(s).
98 m_log.debug("processing message against SAML 2.0 SSO profile");
100 // Remember whether we already established trust.
101 // None of the SAML 2 bindings require security at the protocol layer.
102 bool alreadySecured = policy.isAuthenticated();
104 // Check for errors...this will throw if it's not a successful message.
105 checkError(&xmlObject);
107 const Response* response = dynamic_cast<const Response*>(&xmlObject);
109 throw FatalProfileException("Incoming message was not a samlp:Response.");
111 const vector<saml2::Assertion*>& assertions = response->getAssertions();
112 const vector<saml2::EncryptedAssertion*>& encassertions = response->getEncryptedAssertions();
113 if (assertions.empty() && encassertions.empty())
114 throw FatalProfileException("Incoming message contained no SAML assertions.");
116 // Maintain list of "legit" tokens to feed to SP subsystems.
117 const Subject* ssoSubject=NULL;
118 const AuthnStatement* ssoStatement=NULL;
119 vector<const opensaml::Assertion*> tokens;
121 // Also track "bad" tokens that we'll cache but not use.
122 // This is necessary because there may be valid tokens not aimed at us.
123 vector<const opensaml::Assertion*> badtokens;
125 // And also track "owned" tokens that we decrypt here.
126 vector<saml2::Assertion*> ownedtokens;
128 // Profile validator.
129 time_t now = time(NULL);
130 string dest = httpRequest.getRequestURL();
131 BrowserSSOProfileValidator ssoValidator(application.getAudiences(), now, dest.substr(0,dest.find('?')).c_str());
133 // With this flag on, we ignore any unsigned assertions.
134 pair<bool,bool> flag = settings->getBool("signedAssertions");
136 // Saves off IP-mismatch error message because it's potentially helpful for users.
137 string addressMismatch;
139 for (vector<saml2::Assertion*>::const_iterator a = assertions.begin(); a!=assertions.end(); ++a) {
140 // Skip unsigned assertion?
141 if (!(*a)->getSignature() && flag.first && flag.second) {
142 m_log.warn("found unsigned assertion in SAML response, ignoring it per signedAssertions policy");
143 badtokens.push_back(*a);
148 // We clear the security flag, so we can tell whether the token was secured on its own.
149 policy.setAuthenticated(false);
152 // Extract message bits and re-verify Issuer information.
153 extractMessageDetails(*(*a), samlconstants::SAML20P_NS, policy);
155 // Run the policy over the assertion. Handles replay, freshness, and
156 // signature verification, assuming the relevant rules are configured.
157 policy.evaluate(*(*a));
159 // If no security is in place now, we kick it.
160 if (!alreadySecured && !policy.isAuthenticated()) {
161 m_log.warn("unable to establish security of assertion");
162 badtokens.push_back(*a);
166 // Now do profile and core semantic validation to ensure we can use it for SSO.
167 ssoValidator.validateAssertion(*(*a));
171 if (ssoValidator.getAddress())
172 checkAddress(application, httpRequest, ssoValidator.getAddress());
174 catch (exception& ex) {
175 // We save off the message if there's no SSO statement yet.
177 addressMismatch = ex.what();
181 // Track it as a valid token.
182 tokens.push_back(*a);
184 // Save off the first valid SSO statement, but favor the "soonest" session expiration.
185 const vector<AuthnStatement*>& statements = const_cast<const saml2::Assertion*>(*a)->getAuthnStatements();
186 for (vector<AuthnStatement*>::const_iterator s = statements.begin(); s!=statements.end(); ++s) {
187 if (!ssoStatement || (*s)->getSessionNotOnOrAfterEpoch() < ssoStatement->getSessionNotOnOrAfterEpoch())
191 // Save off the first valid Subject, but favor an unencrypted NameID over anything else.
192 if (!ssoSubject || (!ssoSubject->getNameID() && (*a)->getSubject()->getNameID()))
193 ssoSubject = (*a)->getSubject();
195 catch (exception& ex) {
196 m_log.warn("detected a problem with assertion: %s", ex.what());
197 badtokens.push_back(*a);
201 // In case we need decryption...
202 CredentialResolver* cr=application.getCredentialResolver();
203 if (!cr && !encassertions.empty())
204 m_log.warn("found encrypted assertions, but no CredentialResolver was available");
206 for (vector<saml2::EncryptedAssertion*>::const_iterator ea = encassertions.begin(); cr && ea!=encassertions.end(); ++ea) {
207 // Attempt to decrypt it.
208 saml2::Assertion* decrypted=NULL;
210 Locker credlocker(cr);
211 auto_ptr<MetadataCredentialCriteria> mcc(
212 policy.getIssuerMetadata() ? new MetadataCredentialCriteria(*policy.getIssuerMetadata()) : NULL
214 auto_ptr<XMLObject> wrapper((*ea)->decrypt(*cr, application.getXMLString("entityID").second, mcc.get()));
215 decrypted = dynamic_cast<saml2::Assertion*>(wrapper.get());
218 ownedtokens.push_back(decrypted);
221 catch (exception& ex) {
222 m_log.error(ex.what());
227 // Skip unsigned assertion?
228 if (!decrypted->getSignature() && flag.first && flag.second) {
229 m_log.warn("found unsigned assertion in SAML response, ignoring it per signedAssertions policy");
230 badtokens.push_back(decrypted);
235 // We clear the security flag, so we can tell whether the token was secured on its own.
236 policy.setAuthenticated(false);
239 // Extract message bits and re-verify Issuer information.
240 extractMessageDetails(*decrypted, samlconstants::SAML20P_NS, policy);
242 // Run the policy over the assertion. Handles replay, freshness, and
243 // signature verification, assuming the relevant rules are configured.
244 // We have to marshall the object first to ensure signatures can be checked.
245 if (!decrypted->getDOM())
246 decrypted->marshall();
247 policy.evaluate(*decrypted);
249 // If no security is in place now, we kick it.
250 if (!alreadySecured && !policy.isAuthenticated()) {
251 m_log.warn("unable to establish security of assertion");
252 badtokens.push_back(decrypted);
256 // Now do profile and core semantic validation to ensure we can use it for SSO.
257 ssoValidator.validateAssertion(*decrypted);
261 if (ssoValidator.getAddress())
262 checkAddress(application, httpRequest, ssoValidator.getAddress());
264 catch (exception& ex) {
265 // We save off the message if there's no SSO statement yet.
267 addressMismatch = ex.what();
271 // Track it as a valid token.
272 tokens.push_back(decrypted);
274 // Save off the first valid SSO statement, but favor the "soonest" session expiration.
275 const vector<AuthnStatement*>& statements = const_cast<const saml2::Assertion*>(decrypted)->getAuthnStatements();
276 for (vector<AuthnStatement*>::const_iterator s = statements.begin(); s!=statements.end(); ++s) {
277 if (!ssoStatement || (*s)->getSessionNotOnOrAfterEpoch() < ssoStatement->getSessionNotOnOrAfterEpoch())
281 // Save off the first valid Subject, but favor an unencrypted NameID over anything else.
282 if (!ssoSubject || (!ssoSubject->getNameID() && decrypted->getSubject()->getNameID()))
283 ssoSubject = decrypted->getSubject();
285 catch (exception& ex) {
286 m_log.warn("detected a problem with assertion: %s", ex.what());
287 badtokens.push_back(decrypted);
292 for_each(ownedtokens.begin(), ownedtokens.end(), xmltooling::cleanup<saml2::Assertion>());
293 if (addressMismatch.empty())
294 throw FatalProfileException("A valid authentication statement was not found in the incoming message.");
295 throw FatalProfileException(addressMismatch.c_str());
298 // May need to decrypt NameID.
299 bool ownedName = false;
300 NameID* ssoName = ssoSubject->getNameID();
302 EncryptedID* encname = ssoSubject->getEncryptedID();
305 m_log.warn("found encrypted NameID, but no decryption credential was available");
307 Locker credlocker(cr);
308 auto_ptr<MetadataCredentialCriteria> mcc(
309 policy.getIssuerMetadata() ? new MetadataCredentialCriteria(*policy.getIssuerMetadata()) : NULL
312 auto_ptr<XMLObject> decryptedID(encname->decrypt(*cr,application.getXMLString("entityID").second,mcc.get()));
313 ssoName = dynamic_cast<NameID*>(decryptedID.get());
316 decryptedID.release();
319 catch (exception& ex) {
320 m_log.error(ex.what());
326 m_log.debug("SSO profile processing completed successfully");
328 // We've successfully "accepted" at least one SSO token, along with any additional valid tokens.
329 // To complete processing, we need to extract and resolve attributes and then create the session.
331 // Now we have to extract the authentication details for session setup.
333 // Session expiration for SAML 2.0 is jointly IdP- and SP-driven.
334 time_t sessionExp = ssoStatement->getSessionNotOnOrAfter() ? ssoStatement->getSessionNotOnOrAfterEpoch() : 0;
335 const PropertySet* sessionProps = application.getPropertySet("Sessions");
336 pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
337 if (!lifetime.first || lifetime.second == 0)
338 lifetime.second = 28800;
340 sessionExp = now + lifetime.second; // IdP says nothing, calulate based on SP.
342 sessionExp = min(sessionExp, now + lifetime.second); // Use the lowest.
344 const AuthnContext* authnContext = ssoStatement->getAuthnContext();
347 // The context will handle deleting attributes and new tokens.
348 auto_ptr<ResolutionContext> ctx(
351 policy.getIssuerMetadata(),
352 samlconstants::SAML20P_NS,
355 (authnContext && authnContext->getAuthnContextClassRef()) ? authnContext->getAuthnContextClassRef()->getReference() : NULL,
356 (authnContext && authnContext->getAuthnContextDeclRef()) ? authnContext->getAuthnContextDeclRef()->getReference() : NULL,
362 // Copy over any new tokens, but leave them in the context for cleanup.
363 tokens.insert(tokens.end(), ctx->getResolvedAssertions().begin(), ctx->getResolvedAssertions().end());
366 // Now merge in bad tokens for caching.
367 tokens.insert(tokens.end(), badtokens.begin(), badtokens.end());
369 string key = application.getServiceProvider().getSessionCache()->insert(
372 httpRequest.getRemoteAddr().c_str(),
373 policy.getIssuerMetadata() ? dynamic_cast<const EntityDescriptor*>(policy.getIssuerMetadata()->getParent()) : NULL,
374 samlconstants::SAML20P_NS,
376 ssoStatement->getAuthnInstant() ? ssoStatement->getAuthnInstant()->getRawData() : NULL,
377 ssoStatement->getSessionIndex(),
378 (authnContext && authnContext->getAuthnContextClassRef()) ? authnContext->getAuthnContextClassRef()->getReference() : NULL,
379 (authnContext && authnContext->getAuthnContextDeclRef()) ? authnContext->getAuthnContextDeclRef()->getReference() : NULL,
381 ctx.get() ? &ctx->getResolvedAttributes() : NULL
386 for_each(ownedtokens.begin(), ownedtokens.end(), xmltooling::cleanup<saml2::Assertion>());
392 for_each(ownedtokens.begin(), ownedtokens.end(), xmltooling::cleanup<saml2::Assertion>());