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