blob: 556370b2a37565697b8ff57488e0bfbad39250fe [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.config;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.mgt.DefaultSecurityManager;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.mgt.RealmSecurityManager;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.mgt.SecurityManager;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.realm.Realm;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.realm.RealmFactory;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.realm.text.IniRealm;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.shiro.util.Factory;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.shiro.util.LifecycleUtils;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.shiro.util.Nameable;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.slf4j.Logger;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.slf4j.LoggerFactory;<a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> import java.util.ArrayList;<a name="line.34"></a>
<FONT color="green">035</FONT> import java.util.Collection;<a name="line.35"></a>
<FONT color="green">036</FONT> import java.util.Collections;<a name="line.36"></a>
<FONT color="green">037</FONT> import java.util.LinkedHashMap;<a name="line.37"></a>
<FONT color="green">038</FONT> import java.util.List;<a name="line.38"></a>
<FONT color="green">039</FONT> import java.util.Map;<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> * A {@link Factory} that creates {@link SecurityManager} instances based on {@link Ini} configuration.<a name="line.42"></a>
<FONT color="green">043</FONT> *<a name="line.43"></a>
<FONT color="green">044</FONT> * @since 1.0<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> public class IniSecurityManagerFactory extends IniFactorySupport&lt;SecurityManager&gt; {<a name="line.46"></a>
<FONT color="green">047</FONT> <a name="line.47"></a>
<FONT color="green">048</FONT> public static final String MAIN_SECTION_NAME = "main";<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> public static final String SECURITY_MANAGER_NAME = "securityManager";<a name="line.50"></a>
<FONT color="green">051</FONT> public static final String INI_REALM_NAME = "iniRealm";<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> private static transient final Logger log = LoggerFactory.getLogger(IniSecurityManagerFactory.class);<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> private ReflectionBuilder builder;<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> /**<a name="line.57"></a>
<FONT color="green">058</FONT> * Creates a new instance. See the {@link #getInstance()} JavaDoc for detailed explanation of how an INI<a name="line.58"></a>
<FONT color="green">059</FONT> * source will be resolved to use to build the instance.<a name="line.59"></a>
<FONT color="green">060</FONT> */<a name="line.60"></a>
<FONT color="green">061</FONT> public IniSecurityManagerFactory() {<a name="line.61"></a>
<FONT color="green">062</FONT> }<a name="line.62"></a>
<FONT color="green">063</FONT> <a name="line.63"></a>
<FONT color="green">064</FONT> public IniSecurityManagerFactory(Ini config) {<a name="line.64"></a>
<FONT color="green">065</FONT> setIni(config);<a name="line.65"></a>
<FONT color="green">066</FONT> }<a name="line.66"></a>
<FONT color="green">067</FONT> <a name="line.67"></a>
<FONT color="green">068</FONT> public IniSecurityManagerFactory(String iniResourcePath) {<a name="line.68"></a>
<FONT color="green">069</FONT> this(Ini.fromResourcePath(iniResourcePath));<a name="line.69"></a>
<FONT color="green">070</FONT> }<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> public Map&lt;String, ?&gt; getBeans() {<a name="line.72"></a>
<FONT color="green">073</FONT> return this.builder != null ? Collections.unmodifiableMap(builder.getObjects()) : null;<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> private SecurityManager getSecurityManagerBean() {<a name="line.76"></a>
<FONT color="green">077</FONT> return builder.getBean(SECURITY_MANAGER_NAME, SecurityManager.class);<a name="line.77"></a>
<FONT color="green">078</FONT> }<a name="line.78"></a>
<FONT color="green">079</FONT> <a name="line.79"></a>
<FONT color="green">080</FONT> protected SecurityManager createDefaultInstance() {<a name="line.80"></a>
<FONT color="green">081</FONT> return new DefaultSecurityManager();<a name="line.81"></a>
<FONT color="green">082</FONT> }<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> protected SecurityManager createInstance(Ini ini) {<a name="line.84"></a>
<FONT color="green">085</FONT> if (CollectionUtils.isEmpty(ini)) {<a name="line.85"></a>
<FONT color="green">086</FONT> throw new NullPointerException("Ini argument cannot be null or empty.");<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> SecurityManager securityManager = createSecurityManager(ini);<a name="line.88"></a>
<FONT color="green">089</FONT> if (securityManager == null) {<a name="line.89"></a>
<FONT color="green">090</FONT> String msg = SecurityManager.class + " instance cannot be null.";<a name="line.90"></a>
<FONT color="green">091</FONT> throw new ConfigurationException(msg);<a name="line.91"></a>
<FONT color="green">092</FONT> }<a name="line.92"></a>
<FONT color="green">093</FONT> return securityManager;<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> private SecurityManager createSecurityManager(Ini ini) {<a name="line.96"></a>
<FONT color="green">097</FONT> Ini.Section mainSection = ini.getSection(MAIN_SECTION_NAME);<a name="line.97"></a>
<FONT color="green">098</FONT> if (CollectionUtils.isEmpty(mainSection)) {<a name="line.98"></a>
<FONT color="green">099</FONT> //try the default:<a name="line.99"></a>
<FONT color="green">100</FONT> mainSection = ini.getSection(Ini.DEFAULT_SECTION_NAME);<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> return createSecurityManager(ini, mainSection);<a name="line.102"></a>
<FONT color="green">103</FONT> }<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> protected boolean isAutoApplyRealms(SecurityManager securityManager) {<a name="line.105"></a>
<FONT color="green">106</FONT> boolean autoApply = true;<a name="line.106"></a>
<FONT color="green">107</FONT> if (securityManager instanceof RealmSecurityManager) {<a name="line.107"></a>
<FONT color="green">108</FONT> //only apply realms if they haven't been explicitly set by the user:<a name="line.108"></a>
<FONT color="green">109</FONT> RealmSecurityManager realmSecurityManager = (RealmSecurityManager) securityManager;<a name="line.109"></a>
<FONT color="green">110</FONT> Collection&lt;Realm&gt; realms = realmSecurityManager.getRealms();<a name="line.110"></a>
<FONT color="green">111</FONT> if (!CollectionUtils.isEmpty(realms)) {<a name="line.111"></a>
<FONT color="green">112</FONT> log.info("Realms have been explicitly set on the SecurityManager instance - auto-setting of " +<a name="line.112"></a>
<FONT color="green">113</FONT> "realms will not occur.");<a name="line.113"></a>
<FONT color="green">114</FONT> autoApply = 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> return autoApply;<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> <a name="line.119"></a>
<FONT color="green">120</FONT> @SuppressWarnings({"unchecked"})<a name="line.120"></a>
<FONT color="green">121</FONT> private SecurityManager createSecurityManager(Ini ini, Ini.Section mainSection) {<a name="line.121"></a>
<FONT color="green">122</FONT> <a name="line.122"></a>
<FONT color="green">123</FONT> Map&lt;String, ?&gt; defaults = createDefaults(ini, mainSection);<a name="line.123"></a>
<FONT color="green">124</FONT> Map&lt;String, ?&gt; objects = buildInstances(mainSection, defaults);<a name="line.124"></a>
<FONT color="green">125</FONT> <a name="line.125"></a>
<FONT color="green">126</FONT> SecurityManager securityManager = getSecurityManagerBean();<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> boolean autoApplyRealms = isAutoApplyRealms(securityManager);<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> if (autoApplyRealms) {<a name="line.130"></a>
<FONT color="green">131</FONT> //realms and realm factory might have been created - pull them out first so we can<a name="line.131"></a>
<FONT color="green">132</FONT> //initialize the securityManager:<a name="line.132"></a>
<FONT color="green">133</FONT> Collection&lt;Realm&gt; realms = getRealms(objects);<a name="line.133"></a>
<FONT color="green">134</FONT> //set them on the SecurityManager<a name="line.134"></a>
<FONT color="green">135</FONT> if (!CollectionUtils.isEmpty(realms)) {<a name="line.135"></a>
<FONT color="green">136</FONT> applyRealmsToSecurityManager(realms, securityManager);<a name="line.136"></a>
<FONT color="green">137</FONT> }<a name="line.137"></a>
<FONT color="green">138</FONT> }<a name="line.138"></a>
<FONT color="green">139</FONT> <a name="line.139"></a>
<FONT color="green">140</FONT> return securityManager;<a name="line.140"></a>
<FONT color="green">141</FONT> }<a name="line.141"></a>
<FONT color="green">142</FONT> <a name="line.142"></a>
<FONT color="green">143</FONT> protected Map&lt;String, ?&gt; createDefaults(Ini ini, Ini.Section mainSection) {<a name="line.143"></a>
<FONT color="green">144</FONT> Map&lt;String, Object&gt; defaults = new LinkedHashMap&lt;String, Object&gt;();<a name="line.144"></a>
<FONT color="green">145</FONT> <a name="line.145"></a>
<FONT color="green">146</FONT> SecurityManager securityManager = createDefaultInstance();<a name="line.146"></a>
<FONT color="green">147</FONT> defaults.put(SECURITY_MANAGER_NAME, securityManager);<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> if (shouldImplicitlyCreateRealm(ini)) {<a name="line.149"></a>
<FONT color="green">150</FONT> Realm realm = createRealm(ini);<a name="line.150"></a>
<FONT color="green">151</FONT> if (realm != null) {<a name="line.151"></a>
<FONT color="green">152</FONT> defaults.put(INI_REALM_NAME, realm);<a name="line.152"></a>
<FONT color="green">153</FONT> }<a name="line.153"></a>
<FONT color="green">154</FONT> }<a name="line.154"></a>
<FONT color="green">155</FONT> <a name="line.155"></a>
<FONT color="green">156</FONT> return defaults;<a name="line.156"></a>
<FONT color="green">157</FONT> }<a name="line.157"></a>
<FONT color="green">158</FONT> <a name="line.158"></a>
<FONT color="green">159</FONT> private Map&lt;String, ?&gt; buildInstances(Ini.Section section, Map&lt;String, ?&gt; defaults) {<a name="line.159"></a>
<FONT color="green">160</FONT> this.builder = new ReflectionBuilder(defaults);<a name="line.160"></a>
<FONT color="green">161</FONT> return this.builder.buildObjects(section);<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> private void addToRealms(Collection&lt;Realm&gt; realms, RealmFactory factory) {<a name="line.164"></a>
<FONT color="green">165</FONT> LifecycleUtils.init(factory);<a name="line.165"></a>
<FONT color="green">166</FONT> Collection&lt;Realm&gt; factoryRealms = factory.getRealms();<a name="line.166"></a>
<FONT color="green">167</FONT> //SHIRO-238: check factoryRealms (was 'realms'):<a name="line.167"></a>
<FONT color="green">168</FONT> if (!CollectionUtils.isEmpty(factoryRealms)) {<a name="line.168"></a>
<FONT color="green">169</FONT> realms.addAll(factoryRealms);<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> <a name="line.172"></a>
<FONT color="green">173</FONT> private Collection&lt;Realm&gt; getRealms(Map&lt;String, ?&gt; instances) {<a name="line.173"></a>
<FONT color="green">174</FONT> <a name="line.174"></a>
<FONT color="green">175</FONT> //realms and realm factory might have been created - pull them out first so we can<a name="line.175"></a>
<FONT color="green">176</FONT> //initialize the securityManager:<a name="line.176"></a>
<FONT color="green">177</FONT> List&lt;Realm&gt; realms = new ArrayList&lt;Realm&gt;();<a name="line.177"></a>
<FONT color="green">178</FONT> <a name="line.178"></a>
<FONT color="green">179</FONT> //iterate over the map entries to pull out the realm factory(s):<a name="line.179"></a>
<FONT color="green">180</FONT> for (Map.Entry&lt;String, ?&gt; entry : instances.entrySet()) {<a name="line.180"></a>
<FONT color="green">181</FONT> <a name="line.181"></a>
<FONT color="green">182</FONT> String name = entry.getKey();<a name="line.182"></a>
<FONT color="green">183</FONT> Object value = entry.getValue();<a name="line.183"></a>
<FONT color="green">184</FONT> <a name="line.184"></a>
<FONT color="green">185</FONT> if (value instanceof RealmFactory) {<a name="line.185"></a>
<FONT color="green">186</FONT> addToRealms(realms, (RealmFactory) value);<a name="line.186"></a>
<FONT color="green">187</FONT> } else if (value instanceof Realm) {<a name="line.187"></a>
<FONT color="green">188</FONT> Realm realm = (Realm) value;<a name="line.188"></a>
<FONT color="green">189</FONT> //set the name if null:<a name="line.189"></a>
<FONT color="green">190</FONT> String existingName = realm.getName();<a name="line.190"></a>
<FONT color="green">191</FONT> if (existingName == null || existingName.startsWith(realm.getClass().getName())) {<a name="line.191"></a>
<FONT color="green">192</FONT> if (realm instanceof Nameable) {<a name="line.192"></a>
<FONT color="green">193</FONT> ((Nameable) realm).setName(name);<a name="line.193"></a>
<FONT color="green">194</FONT> log.debug("Applied name '{}' to Nameable realm instance {}", name, realm);<a name="line.194"></a>
<FONT color="green">195</FONT> } else {<a name="line.195"></a>
<FONT color="green">196</FONT> log.info("Realm does not implement the {} interface. Configured name will not be applied.",<a name="line.196"></a>
<FONT color="green">197</FONT> Nameable.class.getName());<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> realms.add(realm);<a name="line.200"></a>
<FONT color="green">201</FONT> }<a name="line.201"></a>
<FONT color="green">202</FONT> }<a name="line.202"></a>
<FONT color="green">203</FONT> <a name="line.203"></a>
<FONT color="green">204</FONT> return realms;<a name="line.204"></a>
<FONT color="green">205</FONT> }<a name="line.205"></a>
<FONT color="green">206</FONT> <a name="line.206"></a>
<FONT color="green">207</FONT> private void assertRealmSecurityManager(SecurityManager securityManager) {<a name="line.207"></a>
<FONT color="green">208</FONT> if (securityManager == null) {<a name="line.208"></a>
<FONT color="green">209</FONT> throw new NullPointerException("securityManager instance cannot be null");<a name="line.209"></a>
<FONT color="green">210</FONT> }<a name="line.210"></a>
<FONT color="green">211</FONT> if (!(securityManager instanceof RealmSecurityManager)) {<a name="line.211"></a>
<FONT color="green">212</FONT> String msg = "securityManager instance is not a " + RealmSecurityManager.class.getName() +<a name="line.212"></a>
<FONT color="green">213</FONT> " instance. This is required to access or configure realms on the instance.";<a name="line.213"></a>
<FONT color="green">214</FONT> throw new ConfigurationException(msg);<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> protected void applyRealmsToSecurityManager(Collection&lt;Realm&gt; realms, SecurityManager securityManager) {<a name="line.218"></a>
<FONT color="green">219</FONT> assertRealmSecurityManager(securityManager);<a name="line.219"></a>
<FONT color="green">220</FONT> ((RealmSecurityManager) securityManager).setRealms(realms);<a name="line.220"></a>
<FONT color="green">221</FONT> }<a name="line.221"></a>
<FONT color="green">222</FONT> <a name="line.222"></a>
<FONT color="green">223</FONT> /**<a name="line.223"></a>
<FONT color="green">224</FONT> * Returns {@code true} if the Ini contains account data and a {@code Realm} should be implicitly<a name="line.224"></a>
<FONT color="green">225</FONT> * {@link #createRealm(Ini) created} to reflect the account data, {@code false} if no realm should be implicitly<a name="line.225"></a>
<FONT color="green">226</FONT> * created.<a name="line.226"></a>
<FONT color="green">227</FONT> *<a name="line.227"></a>
<FONT color="green">228</FONT> * @param ini the Ini instance to inspect for account data resulting in an implicitly created realm.<a name="line.228"></a>
<FONT color="green">229</FONT> * @return {@code true} if the Ini contains account data and a {@code Realm} should be implicitly<a name="line.229"></a>
<FONT color="green">230</FONT> * {@link #createRealm(Ini) created} to reflect the account data, {@code false} if no realm should be<a name="line.230"></a>
<FONT color="green">231</FONT> * implicitly created.<a name="line.231"></a>
<FONT color="green">232</FONT> */<a name="line.232"></a>
<FONT color="green">233</FONT> protected boolean shouldImplicitlyCreateRealm(Ini ini) {<a name="line.233"></a>
<FONT color="green">234</FONT> return !CollectionUtils.isEmpty(ini) &amp;&amp;<a name="line.234"></a>
<FONT color="green">235</FONT> (!CollectionUtils.isEmpty(ini.getSection(IniRealm.ROLES_SECTION_NAME)) ||<a name="line.235"></a>
<FONT color="green">236</FONT> !CollectionUtils.isEmpty(ini.getSection(IniRealm.USERS_SECTION_NAME)));<a name="line.236"></a>
<FONT color="green">237</FONT> }<a name="line.237"></a>
<FONT color="green">238</FONT> <a name="line.238"></a>
<FONT color="green">239</FONT> /**<a name="line.239"></a>
<FONT color="green">240</FONT> * Creates a {@code Realm} from the Ini instance containing account data.<a name="line.240"></a>
<FONT color="green">241</FONT> *<a name="line.241"></a>
<FONT color="green">242</FONT> * @param ini the Ini instance from which to acquire the account data.<a name="line.242"></a>
<FONT color="green">243</FONT> * @return a new Realm instance reflecting the account data discovered in the {@code Ini}.<a name="line.243"></a>
<FONT color="green">244</FONT> */<a name="line.244"></a>
<FONT color="green">245</FONT> protected Realm createRealm(Ini ini) {<a name="line.245"></a>
<FONT color="green">246</FONT> //IniRealm realm = new IniRealm(ini); changed to support SHIRO-322<a name="line.246"></a>
<FONT color="green">247</FONT> IniRealm realm = new IniRealm();<a name="line.247"></a>
<FONT color="green">248</FONT> realm.setName(INI_REALM_NAME);<a name="line.248"></a>
<FONT color="green">249</FONT> realm.setIni(ini); //added for SHIRO-322<a name="line.249"></a>
<FONT color="green">250</FONT> return realm;<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>
</PRE>
</BODY>
</HTML>