Remove login context during exception, not in a finally block
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / profile / saml2 / SSOProfileHandler.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.saml2;
18
19 import java.io.IOException;
20 import java.util.ArrayList;
21
22 import javax.servlet.RequestDispatcher;
23 import javax.servlet.ServletException;
24 import javax.servlet.http.HttpServletRequest;
25 import javax.servlet.http.HttpSession;
26
27 import org.apache.log4j.Logger;
28 import org.opensaml.common.SAMLObjectBuilder;
29 import org.opensaml.common.binding.decoding.SAMLMessageDecoder;
30 import org.opensaml.common.xml.SAMLConstants;
31 import org.opensaml.saml2.binding.AuthnResponseEndpointSelector;
32 import org.opensaml.saml2.core.AuthnContext;
33 import org.opensaml.saml2.core.AuthnContextClassRef;
34 import org.opensaml.saml2.core.AuthnContextDeclRef;
35 import org.opensaml.saml2.core.AuthnRequest;
36 import org.opensaml.saml2.core.AuthnStatement;
37 import org.opensaml.saml2.core.RequestedAuthnContext;
38 import org.opensaml.saml2.core.Response;
39 import org.opensaml.saml2.core.Statement;
40 import org.opensaml.saml2.core.StatusCode;
41 import org.opensaml.saml2.core.SubjectLocality;
42 import org.opensaml.saml2.metadata.AssertionConsumerService;
43 import org.opensaml.saml2.metadata.Endpoint;
44 import org.opensaml.saml2.metadata.EntityDescriptor;
45 import org.opensaml.saml2.metadata.IDPSSODescriptor;
46 import org.opensaml.saml2.metadata.SPSSODescriptor;
47 import org.opensaml.saml2.metadata.provider.MetadataProvider;
48 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
49 import org.opensaml.ws.message.decoder.MessageDecodingException;
50 import org.opensaml.ws.security.SecurityPolicyException;
51 import org.opensaml.ws.transport.http.HTTPInTransport;
52 import org.opensaml.ws.transport.http.HTTPOutTransport;
53 import org.opensaml.ws.transport.http.HttpServletRequestAdapter;
54 import org.opensaml.ws.transport.http.HttpServletResponseAdapter;
55 import org.opensaml.xml.io.MarshallingException;
56 import org.opensaml.xml.io.UnmarshallingException;
57
58 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
59 import edu.internet2.middleware.shibboleth.common.relyingparty.ProfileConfiguration;
60 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
61 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml2.SSOConfiguration;
62 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
63 import edu.internet2.middleware.shibboleth.idp.authn.LoginContext;
64 import edu.internet2.middleware.shibboleth.idp.authn.Saml2LoginContext;
65
66 /** SAML 2.0 SSO request profile handler. */
67 public class SSOProfileHandler extends AbstractSAML2ProfileHandler {
68
69     /** Class logger. */
70     private final Logger log = Logger.getLogger(SSOProfileHandler.class);
71
72     /** Builder of AuthnStatement objects. */
73     private SAMLObjectBuilder<AuthnStatement> authnStatementBuilder;
74
75     /** Builder of AuthnContext objects. */
76     private SAMLObjectBuilder<AuthnContext> authnContextBuilder;
77
78     /** Builder of AuthnContextClassRef objects. */
79     private SAMLObjectBuilder<AuthnContextClassRef> authnContextClassRefBuilder;
80
81     /** Builder of AuthnContextDeclRef objects. */
82     private SAMLObjectBuilder<AuthnContextDeclRef> authnContextDeclRefBuilder;
83
84     /** Builder of SubjectLocality objects. */
85     private SAMLObjectBuilder<SubjectLocality> subjectLocalityBuilder;
86
87     /** URL of the authentication manager servlet. */
88     private String authenticationManagerPath;
89
90     /** URI of request decoder. */
91     private String decodingBinding;
92
93     /**
94      * Constructor.
95      * 
96      * @param authnManagerPath path to the authentication manager servlet
97      */
98     @SuppressWarnings("unchecked")
99     public SSOProfileHandler(String authnManagerPath) {
100         super();
101
102         authenticationManagerPath = authnManagerPath;
103
104         authnStatementBuilder = (SAMLObjectBuilder<AuthnStatement>) getBuilderFactory().getBuilder(
105                 AuthnStatement.DEFAULT_ELEMENT_NAME);
106         authnContextBuilder = (SAMLObjectBuilder<AuthnContext>) getBuilderFactory().getBuilder(
107                 AuthnContext.DEFAULT_ELEMENT_NAME);
108         authnContextClassRefBuilder = (SAMLObjectBuilder<AuthnContextClassRef>) getBuilderFactory().getBuilder(
109                 AuthnContextClassRef.DEFAULT_ELEMENT_NAME);
110         authnContextDeclRefBuilder = (SAMLObjectBuilder<AuthnContextDeclRef>) getBuilderFactory().getBuilder(
111                 AuthnContextDeclRef.DEFAULT_ELEMENT_NAME);
112         subjectLocalityBuilder = (SAMLObjectBuilder<SubjectLocality>) getBuilderFactory().getBuilder(
113                 SubjectLocality.DEFAULT_ELEMENT_NAME);
114     }
115
116     /** {@inheritDoc} */
117     public String getProfileId() {
118         return "urn:mace:shibboleth:2.0:idp:profiles:saml2:request:sso";
119     }
120
121     /** {@inheritDoc} */
122     public void processRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport) throws ProfileException {
123         HttpServletRequest servletRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
124         HttpSession httpSession = servletRequest.getSession(true);
125
126         if (httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY) == null) {
127             performAuthentication(inTransport, outTransport);
128         } else {
129             completeAuthenticationRequest(inTransport, outTransport);
130         }
131     }
132
133     /**
134      * Creates a {@link Saml2LoginContext} an sends the request off to the AuthenticationManager to begin the process of
135      * authenticating the user.
136      * 
137      * @param inTransport inbound request transport
138      * @param outTransport outbound response transport
139      * 
140      * @throws ProfileException thrown if there is a problem creating the login context and transferring control to the
141      *             authentication manager
142      */
143     protected void performAuthentication(HTTPInTransport inTransport, HTTPOutTransport outTransport)
144             throws ProfileException {
145         HttpServletRequest servletRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
146         HttpSession httpSession = servletRequest.getSession();
147
148         try {
149             SSORequestContext requestContext = decodeRequest(inTransport, outTransport);
150
151             String relyingPartyId = requestContext.getInboundMessageIssuer();
152             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
153             ProfileConfiguration ssoConfig = rpConfig.getProfileConfiguration(SSOConfiguration.PROFILE_ID);
154             if (ssoConfig == null) {
155                 log.error("SAML 2 SSO profile is not configured for relying party " + requestContext.getInboundMessageIssuer());
156                 throw new ProfileException("SAML 2 SSO profile is not configured for relying party "
157                         + requestContext.getInboundMessageIssuer());
158             }
159
160             log.debug("Creating login context and transferring control to authentication engine");
161             Saml2LoginContext loginContext = new Saml2LoginContext(relyingPartyId, requestContext.getRelayState(),
162                     requestContext.getInboundSAMLMessage());
163             loginContext.setAuthenticationEngineURL(authenticationManagerPath);
164             loginContext.setProfileHandlerURL(HttpHelper.getRequestUriWithoutContext(servletRequest));
165             if (loginContext.getRequestedAuthenticationMethods().size() == 0) {
166                 loginContext.getRequestedAuthenticationMethods().add(rpConfig.getDefaultAuthenticationMethod());
167             }
168             
169             httpSession.setAttribute(Saml2LoginContext.LOGIN_CONTEXT_KEY, loginContext);
170             RequestDispatcher dispatcher = servletRequest.getRequestDispatcher(authenticationManagerPath);
171             dispatcher.forward(servletRequest, ((HttpServletResponseAdapter) outTransport).getWrappedResponse());
172         } catch (MarshallingException e) {
173             httpSession.removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
174             log.error("Unable to marshall authentication request context");
175             throw new ProfileException("Unable to marshall authentication request context", e);
176         } catch (IOException ex) {
177             httpSession.removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
178             log.error("Error forwarding SAML 2 AuthnRequest to AuthenticationManager", ex);
179             throw new ProfileException("Error forwarding SAML 2 AuthnRequest to AuthenticationManager", ex);
180         } catch (ServletException ex) {
181             httpSession.removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
182             log.error("Error forwarding SAML 2 AuthnRequest to AuthenticationManager", ex);
183             throw new ProfileException("Error forwarding SAML 2 AuthnRequest to AuthenticationManager", ex);
184         }
185     }
186
187     /**
188      * Creates a response to the {@link AuthnRequest} and sends the user, with response in tow, back to the relying
189      * party after they've been authenticated.
190      * 
191      * @param inTransport inbound message transport
192      * @param outTransport outbound message transport
193      * 
194      * @throws ProfileException thrown if the response can not be created and sent back to the relying party
195      */
196     protected void completeAuthenticationRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
197             throws ProfileException {
198         HttpServletRequest servletRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
199         HttpSession httpSession = servletRequest.getSession();
200
201         Saml2LoginContext loginContext = (Saml2LoginContext) httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
202         httpSession.removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
203
204         SSORequestContext requestContext = buildRequestContext(loginContext, inTransport, outTransport);
205
206         checkSamlVersion(requestContext);
207
208         Response samlResponse;
209         try {
210             if (loginContext.getPrincipalName() == null) {
211                 log.error("User's login context did not contain a principal, user considered unauthenticiated.");
212                 requestContext
213                         .setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.AUTHN_FAILED_URI, null));
214                 throw new ProfileException("User failed authentication");
215             }
216
217             resolveAttributes(requestContext);
218
219             ArrayList<Statement> statements = new ArrayList<Statement>();
220             statements.add(buildAuthnStatement(requestContext));
221             if (requestContext.getProfileConfiguration().includeAttributeStatement()) {
222                 requestContext.setRequestedAttributes(requestContext.getPrincipalAttributes().keySet());
223                 statements.add(buildAttributeStatement(requestContext));
224             }
225
226             samlResponse = buildResponse(requestContext, "urn:oasis:names:tc:SAML:2.0:cm:bearer", statements);
227         } catch (ProfileException e) {
228             samlResponse = buildErrorResponse(requestContext);
229         }
230
231         requestContext.setOutboundSAMLMessage(samlResponse);
232         requestContext.setOutboundSAMLMessageId(samlResponse.getID());
233         requestContext.setOutboundSAMLMessageIssueInstant(samlResponse.getIssueInstant());
234         encodeResponse(requestContext);
235         writeAuditLogEntry(requestContext);
236     }
237
238     /**
239      * Decodes an incoming request and stores the information in a created request context.
240      * 
241      * @param inTransport inbound transport
242      * @param outTransport outbound transport
243      * 
244      * @return request context with decoded information
245      * 
246      * @throws ProfileException thrown if the incomming message failed decoding
247      */
248     protected SSORequestContext decodeRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
249             throws ProfileException {
250         if (log.isDebugEnabled()) {
251             log.debug("Decoding message with decoder binding " + decodingBinding);
252         }
253
254         SSORequestContext requestContext = new SSORequestContext();
255         requestContext.setMetadataProvider(getMetadataProvider());
256         
257         requestContext.setInboundMessageTransport(inTransport);
258         requestContext.setInboundSAMLProtocol(SAMLConstants.SAML20P_NS);
259         requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
260         
261         requestContext.setOutboundMessageTransport(outTransport);
262         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML20P_NS);
263
264         try {
265             SAMLMessageDecoder decoder = getMessageDecoders().get(getInboundBinding());
266             requestContext.setMessageDecoder(decoder);
267             decoder.decode(requestContext);
268             return requestContext;
269         } catch (MessageDecodingException e) {
270             log.error("Error decoding authentication request message", e);
271             throw new ProfileException("Error decoding authentication request message", e);
272         } catch (SecurityPolicyException e) {
273             log.error("Message did not meet security policy requirements", e);
274             throw new ProfileException("Message did not meet security policy requirements", e);
275         }
276     }
277
278     /**
279      * Creates an authentication request context from the current environmental information.
280      * 
281      * @param loginContext current login context
282      * @param in inbound transport
283      * @param out outbount transport
284      * 
285      * @return created authentication request context
286      * 
287      * @throws ProfileException thrown if there is a problem creating the context
288      */
289     protected SSORequestContext buildRequestContext(Saml2LoginContext loginContext, HTTPInTransport in,
290             HTTPOutTransport out) throws ProfileException {
291         SSORequestContext requestContext = new SSORequestContext();
292
293         try {
294             requestContext.setMessageDecoder(getMessageDecoders().get(getInboundBinding()));
295             
296             requestContext.setLoginContext(loginContext);
297             requestContext.setPrincipalName(loginContext.getPrincipalName());
298             requestContext.setPrincipalAuthenticationMethod(loginContext.getAuthenticationMethod());
299             requestContext.setUserSession(getUserSession(in));
300             requestContext.setRelayState(loginContext.getRelayState());
301
302             requestContext.setInboundMessageTransport(in);
303             requestContext.setInboundSAMLProtocol(SAMLConstants.SAML20P_NS);
304             requestContext.setInboundMessage(loginContext.getAuthenticationRequest());
305             requestContext.setInboundSAMLMessage(loginContext.getAuthenticationRequest());
306             requestContext.setInboundSAMLMessageId(loginContext.getAuthenticationRequest().getID());
307
308             MetadataProvider metadataProvider = getMetadataProvider();
309             requestContext.setMetadataProvider(metadataProvider);
310
311             String relyingPartyId = loginContext.getRelyingPartyId();
312             requestContext.setInboundMessageIssuer(relyingPartyId);
313             EntityDescriptor relyingPartyMetadata = metadataProvider.getEntityDescriptor(relyingPartyId);
314             requestContext.setPeerEntityMetadata(relyingPartyMetadata);
315             requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
316             requestContext.setPeerEntityRoleMetadata(relyingPartyMetadata.getSPSSODescriptor(SAMLConstants.SAML20P_NS));
317             RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
318             requestContext.setRelyingPartyConfiguration(rpConfig);
319             requestContext.setPeerEntityEndpoint(selectEndpoint(requestContext));
320
321             String assertingPartyId = rpConfig.getProviderId();
322             requestContext.setLocalEntityId(assertingPartyId);
323             EntityDescriptor assertingPartyMetadata = metadataProvider.getEntityDescriptor(assertingPartyId);
324             requestContext.setLocalEntityMetadata(assertingPartyMetadata);
325             requestContext.setLocalEntityRole(IDPSSODescriptor.DEFAULT_ELEMENT_NAME);
326             requestContext.setLocalEntityRoleMetadata(assertingPartyMetadata
327                     .getIDPSSODescriptor(SAMLConstants.SAML20P_NS));
328
329             requestContext.setOutboundMessageTransport(out);
330             requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML20P_NS);
331             SSOConfiguration profileConfig = (SSOConfiguration) rpConfig
332                     .getProfileConfiguration(SSOConfiguration.PROFILE_ID);
333             requestContext.setProfileConfiguration(profileConfig);
334             requestContext.setOutboundMessageArtifactType(profileConfig.getOutboundArtifactType());
335             if (profileConfig.getSigningCredential() != null) {
336                 requestContext.setOutboundSAMLMessageSigningCredential(profileConfig.getSigningCredential());
337             } else if (rpConfig.getDefaultSigningCredential() != null) {
338                 requestContext.setOutboundSAMLMessageSigningCredential(rpConfig.getDefaultSigningCredential());
339             }
340
341             return requestContext;
342         } catch (UnmarshallingException e) {
343             log.error("Unable to unmarshall authentication request context");
344             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
345                     "Error recovering request state"));
346             throw new ProfileException("Error recovering request state", e);
347         } catch (MetadataProviderException e) {
348             log.error("Unable to locate metadata for asserting or relying party");
349             requestContext
350                     .setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error locating party metadata"));
351             throw new ProfileException("Error locating party metadata");
352         }
353     }
354
355     /**
356      * Creates an authentication statement for the current request.
357      * 
358      * @param requestContext current request context
359      * 
360      * @return constructed authentication statement
361      */
362     protected AuthnStatement buildAuthnStatement(SSORequestContext requestContext) {
363         Saml2LoginContext loginContext = requestContext.getLoginContext();
364
365         AuthnContext authnContext = buildAuthnContext(requestContext);
366
367         AuthnStatement statement = authnStatementBuilder.buildObject();
368         statement.setAuthnContext(authnContext);
369         statement.setAuthnInstant(loginContext.getAuthenticationInstant());
370
371         // TODO
372         statement.setSessionIndex(null);
373
374         if (loginContext.getAuthenticationDuration() > 0) {
375             statement.setSessionNotOnOrAfter(loginContext.getAuthenticationInstant().plus(
376                     loginContext.getAuthenticationDuration()));
377         }
378
379         statement.setSubjectLocality(buildSubjectLocality(requestContext));
380
381         return statement;
382     }
383
384     /**
385      * Creates an {@link AuthnContext} for a succesful authentication request.
386      * 
387      * @param requestContext current request
388      * 
389      * @return the built authn context
390      */
391     protected AuthnContext buildAuthnContext(SSORequestContext requestContext) {
392         AuthnContext authnContext = authnContextBuilder.buildObject();
393
394         Saml2LoginContext loginContext = requestContext.getLoginContext();
395         AuthnRequest authnRequest = requestContext.getInboundSAMLMessage();
396         RequestedAuthnContext requestedAuthnContext = authnRequest.getRequestedAuthnContext();
397         if (requestedAuthnContext != null) {
398             if (requestedAuthnContext.getAuthnContextClassRefs() != null) {
399                 for (AuthnContextClassRef classRef : requestedAuthnContext.getAuthnContextClassRefs()) {
400                     if (classRef.getAuthnContextClassRef().equals(loginContext.getAuthenticationMethod())) {
401                         AuthnContextClassRef ref = authnContextClassRefBuilder.buildObject();
402                         ref.setAuthnContextClassRef(loginContext.getAuthenticationMethod());
403                         authnContext.setAuthnContextClassRef(ref);
404                     }
405                 }
406             } else if (requestedAuthnContext.getAuthnContextDeclRefs() != null) {
407                 for (AuthnContextDeclRef declRef : requestedAuthnContext.getAuthnContextDeclRefs()) {
408                     if (declRef.getAuthnContextDeclRef().equals(loginContext.getAuthenticationMethod())) {
409                         AuthnContextDeclRef ref = authnContextDeclRefBuilder.buildObject();
410                         ref.setAuthnContextDeclRef(loginContext.getAuthenticationMethod());
411                         authnContext.setAuthnContextDeclRef(ref);
412                     }
413                 }
414             }
415         } else {
416             AuthnContextDeclRef ref = authnContextDeclRefBuilder.buildObject();
417             ref.setAuthnContextDeclRef(loginContext.getAuthenticationMethod());
418             authnContext.setAuthnContextDeclRef(ref);
419         }
420
421         return authnContext;
422     }
423
424     /**
425      * Constructs the subject locality for the authentication statement.
426      * 
427      * @param requestContext curent request context
428      * 
429      * @return subject locality for the authentication statement
430      */
431     protected SubjectLocality buildSubjectLocality(SSORequestContext requestContext) {
432         HTTPInTransport transport = (HTTPInTransport) requestContext.getInboundMessageTransport();
433         SubjectLocality subjectLocality = subjectLocalityBuilder.buildObject();
434         subjectLocality.setAddress(transport.getPeerAddress());
435         subjectLocality.setDNSName(transport.getPeerDomainName());
436
437         return subjectLocality;
438     }
439
440     /**
441      * Selects the appropriate endpoint for the relying party and stores it in the request context.
442      * 
443      * @param requestContext current request context
444      * 
445      * @return Endpoint selected from the information provided in the request context
446      */
447     protected Endpoint selectEndpoint(SSORequestContext requestContext) {
448         AuthnResponseEndpointSelector endpointSelector = new AuthnResponseEndpointSelector();
449         endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
450         endpointSelector.setMetadataProvider(getMetadataProvider());
451         endpointSelector.setEntityMetadata(requestContext.getPeerEntityMetadata());
452         endpointSelector.setEntityRoleMetadata(requestContext.getPeerEntityRoleMetadata());
453         endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
454         endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
455         return endpointSelector.selectEndpoint();
456     }
457
458     /** Represents the internal state of a SAML 2.0 SSO Request while it's being processed by the IdP. */
459     protected class SSORequestContext extends BaseSAML2ProfileRequestContext<AuthnRequest, Response, SSOConfiguration> {
460
461         /** Current login context. */
462         private Saml2LoginContext loginContext;
463
464         /**
465          * Gets the current login context.
466          * 
467          * @return current login context
468          */
469         public Saml2LoginContext getLoginContext() {
470             return loginContext;
471         }
472
473         /**
474          * Sets the current login context.
475          * 
476          * @param context current login context
477          */
478         public void setLoginContext(Saml2LoginContext context) {
479             loginContext = context;
480         }
481     }
482 }