Add explicit PreviousSession support
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / authn / provider / PreviousSessionLoginHandler.java
1 /*
2  * Copyright 2008 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.authn.provider;
18
19 import java.io.IOException;
20
21 import javax.servlet.http.HttpServletRequest;
22 import javax.servlet.http.HttpServletResponse;
23
24 import org.opensaml.util.URLBuilder;
25 import org.opensaml.xml.util.DatatypeHelper;
26 import org.slf4j.Logger;
27 import org.slf4j.LoggerFactory;
28
29 import edu.internet2.middleware.shibboleth.idp.authn.AuthenticationEngine;
30
31 /**
32  * Login handler that is called when user is logged in under a previously existing session.
33  * 
34  * This login handler can optionally redirect the browser to a given URL. This provides a mechanism for extensions to
35  * hook into the authentication process on every request. If this option is used and the servlet to which the browser is
36  * redirected does not take visible control of the request be sure to indicate passive authentication support by means
37  * of {@link PreviousSessionLoginHandler#setSupportsPassive(boolean)}.
38  * 
39  * When the servlet has completed it's work it <strong>MUST</strong> call
40  * {@link AuthenticationEngine#returnToAuthenticationEngine(HttpServletRequest, HttpServletResponse)} in order to
41  * transfer control back to the authentication engine.
42  */
43 public class PreviousSessionLoginHandler extends AbstractLoginHandler {
44
45     /** PreviousSession authentication method URI. */
46     public static final String PREVIOUS_SESSION_AUTHN_METHOD = "urn:oasis:names:tc:SAML:2.0:ac:classes:PreviousSession";
47
48     /** Class logger. */
49     private final Logger log = LoggerFactory.getLogger(PreviousSessionLoginHandler.class);
50
51     /** The path of the servlet to which the user agent may be redirected. */
52     private String servletPath;
53
54     /** Whether to report the authentication method as PreviousSession. */
55     private boolean reportPreviousSessionAuthnMethod;
56
57     /** Constructor. */
58     public PreviousSessionLoginHandler() {
59         super();
60         servletPath = null;
61     }
62
63     /**
64      * Get the path of the servlet to which the user agent may be redirected.
65      * 
66      * @return path of the servlet to which the user agent may be redirected
67      */
68     public String getServletPath() {
69         return servletPath;
70     }
71
72     /**
73      * Set the path of the servlet to which the user agent may be redirected.
74      * 
75      * @param path path of the servlet to which the user agent may be redirected
76      */
77     public void setServletPath(String path) {
78         servletPath = DatatypeHelper.safeTrimOrNullString(path);
79     }
80
81     /**
82      * Gets whether to use PreviousSession as the users authentication method.
83      * 
84      * @return whether to use PreviousSession as the users authentication method
85      */
86     public boolean reportPreviousSessionAuthnMethod() {
87         return reportPreviousSessionAuthnMethod;
88     }
89
90     /**
91      * Sets whether to use PreviousSession as the users authentication method.
92      * 
93      * @param report whether to use PreviousSession as the users authentication method
94      */
95     public void setReportPreviousSessionAuthnMethod(boolean report) {
96         reportPreviousSessionAuthnMethod = report;
97     }
98
99     /** {@inheritDoc} */
100     public boolean supportsPassive() {
101         if (servletPath == null) {
102             return true;
103         }
104
105         return super.supportsPassive();
106     }
107
108     /** {@inheritDoc} */
109     public void login(HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
110         if (servletPath == null) {
111             AuthenticationEngine.returnToAuthenticationEngine(httpRequest, httpResponse);
112         } else {
113             try {
114                 StringBuilder pathBuilder = new StringBuilder();
115                 pathBuilder.append(httpRequest.getContextPath());
116                 if (!servletPath.startsWith("/")) {
117                     pathBuilder.append("/");
118                 }
119                 pathBuilder.append(servletPath);
120
121                 URLBuilder urlBuilder = new URLBuilder();
122                 urlBuilder.setScheme(httpRequest.getScheme());
123                 urlBuilder.setHost(httpRequest.getLocalName());
124                 urlBuilder.setPort(httpRequest.getLocalPort());
125                 urlBuilder.setPath(pathBuilder.toString());
126
127                 log.debug("Redirecting to {}", urlBuilder.buildURL());
128                 httpResponse.sendRedirect(urlBuilder.buildURL());
129                 return;
130             } catch (IOException ex) {
131                 log.error("Unable to redirect to previous session authentication servlet.", ex);
132             }
133         }
134     }
135 }