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