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 1.x 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/saml1/core/Assertions.h>
33 # include <saml/saml1/core/Protocols.h>
34 # include <saml/saml1/profile/BrowserSSOProfileValidator.h>
35 # include <saml/saml2/metadata/Metadata.h>
36 using namespace opensaml::saml1;
37 using namespace opensaml::saml1p;
38 using namespace opensaml;
40 using saml2::NameIDBuilder;
41 using saml2md::EntityDescriptor;
42 using saml2md::SPSSODescriptor;
43 using saml2md::MetadataException;
45 # include "lite/SAMLConstants.h"
48 using namespace shibsp;
49 using namespace xmltooling;
54 #if defined (_MSC_VER)
55 #pragma warning( push )
56 #pragma warning( disable : 4250 )
59 class SHIBSP_DLLLOCAL SAML1Consumer : public AssertionConsumerService
62 SAML1Consumer(const DOMElement* e, const char* appId)
63 : AssertionConsumerService(e, appId, Category::getInstance(SHIBSP_LOGCAT".SSO.SAML1")) {
65 m_post = XMLString::equals(getString("Binding").second, samlconstants::SAML1_PROFILE_BROWSER_POST);
68 virtual ~SAML1Consumer() {}
71 void generateMetadata(SPSSODescriptor& role, const char* handlerURL) const {
72 AssertionConsumerService::generateMetadata(role, handlerURL);
73 role.addSupport(samlconstants::SAML11_PROTOCOL_ENUM);
74 role.addSupport(samlconstants::SAML10_PROTOCOL_ENUM);
78 string implementProtocol(
79 const Application& application,
80 const HTTPRequest& httpRequest,
81 SecurityPolicy& policy,
82 const PropertySet* settings,
83 const XMLObject& xmlObject
89 #if defined (_MSC_VER)
90 #pragma warning( pop )
93 Handler* SHIBSP_DLLLOCAL SAML1ConsumerFactory(const pair<const DOMElement*,const char*>& p)
95 return new SAML1Consumer(p.first, p.second);
102 string SAML1Consumer::implementProtocol(
103 const Application& application,
104 const HTTPRequest& httpRequest,
105 SecurityPolicy& policy,
106 const PropertySet* settings,
107 const XMLObject& xmlObject
110 // Implementation of SAML 1.x SSO profile(s).
111 m_log.debug("processing message against SAML 1.x SSO profile");
113 // Check for errors...this will throw if it's not a successful message.
114 checkError(&xmlObject);
116 // With the binding aspects now moved out to the MessageDecoder,
117 // the focus here is on the assertion content. For SAML 1.x POST,
118 // all the security comes from the protocol layer, and signing
119 // the assertion isn't sufficient. So we can check the policy
120 // object now and bail if it's not a secured message.
121 if (m_post && !policy.isAuthenticated()) {
122 if (policy.getIssuer() && !policy.getIssuerMetadata())
123 throw MetadataException("Security of SAML 1.x SSO POST response not established.");
124 throw SecurityPolicyException("Security of SAML 1.x SSO POST response not established.");
127 // Remember whether we already established trust.
128 bool alreadySecured = policy.isAuthenticated();
130 const Response* response = dynamic_cast<const Response*>(&xmlObject);
132 throw FatalProfileException("Incoming message was not a samlp:Response.");
134 const vector<saml1::Assertion*>& assertions = response->getAssertions();
135 if (assertions.empty())
136 throw FatalProfileException("Incoming message contained no SAML assertions.");
138 pair<bool,int> minor = response->getMinorVersion();
140 // Maintain list of "legit" tokens to feed to SP subsystems.
141 const AuthenticationStatement* ssoStatement=NULL;
142 vector<const opensaml::Assertion*> tokens;
144 // Also track "bad" tokens that we'll cache but not use.
145 // This is necessary because there may be valid tokens not aimed at us.
146 vector<const opensaml::Assertion*> badtokens;
148 // Profile validator.
149 time_t now = time(NULL);
150 BrowserSSOProfileValidator ssoValidator(application.getAudiences(), now);
152 // With this flag on, we ignore any unsigned assertions.
153 pair<bool,bool> flag = settings->getBool("signedAssertions");
155 // authnskew allows rejection of SSO if AuthnInstant is too old.
156 const PropertySet* sessionProps = application.getPropertySet("Sessions");
157 pair<bool,unsigned int> authnskew = sessionProps ? sessionProps->getUnsignedInt("authnskew") : pair<bool,unsigned int>(false,0);
159 // Saves off error messages potentially helpful for users.
160 string contextualError;
162 for (vector<saml1::Assertion*>::const_iterator a = assertions.begin(); a!=assertions.end(); ++a) {
163 // Skip unsigned assertion?
164 if (!(*a)->getSignature() && flag.first && flag.second) {
165 m_log.warn("found unsigned assertion in SAML response, ignoring it per signedAssertions policy");
166 badtokens.push_back(*a);
171 // We clear the security flag, so we can tell whether the token was secured on its own.
172 policy.setAuthenticated(false);
175 // Extract message bits and re-verify Issuer information.
176 extractMessageDetails(
177 *(*a), (minor.first && minor.second==0) ? samlconstants::SAML10_PROTOCOL_ENUM : samlconstants::SAML11_PROTOCOL_ENUM, policy
180 // Run the policy over the assertion. Handles replay, freshness, and
181 // signature verification, assuming the relevant rules are configured.
182 policy.evaluate(*(*a));
184 // If no security is in place now, we kick it.
185 if (!alreadySecured && !policy.isAuthenticated()) {
186 m_log.warn("unable to establish security of assertion");
187 badtokens.push_back(*a);
191 // Now do profile and core semantic validation to ensure we can use it for SSO.
192 ssoValidator.validateAssertion(*(*a));
194 // Track it as a valid token.
195 tokens.push_back(*a);
197 // Save off the first valid SSO statement.
198 const vector<AuthenticationStatement*>& statements = const_cast<const saml1::Assertion*>(*a)->getAuthenticationStatements();
199 for (vector<AuthenticationStatement*>::const_iterator s = statements.begin(); s!=statements.end(); ++s) {
200 if (authnskew.first && authnskew.second &&
201 (*s)->getAuthenticationInstant() && (now - (*s)->getAuthenticationInstantEpoch() > authnskew.second))
202 contextualError = "The gap between now and the time you logged into your identity provider exceeds the limit.";
203 else if (!ssoStatement) {
209 catch (exception& ex) {
210 m_log.warn("detected a problem with assertion: %s", ex.what());
211 badtokens.push_back(*a);
216 if (contextualError.empty())
217 throw FatalProfileException("A valid authentication statement was not found in the incoming message.");
218 throw FatalProfileException(contextualError.c_str());
222 SubjectLocality* locality = ssoStatement->getSubjectLocality();
223 if (locality && locality->getIPAddress()) {
224 auto_ptr_char ip(locality->getIPAddress());
225 checkAddress(application, httpRequest, ip.get());
228 m_log.debug("SSO profile processing completed successfully");
230 NameIdentifier* n = ssoStatement->getSubject()->getNameIdentifier();
232 // Now we have to extract the authentication details for attribute and session setup.
234 // Session expiration for SAML 1.x is purely SP-driven, and the method is mapped to a ctx class.
235 pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
236 if (!lifetime.first || lifetime.second == 0)
237 lifetime.second = 28800;
239 // We've successfully "accepted" at least one SSO token, along with any additional valid tokens.
240 // To complete processing, we need to extract and resolve attributes and then create the session.
242 // Normalize the SAML 1.x NameIdentifier...
243 auto_ptr<NameID> nameid(n ? NameIDBuilder::buildNameID() : NULL);
245 nameid->setName(n->getName());
246 nameid->setFormat(n->getFormat());
247 nameid->setNameQualifier(n->getNameQualifier());
250 // The context will handle deleting attributes and new tokens.
251 auto_ptr<ResolutionContext> ctx(
254 policy.getIssuerMetadata(),
255 (!response->getMinorVersion().first || response->getMinorVersion().second==1) ?
256 samlconstants::SAML11_PROTOCOL_ENUM : samlconstants::SAML10_PROTOCOL_ENUM,
259 ssoStatement->getAuthenticationMethod(),
266 // Copy over any new tokens, but leave them in the context for cleanup.
267 tokens.insert(tokens.end(), ctx->getResolvedAssertions().begin(), ctx->getResolvedAssertions().end());
270 // Now merge in bad tokens for caching.
271 tokens.insert(tokens.end(), badtokens.begin(), badtokens.end());
273 return application.getServiceProvider().getSessionCache()->insert(
274 now + lifetime.second,
276 httpRequest.getRemoteAddr().c_str(),
277 policy.getIssuerMetadata() ? dynamic_cast<const EntityDescriptor*>(policy.getIssuerMetadata()->getParent()) : NULL,
278 (!response->getMinorVersion().first || response->getMinorVersion().second==1) ?
279 samlconstants::SAML11_PROTOCOL_ENUM : samlconstants::SAML10_PROTOCOL_ENUM,
281 ssoStatement->getAuthenticationInstant() ? ssoStatement->getAuthenticationInstant()->getRawData() : NULL,
283 ssoStatement->getAuthenticationMethod(),
286 ctx.get() ? &ctx->getResolvedAttributes() : NULL