blob: 3fd529eb9c28fc9a9ec0a468394b7ea4d4d30ea4 [file] [log] [blame]
<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.spring.remoting;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.aopalliance.intercept.MethodInvocation;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.SecurityUtils;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.session.Session;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.session.mgt.NativeSessionManager;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.session.mgt.SessionKey;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.session.mgt.SessionManager;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.shiro.subject.Subject;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.slf4j.Logger;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.slf4j.LoggerFactory;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.springframework.remoting.support.DefaultRemoteInvocationFactory;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.springframework.remoting.support.RemoteInvocation;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.springframework.remoting.support.RemoteInvocationFactory;<a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> import java.io.Serializable;<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * A {@link RemoteInvocationFactory} that passes the session ID to the server via a<a name="line.37"></a>
<FONT color="green">038</FONT> * {@link RemoteInvocation} {@link RemoteInvocation#getAttribute(String) attribute}.<a name="line.38"></a>
<FONT color="green">039</FONT> * This factory is the client-side part of<a name="line.39"></a>
<FONT color="green">040</FONT> * the Shiro Spring remoting invocation. A {@link SecureRemoteInvocationExecutor} should<a name="line.40"></a>
<FONT color="green">041</FONT> * be used to export the server-side remote services to ensure that the appropriate<a name="line.41"></a>
<FONT color="green">042</FONT> * Subject and Session are bound to the remote thread during execution.<a name="line.42"></a>
<FONT color="green">043</FONT> *<a name="line.43"></a>
<FONT color="green">044</FONT> * @since 0.1<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> public class SecureRemoteInvocationFactory extends DefaultRemoteInvocationFactory {<a name="line.46"></a>
<FONT color="green">047</FONT> <a name="line.47"></a>
<FONT color="green">048</FONT> private static final Logger log = LoggerFactory.getLogger(SecureRemoteInvocationFactory.class);<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> public static final String SESSION_ID_KEY = SecureRemoteInvocationFactory.class.getName() + ".SESSION_ID_KEY";<a name="line.50"></a>
<FONT color="green">051</FONT> public static final String HOST_KEY = SecureRemoteInvocationFactory.class.getName() + ".HOST_KEY";<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> private static final String SESSION_ID_SYSTEM_PROPERTY_NAME = "shiro.session.id";<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> private String sessionId;<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> public SecureRemoteInvocationFactory() {<a name="line.57"></a>
<FONT color="green">058</FONT> }<a name="line.58"></a>
<FONT color="green">059</FONT> <a name="line.59"></a>
<FONT color="green">060</FONT> public SecureRemoteInvocationFactory(String sessionId) {<a name="line.60"></a>
<FONT color="green">061</FONT> this();<a name="line.61"></a>
<FONT color="green">062</FONT> this.sessionId = sessionId;<a name="line.62"></a>
<FONT color="green">063</FONT> }<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> * Creates a {@link RemoteInvocation} with the current session ID as an<a name="line.66"></a>
<FONT color="green">067</FONT> * {@link RemoteInvocation#getAttribute(String) attribute}.<a name="line.67"></a>
<FONT color="green">068</FONT> *<a name="line.68"></a>
<FONT color="green">069</FONT> * @param mi the method invocation that the remote invocation should be based on.<a name="line.69"></a>
<FONT color="green">070</FONT> * @return a remote invocation object containing the current session ID as an attribute.<a name="line.70"></a>
<FONT color="green">071</FONT> */<a name="line.71"></a>
<FONT color="green">072</FONT> public RemoteInvocation createRemoteInvocation(MethodInvocation mi) {<a name="line.72"></a>
<FONT color="green">073</FONT> <a name="line.73"></a>
<FONT color="green">074</FONT> Serializable sessionId = null;<a name="line.74"></a>
<FONT color="green">075</FONT> String host = null;<a name="line.75"></a>
<FONT color="green">076</FONT> boolean sessionManagerMethodInvocation = false;<a name="line.76"></a>
<FONT color="green">077</FONT> <a name="line.77"></a>
<FONT color="green">078</FONT> //If the calling MI is for a remoting SessionManager delegate, we need to acquire the session ID from the method<a name="line.78"></a>
<FONT color="green">079</FONT> //argument and NOT interact with SecurityUtils/subject.getSession to avoid a stack overflow<a name="line.79"></a>
<FONT color="green">080</FONT> Class miDeclaringClass = mi.getMethod().getDeclaringClass();<a name="line.80"></a>
<FONT color="green">081</FONT> if (SessionManager.class.equals(miDeclaringClass) || NativeSessionManager.class.equals(miDeclaringClass)) {<a name="line.81"></a>
<FONT color="green">082</FONT> sessionManagerMethodInvocation = true;<a name="line.82"></a>
<FONT color="green">083</FONT> //for SessionManager calls, all method calls except the 'start' methods require a SessionKey<a name="line.83"></a>
<FONT color="green">084</FONT> // as the first argument, so just get it from there:<a name="line.84"></a>
<FONT color="green">085</FONT> if (!mi.getMethod().getName().equals("start")) {<a name="line.85"></a>
<FONT color="green">086</FONT> SessionKey key = (SessionKey) mi.getArguments()[0];<a name="line.86"></a>
<FONT color="green">087</FONT> sessionId = key.getSessionId();<a name="line.87"></a>
<FONT color="green">088</FONT> }<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> //tried the delegate. Use the injected session id if given<a name="line.91"></a>
<FONT color="green">092</FONT> if (sessionId == null) sessionId = this.sessionId;<a name="line.92"></a>
<FONT color="green">093</FONT> <a name="line.93"></a>
<FONT color="green">094</FONT> // If sessionId is null, only then try the Subject:<a name="line.94"></a>
<FONT color="green">095</FONT> if (sessionId == null) {<a name="line.95"></a>
<FONT color="green">096</FONT> try {<a name="line.96"></a>
<FONT color="green">097</FONT> // HACK Check if can get the securityManager - this'll cause an exception if it's not set <a name="line.97"></a>
<FONT color="green">098</FONT> SecurityUtils.getSecurityManager();<a name="line.98"></a>
<FONT color="green">099</FONT> if (!sessionManagerMethodInvocation) {<a name="line.99"></a>
<FONT color="green">100</FONT> Subject subject = SecurityUtils.getSubject();<a name="line.100"></a>
<FONT color="green">101</FONT> Session session = subject.getSession(false);<a name="line.101"></a>
<FONT color="green">102</FONT> if (session != null) {<a name="line.102"></a>
<FONT color="green">103</FONT> sessionId = session.getId();<a name="line.103"></a>
<FONT color="green">104</FONT> host = session.getHost();<a name="line.104"></a>
<FONT color="green">105</FONT> }<a name="line.105"></a>
<FONT color="green">106</FONT> }<a name="line.106"></a>
<FONT color="green">107</FONT> }<a name="line.107"></a>
<FONT color="green">108</FONT> catch (Exception e) {<a name="line.108"></a>
<FONT color="green">109</FONT> log.trace("No security manager set. Trying next to get session id from system property");<a name="line.109"></a>
<FONT color="green">110</FONT> }<a name="line.110"></a>
<FONT color="green">111</FONT> }<a name="line.111"></a>
<FONT color="green">112</FONT> //No call to the sessionManager, and the Subject doesn't have a session. Try a system property<a name="line.112"></a>
<FONT color="green">113</FONT> //as a last result:<a name="line.113"></a>
<FONT color="green">114</FONT> if (sessionId == null) {<a name="line.114"></a>
<FONT color="green">115</FONT> if (log.isTraceEnabled()) {<a name="line.115"></a>
<FONT color="green">116</FONT> log.trace("No Session found for the currently executing subject via subject.getSession(false). " +<a name="line.116"></a>
<FONT color="green">117</FONT> "Attempting to revert back to the 'shiro.session.id' system property...");<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> sessionId = System.getProperty(SESSION_ID_SYSTEM_PROPERTY_NAME);<a name="line.119"></a>
<FONT color="green">120</FONT> if (sessionId == null &amp;&amp; log.isTraceEnabled()) {<a name="line.120"></a>
<FONT color="green">121</FONT> log.trace("No 'shiro.session.id' system property found. Heuristics have been exhausted; " +<a name="line.121"></a>
<FONT color="green">122</FONT> "RemoteInvocation will not contain a sessionId.");<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> }<a name="line.124"></a>
<FONT color="green">125</FONT> <a name="line.125"></a>
<FONT color="green">126</FONT> RemoteInvocation ri = new RemoteInvocation(mi);<a name="line.126"></a>
<FONT color="green">127</FONT> if (sessionId != null) {<a name="line.127"></a>
<FONT color="green">128</FONT> ri.addAttribute(SESSION_ID_KEY, sessionId);<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> if (host != null) {<a name="line.130"></a>
<FONT color="green">131</FONT> ri.addAttribute(HOST_KEY, host);<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> return ri;<a name="line.134"></a>
<FONT color="green">135</FONT> }<a name="line.135"></a>
<FONT color="green">136</FONT> }<a name="line.136"></a>
</PRE>
</BODY>
</HTML>