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