3f31a287f924014c1bcebe328005ab4de4fc14ce
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / profile / saml1 / ShibbolethSSOProfileHandler.java
1 /*
2  * Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 package edu.internet2.middleware.shibboleth.idp.profile.saml1;
18
19 import java.io.IOException;
20 import java.io.UnsupportedEncodingException;
21 import java.net.URLDecoder;
22 import java.util.ArrayList;
23
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;
31
32 import org.apache.log4j.Logger;
33 import org.opensaml.common.SAMLObject;
34 import org.opensaml.common.SAMLObjectBuilder;
35 import org.opensaml.common.binding.BasicEndpointSelector;
36 import org.opensaml.common.binding.BindingException;
37 import org.opensaml.common.binding.encoding.MessageEncoder;
38 import org.opensaml.common.xml.SAMLConstants;
39 import org.opensaml.saml1.core.AuthenticationStatement;
40 import org.opensaml.saml1.core.Response;
41 import org.opensaml.saml1.core.Statement;
42 import org.opensaml.saml1.core.StatusCode;
43 import org.opensaml.saml1.core.Subject;
44 import org.opensaml.saml2.metadata.AssertionConsumerService;
45 import org.opensaml.saml2.metadata.Endpoint;
46 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
47 import org.opensaml.xml.util.DatatypeHelper;
48
49 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
50 import edu.internet2.middleware.shibboleth.common.profile.ProfileRequest;
51 import edu.internet2.middleware.shibboleth.common.profile.ProfileResponse;
52 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
53 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.ShibbolethSSOConfiguration;
54 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
55 import edu.internet2.middleware.shibboleth.idp.authn.LoginContext;
56 import edu.internet2.middleware.shibboleth.idp.authn.ShibbolethSSOLoginContext;
57
58 /** Shibboleth SSO request profile handler. */
59 public class ShibbolethSSOProfileHandler extends AbstractSAML1ProfileHandler {
60
61     /** Class logger. */
62     private final Logger log = Logger.getLogger(ShibbolethSSOProfileHandler.class);
63
64     /** Builder of AuthenticationStatement objects. */
65     private SAMLObjectBuilder<AuthenticationStatement> authnStatementBuilder;
66
67     /** URL of the authentication manager servlet. */
68     private String authenticationManagerPath;
69
70     /**
71      * Constructor.
72      * 
73      * @param authnManagerPath path to the authentication manager servlet
74      * 
75      * @throws IllegalArgumentException thrown if either the authentication manager path or encoding binding URI are
76      *             null or empty
77      */
78     public ShibbolethSSOProfileHandler(String authnManagerPath) {
79         if (DatatypeHelper.isEmpty(authnManagerPath)) {
80             throw new IllegalArgumentException("Authentication manager path may not be null");
81         }
82
83         authenticationManagerPath = authnManagerPath;
84
85         authnStatementBuilder = (SAMLObjectBuilder<AuthenticationStatement>) getBuilderFactory().getBuilder(
86                 AuthenticationStatement.DEFAULT_ELEMENT_NAME);
87     }
88
89     /**
90      * Convenience method for getting the SAML 1 AuthenticationStatement builder.
91      * 
92      * @return SAML 1 AuthenticationStatement builder
93      */
94     public SAMLObjectBuilder<AuthenticationStatement> getAuthenticationStatementBuilder() {
95         return authnStatementBuilder;
96     }
97
98     /** {@inheritDoc} */
99     public String getProfileId() {
100         return "urn:mace:shibboleth:2.0:idp:profiles:shibboleth:request:sso";
101     }
102
103     /** {@inheritDoc} */
104     public void processRequest(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response)
105             throws ProfileException {
106
107         if (response.getRawResponse().isCommitted()) {
108             log.error("HTTP Response already committed");
109         }
110
111         if (log.isDebugEnabled()) {
112             log.debug("Processing incomming request");
113         }
114         HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
115         if (httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY) == null) {
116             if (log.isDebugEnabled()) {
117                 log.debug("User session does not contain a login context, processing as first leg of request");
118             }
119             performAuthentication(request, response);
120         } else {
121             if (log.isDebugEnabled()) {
122                 log.debug("User session contains a login context, processing as second leg of request");
123             }
124             completeAuthenticationRequest(request, response);
125         }
126     }
127
128     /**
129      * Creates a {@link LoginContext} an sends the request off to the AuthenticationManager to begin the process of
130      * authenticating the user.
131      * 
132      * @param request current request
133      * @param response current response
134      * 
135      * @throws ProfileException thrown if there is a problem creating the login context and transferring control to the
136      *             authentication manager
137      */
138     protected void performAuthentication(ProfileRequest<ServletRequest> request,
139             ProfileResponse<ServletResponse> response) throws ProfileException {
140
141         HttpServletRequest httpRequest = (HttpServletRequest) request.getRawRequest();
142         HttpServletResponse httpResponse = (HttpServletResponse) response.getRawResponse();
143         HttpSession httpSession = httpRequest.getSession(true);
144
145         LoginContext loginContext = buildLoginContext(httpRequest);
146         if (getRelyingPartyConfiguration(loginContext.getRelyingPartyId()) == null) {
147             log.error("Shibboleth SSO profile is not configured for relying party "
148                     + loginContext.getRelyingPartyId());
149             throw new ProfileException("Shibboleth SSO profile is not configured for relying party "
150                     + loginContext.getRelyingPartyId());
151         }
152
153         httpSession.setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
154
155         try {
156             RequestDispatcher dispatcher = httpRequest.getRequestDispatcher(authenticationManagerPath);
157             dispatcher.forward(httpRequest, httpResponse);
158             return;
159         } catch (IOException ex) {
160             log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
161             throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
162         } catch (ServletException ex) {
163             log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
164             throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
165         }
166     }
167
168     /**
169      * Creates a response to the Shibboleth SSO and sends the user, with response in tow, back to the relying party
170      * after they've been authenticated.
171      * 
172      * @param request current request
173      * @param response current response
174      * 
175      * @throws ProfileException thrown if the response can not be created and sent back to the relying party
176      */
177     protected void completeAuthenticationRequest(ProfileRequest<ServletRequest> request,
178             ProfileResponse<ServletResponse> response) throws ProfileException {
179         HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
180
181         ShibbolethSSOLoginContext loginContext = (ShibbolethSSOLoginContext) httpSession
182                 .getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
183         httpSession.removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
184
185         ShibbolethSSORequestContext requestContext = buildRequestContext(loginContext, request, response);
186
187         Response samlResponse;
188         try {
189             if (!loginContext.isPrincipalAuthenticated()) {
190                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "User failed authentication"));
191                 throw new ProfileException("User failed authentication");
192             }
193
194             ArrayList<Statement> statements = new ArrayList<Statement>();
195             statements.add(buildAuthenticationStatement(requestContext));
196             if (requestContext.getProfileConfiguration().includeAttributeStatement()) {
197                 statements
198                         .add(buildAttributeStatement(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:sender-vouches"));
199             }
200
201             samlResponse = buildResponse(requestContext, statements);
202         } catch (ProfileException e) {
203             samlResponse = buildErrorResponse(requestContext);
204         }
205
206         requestContext.setSamlResponse(samlResponse);
207         encodeResponse(requestContext);
208         writeAuditLogEntry(requestContext);
209     }
210
211     /**
212      * Creates a login context from the incoming HTTP request.
213      * 
214      * @param request current HTTP request
215      * 
216      * @return the constructed login context
217      * 
218      * @throws ProfileException thrown if the incomming request did not contain a providerId, shire, and target
219      *             parameter
220      */
221     protected ShibbolethSSOLoginContext buildLoginContext(HttpServletRequest request) throws ProfileException {
222         ShibbolethSSOLoginContext loginContext = new ShibbolethSSOLoginContext();
223
224         try {
225             String providerId = DatatypeHelper.safeTrimOrNullString(request.getParameter("providerId"));
226             if (providerId == null) {
227                 log.error("No providerId parameter in Shibboleth SSO request");
228                 throw new ProfileException("No providerId parameter in Shibboleth SSO request");
229             }
230             loginContext.setRelyingParty(URLDecoder.decode(providerId, "UTF-8"));
231
232             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(providerId);
233             if (rpConfig == null) {
234                 log.error("No relying party configuration available for " + providerId);
235                 throw new ProfileException("No relying party configuration available for " + providerId);
236             }
237             loginContext.getRequestedAuthenticationMethods().add(rpConfig.getDefaultAuthenticationMethod());
238
239             String acs = DatatypeHelper.safeTrimOrNullString(request.getParameter("shire"));
240             if (acs == null) {
241                 log.error("No shire parameter in Shibboleth SSO request");
242                 throw new ProfileException("No shire parameter in Shibboleth SSO request");
243             }
244             loginContext.setSpAssertionConsumerService(URLDecoder.decode(acs, "UTF-8"));
245
246             String target = DatatypeHelper.safeTrimOrNullString(request.getParameter("target"));
247             if (target == null) {
248                 log.error("No target parameter in Shibboleth SSO request");
249                 throw new ProfileException("No target parameter in Shibboleth SSO request");
250             }
251             loginContext.setSpTarget(URLDecoder.decode(target, "UTF-8"));
252         } catch (UnsupportedEncodingException e) {
253             // UTF-8 encoding required to be supported by all JVMs.
254         }
255
256         loginContext.setAuthenticationEngineURL(authenticationManagerPath);
257         loginContext.setProfileHandlerURL(HttpHelper.getRequestUriWithoutContext(request));
258         return loginContext;
259     }
260
261     /**
262      * Creates an authentication request context from the current environmental information.
263      * 
264      * @param loginContext current login context
265      * @param request current request
266      * @param response current response
267      * 
268      * @return created authentication request context
269      * 
270      * @throws ProfileException thrown if asserting and relying party metadata can not be located
271      */
272     protected ShibbolethSSORequestContext buildRequestContext(ShibbolethSSOLoginContext loginContext,
273             ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response) throws ProfileException {
274         ShibbolethSSORequestContext requestContext = new ShibbolethSSORequestContext(request, response);
275
276         requestContext.setLoginContext(loginContext);
277
278         requestContext.setPrincipalName(loginContext.getPrincipalName());
279
280         requestContext.setPrincipalAuthenticationMethod(loginContext.getAuthenticationMethod());
281
282         String relyingPartyId = loginContext.getRelyingPartyId();
283
284         requestContext.setRelyingPartyId(relyingPartyId);
285
286         try {
287
288             requestContext.setRelyingPartyMetadata(getMetadataProvider().getEntityDescriptor(
289                     requestContext.getRelyingPartyId()));
290
291             requestContext.setRelyingPartyRoleMetadata(requestContext.getRelyingPartyMetadata().getSPSSODescriptor(
292                     SAMLConstants.SAML1P_NS));
293
294             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
295             requestContext.setRelyingPartyConfiguration(rpConfig);
296
297             requestContext.setAssertingPartyId(requestContext.getRelyingPartyConfiguration().getProviderId());
298
299             requestContext.setAssertingPartyMetadata(getMetadataProvider().getEntityDescriptor(
300                     requestContext.getAssertingPartyId()));
301
302             requestContext.setAssertingPartyRoleMetadata(requestContext.getAssertingPartyMetadata()
303                     .getIDPSSODescriptor(SAMLConstants.SAML1P_NS));
304
305             requestContext.setProfileConfiguration((ShibbolethSSOConfiguration) rpConfig
306                     .getProfileConfiguration(ShibbolethSSOConfiguration.PROFILE_ID));
307
308             return requestContext;
309         } catch (MetadataProviderException e) {
310             log.error("Unable to locate metadata for asserting or relying party");
311             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error locating party metadata"));
312             throw new ProfileException("Error locating party metadata");
313         }
314     }
315
316     /**
317      * Builds the authentication statement for the authenticated principal.
318      * 
319      * @param requestContext current request context
320      * 
321      * @return the created statement
322      * 
323      * @throws ProfileException thrown if the authentication statement can not be created
324      */
325     protected AuthenticationStatement buildAuthenticationStatement(ShibbolethSSORequestContext requestContext)
326             throws ProfileException {
327         ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
328
329         AuthenticationStatement statement = getAuthenticationStatementBuilder().buildObject();
330         statement.setAuthenticationInstant(loginContext.getAuthenticationInstant());
331         statement.setAuthenticationMethod(loginContext.getAuthenticationMethod());
332
333         // TODO
334         statement.setSubjectLocality(null);
335
336         Subject statementSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:sender-vouches");
337         statement.setSubject(statementSubject);
338
339         return statement;
340     }
341
342     /**
343      * Encodes the request's SAML response and writes it to the servlet response.
344      * 
345      * @param requestContext current request context
346      * 
347      * @throws ProfileException thrown if no message encoder is registered for this profiles binding
348      */
349     protected void encodeResponse(ShibbolethSSORequestContext requestContext) throws ProfileException {
350         if (log.isDebugEnabled()) {
351             log.debug("Encoding response to SAML request from relying party " + requestContext.getRelyingPartyId());
352         }
353
354         BasicEndpointSelector endpointSelector = new BasicEndpointSelector();
355         endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
356         endpointSelector.setMetadataProvider(getMetadataProvider());
357         endpointSelector.setRelyingParty(requestContext.getRelyingPartyMetadata());
358         endpointSelector.setRelyingPartyRole(requestContext.getRelyingPartyRoleMetadata());
359         endpointSelector.setSamlRequest(requestContext.getSamlRequest());
360         endpointSelector.getSupportedIssuerBindings().addAll(getMessageEncoderFactory().getEncoderBuilders().keySet());
361         Endpoint relyingPartyEndpoint = endpointSelector.selectEndpoint();
362
363         if (relyingPartyEndpoint == null) {
364             log.error("Unable to determine endpoint, from metadata, for relying party "
365                     + requestContext.getRelyingPartyId() + " acting in SPSSO role");
366             throw new ProfileException("Unable to determine endpoint, from metadata, for relying party "
367                     + requestContext.getRelyingPartyId() + " acting in SPSSO role");
368         }
369
370         MessageEncoder<ServletResponse> encoder = getMessageEncoderFactory().getMessageEncoder(
371                 relyingPartyEndpoint.getBinding());
372
373         super.populateMessageEncoder(encoder);
374         ProfileResponse<ServletResponse> profileResponse = requestContext.getProfileResponse();
375         encoder.setResponse(profileResponse.getRawResponse());
376         encoder.setSamlMessage(requestContext.getSamlResponse());
377         requestContext.setMessageEncoder(encoder);
378
379         try {
380             encoder.encode();
381         } catch (BindingException e) {
382             throw new ProfileException("Unable to encode response to relying party: "
383                     + requestContext.getRelyingPartyId(), e);
384         }
385     }
386
387     /** Represents the internal state of a Shibboleth SSO Request while it's being processed by the IdP. */
388     protected class ShibbolethSSORequestContext extends
389             SAML1ProfileRequestContext<SAMLObject, Response, ShibbolethSSOConfiguration> {
390
391         /** Current login context. */
392         private ShibbolethSSOLoginContext loginContext;
393
394         /**
395          * Constructor.
396          * 
397          * @param request current profile request
398          * @param response current profile response
399          */
400         public ShibbolethSSORequestContext(ProfileRequest<ServletRequest> request,
401                 ProfileResponse<ServletResponse> response) {
402             super(request, response);
403         }
404
405         /**
406          * Gets the current login context.
407          * 
408          * @return current login context
409          */
410         public ShibbolethSSOLoginContext getLoginContext() {
411             return loginContext;
412         }
413
414         /**
415          * Sets the current login context.
416          * 
417          * @param context current login context
418          */
419         public void setLoginContext(ShibbolethSSOLoginContext context) {
420             loginContext = context;
421         }
422     }
423 }