2 * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
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.
17 package edu.internet2.middleware.shibboleth.idp.profile.saml1;
19 import java.io.IOException;
20 import java.io.UnsupportedEncodingException;
21 import java.net.URLDecoder;
22 import java.util.ArrayList;
24 import javax.servlet.RequestDispatcher;
25 import javax.servlet.ServletException;
26 import javax.servlet.ServletRequest;
27 import javax.servlet.ServletResponse;
28 import javax.servlet.http.HttpServletRequest;
29 import javax.servlet.http.HttpServletResponse;
30 import javax.servlet.http.HttpSession;
32 import org.apache.log4j.Logger;
33 import org.opensaml.common.SAMLObject;
34 import org.opensaml.common.SAMLObjectBuilder;
35 import org.opensaml.common.binding.BindingException;
36 import org.opensaml.common.binding.encoding.MessageEncoder;
37 import org.opensaml.common.xml.SAMLConstants;
38 import org.opensaml.saml1.core.AuthenticationStatement;
39 import org.opensaml.saml1.core.Response;
40 import org.opensaml.saml1.core.Statement;
41 import org.opensaml.saml1.core.StatusCode;
42 import org.opensaml.saml1.core.Subject;
43 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
44 import org.opensaml.xml.util.DatatypeHelper;
46 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
47 import edu.internet2.middleware.shibboleth.common.profile.ProfileRequest;
48 import edu.internet2.middleware.shibboleth.common.profile.ProfileResponse;
49 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
50 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.ShibbolethSSOConfiguration;
51 import edu.internet2.middleware.shibboleth.idp.authn.LoginContext;
52 import edu.internet2.middleware.shibboleth.idp.authn.ShibbolethSSOLoginContext;
54 /** Shibboleth SSO request profile handler. */
55 public class ShibbolethSSOProfileHandler extends AbstractSAML1ProfileHandler {
58 private final Logger log = Logger.getLogger(ShibbolethSSOProfileHandler.class);
60 /** Builder of AuthenticationStatement objects. */
61 private SAMLObjectBuilder<AuthenticationStatement> authnStatementBuilder;
63 /** URL of the authentication manager servlet. */
64 private String authenticationManagerPath;
66 /** Message encoder binding URI. */
67 private String encodingBinding;
72 * @param authnManagerPath path to the authentication manager servlet
73 * @param encoder URI of the encoding binding
75 * @throws IllegalArgumentException thrown if either the authentication manager path or encoding binding URI are
78 public ShibbolethSSOProfileHandler(String authnManagerPath, String encoder) {
79 if (DatatypeHelper.isEmpty(authnManagerPath) || DatatypeHelper.isEmpty(encoder)) {
80 throw new IllegalArgumentException("Authentication manager path and encoder binding URI may not be null");
83 authenticationManagerPath = authnManagerPath;
84 encodingBinding = encoder;
86 authnStatementBuilder = (SAMLObjectBuilder<AuthenticationStatement>) getBuilderFactory().getBuilder(
87 AuthenticationStatement.DEFAULT_ELEMENT_NAME);
91 * Convenience method for getting the SAML 1 AuthenticationStatement builder.
93 * @return SAML 1 AuthenticationStatement builder
95 public SAMLObjectBuilder<AuthenticationStatement> getAuthenticationStatementBuilder() {
96 return authnStatementBuilder;
100 public String getProfileId() {
101 return "urn:mace:shibboleth:2.0:idp:profiles:shibboleth:request:sso";
105 public void processRequest(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response)
106 throws ProfileException {
108 HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
109 if (httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY) == null) {
110 performAuthentication(request, response);
112 completeAuthenticationRequest(request, response);
117 * Creates a {@link LoginContext} an sends the request off to the AuthenticationManager to begin the process of
118 * authenticating the user.
120 * @param request current request
121 * @param response current response
123 * @throws ProfileException thrown if there is a problem creating the login context and transferring control to the
124 * authentication manager
126 protected void performAuthentication(ProfileRequest<ServletRequest> request,
127 ProfileResponse<ServletResponse> response) throws ProfileException {
129 HttpServletRequest httpRequest = (HttpServletRequest) request.getRawRequest();
130 HttpServletResponse httpResponse = (HttpServletResponse) response.getRawResponse();
131 HttpSession httpSession = httpRequest.getSession(true);
133 LoginContext loginContext = buildLoginContext(httpRequest);
134 httpSession.setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
137 RequestDispatcher dispatcher = httpRequest.getRequestDispatcher(authenticationManagerPath);
138 dispatcher.forward(httpRequest, httpResponse);
139 } catch (IOException ex) {
140 log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
141 throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
142 } catch (ServletException ex) {
143 log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
144 throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
149 * Creates a response to the Shibboleth SSO and sends the user, with response in tow, back to the relying party
150 * after they've been authenticated.
152 * @param request current request
153 * @param response current response
155 * @throws ProfileException thrown if the response can not be created and sent back to the relying party
157 protected void completeAuthenticationRequest(ProfileRequest<ServletRequest> request,
158 ProfileResponse<ServletResponse> response) throws ProfileException {
159 HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
161 ShibbolethSSOLoginContext loginContext = (ShibbolethSSOLoginContext) httpSession
162 .getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
163 httpSession.removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
165 ShibbolethSSORequestContext requestContext = buildRequestContext(loginContext, request, response);
167 Response samlResponse;
169 if (!loginContext.isPrincipalAuthenticated()) {
170 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "User failed authentication"));
171 throw new ProfileException("User failed authentication");
174 ArrayList<Statement> statements = new ArrayList<Statement>();
175 statements.add(buildAuthenticationStatement(requestContext));
176 if (requestContext.getProfileConfiguration().includeAttributeStatement()) {
178 .add(buildAttributeStatement(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:sender-vouches"));
181 samlResponse = buildResponse(requestContext, statements);
182 } catch (ProfileException e) {
183 samlResponse = buildErrorResponse(requestContext);
186 requestContext.setSamlResponse(samlResponse);
187 encodeResponse(requestContext);
188 writeAuditLogEntry(requestContext);
192 * Creates a login context from the incoming HTTP request.
194 * @param request current HTTP request
196 * @return the constructed login context
198 * @throws ProfileException thrown if the incomming request did not contain a providerId, shire, and target
201 protected ShibbolethSSOLoginContext buildLoginContext(HttpServletRequest request) throws ProfileException {
202 ShibbolethSSOLoginContext loginContext = new ShibbolethSSOLoginContext();
205 String providerId = DatatypeHelper.safeTrimOrNullString(request.getParameter("providerId"));
206 if (providerId == null) {
207 log.error("No providerId parameter in Shibboleth SSO request");
208 throw new ProfileException("No providerId parameter in Shibboleth SSO request");
210 loginContext.setRelyingParty(URLDecoder.decode(providerId, "UTF-8"));
212 RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(providerId);
213 if(rpConfig == null){
214 log.error("No relying party configuration available for " + providerId);
215 throw new ProfileException("No relying party configuration available for " + providerId);
217 loginContext.getRequestedAuthenticationMethods().add(rpConfig.getDefaultAuthenticationMethod());
219 String acs = DatatypeHelper.safeTrimOrNullString(request.getParameter("shire"));
221 log.error("No shire parameter in Shibboleth SSO request");
222 throw new ProfileException("No shire parameter in Shibboleth SSO request");
224 loginContext.setSpAssertionConsumerService(URLDecoder.decode(acs, "UTF-8"));
226 String target = DatatypeHelper.safeTrimOrNullString(request.getParameter("target"));
227 if (target == null) {
228 log.error("No target parameter in Shibboleth SSO request");
229 throw new ProfileException("No target parameter in Shibboleth SSO request");
231 loginContext.setSpTarget(URLDecoder.decode(target, "UTF-8"));
232 } catch (UnsupportedEncodingException e) {
233 // UTF-8 encoding required to be supported by all JVMs.
236 loginContext.setAuthenticationEngineURL(authenticationManagerPath);
237 loginContext.setProfileHandlerURL(request.getRequestURI());
242 * Creates an authentication request context from the current environmental information.
244 * @param loginContext current login context
245 * @param request current request
246 * @param response current response
248 * @return created authentication request context
250 * @throws ProfileException thrown if asserting and relying party metadata can not be located
252 protected ShibbolethSSORequestContext buildRequestContext(ShibbolethSSOLoginContext loginContext,
253 ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response) throws ProfileException {
254 ShibbolethSSORequestContext requestContext = new ShibbolethSSORequestContext(request, response);
256 requestContext.setLoginContext(loginContext);
258 requestContext.setPrincipalName(loginContext.getPrincipalName());
260 requestContext.setPrincipalAuthenticationMethod(loginContext.getAuthenticationMethod());
262 String relyingPartyId = loginContext.getRelyingPartyId();
264 requestContext.setRelyingPartyId(relyingPartyId);
268 requestContext.setRelyingPartyMetadata(getMetadataProvider().getEntityDescriptor(
269 requestContext.getRelyingPartyId()));
271 requestContext.setRelyingPartyRoleMetadata(requestContext.getRelyingPartyMetadata().getSPSSODescriptor(
272 SAMLConstants.SAML1P_NS));
274 RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
275 requestContext.setRelyingPartyConfiguration(rpConfig);
277 requestContext.setAssertingPartyId(requestContext.getRelyingPartyConfiguration().getProviderId());
279 requestContext.setAssertingPartyMetadata(getMetadataProvider().getEntityDescriptor(
280 requestContext.getAssertingPartyId()));
282 requestContext.setAssertingPartyRoleMetadata(requestContext.getAssertingPartyMetadata()
283 .getIDPSSODescriptor(SAMLConstants.SAML1P_NS));
285 requestContext.setProfileConfiguration((ShibbolethSSOConfiguration) rpConfig
286 .getProfileConfiguration(ShibbolethSSOConfiguration.PROFILE_ID));
288 return requestContext;
289 } catch (MetadataProviderException e) {
290 log.error("Unable to locate metadata for asserting or relying party");
291 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error locating party metadata"));
292 throw new ProfileException("Error locating party metadata");
297 * Builds the authentication statement for the authenticated principal.
299 * @param requestContext current request context
301 * @return the created statement
303 * @throws ProfileException thrown if the authentication statement can not be created
305 protected AuthenticationStatement buildAuthenticationStatement(ShibbolethSSORequestContext requestContext)
306 throws ProfileException {
307 ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
309 AuthenticationStatement statement = getAuthenticationStatementBuilder().buildObject();
310 statement.setAuthenticationInstant(loginContext.getAuthenticationInstant());
311 statement.setAuthenticationMethod(loginContext.getAuthenticationMethod());
314 statement.setSubjectLocality(null);
316 Subject statementSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:sender-vouches");
317 statement.setSubject(statementSubject);
323 * Encodes the request's SAML response and writes it to the servlet response.
325 * @param requestContext current request context
327 * @throws ProfileException thrown if no message encoder is registered for this profiles binding
329 protected void encodeResponse(ShibbolethSSORequestContext requestContext) throws ProfileException {
330 if (log.isDebugEnabled()) {
331 log.debug("Encoding response to SAML request from relying party " + requestContext.getRelyingPartyId());
333 MessageEncoder<ServletResponse> encoder = getMessageEncoderFactory().getMessageEncoder(encodingBinding);
334 if (encoder == null) {
335 throw new ProfileException("No response encoder was registered for binding type: " + encodingBinding);
338 super.populateMessageEncoder(encoder);
339 ProfileResponse<ServletResponse> profileResponse = requestContext.getProfileResponse();
340 encoder.setResponse(profileResponse.getRawResponse());
341 encoder.setSamlMessage(requestContext.getSamlResponse());
342 requestContext.setMessageEncoder(encoder);
346 } catch (BindingException e) {
347 throw new ProfileException("Unable to encode response to relying party: "
348 + requestContext.getRelyingPartyId(), e);
352 /** Represents the internal state of a Shibboleth SSO Request while it's being processed by the IdP. */
353 protected class ShibbolethSSORequestContext extends
354 SAML1ProfileRequestContext<SAMLObject, Response, ShibbolethSSOConfiguration> {
356 /** Current login context. */
357 private ShibbolethSSOLoginContext loginContext;
362 * @param request current profile request
363 * @param response current profile response
365 public ShibbolethSSORequestContext(ProfileRequest<ServletRequest> request,
366 ProfileResponse<ServletResponse> response) {
367 super(request, response);
371 * Gets the current login context.
373 * @return current login context
375 public ShibbolethSSOLoginContext getLoginContext() {
380 * Sets the current login context.
382 * @param context current login context
384 public void setLoginContext(ShibbolethSSOLoginContext context) {
385 loginContext = context;