| <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.web.servlet;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.SecurityUtils;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.session.Session;<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.subject.support.DisabledSessionException;<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> <a name="line.26"></a> |
| <FONT color="green">027</FONT> import javax.servlet.ServletContext;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import javax.servlet.http.HttpServletRequest;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import javax.servlet.http.HttpServletRequestWrapper;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import javax.servlet.http.HttpSession;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import java.security.Principal;<a name="line.31"></a> |
| <FONT color="green">032</FONT> <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> * A {@code ShiroHttpServletRequest} wraps the Servlet container's original {@code ServletRequest} instance, but ensures<a name="line.35"></a> |
| <FONT color="green">036</FONT> * that all {@link HttpServletRequest} invocations that require Shiro's support ({@link #getRemoteUser getRemoteUser},<a name="line.36"></a> |
| <FONT color="green">037</FONT> * {@link #getSession getSession}, etc) can be executed first by Shiro as necessary before allowing the underlying<a name="line.37"></a> |
| <FONT color="green">038</FONT> * Servlet container instance's method to be invoked.<a name="line.38"></a> |
| <FONT color="green">039</FONT> *<a name="line.39"></a> |
| <FONT color="green">040</FONT> * @since 0.2<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> public class ShiroHttpServletRequest extends HttpServletRequestWrapper {<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> //TODO - complete JavaDoc<a name="line.44"></a> |
| <FONT color="green">045</FONT> <a name="line.45"></a> |
| <FONT color="green">046</FONT> //The following 7 constants support the Shiro's implementation of the Servlet Specification<a name="line.46"></a> |
| <FONT color="green">047</FONT> public static final String COOKIE_SESSION_ID_SOURCE = "cookie";<a name="line.47"></a> |
| <FONT color="green">048</FONT> public static final String URL_SESSION_ID_SOURCE = "url";<a name="line.48"></a> |
| <FONT color="green">049</FONT> public static final String REFERENCED_SESSION_ID = ShiroHttpServletRequest.class.getName() + "_REQUESTED_SESSION_ID";<a name="line.49"></a> |
| <FONT color="green">050</FONT> public static final String REFERENCED_SESSION_ID_IS_VALID = ShiroHttpServletRequest.class.getName() + "_REQUESTED_SESSION_ID_VALID";<a name="line.50"></a> |
| <FONT color="green">051</FONT> public static final String REFERENCED_SESSION_IS_NEW = ShiroHttpServletRequest.class.getName() + "_REFERENCED_SESSION_IS_NEW";<a name="line.51"></a> |
| <FONT color="green">052</FONT> public static final String REFERENCED_SESSION_ID_SOURCE = ShiroHttpServletRequest.class.getName() + "REFERENCED_SESSION_ID_SOURCE";<a name="line.52"></a> |
| <FONT color="green">053</FONT> public static final String IDENTITY_REMOVED_KEY = ShiroHttpServletRequest.class.getName() + "_IDENTITY_REMOVED_KEY";<a name="line.53"></a> |
| <FONT color="green">054</FONT> <a name="line.54"></a> |
| <FONT color="green">055</FONT> protected ServletContext servletContext = null;<a name="line.55"></a> |
| <FONT color="green">056</FONT> <a name="line.56"></a> |
| <FONT color="green">057</FONT> protected HttpSession session = null;<a name="line.57"></a> |
| <FONT color="green">058</FONT> protected boolean httpSessions = true;<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> public ShiroHttpServletRequest(HttpServletRequest wrapped, ServletContext servletContext, boolean httpSessions) {<a name="line.60"></a> |
| <FONT color="green">061</FONT> super(wrapped);<a name="line.61"></a> |
| <FONT color="green">062</FONT> this.servletContext = servletContext;<a name="line.62"></a> |
| <FONT color="green">063</FONT> this.httpSessions = httpSessions;<a name="line.63"></a> |
| <FONT color="green">064</FONT> }<a name="line.64"></a> |
| <FONT color="green">065</FONT> <a name="line.65"></a> |
| <FONT color="green">066</FONT> public boolean isHttpSessions() {<a name="line.66"></a> |
| <FONT color="green">067</FONT> return httpSessions;<a name="line.67"></a> |
| <FONT color="green">068</FONT> }<a name="line.68"></a> |
| <FONT color="green">069</FONT> <a name="line.69"></a> |
| <FONT color="green">070</FONT> public String getRemoteUser() {<a name="line.70"></a> |
| <FONT color="green">071</FONT> String remoteUser;<a name="line.71"></a> |
| <FONT color="green">072</FONT> Object scPrincipal = getSubjectPrincipal();<a name="line.72"></a> |
| <FONT color="green">073</FONT> if (scPrincipal != null) {<a name="line.73"></a> |
| <FONT color="green">074</FONT> if (scPrincipal instanceof String) {<a name="line.74"></a> |
| <FONT color="green">075</FONT> return (String) scPrincipal;<a name="line.75"></a> |
| <FONT color="green">076</FONT> } else if (scPrincipal instanceof Principal) {<a name="line.76"></a> |
| <FONT color="green">077</FONT> remoteUser = ((Principal) scPrincipal).getName();<a name="line.77"></a> |
| <FONT color="green">078</FONT> } else {<a name="line.78"></a> |
| <FONT color="green">079</FONT> remoteUser = scPrincipal.toString();<a name="line.79"></a> |
| <FONT color="green">080</FONT> }<a name="line.80"></a> |
| <FONT color="green">081</FONT> } else {<a name="line.81"></a> |
| <FONT color="green">082</FONT> remoteUser = super.getRemoteUser();<a name="line.82"></a> |
| <FONT color="green">083</FONT> }<a name="line.83"></a> |
| <FONT color="green">084</FONT> return remoteUser;<a name="line.84"></a> |
| <FONT color="green">085</FONT> }<a name="line.85"></a> |
| <FONT color="green">086</FONT> <a name="line.86"></a> |
| <FONT color="green">087</FONT> protected Subject getSubject() {<a name="line.87"></a> |
| <FONT color="green">088</FONT> return SecurityUtils.getSubject();<a name="line.88"></a> |
| <FONT color="green">089</FONT> }<a name="line.89"></a> |
| <FONT color="green">090</FONT> <a name="line.90"></a> |
| <FONT color="green">091</FONT> protected Object getSubjectPrincipal() {<a name="line.91"></a> |
| <FONT color="green">092</FONT> Object userPrincipal = null;<a name="line.92"></a> |
| <FONT color="green">093</FONT> Subject subject = getSubject();<a name="line.93"></a> |
| <FONT color="green">094</FONT> if (subject != null) {<a name="line.94"></a> |
| <FONT color="green">095</FONT> userPrincipal = subject.getPrincipal();<a name="line.95"></a> |
| <FONT color="green">096</FONT> }<a name="line.96"></a> |
| <FONT color="green">097</FONT> return userPrincipal;<a name="line.97"></a> |
| <FONT color="green">098</FONT> }<a name="line.98"></a> |
| <FONT color="green">099</FONT> <a name="line.99"></a> |
| <FONT color="green">100</FONT> public boolean isUserInRole(String s) {<a name="line.100"></a> |
| <FONT color="green">101</FONT> Subject subject = getSubject();<a name="line.101"></a> |
| <FONT color="green">102</FONT> boolean inRole = (subject != null && subject.hasRole(s));<a name="line.102"></a> |
| <FONT color="green">103</FONT> if (!inRole) {<a name="line.103"></a> |
| <FONT color="green">104</FONT> inRole = super.isUserInRole(s);<a name="line.104"></a> |
| <FONT color="green">105</FONT> }<a name="line.105"></a> |
| <FONT color="green">106</FONT> return inRole;<a name="line.106"></a> |
| <FONT color="green">107</FONT> }<a name="line.107"></a> |
| <FONT color="green">108</FONT> <a name="line.108"></a> |
| <FONT color="green">109</FONT> public Principal getUserPrincipal() {<a name="line.109"></a> |
| <FONT color="green">110</FONT> Principal userPrincipal;<a name="line.110"></a> |
| <FONT color="green">111</FONT> Object scPrincipal = getSubjectPrincipal();<a name="line.111"></a> |
| <FONT color="green">112</FONT> if (scPrincipal != null) {<a name="line.112"></a> |
| <FONT color="green">113</FONT> if (scPrincipal instanceof Principal) {<a name="line.113"></a> |
| <FONT color="green">114</FONT> userPrincipal = (Principal) scPrincipal;<a name="line.114"></a> |
| <FONT color="green">115</FONT> } else {<a name="line.115"></a> |
| <FONT color="green">116</FONT> userPrincipal = new ObjectPrincipal(scPrincipal);<a name="line.116"></a> |
| <FONT color="green">117</FONT> }<a name="line.117"></a> |
| <FONT color="green">118</FONT> } else {<a name="line.118"></a> |
| <FONT color="green">119</FONT> userPrincipal = super.getUserPrincipal();<a name="line.119"></a> |
| <FONT color="green">120</FONT> }<a name="line.120"></a> |
| <FONT color="green">121</FONT> return userPrincipal;<a name="line.121"></a> |
| <FONT color="green">122</FONT> }<a name="line.122"></a> |
| <FONT color="green">123</FONT> <a name="line.123"></a> |
| <FONT color="green">124</FONT> public String getRequestedSessionId() {<a name="line.124"></a> |
| <FONT color="green">125</FONT> String requestedSessionId = null;<a name="line.125"></a> |
| <FONT color="green">126</FONT> if (isHttpSessions()) {<a name="line.126"></a> |
| <FONT color="green">127</FONT> requestedSessionId = super.getRequestedSessionId();<a name="line.127"></a> |
| <FONT color="green">128</FONT> } else {<a name="line.128"></a> |
| <FONT color="green">129</FONT> Object sessionId = getAttribute(REFERENCED_SESSION_ID);<a name="line.129"></a> |
| <FONT color="green">130</FONT> if (sessionId != null) {<a name="line.130"></a> |
| <FONT color="green">131</FONT> requestedSessionId = sessionId.toString();<a name="line.131"></a> |
| <FONT color="green">132</FONT> }<a name="line.132"></a> |
| <FONT color="green">133</FONT> }<a name="line.133"></a> |
| <FONT color="green">134</FONT> <a name="line.134"></a> |
| <FONT color="green">135</FONT> return requestedSessionId;<a name="line.135"></a> |
| <FONT color="green">136</FONT> }<a name="line.136"></a> |
| <FONT color="green">137</FONT> <a name="line.137"></a> |
| <FONT color="green">138</FONT> public HttpSession getSession(boolean create) {<a name="line.138"></a> |
| <FONT color="green">139</FONT> <a name="line.139"></a> |
| <FONT color="green">140</FONT> HttpSession httpSession;<a name="line.140"></a> |
| <FONT color="green">141</FONT> <a name="line.141"></a> |
| <FONT color="green">142</FONT> if (isHttpSessions()) {<a name="line.142"></a> |
| <FONT color="green">143</FONT> httpSession = super.getSession(false);<a name="line.143"></a> |
| <FONT color="green">144</FONT> if (httpSession == null && create) {<a name="line.144"></a> |
| <FONT color="green">145</FONT> //Shiro 1.2: assert that creation is enabled (SHIRO-266):<a name="line.145"></a> |
| <FONT color="green">146</FONT> if (WebUtils._isSessionCreationEnabled(this)) {<a name="line.146"></a> |
| <FONT color="green">147</FONT> httpSession = super.getSession(create);<a name="line.147"></a> |
| <FONT color="green">148</FONT> } else {<a name="line.148"></a> |
| <FONT color="green">149</FONT> throw newNoSessionCreationException();<a name="line.149"></a> |
| <FONT color="green">150</FONT> }<a name="line.150"></a> |
| <FONT color="green">151</FONT> }<a name="line.151"></a> |
| <FONT color="green">152</FONT> } else {<a name="line.152"></a> |
| <FONT color="green">153</FONT> if (this.session == null) {<a name="line.153"></a> |
| <FONT color="green">154</FONT> <a name="line.154"></a> |
| <FONT color="green">155</FONT> boolean existing = getSubject().getSession(false) != null;<a name="line.155"></a> |
| <FONT color="green">156</FONT> <a name="line.156"></a> |
| <FONT color="green">157</FONT> Session shiroSession = getSubject().getSession(create);<a name="line.157"></a> |
| <FONT color="green">158</FONT> if (shiroSession != null) {<a name="line.158"></a> |
| <FONT color="green">159</FONT> this.session = new ShiroHttpSession(shiroSession, this, this.servletContext);<a name="line.159"></a> |
| <FONT color="green">160</FONT> if (!existing) {<a name="line.160"></a> |
| <FONT color="green">161</FONT> setAttribute(REFERENCED_SESSION_IS_NEW, Boolean.TRUE);<a name="line.161"></a> |
| <FONT color="green">162</FONT> }<a name="line.162"></a> |
| <FONT color="green">163</FONT> }<a name="line.163"></a> |
| <FONT color="green">164</FONT> }<a name="line.164"></a> |
| <FONT color="green">165</FONT> httpSession = this.session;<a name="line.165"></a> |
| <FONT color="green">166</FONT> }<a name="line.166"></a> |
| <FONT color="green">167</FONT> <a name="line.167"></a> |
| <FONT color="green">168</FONT> return httpSession;<a name="line.168"></a> |
| <FONT color="green">169</FONT> }<a name="line.169"></a> |
| <FONT color="green">170</FONT> <a name="line.170"></a> |
| <FONT color="green">171</FONT> /**<a name="line.171"></a> |
| <FONT color="green">172</FONT> * Constructs and returns a {@link DisabledSessionException} with an appropriate message explaining why<a name="line.172"></a> |
| <FONT color="green">173</FONT> * session creation has been disabled.<a name="line.173"></a> |
| <FONT color="green">174</FONT> *<a name="line.174"></a> |
| <FONT color="green">175</FONT> * @return a new DisabledSessionException with appropriate no creation message<a name="line.175"></a> |
| <FONT color="green">176</FONT> * @since 1.2<a name="line.176"></a> |
| <FONT color="green">177</FONT> */<a name="line.177"></a> |
| <FONT color="green">178</FONT> private DisabledSessionException newNoSessionCreationException() {<a name="line.178"></a> |
| <FONT color="green">179</FONT> String msg = "Session creation has been disabled for the current request. This exception indicates " +<a name="line.179"></a> |
| <FONT color="green">180</FONT> "that there is either a programming error (using a session when it should never be " +<a name="line.180"></a> |
| <FONT color="green">181</FONT> "used) or that Shiro's configuration needs to be adjusted to allow Sessions to be created " +<a name="line.181"></a> |
| <FONT color="green">182</FONT> "for the current request. See the " + DisabledSessionException.class.getName() + " JavaDoc " +<a name="line.182"></a> |
| <FONT color="green">183</FONT> "for more.";<a name="line.183"></a> |
| <FONT color="green">184</FONT> return new DisabledSessionException(msg);<a name="line.184"></a> |
| <FONT color="green">185</FONT> }<a name="line.185"></a> |
| <FONT color="green">186</FONT> <a name="line.186"></a> |
| <FONT color="green">187</FONT> public HttpSession getSession() {<a name="line.187"></a> |
| <FONT color="green">188</FONT> return getSession(true);<a name="line.188"></a> |
| <FONT color="green">189</FONT> }<a name="line.189"></a> |
| <FONT color="green">190</FONT> <a name="line.190"></a> |
| <FONT color="green">191</FONT> public boolean isRequestedSessionIdValid() {<a name="line.191"></a> |
| <FONT color="green">192</FONT> if (isHttpSessions()) {<a name="line.192"></a> |
| <FONT color="green">193</FONT> return super.isRequestedSessionIdValid();<a name="line.193"></a> |
| <FONT color="green">194</FONT> } else {<a name="line.194"></a> |
| <FONT color="green">195</FONT> Boolean value = (Boolean) getAttribute(REFERENCED_SESSION_ID_IS_VALID);<a name="line.195"></a> |
| <FONT color="green">196</FONT> return (value != null && value.equals(Boolean.TRUE));<a name="line.196"></a> |
| <FONT color="green">197</FONT> }<a name="line.197"></a> |
| <FONT color="green">198</FONT> }<a name="line.198"></a> |
| <FONT color="green">199</FONT> <a name="line.199"></a> |
| <FONT color="green">200</FONT> public boolean isRequestedSessionIdFromCookie() {<a name="line.200"></a> |
| <FONT color="green">201</FONT> if (isHttpSessions()) {<a name="line.201"></a> |
| <FONT color="green">202</FONT> return super.isRequestedSessionIdFromCookie();<a name="line.202"></a> |
| <FONT color="green">203</FONT> } else {<a name="line.203"></a> |
| <FONT color="green">204</FONT> String value = (String) getAttribute(REFERENCED_SESSION_ID_SOURCE);<a name="line.204"></a> |
| <FONT color="green">205</FONT> return value != null && value.equals(COOKIE_SESSION_ID_SOURCE);<a name="line.205"></a> |
| <FONT color="green">206</FONT> }<a name="line.206"></a> |
| <FONT color="green">207</FONT> }<a name="line.207"></a> |
| <FONT color="green">208</FONT> <a name="line.208"></a> |
| <FONT color="green">209</FONT> public boolean isRequestedSessionIdFromURL() {<a name="line.209"></a> |
| <FONT color="green">210</FONT> if (isHttpSessions()) {<a name="line.210"></a> |
| <FONT color="green">211</FONT> return super.isRequestedSessionIdFromURL();<a name="line.211"></a> |
| <FONT color="green">212</FONT> } else {<a name="line.212"></a> |
| <FONT color="green">213</FONT> String value = (String) getAttribute(REFERENCED_SESSION_ID_SOURCE);<a name="line.213"></a> |
| <FONT color="green">214</FONT> return value != null && value.equals(URL_SESSION_ID_SOURCE);<a name="line.214"></a> |
| <FONT color="green">215</FONT> }<a name="line.215"></a> |
| <FONT color="green">216</FONT> }<a name="line.216"></a> |
| <FONT color="green">217</FONT> <a name="line.217"></a> |
| <FONT color="green">218</FONT> public boolean isRequestedSessionIdFromUrl() {<a name="line.218"></a> |
| <FONT color="green">219</FONT> return isRequestedSessionIdFromURL();<a name="line.219"></a> |
| <FONT color="green">220</FONT> }<a name="line.220"></a> |
| <FONT color="green">221</FONT> <a name="line.221"></a> |
| <FONT color="green">222</FONT> private class ObjectPrincipal implements java.security.Principal {<a name="line.222"></a> |
| <FONT color="green">223</FONT> private Object object = null;<a name="line.223"></a> |
| <FONT color="green">224</FONT> <a name="line.224"></a> |
| <FONT color="green">225</FONT> public ObjectPrincipal(Object object) {<a name="line.225"></a> |
| <FONT color="green">226</FONT> this.object = object;<a name="line.226"></a> |
| <FONT color="green">227</FONT> }<a name="line.227"></a> |
| <FONT color="green">228</FONT> <a name="line.228"></a> |
| <FONT color="green">229</FONT> public Object getObject() {<a name="line.229"></a> |
| <FONT color="green">230</FONT> return object;<a name="line.230"></a> |
| <FONT color="green">231</FONT> }<a name="line.231"></a> |
| <FONT color="green">232</FONT> <a name="line.232"></a> |
| <FONT color="green">233</FONT> public String getName() {<a name="line.233"></a> |
| <FONT color="green">234</FONT> return getObject().toString();<a name="line.234"></a> |
| <FONT color="green">235</FONT> }<a name="line.235"></a> |
| <FONT color="green">236</FONT> <a name="line.236"></a> |
| <FONT color="green">237</FONT> public int hashCode() {<a name="line.237"></a> |
| <FONT color="green">238</FONT> return object.hashCode();<a name="line.238"></a> |
| <FONT color="green">239</FONT> }<a name="line.239"></a> |
| <FONT color="green">240</FONT> <a name="line.240"></a> |
| <FONT color="green">241</FONT> public boolean equals(Object o) {<a name="line.241"></a> |
| <FONT color="green">242</FONT> if (o instanceof ObjectPrincipal) {<a name="line.242"></a> |
| <FONT color="green">243</FONT> ObjectPrincipal op = (ObjectPrincipal) o;<a name="line.243"></a> |
| <FONT color="green">244</FONT> return getObject().equals(op.getObject());<a name="line.244"></a> |
| <FONT color="green">245</FONT> }<a name="line.245"></a> |
| <FONT color="green">246</FONT> return false;<a name="line.246"></a> |
| <FONT color="green">247</FONT> }<a name="line.247"></a> |
| <FONT color="green">248</FONT> <a name="line.248"></a> |
| <FONT color="green">249</FONT> public String toString() {<a name="line.249"></a> |
| <FONT color="green">250</FONT> return object.toString();<a name="line.250"></a> |
| <FONT color="green">251</FONT> }<a name="line.251"></a> |
| <FONT color="green">252</FONT> }<a name="line.252"></a> |
| <FONT color="green">253</FONT> }<a name="line.253"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
