| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.web.filter.authc;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.SecurityUtils;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.session.SessionException;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.subject.Subject;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.util.StringUtils;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.web.servlet.AdviceFilter;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.web.util.WebUtils;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">029</span><a id="line.29"></a> |
| <span class="sourceLineNo">030</span><a id="line.30">import javax.servlet.ServletRequest;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import javax.servlet.ServletResponse;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import javax.servlet.http.HttpServletResponse;</a> |
| <span class="sourceLineNo">033</span><a id="line.33"></a> |
| <span class="sourceLineNo">034</span><a id="line.34">import java.util.Locale;</a> |
| <span class="sourceLineNo">035</span><a id="line.35"></a> |
| <span class="sourceLineNo">036</span><a id="line.36">import static org.apache.shiro.web.filter.mgt.DefaultFilter.logout;</a> |
| <span class="sourceLineNo">037</span><a id="line.37"></a> |
| <span class="sourceLineNo">038</span><a id="line.38">/**</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * Simple Filter that, upon receiving a request, will immediately log-out the currently executing</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * {@link #getSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse) subject}</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * and then redirect them to a configured {@link #getRedirectUrl() redirectUrl}.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> *</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @since 1.2</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> */</a> |
| <span class="sourceLineNo">045</span><a id="line.45">public class LogoutFilter extends AdviceFilter {</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> </a> |
| <span class="sourceLineNo">047</span><a id="line.47"> private static final Logger log = LoggerFactory.getLogger(LogoutFilter.class);</a> |
| <span class="sourceLineNo">048</span><a id="line.48"></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> /**</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * The default redirect URL to where the user will be redirected after logout. The value is {@code "/"}, Shiro's</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * representation of the web application's context root.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> */</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> public static final String DEFAULT_REDIRECT_URL = "/";</a> |
| <span class="sourceLineNo">054</span><a id="line.54"></a> |
| <span class="sourceLineNo">055</span><a id="line.55"> /**</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * The URL to where the user will be redirected after logout.</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> */</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> private String redirectUrl = DEFAULT_REDIRECT_URL;</a> |
| <span class="sourceLineNo">059</span><a id="line.59"></a> |
| <span class="sourceLineNo">060</span><a id="line.60"> /**</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * Due to browser pre-fetching, using a GET requests for logout my cause a user to be logged accidentally, for example:</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * out while typing in an address bar. If <code>postOnlyLogout</code> is <code>true</code>. Only POST requests will cause</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * a logout to occur.</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> */</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> private boolean postOnlyLogout = false;</a> |
| <span class="sourceLineNo">066</span><a id="line.66"></a> |
| <span class="sourceLineNo">067</span><a id="line.67"> /**</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * Acquires the currently executing {@link #getSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse) subject},</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * a potentially Subject or request-specific</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * {@link #getRedirectUrl(javax.servlet.ServletRequest, javax.servlet.ServletResponse, org.apache.shiro.subject.Subject) redirectUrl},</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * and redirects the end-user to that redirect url.</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> *</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @param request the incoming ServletRequest</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * @param response the outgoing ServletResponse</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * @return {@code false} always as typically no further interaction should be done after user logout.</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * @throws Exception if there is any error.</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> */</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> @Override</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> protected boolean preHandle(ServletRequest request, ServletResponse response) throws Exception {</a> |
| <span class="sourceLineNo">080</span><a id="line.80"></a> |
| <span class="sourceLineNo">081</span><a id="line.81"> Subject subject = getSubject(request, response);</a> |
| <span class="sourceLineNo">082</span><a id="line.82"></a> |
| <span class="sourceLineNo">083</span><a id="line.83"> // Check if POST only logout is enabled</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> if (isPostOnlyLogout()) {</a> |
| <span class="sourceLineNo">085</span><a id="line.85"></a> |
| <span class="sourceLineNo">086</span><a id="line.86"> // check if the current request's method is a POST, if not redirect</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> if (!WebUtils.toHttp(request).getMethod().toUpperCase(Locale.ENGLISH).equals("POST")) {</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> return onLogoutRequestNotAPost(request, response);</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> }</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> }</a> |
| <span class="sourceLineNo">091</span><a id="line.91"></a> |
| <span class="sourceLineNo">092</span><a id="line.92"> String redirectUrl = getRedirectUrl(request, response, subject);</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> //try/catch added for SHIRO-298:</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> try {</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> subject.logout();</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> } catch (SessionException ise) {</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> log.debug("Encountered session exception during logout. This can generally safely be ignored.", ise);</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> }</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> issueRedirect(request, response, redirectUrl);</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> return false;</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> }</a> |
| <span class="sourceLineNo">102</span><a id="line.102"></a> |
| <span class="sourceLineNo">103</span><a id="line.103"> /**</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * Returns the currently executing {@link Subject}. This implementation merely defaults to calling</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * {@code SecurityUtils.}{@link org.apache.shiro.SecurityUtils#getSubject() getSubject()}, but can be overridden</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * by subclasses for different retrieval strategies.</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> *</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> * @param request the incoming Servlet request</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> * @param response the outgoing Servlet response</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> * @return the currently executing {@link Subject}.</a> |
| <span class="sourceLineNo">111</span><a id="line.111"> */</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> protected Subject getSubject(ServletRequest request, ServletResponse response) {</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> return SecurityUtils.getSubject();</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> }</a> |
| <span class="sourceLineNo">115</span><a id="line.115"></a> |
| <span class="sourceLineNo">116</span><a id="line.116"> /**</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> * Issues an HTTP redirect to the specified URL after subject logout. This implementation simply calls</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * {@code WebUtils.}{@link WebUtils#issueRedirect(javax.servlet.ServletRequest, javax.servlet.ServletResponse, String) issueRedirect(request,response,redirectUrl)}.</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> *</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * @param request the incoming Servlet request</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * @param response the outgoing Servlet response</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * @param redirectUrl the URL to where the browser will be redirected immediately after Subject logout.</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> * @throws Exception if there is any error.</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> */</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> protected void issueRedirect(ServletRequest request, ServletResponse response, String redirectUrl) throws Exception {</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> WebUtils.issueRedirect(request, response, redirectUrl);</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> }</a> |
| <span class="sourceLineNo">128</span><a id="line.128"></a> |
| <span class="sourceLineNo">129</span><a id="line.129"> /**</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * Returns the redirect URL to send the user after logout. This default implementation ignores the arguments and</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * returns the static configured {@link #getRedirectUrl() redirectUrl} property, but this method may be overridden</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * by subclasses to dynamically construct the URL based on the request or subject if necessary.</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> * <p/></a> |
| <span class="sourceLineNo">134</span><a id="line.134"> * Note: the Subject is <em>not</em> yet logged out at the time this method is invoked. You may access the Subject's</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> * session if one is available and if necessary.</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> * <p/></a> |
| <span class="sourceLineNo">137</span><a id="line.137"> * Tip: if you need to access the Subject's session, consider using the</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * {@code Subject.}{@link Subject#getSession(boolean) getSession(false)} method to ensure a new session isn't created unnecessarily.</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> * If a session would be created, it will be immediately stopped after logout, not providing any value and</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * unnecessarily taxing session infrastructure/resources.</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> *</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> * @param request the incoming Servlet request</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> * @param response the outgoing ServletResponse</a> |
| <span class="sourceLineNo">144</span><a id="line.144"> * @param subject the not-yet-logged-out currently executing Subject</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> * @return the redirect URL to send the user after logout.</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> */</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> protected String getRedirectUrl(ServletRequest request, ServletResponse response, Subject subject) {</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> return getRedirectUrl();</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> }</a> |
| <span class="sourceLineNo">150</span><a id="line.150"></a> |
| <span class="sourceLineNo">151</span><a id="line.151"> /**</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> * Returns the URL to where the user will be redirected after logout. Default is the web application's context</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> * root, i.e. {@code "/"}</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> *</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> * @return the URL to where the user will be redirected after logout.</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> */</a> |
| <span class="sourceLineNo">157</span><a id="line.157"> public String getRedirectUrl() {</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> return redirectUrl;</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> }</a> |
| <span class="sourceLineNo">160</span><a id="line.160"></a> |
| <span class="sourceLineNo">161</span><a id="line.161"> /**</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> * Sets the URL to where the user will be redirected after logout. Default is the web application's context</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> * root, i.e. {@code "/"}</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> *</a> |
| <span class="sourceLineNo">165</span><a id="line.165"> * @param redirectUrl the url to where the user will be redirected after logout</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> */</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> @SuppressWarnings("unused")</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> public void setRedirectUrl(String redirectUrl) {</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> this.redirectUrl = redirectUrl;</a> |
| <span class="sourceLineNo">170</span><a id="line.170"> }</a> |
| <span class="sourceLineNo">171</span><a id="line.171"></a> |
| <span class="sourceLineNo">172</span><a id="line.172"></a> |
| <span class="sourceLineNo">173</span><a id="line.173"> /**</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> * This method is called when <code>postOnlyLogout</code> is <code>true</code>, and the request was NOT a <code>POST</code>.</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * For example if this filter is bound to '/logout' and the caller makes a GET request, this method would be invoked.</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> * <p></a> |
| <span class="sourceLineNo">177</span><a id="line.177"> * The default implementation sets the response code to a 405, and sets the 'Allow' header to 'POST', and</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> * always returns false.</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> * </p></a> |
| <span class="sourceLineNo">180</span><a id="line.180"> *</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> * @return The return value indicates if the processing should continue in this filter chain.</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> */</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> protected boolean onLogoutRequestNotAPost(ServletRequest request, ServletResponse response) {</a> |
| <span class="sourceLineNo">184</span><a id="line.184"></a> |
| <span class="sourceLineNo">185</span><a id="line.185"> HttpServletResponse httpServletResponse = WebUtils.toHttp(response);</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> httpServletResponse.setStatus(HttpServletResponse.SC_METHOD_NOT_ALLOWED);</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> httpServletResponse.setHeader("Allow", "POST");</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> return false;</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> }</a> |
| <span class="sourceLineNo">190</span><a id="line.190"></a> |
| <span class="sourceLineNo">191</span><a id="line.191"> /**</a> |
| <span class="sourceLineNo">192</span><a id="line.192"> * Due to browser pre-fetching, using a GET requests for logout my cause a user to be logged accidentally, for example:</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> * out while typing in an address bar. If <code>postOnlyLogout</code> is <code>true</code>. Only POST requests will cause</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> * a logout to occur.</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> *</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> * @return Returns true if POST only logout is enabled</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> */</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> public boolean isPostOnlyLogout() {</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> return postOnlyLogout;</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> }</a> |
| <span class="sourceLineNo">201</span><a id="line.201"></a> |
| <span class="sourceLineNo">202</span><a id="line.202"> /**</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> * Due to browser pre-fetching, using a GET requests for logout my cause a user to be logged accidentally, for example:</a> |
| <span class="sourceLineNo">204</span><a id="line.204"> * out while typing in an address bar. If <code>postOnlyLogout</code> is <code>true</code>. Only POST requests will cause</a> |
| <span class="sourceLineNo">205</span><a id="line.205"> * a logout to occur.</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> * @param postOnlyLogout enable or disable POST only logout.</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> */</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> public void setPostOnlyLogout(boolean postOnlyLogout) {</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> this.postOnlyLogout = postOnlyLogout;</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> }</a> |
| <span class="sourceLineNo">211</span><a id="line.211">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
