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