| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.cas;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.authc.AuthenticationException;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.authc.AuthenticationToken;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.subject.Subject;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.web.filter.authc.AuthenticatingFilter;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.slf4j.Logger;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.slf4j.LoggerFactory;<a name="line.27"></a> |
| <FONT color="green">028</FONT> <a name="line.28"></a> |
| <FONT color="green">029</FONT> import javax.servlet.ServletRequest;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import javax.servlet.ServletResponse;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import javax.servlet.http.HttpServletRequest;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import java.io.IOException;<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> /**<a name="line.34"></a> |
| <FONT color="green">035</FONT> * This filter validates the CAS service ticket to authenticate the user. It must be configured on the URL recognized<a name="line.35"></a> |
| <FONT color="green">036</FONT> * by the CAS server. For example, in {@code shiro.ini}:<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <pre><a name="line.37"></a> |
| <FONT color="green">038</FONT> * [main]<a name="line.38"></a> |
| <FONT color="green">039</FONT> * casFilter = org.apache.shiro.cas.CasFilter<a name="line.39"></a> |
| <FONT color="green">040</FONT> * ...<a name="line.40"></a> |
| <FONT color="green">041</FONT> *<a name="line.41"></a> |
| <FONT color="green">042</FONT> * [urls]<a name="line.42"></a> |
| <FONT color="green">043</FONT> * /shiro-cas = casFilter<a name="line.43"></a> |
| <FONT color="green">044</FONT> * ...<a name="line.44"></a> |
| <FONT color="green">045</FONT> * </pre><a name="line.45"></a> |
| <FONT color="green">046</FONT> * (example : http://host:port/mycontextpath/shiro-cas)<a name="line.46"></a> |
| <FONT color="green">047</FONT> *<a name="line.47"></a> |
| <FONT color="green">048</FONT> * @since 1.2<a name="line.48"></a> |
| <FONT color="green">049</FONT> */<a name="line.49"></a> |
| <FONT color="green">050</FONT> public class CasFilter extends AuthenticatingFilter {<a name="line.50"></a> |
| <FONT color="green">051</FONT> <a name="line.51"></a> |
| <FONT color="green">052</FONT> private static Logger logger = LoggerFactory.getLogger(CasFilter.class);<a name="line.52"></a> |
| <FONT color="green">053</FONT> <a name="line.53"></a> |
| <FONT color="green">054</FONT> // the name of the parameter service ticket in url<a name="line.54"></a> |
| <FONT color="green">055</FONT> private static final String TICKET_PARAMETER = "ticket";<a name="line.55"></a> |
| <FONT color="green">056</FONT> <a name="line.56"></a> |
| <FONT color="green">057</FONT> // the url where the application is redirected if the CAS service ticket validation failed (example : /mycontextpatch/cas_error.jsp)<a name="line.57"></a> |
| <FONT color="green">058</FONT> private String failureUrl;<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> /**<a name="line.60"></a> |
| <FONT color="green">061</FONT> * The token created for this authentication is a CasToken containing the CAS service ticket received on the CAS service url (on which<a name="line.61"></a> |
| <FONT color="green">062</FONT> * the filter must be configured).<a name="line.62"></a> |
| <FONT color="green">063</FONT> * <a name="line.63"></a> |
| <FONT color="green">064</FONT> * @param request the incoming request<a name="line.64"></a> |
| <FONT color="green">065</FONT> * @param response the outgoing response<a name="line.65"></a> |
| <FONT color="green">066</FONT> * @throws Exception if there is an error processing the request.<a name="line.66"></a> |
| <FONT color="green">067</FONT> */<a name="line.67"></a> |
| <FONT color="green">068</FONT> @Override<a name="line.68"></a> |
| <FONT color="green">069</FONT> protected AuthenticationToken createToken(ServletRequest request, ServletResponse response) throws Exception {<a name="line.69"></a> |
| <FONT color="green">070</FONT> HttpServletRequest httpRequest = (HttpServletRequest) request;<a name="line.70"></a> |
| <FONT color="green">071</FONT> String ticket = httpRequest.getParameter(TICKET_PARAMETER);<a name="line.71"></a> |
| <FONT color="green">072</FONT> return new CasToken(ticket);<a name="line.72"></a> |
| <FONT color="green">073</FONT> }<a name="line.73"></a> |
| <FONT color="green">074</FONT> <a name="line.74"></a> |
| <FONT color="green">075</FONT> /**<a name="line.75"></a> |
| <FONT color="green">076</FONT> * Execute login by creating {@link #createToken(javax.servlet.ServletRequest, javax.servlet.ServletResponse) token} and logging subject<a name="line.76"></a> |
| <FONT color="green">077</FONT> * with this token.<a name="line.77"></a> |
| <FONT color="green">078</FONT> * <a name="line.78"></a> |
| <FONT color="green">079</FONT> * @param request the incoming request<a name="line.79"></a> |
| <FONT color="green">080</FONT> * @param response the outgoing response<a name="line.80"></a> |
| <FONT color="green">081</FONT> * @throws Exception if there is an error processing the request.<a name="line.81"></a> |
| <FONT color="green">082</FONT> */<a name="line.82"></a> |
| <FONT color="green">083</FONT> @Override<a name="line.83"></a> |
| <FONT color="green">084</FONT> protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception {<a name="line.84"></a> |
| <FONT color="green">085</FONT> return executeLogin(request, response);<a name="line.85"></a> |
| <FONT color="green">086</FONT> }<a name="line.86"></a> |
| <FONT color="green">087</FONT> <a name="line.87"></a> |
| <FONT color="green">088</FONT> /**<a name="line.88"></a> |
| <FONT color="green">089</FONT> * Returns <code>false</code> to always force authentication (user is never considered authenticated by this filter).<a name="line.89"></a> |
| <FONT color="green">090</FONT> * <a name="line.90"></a> |
| <FONT color="green">091</FONT> * @param request the incoming request<a name="line.91"></a> |
| <FONT color="green">092</FONT> * @param response the outgoing response<a name="line.92"></a> |
| <FONT color="green">093</FONT> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings.<a name="line.93"></a> |
| <FONT color="green">094</FONT> * @return <code>false</code><a name="line.94"></a> |
| <FONT color="green">095</FONT> */<a name="line.95"></a> |
| <FONT color="green">096</FONT> @Override<a name="line.96"></a> |
| <FONT color="green">097</FONT> protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) {<a name="line.97"></a> |
| <FONT color="green">098</FONT> return false;<a name="line.98"></a> |
| <FONT color="green">099</FONT> }<a name="line.99"></a> |
| <FONT color="green">100</FONT> <a name="line.100"></a> |
| <FONT color="green">101</FONT> /**<a name="line.101"></a> |
| <FONT color="green">102</FONT> * If login has been successful, redirect user to the original protected url.<a name="line.102"></a> |
| <FONT color="green">103</FONT> * <a name="line.103"></a> |
| <FONT color="green">104</FONT> * @param token the token representing the current authentication<a name="line.104"></a> |
| <FONT color="green">105</FONT> * @param subject the current authenticated subjet<a name="line.105"></a> |
| <FONT color="green">106</FONT> * @param request the incoming request<a name="line.106"></a> |
| <FONT color="green">107</FONT> * @param response the outgoing response<a name="line.107"></a> |
| <FONT color="green">108</FONT> * @throws Exception if there is an error processing the request.<a name="line.108"></a> |
| <FONT color="green">109</FONT> */<a name="line.109"></a> |
| <FONT color="green">110</FONT> @Override<a name="line.110"></a> |
| <FONT color="green">111</FONT> protected boolean onLoginSuccess(AuthenticationToken token, Subject subject, ServletRequest request,<a name="line.111"></a> |
| <FONT color="green">112</FONT> ServletResponse response) throws Exception {<a name="line.112"></a> |
| <FONT color="green">113</FONT> issueSuccessRedirect(request, response);<a name="line.113"></a> |
| <FONT color="green">114</FONT> return false;<a name="line.114"></a> |
| <FONT color="green">115</FONT> }<a name="line.115"></a> |
| <FONT color="green">116</FONT> <a name="line.116"></a> |
| <FONT color="green">117</FONT> /**<a name="line.117"></a> |
| <FONT color="green">118</FONT> * If login has failed, redirect user to the CAS error page (no ticket or ticket validation failed) except if the user is already<a name="line.118"></a> |
| <FONT color="green">119</FONT> * authenticated, in which case redirect to the default success url.<a name="line.119"></a> |
| <FONT color="green">120</FONT> * <a name="line.120"></a> |
| <FONT color="green">121</FONT> * @param token the token representing the current authentication<a name="line.121"></a> |
| <FONT color="green">122</FONT> * @param ae the current authentication exception<a name="line.122"></a> |
| <FONT color="green">123</FONT> * @param request the incoming request<a name="line.123"></a> |
| <FONT color="green">124</FONT> * @param response the outgoing response<a name="line.124"></a> |
| <FONT color="green">125</FONT> */<a name="line.125"></a> |
| <FONT color="green">126</FONT> @Override<a name="line.126"></a> |
| <FONT color="green">127</FONT> protected boolean onLoginFailure(AuthenticationToken token, AuthenticationException ae, ServletRequest request,<a name="line.127"></a> |
| <FONT color="green">128</FONT> ServletResponse response) {<a name="line.128"></a> |
| <FONT color="green">129</FONT> // is user authenticated or in remember me mode ?<a name="line.129"></a> |
| <FONT color="green">130</FONT> Subject subject = getSubject(request, response);<a name="line.130"></a> |
| <FONT color="green">131</FONT> if (subject.isAuthenticated() || subject.isRemembered()) {<a name="line.131"></a> |
| <FONT color="green">132</FONT> try {<a name="line.132"></a> |
| <FONT color="green">133</FONT> issueSuccessRedirect(request, response);<a name="line.133"></a> |
| <FONT color="green">134</FONT> } catch (Exception e) {<a name="line.134"></a> |
| <FONT color="green">135</FONT> logger.error("Cannot redirect to the default success url", e);<a name="line.135"></a> |
| <FONT color="green">136</FONT> }<a name="line.136"></a> |
| <FONT color="green">137</FONT> } else {<a name="line.137"></a> |
| <FONT color="green">138</FONT> try {<a name="line.138"></a> |
| <FONT color="green">139</FONT> WebUtils.issueRedirect(request, response, failureUrl);<a name="line.139"></a> |
| <FONT color="green">140</FONT> } catch (IOException e) {<a name="line.140"></a> |
| <FONT color="green">141</FONT> logger.error("Cannot redirect to failure url : {}", failureUrl, e);<a name="line.141"></a> |
| <FONT color="green">142</FONT> }<a name="line.142"></a> |
| <FONT color="green">143</FONT> }<a name="line.143"></a> |
| <FONT color="green">144</FONT> return false;<a name="line.144"></a> |
| <FONT color="green">145</FONT> }<a name="line.145"></a> |
| <FONT color="green">146</FONT> <a name="line.146"></a> |
| <FONT color="green">147</FONT> public void setFailureUrl(String failureUrl) {<a name="line.147"></a> |
| <FONT color="green">148</FONT> this.failureUrl = failureUrl;<a name="line.148"></a> |
| <FONT color="green">149</FONT> }<a name="line.149"></a> |
| <FONT color="green">150</FONT> }<a name="line.150"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
