| <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.ldap;<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.AuthenticationException;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.authc.AuthenticationInfo;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.authc.AuthenticationToken;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.authz.AuthorizationException;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.authz.AuthorizationInfo;<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.slf4j.Logger;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.slf4j.LoggerFactory;<a name="line.29"></a> |
| <FONT color="green">030</FONT> <a name="line.30"></a> |
| <FONT color="green">031</FONT> import javax.naming.NamingException;<a name="line.31"></a> |
| <FONT color="green">032</FONT> <a name="line.32"></a> |
| <FONT color="green">033</FONT> /**<a name="line.33"></a> |
| <FONT color="green">034</FONT> * <p>A {@link org.apache.shiro.realm.Realm} that authenticates with an LDAP<a name="line.34"></a> |
| <FONT color="green">035</FONT> * server to build the Subject for a user. This implementation only returns roles for a<a name="line.35"></a> |
| <FONT color="green">036</FONT> * particular user, and not permissions - but it can be subclassed to build a permission<a name="line.36"></a> |
| <FONT color="green">037</FONT> * list as well.</p><a name="line.37"></a> |
| <FONT color="green">038</FONT> *<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <p>Implementations would need to implement the<a name="line.39"></a> |
| <FONT color="green">040</FONT> * {@link #queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken ,LdapContextFactory)} and<a name="line.40"></a> |
| <FONT color="green">041</FONT> * {@link #queryForAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection ,LdapContextFactory)} abstract methods.</p><a name="line.41"></a> |
| <FONT color="green">042</FONT> *<a name="line.42"></a> |
| <FONT color="green">043</FONT> * <p>By default, this implementation will create an instance of {@link DefaultLdapContextFactory} to use for<a name="line.43"></a> |
| <FONT color="green">044</FONT> * creating LDAP connections using the principalSuffix, searchBase, url, systemUsername, and systemPassword properties<a name="line.44"></a> |
| <FONT color="green">045</FONT> * specified on the realm. The remaining settings use the defaults of {@link DefaultLdapContextFactory}, which are usually<a name="line.45"></a> |
| <FONT color="green">046</FONT> * sufficient. If more customized connections are needed, you should inject a custom {@link LdapContextFactory}, which<a name="line.46"></a> |
| <FONT color="green">047</FONT> * will cause these properties specified on the realm to be ignored.</p><a name="line.47"></a> |
| <FONT color="green">048</FONT> *<a name="line.48"></a> |
| <FONT color="green">049</FONT> * @see #queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken , LdapContextFactory)<a name="line.49"></a> |
| <FONT color="green">050</FONT> * @see #queryForAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection , LdapContextFactory)<a name="line.50"></a> |
| <FONT color="green">051</FONT> * @since 0.1<a name="line.51"></a> |
| <FONT color="green">052</FONT> */<a name="line.52"></a> |
| <FONT color="green">053</FONT> public abstract class AbstractLdapRealm extends AuthorizingRealm {<a name="line.53"></a> |
| <FONT color="green">054</FONT> <a name="line.54"></a> |
| <FONT color="green">055</FONT> //TODO - complete JavaDoc<a name="line.55"></a> |
| <FONT color="green">056</FONT> <a name="line.56"></a> |
| <FONT color="green">057</FONT> /*--------------------------------------------<a name="line.57"></a> |
| <FONT color="green">058</FONT> | C O N S T A N T S |<a name="line.58"></a> |
| <FONT color="green">059</FONT> ============================================*/<a name="line.59"></a> |
| <FONT color="green">060</FONT> <a name="line.60"></a> |
| <FONT color="green">061</FONT> private static final Logger log = LoggerFactory.getLogger(AbstractLdapRealm.class);<a name="line.61"></a> |
| <FONT color="green">062</FONT> <a name="line.62"></a> |
| <FONT color="green">063</FONT> /*--------------------------------------------<a name="line.63"></a> |
| <FONT color="green">064</FONT> | I N S T A N C E V A R I A B L E S |<a name="line.64"></a> |
| <FONT color="green">065</FONT> ============================================*/<a name="line.65"></a> |
| <FONT color="green">066</FONT> protected String principalSuffix = null;<a name="line.66"></a> |
| <FONT color="green">067</FONT> <a name="line.67"></a> |
| <FONT color="green">068</FONT> protected String searchBase = null;<a name="line.68"></a> |
| <FONT color="green">069</FONT> <a name="line.69"></a> |
| <FONT color="green">070</FONT> protected String url = null;<a name="line.70"></a> |
| <FONT color="green">071</FONT> <a name="line.71"></a> |
| <FONT color="green">072</FONT> protected String systemUsername = null;<a name="line.72"></a> |
| <FONT color="green">073</FONT> <a name="line.73"></a> |
| <FONT color="green">074</FONT> protected String systemPassword = null;<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> private LdapContextFactory ldapContextFactory = null;<a name="line.76"></a> |
| <FONT color="green">077</FONT> <a name="line.77"></a> |
| <FONT color="green">078</FONT> /*--------------------------------------------<a name="line.78"></a> |
| <FONT color="green">079</FONT> | C O N S T R U C T O R S |<a name="line.79"></a> |
| <FONT color="green">080</FONT> ============================================*/<a name="line.80"></a> |
| <FONT color="green">081</FONT> <a name="line.81"></a> |
| <FONT color="green">082</FONT> /*--------------------------------------------<a name="line.82"></a> |
| <FONT color="green">083</FONT> | A C C E S S O R S / M O D I F I E R S |<a name="line.83"></a> |
| <FONT color="green">084</FONT> ============================================*/<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> | M E T H O D S |<a name="line.87"></a> |
| <FONT color="green">088</FONT> ============================================*/<a name="line.88"></a> |
| <FONT color="green">089</FONT> <a name="line.89"></a> |
| <FONT color="green">090</FONT> <a name="line.90"></a> |
| <FONT color="green">091</FONT> /**<a name="line.91"></a> |
| <FONT color="green">092</FONT> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom<a name="line.92"></a> |
| <FONT color="green">093</FONT> * <tt>LdapContextFactory</tt> is specified.<a name="line.93"></a> |
| <FONT color="green">094</FONT> *<a name="line.94"></a> |
| <FONT color="green">095</FONT> * @param principalSuffix the suffix.<a name="line.95"></a> |
| <FONT color="green">096</FONT> * @see DefaultLdapContextFactory#setPrincipalSuffix(String)<a name="line.96"></a> |
| <FONT color="green">097</FONT> */<a name="line.97"></a> |
| <FONT color="green">098</FONT> public void setPrincipalSuffix(String principalSuffix) {<a name="line.98"></a> |
| <FONT color="green">099</FONT> this.principalSuffix = principalSuffix;<a name="line.99"></a> |
| <FONT color="green">100</FONT> }<a name="line.100"></a> |
| <FONT color="green">101</FONT> <a name="line.101"></a> |
| <FONT color="green">102</FONT> /**<a name="line.102"></a> |
| <FONT color="green">103</FONT> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom<a name="line.103"></a> |
| <FONT color="green">104</FONT> * <tt>LdapContextFactory</tt> is specified.<a name="line.104"></a> |
| <FONT color="green">105</FONT> *<a name="line.105"></a> |
| <FONT color="green">106</FONT> * @param searchBase the search base.<a name="line.106"></a> |
| <FONT color="green">107</FONT> * @see DefaultLdapContextFactory#setSearchBase(String)<a name="line.107"></a> |
| <FONT color="green">108</FONT> */<a name="line.108"></a> |
| <FONT color="green">109</FONT> public void setSearchBase(String searchBase) {<a name="line.109"></a> |
| <FONT color="green">110</FONT> this.searchBase = searchBase;<a name="line.110"></a> |
| <FONT color="green">111</FONT> }<a name="line.111"></a> |
| <FONT color="green">112</FONT> <a name="line.112"></a> |
| <FONT color="green">113</FONT> /**<a name="line.113"></a> |
| <FONT color="green">114</FONT> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom<a name="line.114"></a> |
| <FONT color="green">115</FONT> * <tt>LdapContextFactory</tt> is specified.<a name="line.115"></a> |
| <FONT color="green">116</FONT> *<a name="line.116"></a> |
| <FONT color="green">117</FONT> * @param url the LDAP url.<a name="line.117"></a> |
| <FONT color="green">118</FONT> * @see DefaultLdapContextFactory#setUrl(String)<a name="line.118"></a> |
| <FONT color="green">119</FONT> */<a name="line.119"></a> |
| <FONT color="green">120</FONT> public void setUrl(String url) {<a name="line.120"></a> |
| <FONT color="green">121</FONT> this.url = url;<a name="line.121"></a> |
| <FONT color="green">122</FONT> }<a name="line.122"></a> |
| <FONT color="green">123</FONT> <a name="line.123"></a> |
| <FONT color="green">124</FONT> /**<a name="line.124"></a> |
| <FONT color="green">125</FONT> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom<a name="line.125"></a> |
| <FONT color="green">126</FONT> * <tt>LdapContextFactory</tt> is specified.<a name="line.126"></a> |
| <FONT color="green">127</FONT> *<a name="line.127"></a> |
| <FONT color="green">128</FONT> * @param systemUsername the username to use when logging into the LDAP server for authorization.<a name="line.128"></a> |
| <FONT color="green">129</FONT> * @see DefaultLdapContextFactory#setSystemUsername(String)<a name="line.129"></a> |
| <FONT color="green">130</FONT> */<a name="line.130"></a> |
| <FONT color="green">131</FONT> public void setSystemUsername(String systemUsername) {<a name="line.131"></a> |
| <FONT color="green">132</FONT> this.systemUsername = systemUsername;<a name="line.132"></a> |
| <FONT color="green">133</FONT> }<a name="line.133"></a> |
| <FONT color="green">134</FONT> <a name="line.134"></a> |
| <FONT color="green">135</FONT> <a name="line.135"></a> |
| <FONT color="green">136</FONT> /**<a name="line.136"></a> |
| <FONT color="green">137</FONT> * Used when initializing the default {@link LdapContextFactory}. This property is ignored if a custom<a name="line.137"></a> |
| <FONT color="green">138</FONT> * <tt>LdapContextFactory</tt> is specified.<a name="line.138"></a> |
| <FONT color="green">139</FONT> *<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @param systemPassword the password to use when logging into the LDAP server for authorization.<a name="line.140"></a> |
| <FONT color="green">141</FONT> * @see DefaultLdapContextFactory#setSystemPassword(String)<a name="line.141"></a> |
| <FONT color="green">142</FONT> */<a name="line.142"></a> |
| <FONT color="green">143</FONT> public void setSystemPassword(String systemPassword) {<a name="line.143"></a> |
| <FONT color="green">144</FONT> this.systemPassword = systemPassword;<a name="line.144"></a> |
| <FONT color="green">145</FONT> }<a name="line.145"></a> |
| <FONT color="green">146</FONT> <a name="line.146"></a> |
| <FONT color="green">147</FONT> <a name="line.147"></a> |
| <FONT color="green">148</FONT> /**<a name="line.148"></a> |
| <FONT color="green">149</FONT> * Configures the {@link LdapContextFactory} implementation that is used to create LDAP connections for<a name="line.149"></a> |
| <FONT color="green">150</FONT> * authentication and authorization. If this is set, the {@link LdapContextFactory} provided will be used.<a name="line.150"></a> |
| <FONT color="green">151</FONT> * Otherwise, a {@link DefaultLdapContextFactory} instance will be created based on the properties specified<a name="line.151"></a> |
| <FONT color="green">152</FONT> * in this realm.<a name="line.152"></a> |
| <FONT color="green">153</FONT> *<a name="line.153"></a> |
| <FONT color="green">154</FONT> * @param ldapContextFactory the factory to use - if not specified, a default factory will be created automatically.<a name="line.154"></a> |
| <FONT color="green">155</FONT> */<a name="line.155"></a> |
| <FONT color="green">156</FONT> public void setLdapContextFactory(LdapContextFactory ldapContextFactory) {<a name="line.156"></a> |
| <FONT color="green">157</FONT> this.ldapContextFactory = ldapContextFactory;<a name="line.157"></a> |
| <FONT color="green">158</FONT> }<a name="line.158"></a> |
| <FONT color="green">159</FONT> <a name="line.159"></a> |
| <FONT color="green">160</FONT> /*--------------------------------------------<a name="line.160"></a> |
| <FONT color="green">161</FONT> | M E T H O D S |<a name="line.161"></a> |
| <FONT color="green">162</FONT> ============================================*/<a name="line.162"></a> |
| <FONT color="green">163</FONT> <a name="line.163"></a> |
| <FONT color="green">164</FONT> protected void onInit() {<a name="line.164"></a> |
| <FONT color="green">165</FONT> super.onInit();<a name="line.165"></a> |
| <FONT color="green">166</FONT> ensureContextFactory();<a name="line.166"></a> |
| <FONT color="green">167</FONT> }<a name="line.167"></a> |
| <FONT color="green">168</FONT> <a name="line.168"></a> |
| <FONT color="green">169</FONT> private LdapContextFactory ensureContextFactory() {<a name="line.169"></a> |
| <FONT color="green">170</FONT> if (this.ldapContextFactory == null) {<a name="line.170"></a> |
| <FONT color="green">171</FONT> <a name="line.171"></a> |
| <FONT color="green">172</FONT> if (log.isDebugEnabled()) {<a name="line.172"></a> |
| <FONT color="green">173</FONT> log.debug("No LdapContextFactory specified - creating a default instance.");<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> DefaultLdapContextFactory defaultFactory = new DefaultLdapContextFactory();<a name="line.176"></a> |
| <FONT color="green">177</FONT> defaultFactory.setPrincipalSuffix(this.principalSuffix);<a name="line.177"></a> |
| <FONT color="green">178</FONT> defaultFactory.setSearchBase(this.searchBase);<a name="line.178"></a> |
| <FONT color="green">179</FONT> defaultFactory.setUrl(this.url);<a name="line.179"></a> |
| <FONT color="green">180</FONT> defaultFactory.setSystemUsername(this.systemUsername);<a name="line.180"></a> |
| <FONT color="green">181</FONT> defaultFactory.setSystemPassword(this.systemPassword);<a name="line.181"></a> |
| <FONT color="green">182</FONT> <a name="line.182"></a> |
| <FONT color="green">183</FONT> this.ldapContextFactory = defaultFactory;<a name="line.183"></a> |
| <FONT color="green">184</FONT> }<a name="line.184"></a> |
| <FONT color="green">185</FONT> return this.ldapContextFactory;<a name="line.185"></a> |
| <FONT color="green">186</FONT> }<a name="line.186"></a> |
| <FONT color="green">187</FONT> <a name="line.187"></a> |
| <FONT color="green">188</FONT> <a name="line.188"></a> |
| <FONT color="green">189</FONT> protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {<a name="line.189"></a> |
| <FONT color="green">190</FONT> AuthenticationInfo info;<a name="line.190"></a> |
| <FONT color="green">191</FONT> try {<a name="line.191"></a> |
| <FONT color="green">192</FONT> info = queryForAuthenticationInfo(token, ensureContextFactory());<a name="line.192"></a> |
| <FONT color="green">193</FONT> } catch (javax.naming.AuthenticationException e) {<a name="line.193"></a> |
| <FONT color="green">194</FONT> throw new AuthenticationException("LDAP authentication failed.", e);<a name="line.194"></a> |
| <FONT color="green">195</FONT> } catch (NamingException e) {<a name="line.195"></a> |
| <FONT color="green">196</FONT> String msg = "LDAP naming error while attempting to authenticate user.";<a name="line.196"></a> |
| <FONT color="green">197</FONT> throw new AuthenticationException(msg, e);<a name="line.197"></a> |
| <FONT color="green">198</FONT> }<a name="line.198"></a> |
| <FONT color="green">199</FONT> <a name="line.199"></a> |
| <FONT color="green">200</FONT> return info;<a name="line.200"></a> |
| <FONT color="green">201</FONT> }<a name="line.201"></a> |
| <FONT color="green">202</FONT> <a name="line.202"></a> |
| <FONT color="green">203</FONT> <a name="line.203"></a> |
| <FONT color="green">204</FONT> protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {<a name="line.204"></a> |
| <FONT color="green">205</FONT> AuthorizationInfo info;<a name="line.205"></a> |
| <FONT color="green">206</FONT> try {<a name="line.206"></a> |
| <FONT color="green">207</FONT> info = queryForAuthorizationInfo(principals, ensureContextFactory());<a name="line.207"></a> |
| <FONT color="green">208</FONT> } catch (NamingException e) {<a name="line.208"></a> |
| <FONT color="green">209</FONT> String msg = "LDAP naming error while attempting to retrieve authorization for user [" + principals + "].";<a name="line.209"></a> |
| <FONT color="green">210</FONT> throw new AuthorizationException(msg, e);<a name="line.210"></a> |
| <FONT color="green">211</FONT> }<a name="line.211"></a> |
| <FONT color="green">212</FONT> <a name="line.212"></a> |
| <FONT color="green">213</FONT> return info;<a name="line.213"></a> |
| <FONT color="green">214</FONT> }<a name="line.214"></a> |
| <FONT color="green">215</FONT> <a name="line.215"></a> |
| <FONT color="green">216</FONT> <a name="line.216"></a> |
| <FONT color="green">217</FONT> /**<a name="line.217"></a> |
| <FONT color="green">218</FONT> * <p>Abstract method that should be implemented by subclasses to builds an<a name="line.218"></a> |
| <FONT color="green">219</FONT> * {@link AuthenticationInfo} object by querying the LDAP context for the<a name="line.219"></a> |
| <FONT color="green">220</FONT> * specified username.</p><a name="line.220"></a> |
| <FONT color="green">221</FONT> *<a name="line.221"></a> |
| <FONT color="green">222</FONT> * @param token the authentication token given during authentication.<a name="line.222"></a> |
| <FONT color="green">223</FONT> * @param ldapContextFactory factory used to retrieve LDAP connections.<a name="line.223"></a> |
| <FONT color="green">224</FONT> * @return an {@link AuthenticationInfo} instance containing information retrieved from the LDAP server.<a name="line.224"></a> |
| <FONT color="green">225</FONT> * @throws NamingException if any LDAP errors occur during the search.<a name="line.225"></a> |
| <FONT color="green">226</FONT> */<a name="line.226"></a> |
| <FONT color="green">227</FONT> protected abstract AuthenticationInfo queryForAuthenticationInfo(AuthenticationToken token, LdapContextFactory ldapContextFactory) throws NamingException;<a name="line.227"></a> |
| <FONT color="green">228</FONT> <a name="line.228"></a> |
| <FONT color="green">229</FONT> <a name="line.229"></a> |
| <FONT color="green">230</FONT> /**<a name="line.230"></a> |
| <FONT color="green">231</FONT> * <p>Abstract method that should be implemented by subclasses to builds an<a name="line.231"></a> |
| <FONT color="green">232</FONT> * {@link AuthorizationInfo} object by querying the LDAP context for the<a name="line.232"></a> |
| <FONT color="green">233</FONT> * specified principal.</p><a name="line.233"></a> |
| <FONT color="green">234</FONT> *<a name="line.234"></a> |
| <FONT color="green">235</FONT> * @param principal the principal of the Subject whose AuthenticationInfo should be queried from the LDAP server.<a name="line.235"></a> |
| <FONT color="green">236</FONT> * @param ldapContextFactory factory used to retrieve LDAP connections.<a name="line.236"></a> |
| <FONT color="green">237</FONT> * @return an {@link AuthorizationInfo} instance containing information retrieved from the LDAP server.<a name="line.237"></a> |
| <FONT color="green">238</FONT> * @throws NamingException if any LDAP errors occur during the search.<a name="line.238"></a> |
| <FONT color="green">239</FONT> */<a name="line.239"></a> |
| <FONT color="green">240</FONT> protected abstract AuthorizationInfo queryForAuthorizationInfo(PrincipalCollection principal, LdapContextFactory ldapContextFactory) throws NamingException;<a name="line.240"></a> |
| <FONT color="green">241</FONT> <a name="line.241"></a> |
| <FONT color="green">242</FONT> }<a name="line.242"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
