fix order problem that caused name identifier construction to occur before attribute...
[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 import java.util.List;
24
25 import javax.servlet.RequestDispatcher;
26 import javax.servlet.ServletException;
27 import javax.servlet.ServletRequest;
28 import javax.servlet.ServletResponse;
29 import javax.servlet.http.HttpServletRequest;
30 import javax.servlet.http.HttpServletResponse;
31 import javax.servlet.http.HttpSession;
32
33 import org.apache.log4j.Logger;
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.saml1.core.AttributeStatement;
39 import org.opensaml.saml1.core.AuthenticationStatement;
40 import org.opensaml.saml1.core.Request;
41 import org.opensaml.saml1.core.Response;
42 import org.opensaml.saml1.core.Statement;
43 import org.opensaml.saml1.core.StatusCode;
44 import org.opensaml.saml1.core.Subject;
45 import org.opensaml.saml1.core.SubjectLocality;
46 import org.opensaml.saml2.metadata.AssertionConsumerService;
47 import org.opensaml.saml2.metadata.Endpoint;
48 import org.opensaml.saml2.metadata.RoleDescriptor;
49 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
50 import org.opensaml.xml.util.DatatypeHelper;
51
52 import edu.internet2.middleware.shibboleth.common.ShibbolethConstants;
53 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
54 import edu.internet2.middleware.shibboleth.common.profile.ProfileRequest;
55 import edu.internet2.middleware.shibboleth.common.profile.ProfileResponse;
56 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
57 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.ShibbolethSSOConfiguration;
58 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
59 import edu.internet2.middleware.shibboleth.idp.authn.LoginContext;
60 import edu.internet2.middleware.shibboleth.idp.authn.ShibbolethSSOLoginContext;
61
62 /** Shibboleth SSO request profile handler. */
63 public class ShibbolethSSOProfileHandler extends AbstractSAML1ProfileHandler {
64
65     /** Class logger. */
66     private final Logger log = Logger.getLogger(ShibbolethSSOProfileHandler.class);
67
68     /** Builder of AuthenticationStatement objects. */
69     private SAMLObjectBuilder<AuthenticationStatement> authnStatementBuilder;
70
71     /** Builder of SubjectLocality objects. */
72     private SAMLObjectBuilder<SubjectLocality> subjectLocalityBuilder;
73
74     /** URL of the authentication manager servlet. */
75     private String authenticationManagerPath;
76     
77     /** URI of SAML 1 bindings supported for outgoing message encoding. */
78     private ArrayList<String> supportedOutgoingBindings;
79
80     /**
81      * Constructor.
82      * 
83      * @param authnManagerPath path to the authentication manager servlet
84      * @param outgoingBindings URIs of SAML 1 bindings supported for outgoing message encoding
85      * 
86      * @throws IllegalArgumentException thrown if either the authentication manager path or encoding binding URI are
87      *             null or empty
88      */
89     public ShibbolethSSOProfileHandler(String authnManagerPath, List<String> outgoingBindings) {
90         if (DatatypeHelper.isEmpty(authnManagerPath)) {
91             throw new IllegalArgumentException("Authentication manager path may not be null");
92         }
93         authenticationManagerPath = authnManagerPath;
94         
95         if(outgoingBindings == null || outgoingBindings.isEmpty()){
96             throw new IllegalArgumentException("List of supported outgoing bindings may not be empty");
97         }
98         supportedOutgoingBindings = new ArrayList<String>(outgoingBindings);
99
100         authnStatementBuilder = (SAMLObjectBuilder<AuthenticationStatement>) getBuilderFactory().getBuilder(
101                 AuthenticationStatement.DEFAULT_ELEMENT_NAME);
102
103         subjectLocalityBuilder = (SAMLObjectBuilder<SubjectLocality>) getBuilderFactory().getBuilder(
104                 SubjectLocality.DEFAULT_ELEMENT_NAME);
105     }
106
107     /** {@inheritDoc} */
108     public String getProfileId() {
109         return "urn:mace:shibboleth:2.0:idp:profiles:shibboleth:request:sso";
110     }
111
112     /** {@inheritDoc} */
113     public void processRequest(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response)
114             throws ProfileException {
115
116         if (response.getRawResponse().isCommitted()) {
117             log.error("HTTP Response already committed");
118         }
119
120         if (log.isDebugEnabled()) {
121             log.debug("Processing incomming request");
122         }
123         HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
124         if (httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY) == null) {
125             if (log.isDebugEnabled()) {
126                 log.debug("User session does not contain a login context, processing as first leg of request");
127             }
128             performAuthentication(request, response);
129         } else {
130             if (log.isDebugEnabled()) {
131                 log.debug("User session contains a login context, processing as second leg of request");
132             }
133             completeAuthenticationRequest(request, response);
134         }
135     }
136
137     /**
138      * Creates a {@link LoginContext} an sends the request off to the AuthenticationManager to begin the process of
139      * authenticating the user.
140      * 
141      * @param request current request
142      * @param response current response
143      * 
144      * @throws ProfileException thrown if there is a problem creating the login context and transferring control to the
145      *             authentication manager
146      */
147     protected void performAuthentication(ProfileRequest<ServletRequest> request,
148             ProfileResponse<ServletResponse> response) throws ProfileException {
149
150         HttpServletRequest httpRequest = (HttpServletRequest) request.getRawRequest();
151         HttpServletResponse httpResponse = (HttpServletResponse) response.getRawResponse();
152         HttpSession httpSession = httpRequest.getSession(true);
153
154         LoginContext loginContext = buildLoginContext(httpRequest);
155         if (getRelyingPartyConfiguration(loginContext.getRelyingPartyId()) == null) {
156             log.error("Shibboleth SSO profile is not configured for relying party " + loginContext.getRelyingPartyId());
157             throw new ProfileException("Shibboleth SSO profile is not configured for relying party "
158                     + loginContext.getRelyingPartyId());
159         }
160
161         httpSession.setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
162
163         try {
164             RequestDispatcher dispatcher = httpRequest.getRequestDispatcher(authenticationManagerPath);
165             dispatcher.forward(httpRequest, httpResponse);
166             return;
167         } catch (IOException ex) {
168             log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
169             throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
170         } catch (ServletException ex) {
171             log.error("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
172             throw new ProfileException("Error forwarding Shibboleth SSO request to AuthenticationManager", ex);
173         }
174     }
175
176     /**
177      * Creates a response to the Shibboleth SSO and sends the user, with response in tow, back to the relying party
178      * after they've been authenticated.
179      * 
180      * @param request current request
181      * @param response current response
182      * 
183      * @throws ProfileException thrown if the response can not be created and sent back to the relying party
184      */
185     protected void completeAuthenticationRequest(ProfileRequest<ServletRequest> request,
186             ProfileResponse<ServletResponse> response) throws ProfileException {
187         HttpSession httpSession = ((HttpServletRequest) request.getRawRequest()).getSession(true);
188
189         ShibbolethSSOLoginContext loginContext = (ShibbolethSSOLoginContext) httpSession
190                 .getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
191         httpSession.removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
192
193         ShibbolethSSORequestContext requestContext = buildRequestContext(loginContext, request, response);
194
195         Response samlResponse;
196         try {
197             if (loginContext.getPrincipalName() == null) {
198                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "User failed authentication"));
199                 throw new ProfileException("User failed authentication");
200             }
201
202             //TODO currently attribute query must come first in order to get the principal's attributes, fix this
203             AttributeStatement attributeStatement = buildAttributeStatement(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:bearer");
204             AuthenticationStatement authnStatement = buildAuthenticationStatement(requestContext);
205             
206             ArrayList<Statement> statements = new ArrayList<Statement>();
207             //TODO make this more effecient
208             statements.add(authnStatement);
209             if (requestContext.getProfileConfiguration().includeAttributeStatement()) {
210                 statements.add(attributeStatement);
211             }
212
213             samlResponse = buildResponse(requestContext, statements);
214         } catch (ProfileException e) {
215             samlResponse = buildErrorResponse(requestContext);
216         }
217
218         requestContext.setSamlResponse(samlResponse);
219         encodeResponse(requestContext);
220         writeAuditLogEntry(requestContext);
221     }
222
223     /**
224      * Creates a login context from the incoming HTTP request.
225      * 
226      * @param request current HTTP request
227      * 
228      * @return the constructed login context
229      * 
230      * @throws ProfileException thrown if the incomming request did not contain a providerId, shire, and target
231      *             parameter
232      */
233     protected ShibbolethSSOLoginContext buildLoginContext(HttpServletRequest request) throws ProfileException {
234         ShibbolethSSOLoginContext loginContext = new ShibbolethSSOLoginContext();
235
236         try {
237             String providerId = DatatypeHelper.safeTrimOrNullString(request.getParameter("providerId"));
238             if (providerId == null) {
239                 log.error("No providerId parameter in Shibboleth SSO request");
240                 throw new ProfileException("No providerId parameter in Shibboleth SSO request");
241             }
242             loginContext.setRelyingParty(URLDecoder.decode(providerId, "UTF-8"));
243
244             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(providerId);
245             if (rpConfig == null) {
246                 log.error("No relying party configuration available for " + providerId);
247                 throw new ProfileException("No relying party configuration available for " + providerId);
248             }
249             loginContext.getRequestedAuthenticationMethods().add(rpConfig.getDefaultAuthenticationMethod());
250
251             String acs = DatatypeHelper.safeTrimOrNullString(request.getParameter("shire"));
252             if (acs == null) {
253                 log.error("No shire parameter in Shibboleth SSO request");
254                 throw new ProfileException("No shire parameter in Shibboleth SSO request");
255             }
256             loginContext.setSpAssertionConsumerService(URLDecoder.decode(acs, "UTF-8"));
257
258             String target = DatatypeHelper.safeTrimOrNullString(request.getParameter("target"));
259             if (target == null) {
260                 log.error("No target parameter in Shibboleth SSO request");
261                 throw new ProfileException("No target parameter in Shibboleth SSO request");
262             }
263             loginContext.setSpTarget(URLDecoder.decode(target, "UTF-8"));
264         } catch (UnsupportedEncodingException e) {
265             // UTF-8 encoding required to be supported by all JVMs.
266         }
267
268         loginContext.setAuthenticationEngineURL(authenticationManagerPath);
269         loginContext.setProfileHandlerURL(HttpHelper.getRequestUriWithoutContext(request));
270         return loginContext;
271     }
272
273     /**
274      * Creates an authentication request context from the current environmental information.
275      * 
276      * @param loginContext current login context
277      * @param request current request
278      * @param response current response
279      * 
280      * @return created authentication request context
281      * 
282      * @throws ProfileException thrown if asserting and relying party metadata can not be located
283      */
284     protected ShibbolethSSORequestContext buildRequestContext(ShibbolethSSOLoginContext loginContext,
285             ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response) throws ProfileException {
286         ShibbolethSSORequestContext requestContext = new ShibbolethSSORequestContext(request, response);
287
288         requestContext.setLoginContext(loginContext);
289
290         requestContext.setPrincipalName(loginContext.getPrincipalName());
291
292         requestContext.setPrincipalAuthenticationMethod(loginContext.getAuthenticationMethod());
293
294         String relyingPartyId = loginContext.getRelyingPartyId();
295
296         requestContext.setRelyingPartyId(relyingPartyId);
297
298         populateRelyingPartyData(requestContext);
299
300         populateAssertingPartyData(requestContext);
301
302         return requestContext;
303     }
304
305     /**
306      * Populates the relying party entity and role metadata and relying party configuration data.
307      * 
308      * @param requestContext current request context with relying party ID populated
309      * 
310      * @throws ProfileException thrown if metadata can not be located for the relying party
311      */
312     protected void populateRelyingPartyData(ShibbolethSSORequestContext requestContext) throws ProfileException {
313         try {
314             requestContext.setRelyingPartyMetadata(getMetadataProvider().getEntityDescriptor(
315                     requestContext.getRelyingPartyId()));
316
317             RoleDescriptor relyingPartyRole = requestContext.getRelyingPartyMetadata().getSPSSODescriptor(
318                     ShibbolethConstants.SAML11P_NS);
319
320             if (relyingPartyRole == null) {
321                 relyingPartyRole = requestContext.getRelyingPartyMetadata().getSPSSODescriptor(
322                         ShibbolethConstants.SAML10P_NS);
323                 if (relyingPartyRole == null) {
324                     throw new MetadataProviderException("Unable to locate SPSSO role descriptor for entity "
325                             + requestContext.getRelyingPartyId());
326                 }
327             }
328             requestContext.setRelyingPartyRoleMetadata(relyingPartyRole);
329
330             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(requestContext.getRelyingPartyId());
331             requestContext.setRelyingPartyConfiguration(rpConfig);
332
333             requestContext.setProfileConfiguration((ShibbolethSSOConfiguration) rpConfig
334                     .getProfileConfiguration(ShibbolethSSOConfiguration.PROFILE_ID));
335
336         } catch (MetadataProviderException e) {
337             log.error("Unable to locate metadata for relying party " + requestContext.getRelyingPartyId());
338             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
339                     "Unable to locate metadata for relying party " + requestContext.getRelyingPartyId()));
340             throw new ProfileException("Unable to locate metadata for relying party "
341                     + requestContext.getRelyingPartyId());
342         }
343     }
344
345     /**
346      * Populates the asserting party entity and role metadata.
347      * 
348      * @param requestContext current request context with relying party configuration populated
349      * 
350      * @throws ProfileException thrown if metadata can not be located for the asserting party
351      */
352     protected void populateAssertingPartyData(ShibbolethSSORequestContext requestContext) throws ProfileException {
353         String assertingPartyId = requestContext.getRelyingPartyConfiguration().getProviderId();
354
355         try {
356             requestContext.setAssertingPartyId(assertingPartyId);
357
358             requestContext.setAssertingPartyMetadata(getMetadataProvider().getEntityDescriptor(assertingPartyId));
359
360             RoleDescriptor assertingPartyRole = requestContext.getAssertingPartyMetadata().getIDPSSODescriptor(
361                     ShibbolethConstants.SHIB_SSO_PROFILE_URI);
362             if (assertingPartyRole == null) {
363                 throw new MetadataProviderException("Unable to locate IDPSSO role descriptor for entity "
364                         + assertingPartyId);
365             }
366             requestContext.setAssertingPartyRoleMetadata(assertingPartyRole);
367         } catch (MetadataProviderException e) {
368             log.error("Unable to locate metadata for asserting party " + assertingPartyId);
369             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
370                     "Unable to locate metadata for relying party " + assertingPartyId));
371             throw new ProfileException("Unable to locate metadata for relying party " + assertingPartyId);
372         }
373     }
374
375     /**
376      * Builds the authentication statement for the authenticated principal.
377      * 
378      * @param requestContext current request context
379      * 
380      * @return the created statement
381      * 
382      * @throws ProfileException thrown if the authentication statement can not be created
383      */
384     protected AuthenticationStatement buildAuthenticationStatement(ShibbolethSSORequestContext requestContext)
385             throws ProfileException {
386         ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
387
388         AuthenticationStatement statement = authnStatementBuilder.buildObject();
389         statement.setAuthenticationInstant(loginContext.getAuthenticationInstant());
390         statement.setAuthenticationMethod(loginContext.getAuthenticationMethod());
391
392         statement.setSubjectLocality(buildSubjectLocality(requestContext));
393
394         Subject statementSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:bearer");
395         statement.setSubject(statementSubject);
396
397         return statement;
398     }
399
400     /**
401      * Constructs the subject locality for the authentication statement.
402      * 
403      * @param requestContext curent request context
404      * 
405      * @return subject locality for the authentication statement
406      */
407     protected SubjectLocality buildSubjectLocality(ShibbolethSSORequestContext requestContext) {
408         SubjectLocality subjectLocality = subjectLocalityBuilder.buildObject();
409
410         HttpServletRequest httpRequest = (HttpServletRequest) requestContext.getProfileRequest().getRawRequest();
411         subjectLocality.setIPAddress(httpRequest.getRemoteAddr());
412         subjectLocality.setDNSAddress(httpRequest.getRemoteHost());
413
414         return subjectLocality;
415     }
416
417     /**
418      * Encodes the request's SAML response and writes it to the servlet response.
419      * 
420      * @param requestContext current request context
421      * 
422      * @throws ProfileException thrown if no message encoder is registered for this profiles binding
423      */
424     protected void encodeResponse(ShibbolethSSORequestContext requestContext) throws ProfileException {
425         if (log.isDebugEnabled()) {
426             log.debug("Encoding response to SAML request from relying party " + requestContext.getRelyingPartyId());
427         }
428
429         Endpoint relyingPartyEndpoint;
430
431         BasicEndpointSelector endpointSelector = new BasicEndpointSelector();
432         endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
433         endpointSelector.setMetadataProvider(getMetadataProvider());
434         endpointSelector.setRelyingParty(requestContext.getRelyingPartyMetadata());
435         endpointSelector.setRelyingPartyRole(requestContext.getRelyingPartyRoleMetadata());
436         endpointSelector.setSamlRequest(requestContext.getSamlRequest());
437         endpointSelector.getSupportedIssuerBindings().addAll(supportedOutgoingBindings);
438         relyingPartyEndpoint = endpointSelector.selectEndpoint();
439
440         if (relyingPartyEndpoint == null) {
441             log.error("Unable to determine endpoint, from metadata, for relying party "
442                     + requestContext.getRelyingPartyId() + " acting in SPSSO role");
443             throw new ProfileException("Unable to determine endpoint, from metadata, for relying party "
444                     + requestContext.getRelyingPartyId() + " acting in SPSSO role");
445         }
446
447         MessageEncoder<ServletResponse> encoder = getMessageEncoderFactory().getMessageEncoder(
448                 relyingPartyEndpoint.getBinding());
449         encoder.setRelyingPartyEndpoint(relyingPartyEndpoint);
450         super.populateMessageEncoder(encoder);
451         encoder.setRelayState(requestContext.getLoginContext().getSpTarget());
452         ProfileResponse<ServletResponse> profileResponse = requestContext.getProfileResponse();
453         encoder.setResponse(profileResponse.getRawResponse());
454         encoder.setSamlMessage(requestContext.getSamlResponse());
455         requestContext.setMessageEncoder(encoder);
456
457         try {
458             encoder.encode();
459         } catch (BindingException e) {
460             throw new ProfileException("Unable to encode response to relying party: "
461                     + requestContext.getRelyingPartyId(), e);
462         }
463     }
464
465     /** Represents the internal state of a Shibboleth SSO Request while it's being processed by the IdP. */
466     protected class ShibbolethSSORequestContext extends
467             SAML1ProfileRequestContext<Request, Response, ShibbolethSSOConfiguration> {
468
469         /** Current login context. */
470         private ShibbolethSSOLoginContext loginContext;
471
472         /**
473          * Constructor.
474          * 
475          * @param request current profile request
476          * @param response current profile response
477          */
478         public ShibbolethSSORequestContext(ProfileRequest<ServletRequest> request,
479                 ProfileResponse<ServletResponse> response) {
480             super(request, response);
481         }
482
483         /**
484          * Gets the current login context.
485          * 
486          * @return current login context
487          */
488         public ShibbolethSSOLoginContext getLoginContext() {
489             return loginContext;
490         }
491
492         /**
493          * Sets the current login context.
494          * 
495          * @param context current login context
496          */
497         public void setLoginContext(ShibbolethSSOLoginContext context) {
498             loginContext = context;
499         }
500     }
501 }