| <!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.realm.text;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.authc.SimpleAccount;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.authz.Permission;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.authz.SimpleRole;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.config.ConfigurationException;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.realm.SimpleAccountRealm;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.util.PermissionUtils;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.shiro.util.StringUtils;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.text.ParseException;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.Collection;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.HashMap;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.LinkedHashSet;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import java.util.Map;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import java.util.Scanner;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import java.util.Set;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><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> * A SimpleAccountRealm that enables text-based configuration of the initial User, Role, and Permission objects<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * created at startup.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p/><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * Each User account definition specifies the username, password, and roles for a user. Each Role definition<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * specifies a name and an optional collection of assigned Permissions. Users can be assigned Roles, and Roles can be<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * assigned Permissions. By transitive association, each User 'has' all of their Role's Permissions.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <p/><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * User and user-to-role definitions are specified via the {@link #setUserDefinitions} method and<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Role-to-permission definitions are specified via the {@link #setRoleDefinitions} method.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @since 0.9<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public class TextConfigurationRealm extends SimpleAccountRealm {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> //TODO - complete JavaDoc<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private volatile String userDefinitions;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> private volatile String roleDefinitions;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> public TextConfigurationRealm() {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> super();<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> }<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Will call 'processDefinitions' on startup.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> *<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @since 1.2<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @see <a href="https://issues.apache.org/jira/browse/SHIRO-223">SHIRO-223</a><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> @Override<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> protected void onInit() {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> super.onInit();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> processDefinitions();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public String getUserDefinitions() {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> return userDefinitions;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <p>Sets a newline (\n) delimited String that defines user-to-password-and-role(s) key/value pairs according<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * to the following format:<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <p/><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <p><code><em>username</em> = <em>password</em>, role1, role2,...</code></p><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * <p/><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <p>Here are some examples of what these lines might look like:</p><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * <p/><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <p><code>root = <em>reallyHardToGuessPassword</em>, administrator<br/><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * jsmith = <em>jsmithsPassword</em>, manager, engineer, employee<br/><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * abrown = <em>abrownsPassword</em>, qa, employee<br/><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * djones = <em>djonesPassword</em>, qa, contractor<br/><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * guest = <em>guestPassword</em></code></p><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> *<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param userDefinitions the user definitions to be parsed and converted to Map.Entry elements<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public void setUserDefinitions(String userDefinitions) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> this.userDefinitions = userDefinitions;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> public String getRoleDefinitions() {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> return roleDefinitions;<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<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> * Sets a newline (\n) delimited String that defines role-to-permission definitions.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * <p/><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <p>Each line within the string must define a role-to-permission(s) key/value mapping with the<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * equals character signifies the key/value separation, like so:</p><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * <p/><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * <p><code><em>rolename</em> = <em>permissionDefinition1</em>, <em>permissionDefinition2</em>, ...</code></p><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * <p/><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <p>where <em>permissionDefinition</em> is an arbitrary String, but must people will want to use<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Strings that conform to the {@link org.apache.shiro.authz.permission.WildcardPermission WildcardPermission}<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * format for ease of use and flexibility. Note that if an individual <em>permissionDefinition</em> needs to<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * be internally comma-delimited (e.g. <code>printer:5thFloor:print,info</code>), you will need to surround that<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * definition with double quotes (&quot;) to avoid parsing errors (e.g.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * <code>&quot;printer:5thFloor:print,info&quot;</code>).<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * <p/><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * <p><b>NOTE:</b> if you have roles that don't require permission associations, don't include them in this<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * definition - just defining the role name in the {@link #setUserDefinitions(String) userDefinitions} is<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * enough to create the role if it does not yet exist. This property is really only for configuring realms that<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * have one or more assigned Permission.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> *<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @param roleDefinitions the role definitions to be parsed at initialization<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> */<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> public void setRoleDefinitions(String roleDefinitions) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> this.roleDefinitions = roleDefinitions;<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> protected void processDefinitions() {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> try {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> processRoleDefinitions();<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> processUserDefinitions();<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> } catch (ParseException e) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> String msg = "Unable to parse user and/or role definitions.";<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> throw new ConfigurationException(msg, e);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> }<a name="line.136"></a> |
| <span class="sourceLineNo">137</span><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> protected void processRoleDefinitions() throws ParseException {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> String roleDefinitions = getRoleDefinitions();<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> if (roleDefinitions == null) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> return;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> Map<String, String> roleDefs = toMap(toLines(roleDefinitions));<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> processRoleDefinitions(roleDefs);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> protected void processRoleDefinitions(Map<String, String> roleDefs) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> if (roleDefs == null || roleDefs.isEmpty()) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return;<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> for (String rolename : roleDefs.keySet()) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> String value = roleDefs.get(rolename);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> SimpleRole role = getRole(rolename);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> if (role == null) {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> role = new SimpleRole(rolename);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> add(role);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> Set<Permission> permissions = PermissionUtils.resolveDelimitedPermissions(value, getPermissionResolver());<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> role.setPermissions(permissions);<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> protected void processUserDefinitions() throws ParseException {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> String userDefinitions = getUserDefinitions();<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> if (userDefinitions == null) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> return;<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> }<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> Map<String, String> userDefs = toMap(toLines(userDefinitions));<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> processUserDefinitions(userDefs);<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> protected void processUserDefinitions(Map<String, String> userDefs) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> if (userDefs == null || userDefs.isEmpty()) {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> for (String username : userDefs.keySet()) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> String value = userDefs.get(username);<a name="line.182"></a> |
| <span class="sourceLineNo">183</span><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> String[] passwordAndRolesArray = StringUtils.split(value);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> String password = passwordAndRolesArray[0];<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> SimpleAccount account = getUser(username);<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> if (account == null) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> account = new SimpleAccount(username, password, getName());<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> add(account);<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> account.setCredentials(password);<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> if (passwordAndRolesArray.length > 1) {<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> for (int i = 1; i < passwordAndRolesArray.length; i++) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> String rolename = passwordAndRolesArray[i];<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> account.addRole(rolename);<a name="line.198"></a> |
| <span class="sourceLineNo">199</span><a name="line.199"></a> |
| <span class="sourceLineNo">200</span> SimpleRole role = getRole(rolename);<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> if (role != null) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> account.addObjectPermissions(role.getPermissions());<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> } else {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> account.setRoles(null);<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> }<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span><a name="line.210"></a> |
| <span class="sourceLineNo">211</span> protected static Set<String> toLines(String s) {<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> LinkedHashSet<String> set = new LinkedHashSet<String>();<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> Scanner scanner = new Scanner(s);<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> while (scanner.hasNextLine()) {<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> set.add(scanner.nextLine());<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> }<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> return set;<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span><a name="line.219"></a> |
| <span class="sourceLineNo">220</span> protected static Map<String, String> toMap(Collection<String> keyValuePairs) throws ParseException {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> if (keyValuePairs == null || keyValuePairs.isEmpty()) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> return null;<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> }<a name="line.223"></a> |
| <span class="sourceLineNo">224</span><a name="line.224"></a> |
| <span class="sourceLineNo">225</span> Map<String, String> pairs = new HashMap<String, String>();<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> for (String pairString : keyValuePairs) {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> String[] pair = StringUtils.splitKeyValue(pairString);<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> if (pair != null) {<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> pairs.put(pair[0].trim(), pair[1].trim());<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> }<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> }<a name="line.231"></a> |
| <span class="sourceLineNo">232</span><a name="line.232"></a> |
| <span class="sourceLineNo">233</span> return pairs;<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> }<a name="line.234"></a> |
| <span class="sourceLineNo">235</span>}<a name="line.235"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
