Remove use of http session in a couple more places
[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.util.ArrayList;
21
22 import javax.servlet.RequestDispatcher;
23 import javax.servlet.ServletException;
24 import javax.servlet.http.HttpServletRequest;
25 import javax.servlet.http.HttpServletResponse;
26
27 import org.opensaml.common.SAMLObjectBuilder;
28 import org.opensaml.common.binding.decoding.SAMLMessageDecoder;
29 import org.opensaml.common.xml.SAMLConstants;
30 import org.opensaml.saml1.core.AttributeStatement;
31 import org.opensaml.saml1.core.AuthenticationStatement;
32 import org.opensaml.saml1.core.Request;
33 import org.opensaml.saml1.core.Response;
34 import org.opensaml.saml1.core.Statement;
35 import org.opensaml.saml1.core.StatusCode;
36 import org.opensaml.saml1.core.Subject;
37 import org.opensaml.saml1.core.SubjectLocality;
38 import org.opensaml.saml2.metadata.AssertionConsumerService;
39 import org.opensaml.saml2.metadata.Endpoint;
40 import org.opensaml.saml2.metadata.EntityDescriptor;
41 import org.opensaml.saml2.metadata.IDPSSODescriptor;
42 import org.opensaml.saml2.metadata.SPSSODescriptor;
43 import org.opensaml.saml2.metadata.provider.MetadataProvider;
44 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
45 import org.opensaml.ws.message.decoder.MessageDecodingException;
46 import org.opensaml.ws.transport.http.HTTPInTransport;
47 import org.opensaml.ws.transport.http.HTTPOutTransport;
48 import org.opensaml.ws.transport.http.HttpServletRequestAdapter;
49 import org.opensaml.ws.transport.http.HttpServletResponseAdapter;
50 import org.opensaml.xml.security.SecurityException;
51 import org.opensaml.xml.util.DatatypeHelper;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
54
55 import edu.internet2.middleware.shibboleth.common.ShibbolethConstants;
56 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
57 import edu.internet2.middleware.shibboleth.common.relyingparty.ProfileConfiguration;
58 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
59 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.ShibbolethSSOConfiguration;
60 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
61 import edu.internet2.middleware.shibboleth.idp.authn.LoginContext;
62 import edu.internet2.middleware.shibboleth.idp.authn.ShibbolethSSOLoginContext;
63
64 /** Shibboleth SSO request profile handler. */
65 public class ShibbolethSSOProfileHandler extends AbstractSAML1ProfileHandler {
66
67     /** Class logger. */
68     private final Logger log = LoggerFactory.getLogger(ShibbolethSSOProfileHandler.class);
69
70     /** Builder of AuthenticationStatement objects. */
71     private SAMLObjectBuilder<AuthenticationStatement> authnStatementBuilder;
72
73     /** Builder of SubjectLocality objects. */
74     private SAMLObjectBuilder<SubjectLocality> subjectLocalityBuilder;
75
76     /** URL of the authentication manager servlet. */
77     private String authenticationManagerPath;
78
79     /**
80      * Constructor.
81      * 
82      * @param authnManagerPath path to the authentication manager servlet
83      * 
84      * @throws IllegalArgumentException thrown if either the authentication manager path or encoding binding URI are
85      *             null or empty
86      */
87     public ShibbolethSSOProfileHandler(String authnManagerPath) {
88         if (DatatypeHelper.isEmpty(authnManagerPath)) {
89             throw new IllegalArgumentException("Authentication manager path may not be null");
90         }
91         authenticationManagerPath = authnManagerPath;
92
93         authnStatementBuilder = (SAMLObjectBuilder<AuthenticationStatement>) getBuilderFactory().getBuilder(
94                 AuthenticationStatement.DEFAULT_ELEMENT_NAME);
95
96         subjectLocalityBuilder = (SAMLObjectBuilder<SubjectLocality>) getBuilderFactory().getBuilder(
97                 SubjectLocality.DEFAULT_ELEMENT_NAME);
98     }
99
100     /** {@inheritDoc} */
101     public String getProfileId() {
102         return "urn:mace:shibboleth:2.0:idp:profiles:shibboleth:request:sso";
103     }
104
105     /** {@inheritDoc} */
106     public void processRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport) throws ProfileException {
107         log.debug("Processing incoming request");
108
109         HttpServletRequest httpRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
110         LoginContext loginContext = (LoginContext) httpRequest.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
111
112         if (loginContext == null) {
113             log.debug("User session does not contain a login context, processing as first leg of request");
114             performAuthentication(inTransport, outTransport);
115         } else if (!loginContext.isPrincipalAuthenticated() && !loginContext.getAuthenticationAttempted()) {
116             log
117                     .debug("User session contained a login context but user was not authenticated, processing as first leg of request");
118             performAuthentication(inTransport, outTransport);
119         } else {
120             log.debug("User session contains a login context, processing as second leg of request");
121             completeAuthenticationRequest(inTransport, outTransport);
122         }
123     }
124
125     /**
126      * Creates a {@link LoginContext} an sends the request off to the AuthenticationManager to begin the process of
127      * authenticating the user.
128      * 
129      * @param inTransport inbound message transport
130      * @param outTransport outbound message transport
131      * 
132      * @throws ProfileException thrown if there is a problem creating the login context and transferring control to the
133      *             authentication manager
134      */
135     protected void performAuthentication(HTTPInTransport inTransport, HTTPOutTransport outTransport)
136             throws ProfileException {
137
138         HttpServletRequest httpRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
139         HttpServletResponse httpResponse = ((HttpServletResponseAdapter) outTransport).getWrappedResponse();
140
141         ShibbolethSSORequestContext requestContext = decodeRequest(inTransport, outTransport);
142         ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
143
144         RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(loginContext.getRelyingPartyId());
145         ProfileConfiguration ssoConfig = rpConfig.getProfileConfiguration(ShibbolethSSOConfiguration.PROFILE_ID);
146         if (ssoConfig == null) {
147             log.error("Shibboleth SSO profile is not configured for relying party " + loginContext.getRelyingPartyId());
148             throw new ProfileException("Shibboleth SSO profile is not configured for relying party "
149                     + loginContext.getRelyingPartyId());
150         }
151         loginContext.getRequestedAuthenticationMethods().add(rpConfig.getDefaultAuthenticationMethod());
152
153         httpRequest.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      * Decodes an incoming request and populates a created request context with the resultant information.
170      * 
171      * @param inTransport inbound message transport
172      * @param outTransport outbound message transport
173      * 
174      * @return the created request context
175      * 
176      * @throws ProfileException throw if there is a problem decoding the request
177      */
178     protected ShibbolethSSORequestContext decodeRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
179             throws ProfileException {
180         log.debug("Decoding message with decoder binding {}", getInboundBinding());
181
182         HttpServletRequest httpRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
183
184         ShibbolethSSORequestContext requestContext = new ShibbolethSSORequestContext();
185         requestContext.setMetadataProvider(getMetadataProvider());
186         requestContext.setSecurityPolicyResolver(getSecurityPolicyResolver());
187
188         requestContext.setCommunicationProfileId(ShibbolethSSOConfiguration.PROFILE_ID);
189         requestContext.setInboundMessageTransport(inTransport);
190         requestContext.setInboundSAMLProtocol(ShibbolethConstants.SHIB_SSO_PROFILE_URI);
191         requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
192
193         requestContext.setOutboundMessageTransport(outTransport);
194         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML11P_NS);
195
196         SAMLMessageDecoder decoder = getMessageDecoders().get(getInboundBinding());
197         requestContext.setMessageDecoder(decoder);
198         try {
199             decoder.decode(requestContext);
200         } catch (MessageDecodingException e) {
201             log.error("Error decoding Shibboleth SSO request", e);
202             throw new ProfileException("Error decoding Shibboleth SSO request", e);
203         } catch (SecurityException e) {
204             log.error("Shibboleth SSO request does not meet security requirements", e);
205             throw new ProfileException("Shibboleth SSO request does not meet security requirements", e);
206         }
207
208         ShibbolethSSOLoginContext loginContext = new ShibbolethSSOLoginContext();
209         loginContext.setRelyingParty(requestContext.getInboundMessageIssuer());
210         loginContext.setSpAssertionConsumerService(requestContext.getSpAssertionConsumerService());
211         loginContext.setSpTarget(requestContext.getRelayState());
212         loginContext.setAuthenticationEngineURL(authenticationManagerPath);
213         loginContext.setProfileHandlerURL(HttpHelper.getRequestUriWithoutContext(httpRequest));
214
215         requestContext.setLoginContext(loginContext);
216
217         return requestContext;
218     }
219
220     /**
221      * Creates a response to the Shibboleth SSO and sends the user, with response in tow, back to the relying party
222      * after they've been authenticated.
223      * 
224      * @param inTransport inbound message transport
225      * @param outTransport outbound message transport
226      * 
227      * @throws ProfileException thrown if the response can not be created and sent back to the relying party
228      */
229     protected void completeAuthenticationRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
230             throws ProfileException {
231         HttpServletRequest httpRequest = ((HttpServletRequestAdapter) inTransport).getWrappedRequest();
232         ShibbolethSSOLoginContext loginContext = (ShibbolethSSOLoginContext) httpRequest
233                 .getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
234
235         ShibbolethSSORequestContext requestContext = buildRequestContext(loginContext, inTransport, outTransport);
236
237         Response samlResponse;
238         try {
239             if (loginContext.getAuthenticationFailure() != null) {
240                 log.error("User authentication failed with the following error: {}", loginContext
241                         .getAuthenticationFailure().toString());
242                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "User failed authentication"));
243             }
244
245             resolveAttributes(requestContext);
246
247             ArrayList<Statement> statements = new ArrayList<Statement>();
248             statements.add(buildAuthenticationStatement(requestContext));
249             if (requestContext.getProfileConfiguration().includeAttributeStatement()) {
250                 AttributeStatement attributeStatement = buildAttributeStatement(requestContext,
251                         "urn:oasis:names:tc:SAML:1.0:cm:bearer");
252                 if (attributeStatement != null) {
253                     requestContext.setRequestedAttributes(requestContext.getPrincipalAttributes().keySet());
254                     statements.add(attributeStatement);
255                 }
256             }
257
258             samlResponse = buildResponse(requestContext, statements);
259         } catch (ProfileException e) {
260             samlResponse = buildErrorResponse(requestContext);
261         }
262
263         requestContext.setOutboundSAMLMessage(samlResponse);
264         requestContext.setOutboundSAMLMessageId(samlResponse.getID());
265         requestContext.setOutboundSAMLMessageIssueInstant(samlResponse.getIssueInstant());
266         encodeResponse(requestContext);
267         writeAuditLogEntry(requestContext);
268     }
269
270     /**
271      * Creates an authentication request context from the current environmental information.
272      * 
273      * @param loginContext current login context
274      * @param in inbound transport
275      * @param out outbount transport
276      * 
277      * @return created authentication request context
278      * 
279      * @throws ProfileException thrown if there is a problem creating the context
280      */
281     protected ShibbolethSSORequestContext buildRequestContext(ShibbolethSSOLoginContext loginContext,
282             HTTPInTransport in, HTTPOutTransport out) throws ProfileException {
283         ShibbolethSSORequestContext requestContext = new ShibbolethSSORequestContext();
284
285         requestContext.setMessageDecoder(getMessageDecoders().get(getInboundBinding()));
286
287         requestContext.setLoginContext(loginContext);
288         requestContext.setPrincipalName(loginContext.getPrincipalName());
289         requestContext.setPrincipalAuthenticationMethod(loginContext.getAuthenticationMethod());
290         requestContext.setUserSession(getUserSession(in));
291         requestContext.setRelayState(loginContext.getSpTarget());
292
293         requestContext.setInboundMessageTransport(in);
294         requestContext.setInboundSAMLProtocol(ShibbolethConstants.SHIB_SSO_PROFILE_URI);
295
296         requestContext.setOutboundMessageTransport(out);
297         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML20P_NS);
298
299         MetadataProvider metadataProvider = getMetadataProvider();
300         requestContext.setMetadataProvider(metadataProvider);
301
302         String relyingPartyId = loginContext.getRelyingPartyId();
303         requestContext.setInboundMessageIssuer(relyingPartyId);
304
305         try {
306             EntityDescriptor relyingPartyMetadata = metadataProvider.getEntityDescriptor(relyingPartyId);
307             if (relyingPartyMetadata != null) {
308                 requestContext.setPeerEntityMetadata(relyingPartyMetadata);
309                 requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
310                 requestContext.setPeerEntityRoleMetadata(relyingPartyMetadata
311                         .getSPSSODescriptor(SAMLConstants.SAML11P_NS));
312             }
313         } catch (MetadataProviderException e) {
314             log.error("Unable to locate metadata for relying party");
315             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
316                     "Error locating relying party metadata"));
317             throw new ProfileException("Error locating relying party metadata");
318         }
319
320         RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
321         if (rpConfig == null) {
322             log.error("Unable to retrieve relying party configuration data for entity with ID {}", relyingPartyId);
323             throw new ProfileException("Unable to retrieve relying party configuration data for entity with ID "
324                     + relyingPartyId);
325         }
326         requestContext.setRelyingPartyConfiguration(rpConfig);
327
328         ShibbolethSSOConfiguration profileConfig = (ShibbolethSSOConfiguration) rpConfig
329                 .getProfileConfiguration(ShibbolethSSOConfiguration.PROFILE_ID);
330         requestContext.setProfileConfiguration(profileConfig);
331         requestContext.setOutboundMessageArtifactType(profileConfig.getOutboundArtifactType());
332         requestContext.setPeerEntityEndpoint(selectEndpoint(requestContext));
333
334         String assertingPartyId = rpConfig.getProviderId();
335         requestContext.setLocalEntityId(assertingPartyId);
336         requestContext.setOutboundMessageIssuer(assertingPartyId);
337         try {
338             EntityDescriptor localEntityDescriptor = metadataProvider.getEntityDescriptor(assertingPartyId);
339             if (localEntityDescriptor != null) {
340                 requestContext.setLocalEntityMetadata(localEntityDescriptor);
341                 requestContext.setLocalEntityRole(IDPSSODescriptor.DEFAULT_ELEMENT_NAME);
342                 requestContext.setLocalEntityRoleMetadata(localEntityDescriptor
343                         .getIDPSSODescriptor(SAMLConstants.SAML20P_NS));
344             }
345         } catch (MetadataProviderException e) {
346             log.error("Unable to locate metadata for asserting party");
347             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
348                     "Error locating asserting party metadata"));
349             throw new ProfileException("Error locating asserting party metadata");
350         }
351
352         return requestContext;
353     }
354
355     /**
356      * Selects the appropriate endpoint for the relying party and stores it in the request context.
357      * 
358      * @param requestContext current request context
359      * 
360      * @return Endpoint selected from the information provided in the request context
361      */
362     protected Endpoint selectEndpoint(ShibbolethSSORequestContext requestContext) {
363         ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
364
365         ShibbolethSSOEndpointSelector endpointSelector = new ShibbolethSSOEndpointSelector();
366         endpointSelector.setSpAssertionConsumerService(loginContext.getSpAssertionConsumerService());
367         endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
368         endpointSelector.setMetadataProvider(getMetadataProvider());
369         endpointSelector.setEntityMetadata(requestContext.getPeerEntityMetadata());
370         endpointSelector.setEntityRoleMetadata(requestContext.getPeerEntityRoleMetadata());
371         endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
372         endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
373
374         return endpointSelector.selectEndpoint();
375     }
376
377     /**
378      * Builds the authentication statement for the authenticated principal.
379      * 
380      * @param requestContext current request context
381      * 
382      * @return the created statement
383      * 
384      * @throws ProfileException thrown if the authentication statement can not be created
385      */
386     protected AuthenticationStatement buildAuthenticationStatement(ShibbolethSSORequestContext requestContext)
387             throws ProfileException {
388         ShibbolethSSOLoginContext loginContext = requestContext.getLoginContext();
389
390         AuthenticationStatement statement = authnStatementBuilder.buildObject();
391         statement.setAuthenticationInstant(loginContext.getAuthenticationInstant());
392         statement.setAuthenticationMethod(loginContext.getAuthenticationMethod());
393
394         statement.setSubjectLocality(buildSubjectLocality(requestContext));
395
396         Subject statementSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:bearer");
397         statement.setSubject(statementSubject);
398
399         return statement;
400     }
401
402     /**
403      * Constructs the subject locality for the authentication statement.
404      * 
405      * @param requestContext curent request context
406      * 
407      * @return subject locality for the authentication statement
408      */
409     protected SubjectLocality buildSubjectLocality(ShibbolethSSORequestContext requestContext) {
410         SubjectLocality subjectLocality = subjectLocalityBuilder.buildObject();
411
412         HTTPInTransport inTransport = (HTTPInTransport) requestContext.getInboundMessageTransport();
413         subjectLocality.setIPAddress(inTransport.getPeerAddress());
414         subjectLocality.setDNSAddress(inTransport.getPeerDomainName());
415
416         return subjectLocality;
417     }
418
419     /** Represents the internal state of a Shibboleth SSO Request while it's being processed by the IdP. */
420     public class ShibbolethSSORequestContext extends
421             BaseSAML1ProfileRequestContext<Request, Response, ShibbolethSSOConfiguration> {
422
423         /** SP-provide assertion consumer service URL. */
424         private String spAssertionConsumerService;
425
426         /** Current login context. */
427         private ShibbolethSSOLoginContext loginContext;
428
429         /**
430          * Gets the current login context.
431          * 
432          * @return current login context
433          */
434         public ShibbolethSSOLoginContext getLoginContext() {
435             return loginContext;
436         }
437
438         /**
439          * Sets the current login context.
440          * 
441          * @param context current login context
442          */
443         public void setLoginContext(ShibbolethSSOLoginContext context) {
444             loginContext = context;
445         }
446
447         /**
448          * Gets the SP-provided assertion consumer service URL.
449          * 
450          * @return SP-provided assertion consumer service URL
451          */
452         public String getSpAssertionConsumerService() {
453             return spAssertionConsumerService;
454         }
455
456         /**
457          * Sets the SP-provided assertion consumer service URL.
458          * 
459          * @param acs SP-provided assertion consumer service URL
460          */
461         public void setSpAssertionConsumerService(String acs) {
462             spAssertionConsumerService = acs;
463         }
464     }
465 }