blob: 5f344bae8c9c15c68b5c55b621457aeb30a3cfac [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.realm.jdbc;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.authc.*;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.authz.AuthorizationException;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.authz.AuthorizationInfo;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.authz.SimpleAuthorizationInfo;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.config.ConfigurationException;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.realm.AuthorizingRealm;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.shiro.subject.PrincipalCollection;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.shiro.util.ByteSource;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.shiro.util.JdbcUtils;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.slf4j.Logger;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.slf4j.LoggerFactory;<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> import javax.sql.DataSource;<a name="line.33"></a>
<FONT color="green">034</FONT> import java.sql.Connection;<a name="line.34"></a>
<FONT color="green">035</FONT> import java.sql.PreparedStatement;<a name="line.35"></a>
<FONT color="green">036</FONT> import java.sql.ResultSet;<a name="line.36"></a>
<FONT color="green">037</FONT> import java.sql.SQLException;<a name="line.37"></a>
<FONT color="green">038</FONT> import java.util.Collection;<a name="line.38"></a>
<FONT color="green">039</FONT> import java.util.LinkedHashSet;<a name="line.39"></a>
<FONT color="green">040</FONT> import java.util.Set;<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /**<a name="line.43"></a>
<FONT color="green">044</FONT> * Realm that allows authentication and authorization via JDBC calls. The default queries suggest a potential schema<a name="line.44"></a>
<FONT color="green">045</FONT> * for retrieving the user's password for authentication, and querying for a user's roles and permissions. The<a name="line.45"></a>
<FONT color="green">046</FONT> * default queries can be overridden by setting the query properties of the realm.<a name="line.46"></a>
<FONT color="green">047</FONT> * &lt;p/&gt;<a name="line.47"></a>
<FONT color="green">048</FONT> * If the default implementation<a name="line.48"></a>
<FONT color="green">049</FONT> * of authentication and authorization cannot handle your schema, this class can be subclassed and the<a name="line.49"></a>
<FONT color="green">050</FONT> * appropriate methods overridden. (usually {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)},<a name="line.50"></a>
<FONT color="green">051</FONT> * {@link #getRoleNamesForUser(java.sql.Connection,String)}, and/or {@link #getPermissions(java.sql.Connection,String,java.util.Collection)}<a name="line.51"></a>
<FONT color="green">052</FONT> * &lt;p/&gt;<a name="line.52"></a>
<FONT color="green">053</FONT> * This realm supports caching by extending from {@link org.apache.shiro.realm.AuthorizingRealm}.<a name="line.53"></a>
<FONT color="green">054</FONT> *<a name="line.54"></a>
<FONT color="green">055</FONT> * @since 0.2<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> public class JdbcRealm extends AuthorizingRealm {<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> //TODO - complete JavaDoc<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> /*--------------------------------------------<a name="line.61"></a>
<FONT color="green">062</FONT> | C O N S T A N T S |<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> * The default query used to retrieve account data for the user.<a name="line.65"></a>
<FONT color="green">066</FONT> */<a name="line.66"></a>
<FONT color="green">067</FONT> protected static final String DEFAULT_AUTHENTICATION_QUERY = "select password from users where username = ?";<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> * The default query used to retrieve account data for the user when {@link #saltStyle} is COLUMN.<a name="line.70"></a>
<FONT color="green">071</FONT> */<a name="line.71"></a>
<FONT color="green">072</FONT> protected static final String DEFAULT_SALTED_AUTHENTICATION_QUERY = "select password, password_salt from users where username = ?";<a name="line.72"></a>
<FONT color="green">073</FONT> <a name="line.73"></a>
<FONT color="green">074</FONT> /**<a name="line.74"></a>
<FONT color="green">075</FONT> * The default query used to retrieve the roles that apply to a user.<a name="line.75"></a>
<FONT color="green">076</FONT> */<a name="line.76"></a>
<FONT color="green">077</FONT> protected static final String DEFAULT_USER_ROLES_QUERY = "select role_name from user_roles where username = ?";<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> * The default query used to retrieve permissions that apply to a particular role.<a name="line.80"></a>
<FONT color="green">081</FONT> */<a name="line.81"></a>
<FONT color="green">082</FONT> protected static final String DEFAULT_PERMISSIONS_QUERY = "select permission from roles_permissions where role_name = ?";<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> private static final Logger log = LoggerFactory.getLogger(JdbcRealm.class);<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> * Password hash salt configuration. &lt;ul&gt;<a name="line.87"></a>
<FONT color="green">088</FONT> * &lt;li&gt;NO_SALT - password hashes are not salted.&lt;/li&gt;<a name="line.88"></a>
<FONT color="green">089</FONT> * &lt;li&gt;CRYPT - password hashes are stored in unix crypt format.&lt;/li&gt;<a name="line.89"></a>
<FONT color="green">090</FONT> * &lt;li&gt;COLUMN - salt is in a separate column in the database.&lt;/li&gt; <a name="line.90"></a>
<FONT color="green">091</FONT> * &lt;li&gt;EXTERNAL - salt is not stored in the database. {@link #getSaltForUser(String)} will be called<a name="line.91"></a>
<FONT color="green">092</FONT> * to get the salt&lt;/li&gt;&lt;/ul&gt;<a name="line.92"></a>
<FONT color="green">093</FONT> */<a name="line.93"></a>
<FONT color="green">094</FONT> public enum SaltStyle {NO_SALT, CRYPT, COLUMN, EXTERNAL};<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> /*--------------------------------------------<a name="line.96"></a>
<FONT color="green">097</FONT> | I N S T A N C E V A R I A B L E S |<a name="line.97"></a>
<FONT color="green">098</FONT> ============================================*/<a name="line.98"></a>
<FONT color="green">099</FONT> protected DataSource dataSource;<a name="line.99"></a>
<FONT color="green">100</FONT> <a name="line.100"></a>
<FONT color="green">101</FONT> protected String authenticationQuery = DEFAULT_AUTHENTICATION_QUERY;<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> protected String userRolesQuery = DEFAULT_USER_ROLES_QUERY;<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> protected String permissionsQuery = DEFAULT_PERMISSIONS_QUERY;<a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> protected boolean permissionsLookupEnabled = false;<a name="line.107"></a>
<FONT color="green">108</FONT> <a name="line.108"></a>
<FONT color="green">109</FONT> protected SaltStyle saltStyle = SaltStyle.NO_SALT;<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> | C O N S T R U C T O R S |<a name="line.112"></a>
<FONT color="green">113</FONT> ============================================*/<a name="line.113"></a>
<FONT color="green">114</FONT> <a name="line.114"></a>
<FONT color="green">115</FONT> /*--------------------------------------------<a name="line.115"></a>
<FONT color="green">116</FONT> | A C C E S S O R S / M O D I F I E R S |<a name="line.116"></a>
<FONT color="green">117</FONT> ============================================*/<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> * Sets the datasource that should be used to retrieve connections used by this realm.<a name="line.120"></a>
<FONT color="green">121</FONT> *<a name="line.121"></a>
<FONT color="green">122</FONT> * @param dataSource the SQL data source.<a name="line.122"></a>
<FONT color="green">123</FONT> */<a name="line.123"></a>
<FONT color="green">124</FONT> public void setDataSource(DataSource dataSource) {<a name="line.124"></a>
<FONT color="green">125</FONT> this.dataSource = dataSource;<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> /**<a name="line.128"></a>
<FONT color="green">129</FONT> * Overrides the default query used to retrieve a user's password during authentication. When using the default<a name="line.129"></a>
<FONT color="green">130</FONT> * implementation, this query must take the user's username as a single parameter and return a single result<a name="line.130"></a>
<FONT color="green">131</FONT> * with the user's password as the first column. If you require a solution that does not match this query<a name="line.131"></a>
<FONT color="green">132</FONT> * structure, you can override {@link #doGetAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)} or<a name="line.132"></a>
<FONT color="green">133</FONT> * just {@link #getPasswordForUser(java.sql.Connection,String)}<a name="line.133"></a>
<FONT color="green">134</FONT> *<a name="line.134"></a>
<FONT color="green">135</FONT> * @param authenticationQuery the query to use for authentication.<a name="line.135"></a>
<FONT color="green">136</FONT> * @see #DEFAULT_AUTHENTICATION_QUERY<a name="line.136"></a>
<FONT color="green">137</FONT> */<a name="line.137"></a>
<FONT color="green">138</FONT> public void setAuthenticationQuery(String authenticationQuery) {<a name="line.138"></a>
<FONT color="green">139</FONT> this.authenticationQuery = authenticationQuery;<a name="line.139"></a>
<FONT color="green">140</FONT> }<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> * Overrides the default query used to retrieve a user's roles during authorization. When using the default<a name="line.143"></a>
<FONT color="green">144</FONT> * implementation, this query must take the user's username as a single parameter and return a row<a name="line.144"></a>
<FONT color="green">145</FONT> * per role with a single column containing the role name. If you require a solution that does not match this query<a name="line.145"></a>
<FONT color="green">146</FONT> * structure, you can override {@link #doGetAuthorizationInfo(PrincipalCollection)} or just<a name="line.146"></a>
<FONT color="green">147</FONT> * {@link #getRoleNamesForUser(java.sql.Connection,String)}<a name="line.147"></a>
<FONT color="green">148</FONT> *<a name="line.148"></a>
<FONT color="green">149</FONT> * @param userRolesQuery the query to use for retrieving a user's roles.<a name="line.149"></a>
<FONT color="green">150</FONT> * @see #DEFAULT_USER_ROLES_QUERY<a name="line.150"></a>
<FONT color="green">151</FONT> */<a name="line.151"></a>
<FONT color="green">152</FONT> public void setUserRolesQuery(String userRolesQuery) {<a name="line.152"></a>
<FONT color="green">153</FONT> this.userRolesQuery = userRolesQuery;<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> /**<a name="line.156"></a>
<FONT color="green">157</FONT> * Overrides the default query used to retrieve a user's permissions during authorization. When using the default<a name="line.157"></a>
<FONT color="green">158</FONT> * implementation, this query must take a role name as the single parameter and return a row<a name="line.158"></a>
<FONT color="green">159</FONT> * per permission with three columns containing the fully qualified name of the permission class, the permission<a name="line.159"></a>
<FONT color="green">160</FONT> * name, and the permission actions (in that order). If you require a solution that does not match this query<a name="line.160"></a>
<FONT color="green">161</FONT> * structure, you can override {@link #doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)} or just<a name="line.161"></a>
<FONT color="green">162</FONT> * {@link #getPermissions(java.sql.Connection,String,java.util.Collection)}&lt;/p&gt;<a name="line.162"></a>
<FONT color="green">163</FONT> * &lt;p/&gt;<a name="line.163"></a>
<FONT color="green">164</FONT> * &lt;b&gt;Permissions are only retrieved if you set {@link #permissionsLookupEnabled} to true. Otherwise,<a name="line.164"></a>
<FONT color="green">165</FONT> * this query is ignored.&lt;/b&gt;<a name="line.165"></a>
<FONT color="green">166</FONT> *<a name="line.166"></a>
<FONT color="green">167</FONT> * @param permissionsQuery the query to use for retrieving permissions for a role.<a name="line.167"></a>
<FONT color="green">168</FONT> * @see #DEFAULT_PERMISSIONS_QUERY<a name="line.168"></a>
<FONT color="green">169</FONT> * @see #setPermissionsLookupEnabled(boolean)<a name="line.169"></a>
<FONT color="green">170</FONT> */<a name="line.170"></a>
<FONT color="green">171</FONT> public void setPermissionsQuery(String permissionsQuery) {<a name="line.171"></a>
<FONT color="green">172</FONT> this.permissionsQuery = permissionsQuery;<a name="line.172"></a>
<FONT color="green">173</FONT> }<a name="line.173"></a>
<FONT color="green">174</FONT> <a name="line.174"></a>
<FONT color="green">175</FONT> /**<a name="line.175"></a>
<FONT color="green">176</FONT> * Enables lookup of permissions during authorization. The default is "false" - meaning that only roles<a name="line.176"></a>
<FONT color="green">177</FONT> * are associated with a user. Set this to true in order to lookup roles &lt;b&gt;and&lt;/b&gt; permissions.<a name="line.177"></a>
<FONT color="green">178</FONT> *<a name="line.178"></a>
<FONT color="green">179</FONT> * @param permissionsLookupEnabled true if permissions should be looked up during authorization, or false if only<a name="line.179"></a>
<FONT color="green">180</FONT> * roles should be looked up.<a name="line.180"></a>
<FONT color="green">181</FONT> */<a name="line.181"></a>
<FONT color="green">182</FONT> public void setPermissionsLookupEnabled(boolean permissionsLookupEnabled) {<a name="line.182"></a>
<FONT color="green">183</FONT> this.permissionsLookupEnabled = permissionsLookupEnabled;<a name="line.183"></a>
<FONT color="green">184</FONT> }<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> * Sets the salt style. See {@link #saltStyle}.<a name="line.187"></a>
<FONT color="green">188</FONT> * <a name="line.188"></a>
<FONT color="green">189</FONT> * @param saltStyle new SaltStyle to set.<a name="line.189"></a>
<FONT color="green">190</FONT> */<a name="line.190"></a>
<FONT color="green">191</FONT> public void setSaltStyle(SaltStyle saltStyle) {<a name="line.191"></a>
<FONT color="green">192</FONT> this.saltStyle = saltStyle;<a name="line.192"></a>
<FONT color="green">193</FONT> if (saltStyle == SaltStyle.COLUMN &amp;&amp; authenticationQuery.equals(DEFAULT_AUTHENTICATION_QUERY)) {<a name="line.193"></a>
<FONT color="green">194</FONT> authenticationQuery = DEFAULT_SALTED_AUTHENTICATION_QUERY;<a name="line.194"></a>
<FONT color="green">195</FONT> }<a name="line.195"></a>
<FONT color="green">196</FONT> }<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> | M E T H O D S |<a name="line.199"></a>
<FONT color="green">200</FONT> ============================================*/<a name="line.200"></a>
<FONT color="green">201</FONT> <a name="line.201"></a>
<FONT color="green">202</FONT> protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {<a name="line.202"></a>
<FONT color="green">203</FONT> <a name="line.203"></a>
<FONT color="green">204</FONT> UsernamePasswordToken upToken = (UsernamePasswordToken) token;<a name="line.204"></a>
<FONT color="green">205</FONT> String username = upToken.getUsername();<a name="line.205"></a>
<FONT color="green">206</FONT> <a name="line.206"></a>
<FONT color="green">207</FONT> // Null username is invalid<a name="line.207"></a>
<FONT color="green">208</FONT> if (username == null) {<a name="line.208"></a>
<FONT color="green">209</FONT> throw new AccountException("Null usernames are not allowed by this realm.");<a name="line.209"></a>
<FONT color="green">210</FONT> }<a name="line.210"></a>
<FONT color="green">211</FONT> <a name="line.211"></a>
<FONT color="green">212</FONT> Connection conn = null;<a name="line.212"></a>
<FONT color="green">213</FONT> SimpleAuthenticationInfo info = null;<a name="line.213"></a>
<FONT color="green">214</FONT> try {<a name="line.214"></a>
<FONT color="green">215</FONT> conn = dataSource.getConnection();<a name="line.215"></a>
<FONT color="green">216</FONT> <a name="line.216"></a>
<FONT color="green">217</FONT> String password = null;<a name="line.217"></a>
<FONT color="green">218</FONT> String salt = null;<a name="line.218"></a>
<FONT color="green">219</FONT> switch (saltStyle) {<a name="line.219"></a>
<FONT color="green">220</FONT> case NO_SALT:<a name="line.220"></a>
<FONT color="green">221</FONT> password = getPasswordForUser(conn, username)[0];<a name="line.221"></a>
<FONT color="green">222</FONT> break;<a name="line.222"></a>
<FONT color="green">223</FONT> case CRYPT:<a name="line.223"></a>
<FONT color="green">224</FONT> // TODO: separate password and hash from getPasswordForUser[0]<a name="line.224"></a>
<FONT color="green">225</FONT> throw new ConfigurationException("Not implemented yet");<a name="line.225"></a>
<FONT color="green">226</FONT> //break;<a name="line.226"></a>
<FONT color="green">227</FONT> case COLUMN:<a name="line.227"></a>
<FONT color="green">228</FONT> String[] queryResults = getPasswordForUser(conn, username);<a name="line.228"></a>
<FONT color="green">229</FONT> password = queryResults[0];<a name="line.229"></a>
<FONT color="green">230</FONT> salt = queryResults[1];<a name="line.230"></a>
<FONT color="green">231</FONT> break;<a name="line.231"></a>
<FONT color="green">232</FONT> case EXTERNAL:<a name="line.232"></a>
<FONT color="green">233</FONT> password = getPasswordForUser(conn, username)[0];<a name="line.233"></a>
<FONT color="green">234</FONT> salt = getSaltForUser(username);<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> if (password == null) {<a name="line.237"></a>
<FONT color="green">238</FONT> throw new UnknownAccountException("No account found for user [" + username + "]");<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> info = new SimpleAuthenticationInfo(username, password.toCharArray(), getName());<a name="line.241"></a>
<FONT color="green">242</FONT> <a name="line.242"></a>
<FONT color="green">243</FONT> if (salt != null) {<a name="line.243"></a>
<FONT color="green">244</FONT> info.setCredentialsSalt(ByteSource.Util.bytes(salt));<a name="line.244"></a>
<FONT color="green">245</FONT> }<a name="line.245"></a>
<FONT color="green">246</FONT> <a name="line.246"></a>
<FONT color="green">247</FONT> } catch (SQLException e) {<a name="line.247"></a>
<FONT color="green">248</FONT> final String message = "There was a SQL error while authenticating user [" + username + "]";<a name="line.248"></a>
<FONT color="green">249</FONT> if (log.isErrorEnabled()) {<a name="line.249"></a>
<FONT color="green">250</FONT> log.error(message, e);<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> // Rethrow any SQL errors as an authentication exception<a name="line.253"></a>
<FONT color="green">254</FONT> throw new AuthenticationException(message, e);<a name="line.254"></a>
<FONT color="green">255</FONT> } finally {<a name="line.255"></a>
<FONT color="green">256</FONT> JdbcUtils.closeConnection(conn);<a name="line.256"></a>
<FONT color="green">257</FONT> }<a name="line.257"></a>
<FONT color="green">258</FONT> <a name="line.258"></a>
<FONT color="green">259</FONT> return info;<a name="line.259"></a>
<FONT color="green">260</FONT> }<a name="line.260"></a>
<FONT color="green">261</FONT> <a name="line.261"></a>
<FONT color="green">262</FONT> private String[] getPasswordForUser(Connection conn, String username) throws SQLException {<a name="line.262"></a>
<FONT color="green">263</FONT> <a name="line.263"></a>
<FONT color="green">264</FONT> String[] result;<a name="line.264"></a>
<FONT color="green">265</FONT> boolean returningSeparatedSalt = false;<a name="line.265"></a>
<FONT color="green">266</FONT> switch (saltStyle) {<a name="line.266"></a>
<FONT color="green">267</FONT> case NO_SALT:<a name="line.267"></a>
<FONT color="green">268</FONT> case CRYPT:<a name="line.268"></a>
<FONT color="green">269</FONT> case EXTERNAL:<a name="line.269"></a>
<FONT color="green">270</FONT> result = new String[1];<a name="line.270"></a>
<FONT color="green">271</FONT> break;<a name="line.271"></a>
<FONT color="green">272</FONT> default:<a name="line.272"></a>
<FONT color="green">273</FONT> result = new String[2];<a name="line.273"></a>
<FONT color="green">274</FONT> returningSeparatedSalt = true;<a name="line.274"></a>
<FONT color="green">275</FONT> }<a name="line.275"></a>
<FONT color="green">276</FONT> <a name="line.276"></a>
<FONT color="green">277</FONT> PreparedStatement ps = null;<a name="line.277"></a>
<FONT color="green">278</FONT> ResultSet rs = null;<a name="line.278"></a>
<FONT color="green">279</FONT> try {<a name="line.279"></a>
<FONT color="green">280</FONT> ps = conn.prepareStatement(authenticationQuery);<a name="line.280"></a>
<FONT color="green">281</FONT> ps.setString(1, username);<a name="line.281"></a>
<FONT color="green">282</FONT> <a name="line.282"></a>
<FONT color="green">283</FONT> // Execute query<a name="line.283"></a>
<FONT color="green">284</FONT> rs = ps.executeQuery();<a name="line.284"></a>
<FONT color="green">285</FONT> <a name="line.285"></a>
<FONT color="green">286</FONT> // Loop over results - although we are only expecting one result, since usernames should be unique<a name="line.286"></a>
<FONT color="green">287</FONT> boolean foundResult = false;<a name="line.287"></a>
<FONT color="green">288</FONT> while (rs.next()) {<a name="line.288"></a>
<FONT color="green">289</FONT> <a name="line.289"></a>
<FONT color="green">290</FONT> // Check to ensure only one row is processed<a name="line.290"></a>
<FONT color="green">291</FONT> if (foundResult) {<a name="line.291"></a>
<FONT color="green">292</FONT> throw new AuthenticationException("More than one user row found for user [" + username + "]. Usernames must be unique.");<a name="line.292"></a>
<FONT color="green">293</FONT> }<a name="line.293"></a>
<FONT color="green">294</FONT> <a name="line.294"></a>
<FONT color="green">295</FONT> result[0] = rs.getString(1);<a name="line.295"></a>
<FONT color="green">296</FONT> if (returningSeparatedSalt) {<a name="line.296"></a>
<FONT color="green">297</FONT> result[1] = rs.getString(2);<a name="line.297"></a>
<FONT color="green">298</FONT> }<a name="line.298"></a>
<FONT color="green">299</FONT> <a name="line.299"></a>
<FONT color="green">300</FONT> foundResult = true;<a name="line.300"></a>
<FONT color="green">301</FONT> }<a name="line.301"></a>
<FONT color="green">302</FONT> } finally {<a name="line.302"></a>
<FONT color="green">303</FONT> JdbcUtils.closeResultSet(rs);<a name="line.303"></a>
<FONT color="green">304</FONT> JdbcUtils.closeStatement(ps);<a name="line.304"></a>
<FONT color="green">305</FONT> }<a name="line.305"></a>
<FONT color="green">306</FONT> <a name="line.306"></a>
<FONT color="green">307</FONT> return result;<a name="line.307"></a>
<FONT color="green">308</FONT> }<a name="line.308"></a>
<FONT color="green">309</FONT> <a name="line.309"></a>
<FONT color="green">310</FONT> /**<a name="line.310"></a>
<FONT color="green">311</FONT> * This implementation of the interface expects the principals collection to return a String username keyed off of<a name="line.311"></a>
<FONT color="green">312</FONT> * this realm's {@link #getName() name}<a name="line.312"></a>
<FONT color="green">313</FONT> *<a name="line.313"></a>
<FONT color="green">314</FONT> * @see #getAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)<a name="line.314"></a>
<FONT color="green">315</FONT> */<a name="line.315"></a>
<FONT color="green">316</FONT> @Override<a name="line.316"></a>
<FONT color="green">317</FONT> protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {<a name="line.317"></a>
<FONT color="green">318</FONT> <a name="line.318"></a>
<FONT color="green">319</FONT> //null usernames are invalid<a name="line.319"></a>
<FONT color="green">320</FONT> if (principals == null) {<a name="line.320"></a>
<FONT color="green">321</FONT> throw new AuthorizationException("PrincipalCollection method argument cannot be null.");<a name="line.321"></a>
<FONT color="green">322</FONT> }<a name="line.322"></a>
<FONT color="green">323</FONT> <a name="line.323"></a>
<FONT color="green">324</FONT> String username = (String) getAvailablePrincipal(principals);<a name="line.324"></a>
<FONT color="green">325</FONT> <a name="line.325"></a>
<FONT color="green">326</FONT> Connection conn = null;<a name="line.326"></a>
<FONT color="green">327</FONT> Set&lt;String&gt; roleNames = null;<a name="line.327"></a>
<FONT color="green">328</FONT> Set&lt;String&gt; permissions = null;<a name="line.328"></a>
<FONT color="green">329</FONT> try {<a name="line.329"></a>
<FONT color="green">330</FONT> conn = dataSource.getConnection();<a name="line.330"></a>
<FONT color="green">331</FONT> <a name="line.331"></a>
<FONT color="green">332</FONT> // Retrieve roles and permissions from database<a name="line.332"></a>
<FONT color="green">333</FONT> roleNames = getRoleNamesForUser(conn, username);<a name="line.333"></a>
<FONT color="green">334</FONT> if (permissionsLookupEnabled) {<a name="line.334"></a>
<FONT color="green">335</FONT> permissions = getPermissions(conn, username, roleNames);<a name="line.335"></a>
<FONT color="green">336</FONT> }<a name="line.336"></a>
<FONT color="green">337</FONT> <a name="line.337"></a>
<FONT color="green">338</FONT> } catch (SQLException e) {<a name="line.338"></a>
<FONT color="green">339</FONT> final String message = "There was a SQL error while authorizing user [" + username + "]";<a name="line.339"></a>
<FONT color="green">340</FONT> if (log.isErrorEnabled()) {<a name="line.340"></a>
<FONT color="green">341</FONT> log.error(message, e);<a name="line.341"></a>
<FONT color="green">342</FONT> }<a name="line.342"></a>
<FONT color="green">343</FONT> <a name="line.343"></a>
<FONT color="green">344</FONT> // Rethrow any SQL errors as an authorization exception<a name="line.344"></a>
<FONT color="green">345</FONT> throw new AuthorizationException(message, e);<a name="line.345"></a>
<FONT color="green">346</FONT> } finally {<a name="line.346"></a>
<FONT color="green">347</FONT> JdbcUtils.closeConnection(conn);<a name="line.347"></a>
<FONT color="green">348</FONT> }<a name="line.348"></a>
<FONT color="green">349</FONT> <a name="line.349"></a>
<FONT color="green">350</FONT> SimpleAuthorizationInfo info = new SimpleAuthorizationInfo(roleNames);<a name="line.350"></a>
<FONT color="green">351</FONT> info.setStringPermissions(permissions);<a name="line.351"></a>
<FONT color="green">352</FONT> return info;<a name="line.352"></a>
<FONT color="green">353</FONT> <a name="line.353"></a>
<FONT color="green">354</FONT> }<a name="line.354"></a>
<FONT color="green">355</FONT> <a name="line.355"></a>
<FONT color="green">356</FONT> protected Set&lt;String&gt; getRoleNamesForUser(Connection conn, String username) throws SQLException {<a name="line.356"></a>
<FONT color="green">357</FONT> PreparedStatement ps = null;<a name="line.357"></a>
<FONT color="green">358</FONT> ResultSet rs = null;<a name="line.358"></a>
<FONT color="green">359</FONT> Set&lt;String&gt; roleNames = new LinkedHashSet&lt;String&gt;();<a name="line.359"></a>
<FONT color="green">360</FONT> try {<a name="line.360"></a>
<FONT color="green">361</FONT> ps = conn.prepareStatement(userRolesQuery);<a name="line.361"></a>
<FONT color="green">362</FONT> ps.setString(1, username);<a name="line.362"></a>
<FONT color="green">363</FONT> <a name="line.363"></a>
<FONT color="green">364</FONT> // Execute query<a name="line.364"></a>
<FONT color="green">365</FONT> rs = ps.executeQuery();<a name="line.365"></a>
<FONT color="green">366</FONT> <a name="line.366"></a>
<FONT color="green">367</FONT> // Loop over results and add each returned role to a set<a name="line.367"></a>
<FONT color="green">368</FONT> while (rs.next()) {<a name="line.368"></a>
<FONT color="green">369</FONT> <a name="line.369"></a>
<FONT color="green">370</FONT> String roleName = rs.getString(1);<a name="line.370"></a>
<FONT color="green">371</FONT> <a name="line.371"></a>
<FONT color="green">372</FONT> // Add the role to the list of names if it isn't null<a name="line.372"></a>
<FONT color="green">373</FONT> if (roleName != null) {<a name="line.373"></a>
<FONT color="green">374</FONT> roleNames.add(roleName);<a name="line.374"></a>
<FONT color="green">375</FONT> } else {<a name="line.375"></a>
<FONT color="green">376</FONT> if (log.isWarnEnabled()) {<a name="line.376"></a>
<FONT color="green">377</FONT> log.warn("Null role name found while retrieving role names for user [" + username + "]");<a name="line.377"></a>
<FONT color="green">378</FONT> }<a name="line.378"></a>
<FONT color="green">379</FONT> }<a name="line.379"></a>
<FONT color="green">380</FONT> }<a name="line.380"></a>
<FONT color="green">381</FONT> } finally {<a name="line.381"></a>
<FONT color="green">382</FONT> JdbcUtils.closeResultSet(rs);<a name="line.382"></a>
<FONT color="green">383</FONT> JdbcUtils.closeStatement(ps);<a name="line.383"></a>
<FONT color="green">384</FONT> }<a name="line.384"></a>
<FONT color="green">385</FONT> return roleNames;<a name="line.385"></a>
<FONT color="green">386</FONT> }<a name="line.386"></a>
<FONT color="green">387</FONT> <a name="line.387"></a>
<FONT color="green">388</FONT> protected Set&lt;String&gt; getPermissions(Connection conn, String username, Collection&lt;String&gt; roleNames) throws SQLException {<a name="line.388"></a>
<FONT color="green">389</FONT> PreparedStatement ps = null;<a name="line.389"></a>
<FONT color="green">390</FONT> Set&lt;String&gt; permissions = new LinkedHashSet&lt;String&gt;();<a name="line.390"></a>
<FONT color="green">391</FONT> try {<a name="line.391"></a>
<FONT color="green">392</FONT> ps = conn.prepareStatement(permissionsQuery);<a name="line.392"></a>
<FONT color="green">393</FONT> for (String roleName : roleNames) {<a name="line.393"></a>
<FONT color="green">394</FONT> <a name="line.394"></a>
<FONT color="green">395</FONT> ps.setString(1, roleName);<a name="line.395"></a>
<FONT color="green">396</FONT> <a name="line.396"></a>
<FONT color="green">397</FONT> ResultSet rs = null;<a name="line.397"></a>
<FONT color="green">398</FONT> <a name="line.398"></a>
<FONT color="green">399</FONT> try {<a name="line.399"></a>
<FONT color="green">400</FONT> // Execute query<a name="line.400"></a>
<FONT color="green">401</FONT> rs = ps.executeQuery();<a name="line.401"></a>
<FONT color="green">402</FONT> <a name="line.402"></a>
<FONT color="green">403</FONT> // Loop over results and add each returned role to a set<a name="line.403"></a>
<FONT color="green">404</FONT> while (rs.next()) {<a name="line.404"></a>
<FONT color="green">405</FONT> <a name="line.405"></a>
<FONT color="green">406</FONT> String permissionString = rs.getString(1);<a name="line.406"></a>
<FONT color="green">407</FONT> <a name="line.407"></a>
<FONT color="green">408</FONT> // Add the permission to the set of permissions<a name="line.408"></a>
<FONT color="green">409</FONT> permissions.add(permissionString);<a name="line.409"></a>
<FONT color="green">410</FONT> }<a name="line.410"></a>
<FONT color="green">411</FONT> } finally {<a name="line.411"></a>
<FONT color="green">412</FONT> JdbcUtils.closeResultSet(rs);<a name="line.412"></a>
<FONT color="green">413</FONT> }<a name="line.413"></a>
<FONT color="green">414</FONT> <a name="line.414"></a>
<FONT color="green">415</FONT> }<a name="line.415"></a>
<FONT color="green">416</FONT> } finally {<a name="line.416"></a>
<FONT color="green">417</FONT> JdbcUtils.closeStatement(ps);<a name="line.417"></a>
<FONT color="green">418</FONT> }<a name="line.418"></a>
<FONT color="green">419</FONT> <a name="line.419"></a>
<FONT color="green">420</FONT> return permissions;<a name="line.420"></a>
<FONT color="green">421</FONT> }<a name="line.421"></a>
<FONT color="green">422</FONT> <a name="line.422"></a>
<FONT color="green">423</FONT> protected String getSaltForUser(String username) {<a name="line.423"></a>
<FONT color="green">424</FONT> return username;<a name="line.424"></a>
<FONT color="green">425</FONT> }<a name="line.425"></a>
<FONT color="green">426</FONT> <a name="line.426"></a>
<FONT color="green">427</FONT> }<a name="line.427"></a>
</PRE>
</BODY>
</HTML>