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 void implementProtocol(
79 const Application& application,
80 const HTTPRequest& httpRequest,
81 HTTPResponse& httpResponse,
82 SecurityPolicy& policy,
83 const PropertySet* settings,
84 const XMLObject& xmlObject
90 #if defined (_MSC_VER)
91 #pragma warning( pop )
94 Handler* SHIBSP_DLLLOCAL SAML1ConsumerFactory(const pair<const DOMElement*,const char*>& p)
96 return new SAML1Consumer(p.first, p.second);
103 void SAML1Consumer::implementProtocol(
104 const Application& application,
105 const HTTPRequest& httpRequest,
106 HTTPResponse& httpResponse,
107 SecurityPolicy& policy,
108 const PropertySet* settings,
109 const XMLObject& xmlObject
112 // Implementation of SAML 1.x SSO profile(s).
113 m_log.debug("processing message against SAML 1.x SSO profile");
115 // Check for errors...this will throw if it's not a successful message.
116 checkError(&xmlObject);
118 // With the binding aspects now moved out to the MessageDecoder,
119 // the focus here is on the assertion content. For SAML 1.x POST,
120 // all the security comes from the protocol layer, and signing
121 // the assertion isn't sufficient. So we can check the policy
122 // object now and bail if it's not a secured message.
123 if (m_post && !policy.isAuthenticated()) {
124 if (policy.getIssuer() && !policy.getIssuerMetadata())
125 throw MetadataException("Security of SAML 1.x SSO POST response not established.");
126 throw SecurityPolicyException("Security of SAML 1.x SSO POST response not established.");
129 // Remember whether we already established trust.
130 bool alreadySecured = policy.isAuthenticated();
132 const Response* response = dynamic_cast<const Response*>(&xmlObject);
134 throw FatalProfileException("Incoming message was not a samlp:Response.");
136 const vector<saml1::Assertion*>& assertions = response->getAssertions();
137 if (assertions.empty())
138 throw FatalProfileException("Incoming message contained no SAML assertions.");
140 pair<bool,int> minor = response->getMinorVersion();
142 // Maintain list of "legit" tokens to feed to SP subsystems.
143 const AuthenticationStatement* ssoStatement=NULL;
144 vector<const opensaml::Assertion*> tokens;
146 // Also track "bad" tokens that we'll cache but not use.
147 // This is necessary because there may be valid tokens not aimed at us.
148 vector<const opensaml::Assertion*> badtokens;
150 // Profile validator.
151 time_t now = time(NULL);
152 BrowserSSOProfileValidator ssoValidator(application.getAudiences(), now);
154 // With this flag on, we ignore any unsigned assertions.
155 pair<bool,bool> flag = settings->getBool("signedAssertions");
157 // authnskew allows rejection of SSO if AuthnInstant is too old.
158 const PropertySet* sessionProps = application.getPropertySet("Sessions");
159 pair<bool,unsigned int> authnskew = sessionProps ? sessionProps->getUnsignedInt("authnskew") : pair<bool,unsigned int>(false,0);
161 // Saves off error messages potentially helpful for users.
162 string contextualError;
164 for (vector<saml1::Assertion*>::const_iterator a = assertions.begin(); a!=assertions.end(); ++a) {
165 // Skip unsigned assertion?
166 if (!(*a)->getSignature() && flag.first && flag.second) {
167 m_log.warn("found unsigned assertion in SAML response, ignoring it per signedAssertions policy");
168 badtokens.push_back(*a);
173 // We clear the security flag, so we can tell whether the token was secured on its own.
174 policy.setAuthenticated(false);
177 // Extract message bits and re-verify Issuer information.
178 extractMessageDetails(
179 *(*a), (minor.first && minor.second==0) ? samlconstants::SAML10_PROTOCOL_ENUM : samlconstants::SAML11_PROTOCOL_ENUM, policy
182 // Run the policy over the assertion. Handles replay, freshness, and
183 // signature verification, assuming the relevant rules are configured.
184 policy.evaluate(*(*a));
186 // If no security is in place now, we kick it.
187 if (!alreadySecured && !policy.isAuthenticated()) {
188 m_log.warn("unable to establish security of assertion");
189 badtokens.push_back(*a);
193 // Now do profile and core semantic validation to ensure we can use it for SSO.
194 ssoValidator.validateAssertion(*(*a));
196 // Track it as a valid token.
197 tokens.push_back(*a);
199 // Save off the first valid SSO statement.
200 const vector<AuthenticationStatement*>& statements = const_cast<const saml1::Assertion*>(*a)->getAuthenticationStatements();
201 for (vector<AuthenticationStatement*>::const_iterator s = statements.begin(); s!=statements.end(); ++s) {
202 if (authnskew.first && authnskew.second &&
203 (*s)->getAuthenticationInstant() && (now - (*s)->getAuthenticationInstantEpoch() > authnskew.second))
204 contextualError = "The gap between now and the time you logged into your identity provider exceeds the limit.";
205 else if (!ssoStatement) {
211 catch (exception& ex) {
212 m_log.warn("detected a problem with assertion: %s", ex.what());
213 badtokens.push_back(*a);
218 if (contextualError.empty())
219 throw FatalProfileException("A valid authentication statement was not found in the incoming message.");
220 throw FatalProfileException(contextualError.c_str());
224 SubjectLocality* locality = ssoStatement->getSubjectLocality();
225 if (locality && locality->getIPAddress()) {
226 auto_ptr_char ip(locality->getIPAddress());
227 checkAddress(application, httpRequest, ip.get());
230 m_log.debug("SSO profile processing completed successfully");
232 NameIdentifier* n = ssoStatement->getSubject()->getNameIdentifier();
234 // Now we have to extract the authentication details for attribute and session setup.
236 // Session expiration for SAML 1.x is purely SP-driven, and the method is mapped to a ctx class.
237 pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : pair<bool,unsigned int>(true,28800);
238 if (!lifetime.first || lifetime.second == 0)
239 lifetime.second = 28800;
241 // We've successfully "accepted" at least one SSO token, along with any additional valid tokens.
242 // To complete processing, we need to extract and resolve attributes and then create the session.
244 // Normalize the SAML 1.x NameIdentifier...
245 auto_ptr<NameID> nameid(n ? NameIDBuilder::buildNameID() : NULL);
247 nameid->setName(n->getName());
248 nameid->setFormat(n->getFormat());
249 nameid->setNameQualifier(n->getNameQualifier());
252 // The context will handle deleting attributes and new tokens.
253 auto_ptr<ResolutionContext> ctx(
256 policy.getIssuerMetadata(),
257 (!response->getMinorVersion().first || response->getMinorVersion().second==1) ?
258 samlconstants::SAML11_PROTOCOL_ENUM : samlconstants::SAML10_PROTOCOL_ENUM,
261 ssoStatement->getAuthenticationMethod(),
268 // Copy over any new tokens, but leave them in the context for cleanup.
269 tokens.insert(tokens.end(), ctx->getResolvedAssertions().begin(), ctx->getResolvedAssertions().end());
272 // Now merge in bad tokens for caching.
273 tokens.insert(tokens.end(), badtokens.begin(), badtokens.end());
275 application.getServiceProvider().getSessionCache()->insert(
276 now + lifetime.second,
280 policy.getIssuerMetadata() ? dynamic_cast<const EntityDescriptor*>(policy.getIssuerMetadata()->getParent()) : NULL,
281 (!response->getMinorVersion().first || response->getMinorVersion().second==1) ?
282 samlconstants::SAML11_PROTOCOL_ENUM : samlconstants::SAML10_PROTOCOL_ENUM,
284 ssoStatement->getAuthenticationInstant() ? ssoStatement->getAuthenticationInstant()->getRawData() : NULL,
286 ssoStatement->getAuthenticationMethod(),
289 ctx.get() ? &ctx->getResolvedAttributes() : NULL