| <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 java.util.Hashtable;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import java.util.Map;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import javax.naming.AuthenticationException;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import javax.naming.Context;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import javax.naming.NamingException;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import javax.naming.ldap.InitialLdapContext;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import javax.naming.ldap.LdapContext;<a name="line.27"></a> |
| <FONT color="green">028</FONT> <a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.shiro.util.StringUtils;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.slf4j.Logger;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import org.slf4j.LoggerFactory;<a name="line.31"></a> |
| <FONT color="green">032</FONT> <a name="line.32"></a> |
| <FONT color="green">033</FONT> /**<a name="line.33"></a> |
| <FONT color="green">034</FONT> * <p>Default implementation of {@link LdapContextFactory} that can be configured or extended to<a name="line.34"></a> |
| <FONT color="green">035</FONT> * customize the way {@link javax.naming.ldap.LdapContext} objects are retrieved.</p><a name="line.35"></a> |
| <FONT color="green">036</FONT> * <p/><a name="line.36"></a> |
| <FONT color="green">037</FONT> * <p>This implementation of {@link LdapContextFactory} is used by the {@link AbstractLdapRealm} if a<a name="line.37"></a> |
| <FONT color="green">038</FONT> * factory is not explictly configured.</p><a name="line.38"></a> |
| <FONT color="green">039</FONT> * <p/><a name="line.39"></a> |
| <FONT color="green">040</FONT> * <p>Connection pooling is enabled by default on this factory, but can be disabled using the<a name="line.40"></a> |
| <FONT color="green">041</FONT> * {@link #usePooling} property.</p><a name="line.41"></a> |
| <FONT color="green">042</FONT> *<a name="line.42"></a> |
| <FONT color="green">043</FONT> * @since 0.2<a name="line.43"></a> |
| <FONT color="green">044</FONT> * @deprecated replaced by the {@link JndiLdapContextFactory} implementation. This implementation will be removed<a name="line.44"></a> |
| <FONT color="green">045</FONT> * prior to Shiro 2.0<a name="line.45"></a> |
| <FONT color="green">046</FONT> */<a name="line.46"></a> |
| <FONT color="green">047</FONT> @Deprecated<a name="line.47"></a> |
| <FONT color="green">048</FONT> public class DefaultLdapContextFactory implements LdapContextFactory {<a name="line.48"></a> |
| <FONT color="green">049</FONT> <a name="line.49"></a> |
| <FONT color="green">050</FONT> //TODO - complete JavaDoc<a name="line.50"></a> |
| <FONT color="green">051</FONT> <a name="line.51"></a> |
| <FONT color="green">052</FONT> /*--------------------------------------------<a name="line.52"></a> |
| <FONT color="green">053</FONT> | C O N S T A N T S |<a name="line.53"></a> |
| <FONT color="green">054</FONT> ============================================*/<a name="line.54"></a> |
| <FONT color="green">055</FONT> /**<a name="line.55"></a> |
| <FONT color="green">056</FONT> * The Sun LDAP property used to enable connection pooling. This is used in the default implementation<a name="line.56"></a> |
| <FONT color="green">057</FONT> * to enable LDAP connection pooling.<a name="line.57"></a> |
| <FONT color="green">058</FONT> */<a name="line.58"></a> |
| <FONT color="green">059</FONT> protected static final String SUN_CONNECTION_POOLING_PROPERTY = "com.sun.jndi.ldap.connect.pool";<a name="line.59"></a> |
| <FONT color="green">060</FONT> private static final String SIMPLE_AUTHENTICATION_MECHANISM_NAME = "simple";<a name="line.60"></a> |
| <FONT color="green">061</FONT> <a name="line.61"></a> |
| <FONT color="green">062</FONT> /*--------------------------------------------<a name="line.62"></a> |
| <FONT color="green">063</FONT> | I N S T A N C E V A R I A B L E S |<a name="line.63"></a> |
| <FONT color="green">064</FONT> ============================================*/<a name="line.64"></a> |
| <FONT color="green">065</FONT> <a name="line.65"></a> |
| <FONT color="green">066</FONT> private static final Logger log = LoggerFactory.getLogger(DefaultLdapContextFactory.class);<a name="line.66"></a> |
| <FONT color="green">067</FONT> <a name="line.67"></a> |
| <FONT color="green">068</FONT> protected String authentication = SIMPLE_AUTHENTICATION_MECHANISM_NAME;<a name="line.68"></a> |
| <FONT color="green">069</FONT> <a name="line.69"></a> |
| <FONT color="green">070</FONT> protected String principalSuffix = null;<a name="line.70"></a> |
| <FONT color="green">071</FONT> <a name="line.71"></a> |
| <FONT color="green">072</FONT> protected String searchBase = null;<a name="line.72"></a> |
| <FONT color="green">073</FONT> <a name="line.73"></a> |
| <FONT color="green">074</FONT> protected String contextFactoryClassName = "com.sun.jndi.ldap.LdapCtxFactory";<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> protected String url = null;<a name="line.76"></a> |
| <FONT color="green">077</FONT> <a name="line.77"></a> |
| <FONT color="green">078</FONT> protected String referral = "follow";<a name="line.78"></a> |
| <FONT color="green">079</FONT> <a name="line.79"></a> |
| <FONT color="green">080</FONT> protected String systemUsername = null;<a name="line.80"></a> |
| <FONT color="green">081</FONT> <a name="line.81"></a> |
| <FONT color="green">082</FONT> protected String systemPassword = null;<a name="line.82"></a> |
| <FONT color="green">083</FONT> <a name="line.83"></a> |
| <FONT color="green">084</FONT> private boolean usePooling = true;<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> private Map<String, String> additionalEnvironment;<a name="line.86"></a> |
| <FONT color="green">087</FONT> <a name="line.87"></a> |
| <FONT color="green">088</FONT> /*--------------------------------------------<a name="line.88"></a> |
| <FONT color="green">089</FONT> | C O N S T R U C T O R S |<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> /*--------------------------------------------<a name="line.92"></a> |
| <FONT color="green">093</FONT> | A C C E S S O R S / M O D I F I E R S |<a name="line.93"></a> |
| <FONT color="green">094</FONT> ============================================*/<a name="line.94"></a> |
| <FONT color="green">095</FONT> <a name="line.95"></a> |
| <FONT color="green">096</FONT> /**<a name="line.96"></a> |
| <FONT color="green">097</FONT> * Sets the type of LDAP authentication to perform when connecting to the LDAP server. Defaults to "simple"<a name="line.97"></a> |
| <FONT color="green">098</FONT> *<a name="line.98"></a> |
| <FONT color="green">099</FONT> * @param authentication the type of LDAP authentication to perform.<a name="line.99"></a> |
| <FONT color="green">100</FONT> */<a name="line.100"></a> |
| <FONT color="green">101</FONT> public void setAuthentication(String authentication) {<a name="line.101"></a> |
| <FONT color="green">102</FONT> this.authentication = authentication;<a name="line.102"></a> |
| <FONT color="green">103</FONT> }<a name="line.103"></a> |
| <FONT color="green">104</FONT> <a name="line.104"></a> |
| <FONT color="green">105</FONT> /**<a name="line.105"></a> |
| <FONT color="green">106</FONT> * A suffix appended to the username. This is typically for<a name="line.106"></a> |
| <FONT color="green">107</FONT> * domain names. (e.g. "@MyDomain.local")<a name="line.107"></a> |
| <FONT color="green">108</FONT> *<a name="line.108"></a> |
| <FONT color="green">109</FONT> * @param principalSuffix the suffix.<a name="line.109"></a> |
| <FONT color="green">110</FONT> */<a name="line.110"></a> |
| <FONT color="green">111</FONT> public void setPrincipalSuffix(String principalSuffix) {<a name="line.111"></a> |
| <FONT color="green">112</FONT> this.principalSuffix = principalSuffix;<a name="line.112"></a> |
| <FONT color="green">113</FONT> }<a name="line.113"></a> |
| <FONT color="green">114</FONT> <a name="line.114"></a> |
| <FONT color="green">115</FONT> /**<a name="line.115"></a> |
| <FONT color="green">116</FONT> * The search base for the search to perform in the LDAP server.<a name="line.116"></a> |
| <FONT color="green">117</FONT> * (e.g. OU=OrganizationName,DC=MyDomain,DC=local )<a name="line.117"></a> |
| <FONT color="green">118</FONT> *<a name="line.118"></a> |
| <FONT color="green">119</FONT> * @param searchBase the search base.<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @deprecated this attribute existed, but was never used in Shiro 1.x. It will be removed prior to Shiro 2.0.<a name="line.120"></a> |
| <FONT color="green">121</FONT> */<a name="line.121"></a> |
| <FONT color="green">122</FONT> @Deprecated<a name="line.122"></a> |
| <FONT color="green">123</FONT> public void setSearchBase(String searchBase) {<a name="line.123"></a> |
| <FONT color="green">124</FONT> this.searchBase = searchBase;<a name="line.124"></a> |
| <FONT color="green">125</FONT> }<a name="line.125"></a> |
| <FONT color="green">126</FONT> <a name="line.126"></a> |
| <FONT color="green">127</FONT> /**<a name="line.127"></a> |
| <FONT color="green">128</FONT> * The context factory to use. This defaults to the SUN LDAP JNDI implementation<a name="line.128"></a> |
| <FONT color="green">129</FONT> * but can be overridden to use custom LDAP factories.<a name="line.129"></a> |
| <FONT color="green">130</FONT> *<a name="line.130"></a> |
| <FONT color="green">131</FONT> * @param contextFactoryClassName the context factory that should be used.<a name="line.131"></a> |
| <FONT color="green">132</FONT> */<a name="line.132"></a> |
| <FONT color="green">133</FONT> public void setContextFactoryClassName(String contextFactoryClassName) {<a name="line.133"></a> |
| <FONT color="green">134</FONT> this.contextFactoryClassName = contextFactoryClassName;<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> /**<a name="line.137"></a> |
| <FONT color="green">138</FONT> * The LDAP url to connect to. (e.g. ldap://<ldapDirectoryHostname>:<port>)<a name="line.138"></a> |
| <FONT color="green">139</FONT> *<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @param url the LDAP url.<a name="line.140"></a> |
| <FONT color="green">141</FONT> */<a name="line.141"></a> |
| <FONT color="green">142</FONT> public void setUrl(String url) {<a name="line.142"></a> |
| <FONT color="green">143</FONT> this.url = url;<a name="line.143"></a> |
| <FONT color="green">144</FONT> }<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> * Sets the LDAP referral property. Defaults to "follow"<a name="line.147"></a> |
| <FONT color="green">148</FONT> *<a name="line.148"></a> |
| <FONT color="green">149</FONT> * @param referral the referral property.<a name="line.149"></a> |
| <FONT color="green">150</FONT> */<a name="line.150"></a> |
| <FONT color="green">151</FONT> public void setReferral(String referral) {<a name="line.151"></a> |
| <FONT color="green">152</FONT> this.referral = referral;<a name="line.152"></a> |
| <FONT color="green">153</FONT> }<a name="line.153"></a> |
| <FONT color="green">154</FONT> <a name="line.154"></a> |
| <FONT color="green">155</FONT> /**<a name="line.155"></a> |
| <FONT color="green">156</FONT> * The system username that will be used when connecting to the LDAP server to retrieve authorization<a name="line.156"></a> |
| <FONT color="green">157</FONT> * information about a user. This must be specified for LDAP authorization to work, but is not required for<a name="line.157"></a> |
| <FONT color="green">158</FONT> * only authentication.<a name="line.158"></a> |
| <FONT color="green">159</FONT> *<a name="line.159"></a> |
| <FONT color="green">160</FONT> * @param systemUsername the username to use when logging into the LDAP server for authorization.<a name="line.160"></a> |
| <FONT color="green">161</FONT> */<a name="line.161"></a> |
| <FONT color="green">162</FONT> public void setSystemUsername(String systemUsername) {<a name="line.162"></a> |
| <FONT color="green">163</FONT> this.systemUsername = systemUsername;<a name="line.163"></a> |
| <FONT color="green">164</FONT> }<a name="line.164"></a> |
| <FONT color="green">165</FONT> <a name="line.165"></a> |
| <FONT color="green">166</FONT> <a name="line.166"></a> |
| <FONT color="green">167</FONT> /**<a name="line.167"></a> |
| <FONT color="green">168</FONT> * The system password that will be used when connecting to the LDAP server to retrieve authorization<a name="line.168"></a> |
| <FONT color="green">169</FONT> * information about a user. This must be specified for LDAP authorization to work, but is not required for<a name="line.169"></a> |
| <FONT color="green">170</FONT> * only authentication.<a name="line.170"></a> |
| <FONT color="green">171</FONT> *<a name="line.171"></a> |
| <FONT color="green">172</FONT> * @param systemPassword the password to use when logging into the LDAP server for authorization.<a name="line.172"></a> |
| <FONT color="green">173</FONT> */<a name="line.173"></a> |
| <FONT color="green">174</FONT> public void setSystemPassword(String systemPassword) {<a name="line.174"></a> |
| <FONT color="green">175</FONT> this.systemPassword = systemPassword;<a name="line.175"></a> |
| <FONT color="green">176</FONT> }<a name="line.176"></a> |
| <FONT color="green">177</FONT> <a name="line.177"></a> |
| <FONT color="green">178</FONT> /**<a name="line.178"></a> |
| <FONT color="green">179</FONT> * Determines whether or not LdapContext pooling is enabled for connections made using the system<a name="line.179"></a> |
| <FONT color="green">180</FONT> * user account. In the default implementation, this simply<a name="line.180"></a> |
| <FONT color="green">181</FONT> * sets the <tt>com.sun.jndi.ldap.connect.pool</tt> property in the LDAP context environment. If you use an<a name="line.181"></a> |
| <FONT color="green">182</FONT> * LDAP Context Factory that is not Sun's default implementation, you will need to override the<a name="line.182"></a> |
| <FONT color="green">183</FONT> * default behavior to use this setting in whatever way your underlying LDAP ContextFactory<a name="line.183"></a> |
| <FONT color="green">184</FONT> * supports. By default, pooling is enabled.<a name="line.184"></a> |
| <FONT color="green">185</FONT> *<a name="line.185"></a> |
| <FONT color="green">186</FONT> * @param usePooling true to enable pooling, or false to disable it.<a name="line.186"></a> |
| <FONT color="green">187</FONT> */<a name="line.187"></a> |
| <FONT color="green">188</FONT> public void setUsePooling(boolean usePooling) {<a name="line.188"></a> |
| <FONT color="green">189</FONT> this.usePooling = usePooling;<a name="line.189"></a> |
| <FONT color="green">190</FONT> }<a name="line.190"></a> |
| <FONT color="green">191</FONT> <a name="line.191"></a> |
| <FONT color="green">192</FONT> /**<a name="line.192"></a> |
| <FONT color="green">193</FONT> * These entries are added to the environment map before initializing the LDAP context.<a name="line.193"></a> |
| <FONT color="green">194</FONT> *<a name="line.194"></a> |
| <FONT color="green">195</FONT> * @param additionalEnvironment additional environment entries to be configured on the LDAP context.<a name="line.195"></a> |
| <FONT color="green">196</FONT> */<a name="line.196"></a> |
| <FONT color="green">197</FONT> public void setAdditionalEnvironment(Map<String, String> additionalEnvironment) {<a name="line.197"></a> |
| <FONT color="green">198</FONT> this.additionalEnvironment = additionalEnvironment;<a name="line.198"></a> |
| <FONT color="green">199</FONT> }<a name="line.199"></a> |
| <FONT color="green">200</FONT> <a name="line.200"></a> |
| <FONT color="green">201</FONT> /*--------------------------------------------<a name="line.201"></a> |
| <FONT color="green">202</FONT> | M E T H O D S |<a name="line.202"></a> |
| <FONT color="green">203</FONT> ============================================*/<a name="line.203"></a> |
| <FONT color="green">204</FONT> public LdapContext getSystemLdapContext() throws NamingException {<a name="line.204"></a> |
| <FONT color="green">205</FONT> return getLdapContext(systemUsername, systemPassword);<a name="line.205"></a> |
| <FONT color="green">206</FONT> }<a name="line.206"></a> |
| <FONT color="green">207</FONT> <a name="line.207"></a> |
| <FONT color="green">208</FONT> /**<a name="line.208"></a> |
| <FONT color="green">209</FONT> * Deprecated - use {@link #getLdapContext(Object, Object)} instead. This will be removed before Apache Shiro 2.0.<a name="line.209"></a> |
| <FONT color="green">210</FONT> *<a name="line.210"></a> |
| <FONT color="green">211</FONT> * @param username the username to use when creating the connection.<a name="line.211"></a> |
| <FONT color="green">212</FONT> * @param password the password to use when creating the connection.<a name="line.212"></a> |
| <FONT color="green">213</FONT> * @return a {@code LdapContext} bound using the given username and password.<a name="line.213"></a> |
| <FONT color="green">214</FONT> * @throws javax.naming.NamingException if there is an error creating the context.<a name="line.214"></a> |
| <FONT color="green">215</FONT> * @deprecated the {@link #getLdapContext(Object, Object)} method should be used in all cases to ensure more than<a name="line.215"></a> |
| <FONT color="green">216</FONT> * String principals and credentials can be used. Shiro no longer calls this method - it will be<a name="line.216"></a> |
| <FONT color="green">217</FONT> * removed before the 2.0 release.<a name="line.217"></a> |
| <FONT color="green">218</FONT> */<a name="line.218"></a> |
| <FONT color="green">219</FONT> @Deprecated<a name="line.219"></a> |
| <FONT color="green">220</FONT> public LdapContext getLdapContext(String username, String password) throws NamingException {<a name="line.220"></a> |
| <FONT color="green">221</FONT> if (username != null && principalSuffix != null) {<a name="line.221"></a> |
| <FONT color="green">222</FONT> username += principalSuffix;<a name="line.222"></a> |
| <FONT color="green">223</FONT> }<a name="line.223"></a> |
| <FONT color="green">224</FONT> return getLdapContext((Object) username, password);<a name="line.224"></a> |
| <FONT color="green">225</FONT> }<a name="line.225"></a> |
| <FONT color="green">226</FONT> <a name="line.226"></a> |
| <FONT color="green">227</FONT> public LdapContext getLdapContext(Object principal, Object credentials) throws NamingException {<a name="line.227"></a> |
| <FONT color="green">228</FONT> if (url == null) {<a name="line.228"></a> |
| <FONT color="green">229</FONT> throw new IllegalStateException("An LDAP URL must be specified of the form ldap://<hostname>:<port>");<a name="line.229"></a> |
| <FONT color="green">230</FONT> }<a name="line.230"></a> |
| <FONT color="green">231</FONT> <a name="line.231"></a> |
| <FONT color="green">232</FONT> Hashtable<String, Object> env = new Hashtable<String, Object>();<a name="line.232"></a> |
| <FONT color="green">233</FONT> <a name="line.233"></a> |
| <FONT color="green">234</FONT> env.put(Context.SECURITY_AUTHENTICATION, authentication);<a name="line.234"></a> |
| <FONT color="green">235</FONT> if (principal != null) {<a name="line.235"></a> |
| <FONT color="green">236</FONT> env.put(Context.SECURITY_PRINCIPAL, principal);<a name="line.236"></a> |
| <FONT color="green">237</FONT> }<a name="line.237"></a> |
| <FONT color="green">238</FONT> if (credentials!= null) {<a name="line.238"></a> |
| <FONT color="green">239</FONT> env.put(Context.SECURITY_CREDENTIALS, credentials);<a name="line.239"></a> |
| <FONT color="green">240</FONT> }<a name="line.240"></a> |
| <FONT color="green">241</FONT> env.put(Context.INITIAL_CONTEXT_FACTORY, contextFactoryClassName);<a name="line.241"></a> |
| <FONT color="green">242</FONT> env.put(Context.PROVIDER_URL, url);<a name="line.242"></a> |
| <FONT color="green">243</FONT> env.put(Context.REFERRAL, referral);<a name="line.243"></a> |
| <FONT color="green">244</FONT> <a name="line.244"></a> |
| <FONT color="green">245</FONT> // Only pool connections for system contexts<a name="line.245"></a> |
| <FONT color="green">246</FONT> if (usePooling && principal != null && principal.equals(systemUsername)) {<a name="line.246"></a> |
| <FONT color="green">247</FONT> // Enable connection pooling<a name="line.247"></a> |
| <FONT color="green">248</FONT> env.put(SUN_CONNECTION_POOLING_PROPERTY, "true");<a name="line.248"></a> |
| <FONT color="green">249</FONT> }<a name="line.249"></a> |
| <FONT color="green">250</FONT> <a name="line.250"></a> |
| <FONT color="green">251</FONT> if (additionalEnvironment != null) {<a name="line.251"></a> |
| <FONT color="green">252</FONT> env.putAll(additionalEnvironment);<a name="line.252"></a> |
| <FONT color="green">253</FONT> }<a name="line.253"></a> |
| <FONT color="green">254</FONT> <a name="line.254"></a> |
| <FONT color="green">255</FONT> if (log.isDebugEnabled()) {<a name="line.255"></a> |
| <FONT color="green">256</FONT> log.debug("Initializing LDAP context using URL [" + url + "] and username [" + systemUsername + "] " +<a name="line.256"></a> |
| <FONT color="green">257</FONT> "with pooling [" + (usePooling ? "enabled" : "disabled") + "]");<a name="line.257"></a> |
| <FONT color="green">258</FONT> }<a name="line.258"></a> |
| <FONT color="green">259</FONT> <a name="line.259"></a> |
| <FONT color="green">260</FONT> // validate the config before creating the context<a name="line.260"></a> |
| <FONT color="green">261</FONT> validateAuthenticationInfo(env);<a name="line.261"></a> |
| <FONT color="green">262</FONT> <a name="line.262"></a> |
| <FONT color="green">263</FONT> return createLdapContext(env);<a name="line.263"></a> |
| <FONT color="green">264</FONT> }<a name="line.264"></a> |
| <FONT color="green">265</FONT> <a name="line.265"></a> |
| <FONT color="green">266</FONT> /**<a name="line.266"></a> |
| <FONT color="green">267</FONT> * Creates and returns a new {@link javax.naming.ldap.InitialLdapContext} instance. This method exists primarily<a name="line.267"></a> |
| <FONT color="green">268</FONT> * to support testing where a mock LdapContext can be returned instead of actually creating a connection, but<a name="line.268"></a> |
| <FONT color="green">269</FONT> * subclasses are free to provide a different implementation if necessary.<a name="line.269"></a> |
| <FONT color="green">270</FONT> *<a name="line.270"></a> |
| <FONT color="green">271</FONT> * @param env the JNDI environment settings used to create the LDAP connection<a name="line.271"></a> |
| <FONT color="green">272</FONT> * @return an LdapConnection<a name="line.272"></a> |
| <FONT color="green">273</FONT> * @throws NamingException if a problem occurs creating the connection<a name="line.273"></a> |
| <FONT color="green">274</FONT> */<a name="line.274"></a> |
| <FONT color="green">275</FONT> protected LdapContext createLdapContext(Hashtable env) throws NamingException {<a name="line.275"></a> |
| <FONT color="green">276</FONT> return new InitialLdapContext(env, null);<a name="line.276"></a> |
| <FONT color="green">277</FONT> }<a name="line.277"></a> |
| <FONT color="green">278</FONT> <a name="line.278"></a> |
| <FONT color="green">279</FONT> <a name="line.279"></a> |
| <FONT color="green">280</FONT> /**<a name="line.280"></a> |
| <FONT color="green">281</FONT> * Validates the configuration in the JNDI <code>environment</code> settings and throws an exception if a problem<a name="line.281"></a> |
| <FONT color="green">282</FONT> * exists.<a name="line.282"></a> |
| <FONT color="green">283</FONT> * <p/><a name="line.283"></a> |
| <FONT color="green">284</FONT> * This implementation will throw a {@link AuthenticationException} if the authentication mechanism is set to<a name="line.284"></a> |
| <FONT color="green">285</FONT> * 'simple', the principal is non-empty, and the credentials are empty (as per<a name="line.285"></a> |
| <FONT color="green">286</FONT> * <a href="http://tools.ietf.org/html/rfc4513#section-5.1.2">rfc4513 section-5.1.2</a>).<a name="line.286"></a> |
| <FONT color="green">287</FONT> *<a name="line.287"></a> |
| <FONT color="green">288</FONT> * @param environment the JNDI environment settings to be validated<a name="line.288"></a> |
| <FONT color="green">289</FONT> * @throws AuthenticationException if a configuration problem is detected<a name="line.289"></a> |
| <FONT color="green">290</FONT> */<a name="line.290"></a> |
| <FONT color="green">291</FONT> private void validateAuthenticationInfo(Hashtable<String, Object> environment)<a name="line.291"></a> |
| <FONT color="green">292</FONT> throws AuthenticationException<a name="line.292"></a> |
| <FONT color="green">293</FONT> {<a name="line.293"></a> |
| <FONT color="green">294</FONT> // validate when using Simple auth both principal and credentials are set<a name="line.294"></a> |
| <FONT color="green">295</FONT> if(SIMPLE_AUTHENTICATION_MECHANISM_NAME.equals(environment.get(Context.SECURITY_AUTHENTICATION))) {<a name="line.295"></a> |
| <FONT color="green">296</FONT> <a name="line.296"></a> |
| <FONT color="green">297</FONT> // only validate credentials if we have a non-empty principal<a name="line.297"></a> |
| <FONT color="green">298</FONT> if( environment.get(Context.SECURITY_PRINCIPAL) != null &&<a name="line.298"></a> |
| <FONT color="green">299</FONT> StringUtils.hasText( String.valueOf( environment.get(Context.SECURITY_PRINCIPAL) ))) {<a name="line.299"></a> |
| <FONT color="green">300</FONT> <a name="line.300"></a> |
| <FONT color="green">301</FONT> Object credentials = environment.get(Context.SECURITY_CREDENTIALS);<a name="line.301"></a> |
| <FONT color="green">302</FONT> <a name="line.302"></a> |
| <FONT color="green">303</FONT> // from the FAQ, we need to check for empty credentials:<a name="line.303"></a> |
| <FONT color="green">304</FONT> // http://docs.oracle.com/javase/tutorial/jndi/ldap/faq.html<a name="line.304"></a> |
| <FONT color="green">305</FONT> if( credentials == null ||<a name="line.305"></a> |
| <FONT color="green">306</FONT> (credentials instanceof byte[] && ((byte[])credentials).length <= 0) || // empty byte[]<a name="line.306"></a> |
| <FONT color="green">307</FONT> (credentials instanceof char[] && ((char[])credentials).length <= 0) || // empty char[]<a name="line.307"></a> |
| <FONT color="green">308</FONT> (String.class.isInstance(credentials) && !StringUtils.hasText(String.valueOf(credentials)))) {<a name="line.308"></a> |
| <FONT color="green">309</FONT> <a name="line.309"></a> |
| <FONT color="green">310</FONT> throw new javax.naming.AuthenticationException("LDAP Simple authentication requires both a "<a name="line.310"></a> |
| <FONT color="green">311</FONT> + "principal and credentials.");<a name="line.311"></a> |
| <FONT color="green">312</FONT> }<a name="line.312"></a> |
| <FONT color="green">313</FONT> }<a name="line.313"></a> |
| <FONT color="green">314</FONT> }<a name="line.314"></a> |
| <FONT color="green">315</FONT> }<a name="line.315"></a> |
| <FONT color="green">316</FONT> <a name="line.316"></a> |
| <FONT color="green">317</FONT> }<a name="line.317"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
