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