| <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.util.StringUtils;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.slf4j.Logger;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.slf4j.LoggerFactory;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> import javax.naming.AuthenticationException;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import javax.naming.Context;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import javax.naming.NamingException;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import javax.naming.ldap.InitialLdapContext;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import javax.naming.ldap.LdapContext;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import java.util.HashMap;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import java.util.Hashtable;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import java.util.Map;<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> /**<a name="line.34"></a> |
| <FONT color="green">035</FONT> * {@link LdapContextFactory} implementation using the default Sun/Oracle JNDI Ldap API, utilizing JNDI<a name="line.35"></a> |
| <FONT color="green">036</FONT> * environment properties and an {@link javax.naming.InitialContext}.<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <h2>Configuration</h2><a name="line.37"></a> |
| <FONT color="green">038</FONT> * This class basically wraps a default template JNDI environment properties Map. This properties map is the base<a name="line.38"></a> |
| <FONT color="green">039</FONT> * configuration template used to acquire JNDI {@link LdapContext} connections at runtime. The<a name="line.39"></a> |
| <FONT color="green">040</FONT> * {@link #getLdapContext(Object, Object)} method implementation merges this default template with other properties<a name="line.40"></a> |
| <FONT color="green">041</FONT> * accessible at runtime only (for example per-method principals and credentials). The constructed runtime map is the<a name="line.41"></a> |
| <FONT color="green">042</FONT> * one used to acquire the {@link LdapContext}.<a name="line.42"></a> |
| <FONT color="green">043</FONT> * <p/><a name="line.43"></a> |
| <FONT color="green">044</FONT> * The template can be configured directly via the {@link #getEnvironment()}/{@link #setEnvironment(java.util.Map)}<a name="line.44"></a> |
| <FONT color="green">045</FONT> * properties directly if necessary, but it is usually more convenient to use the supporting wrapper get/set methods<a name="line.45"></a> |
| <FONT color="green">046</FONT> * for various environment properties. These wrapper methods interact with the environment<a name="line.46"></a> |
| <FONT color="green">047</FONT> * template on your behalf, leaving your configuration cleaner and easier to understand.<a name="line.47"></a> |
| <FONT color="green">048</FONT> * <p/><a name="line.48"></a> |
| <FONT color="green">049</FONT> * For example, consider the following two identical configurations:<a name="line.49"></a> |
| <FONT color="green">050</FONT> * <pre><a name="line.50"></a> |
| <FONT color="green">051</FONT> * [main]<a name="line.51"></a> |
| <FONT color="green">052</FONT> * ldapRealm = org.apache.shiro.realm.ldap.JndiLdapRealm<a name="line.52"></a> |
| <FONT color="green">053</FONT> * ldapRealm.contextFactory.url = ldap://localhost:389<a name="line.53"></a> |
| <FONT color="green">054</FONT> * ldapRealm.contextFactory.authenticationMechanism = DIGEST-MD5<a name="line.54"></a> |
| <FONT color="green">055</FONT> * </pre><a name="line.55"></a> |
| <FONT color="green">056</FONT> * and<a name="line.56"></a> |
| <FONT color="green">057</FONT> * <pre><a name="line.57"></a> |
| <FONT color="green">058</FONT> * [main]<a name="line.58"></a> |
| <FONT color="green">059</FONT> * ldapRealm = org.apache.shiro.realm.ldap.JndiLdapRealm<a name="line.59"></a> |
| <FONT color="green">060</FONT> * ldapRealm.contextFactory.environment[java.naming.provider.url] = ldap://localhost:389<a name="line.60"></a> |
| <FONT color="green">061</FONT> * ldapRealm.contextFactory.environment[java.naming.security.authentication] = DIGEST-MD5<a name="line.61"></a> |
| <FONT color="green">062</FONT> * </pre><a name="line.62"></a> |
| <FONT color="green">063</FONT> * As you can see, the 2nd configuration block is a little more difficult to read and also requires knowledge<a name="line.63"></a> |
| <FONT color="green">064</FONT> * of the underlying JNDI Context property keys. The first is easier to read and understand.<a name="line.64"></a> |
| <FONT color="green">065</FONT> * <p/><a name="line.65"></a> |
| <FONT color="green">066</FONT> * Note that occasionally it will be necessary to use the latter configuration style to set environment properties<a name="line.66"></a> |
| <FONT color="green">067</FONT> * where no corresponding wrapper method exists. In this case, the hybrid approach is still a little easier to read.<a name="line.67"></a> |
| <FONT color="green">068</FONT> * For example:<a name="line.68"></a> |
| <FONT color="green">069</FONT> * <pre><a name="line.69"></a> |
| <FONT color="green">070</FONT> * [main]<a name="line.70"></a> |
| <FONT color="green">071</FONT> * ldapRealm = org.apache.shiro.realm.ldap.JndiLdapRealm<a name="line.71"></a> |
| <FONT color="green">072</FONT> * ldapRealm.contextFactory.url = ldap://localhost:389<a name="line.72"></a> |
| <FONT color="green">073</FONT> * ldapRealm.contextFactory.authenticationMechanism = DIGEST-MD5<a name="line.73"></a> |
| <FONT color="green">074</FONT> * ldapRealm.contextFactory.environment[some.other.obscure.jndi.key] = some value<a name="line.74"></a> |
| <FONT color="green">075</FONT> * </pre><a name="line.75"></a> |
| <FONT color="green">076</FONT> *<a name="line.76"></a> |
| <FONT color="green">077</FONT> * @since 1.1<a name="line.77"></a> |
| <FONT color="green">078</FONT> */<a name="line.78"></a> |
| <FONT color="green">079</FONT> public class JndiLdapContextFactory implements LdapContextFactory {<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> | C O N S T A N T S |<a name="line.82"></a> |
| <FONT color="green">083</FONT> ===========================================*/<a name="line.83"></a> |
| <FONT color="green">084</FONT> /**<a name="line.84"></a> |
| <FONT color="green">085</FONT> * The Sun LDAP property used to enable connection pooling. This is used in the default implementation<a name="line.85"></a> |
| <FONT color="green">086</FONT> * to enable LDAP connection pooling.<a name="line.86"></a> |
| <FONT color="green">087</FONT> */<a name="line.87"></a> |
| <FONT color="green">088</FONT> protected static final String SUN_CONNECTION_POOLING_PROPERTY = "com.sun.jndi.ldap.connect.pool";<a name="line.88"></a> |
| <FONT color="green">089</FONT> protected static final String DEFAULT_CONTEXT_FACTORY_CLASS_NAME = "com.sun.jndi.ldap.LdapCtxFactory";<a name="line.89"></a> |
| <FONT color="green">090</FONT> protected static final String SIMPLE_AUTHENTICATION_MECHANISM_NAME = "simple";<a name="line.90"></a> |
| <FONT color="green">091</FONT> protected static final String DEFAULT_REFERRAL = "follow";<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> private static final Logger log = LoggerFactory.getLogger(JndiLdapContextFactory.class);<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> | I N S T A N C E V A R I A B L E S |<a name="line.96"></a> |
| <FONT color="green">097</FONT> ============================================*/<a name="line.97"></a> |
| <FONT color="green">098</FONT> private Map<String, Object> environment;<a name="line.98"></a> |
| <FONT color="green">099</FONT> private boolean poolingEnabled;<a name="line.99"></a> |
| <FONT color="green">100</FONT> private String systemPassword;<a name="line.100"></a> |
| <FONT color="green">101</FONT> private String systemUsername;<a name="line.101"></a> |
| <FONT color="green">102</FONT> <a name="line.102"></a> |
| <FONT color="green">103</FONT> /*-------------------------------------------<a name="line.103"></a> |
| <FONT color="green">104</FONT> | C O N S T R U C T O R S |<a name="line.104"></a> |
| <FONT color="green">105</FONT> ===========================================*/<a name="line.105"></a> |
| <FONT color="green">106</FONT> <a name="line.106"></a> |
| <FONT color="green">107</FONT> /**<a name="line.107"></a> |
| <FONT color="green">108</FONT> * Default no-argument constructor that initializes the backing {@link #getEnvironment() environment template} with<a name="line.108"></a> |
| <FONT color="green">109</FONT> * the {@link #setContextFactoryClassName(String) contextFactoryClassName} equal to<a name="line.109"></a> |
| <FONT color="green">110</FONT> * {@code com.sun.jndi.ldap.LdapCtxFactory} (the Sun/Oracle default) and the default<a name="line.110"></a> |
| <FONT color="green">111</FONT> * {@link #setReferral(String) referral} behavior to {@code follow}.<a name="line.111"></a> |
| <FONT color="green">112</FONT> */<a name="line.112"></a> |
| <FONT color="green">113</FONT> public JndiLdapContextFactory() {<a name="line.113"></a> |
| <FONT color="green">114</FONT> this.environment = new HashMap<String, Object>();<a name="line.114"></a> |
| <FONT color="green">115</FONT> setContextFactoryClassName(DEFAULT_CONTEXT_FACTORY_CLASS_NAME);<a name="line.115"></a> |
| <FONT color="green">116</FONT> setReferral(DEFAULT_REFERRAL);<a name="line.116"></a> |
| <FONT color="green">117</FONT> poolingEnabled = true;<a name="line.117"></a> |
| <FONT color="green">118</FONT> }<a name="line.118"></a> |
| <FONT color="green">119</FONT> <a name="line.119"></a> |
| <FONT color="green">120</FONT> /*-------------------------------------------<a name="line.120"></a> |
| <FONT color="green">121</FONT> | A C C E S S O R S / M O D I F I E R S |<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> * Sets the type of LDAP authentication mechanism to use when connecting to the LDAP server.<a name="line.125"></a> |
| <FONT color="green">126</FONT> * This is a wrapper method for setting the JNDI {@link #getEnvironment() environment template}'s<a name="line.126"></a> |
| <FONT color="green">127</FONT> * {@link Context#SECURITY_AUTHENTICATION} property.<a name="line.127"></a> |
| <FONT color="green">128</FONT> * <p/><a name="line.128"></a> |
| <FONT color="green">129</FONT> * "none" (i.e. anonymous) and "simple" authentications are supported automatically and don't need to be configured<a name="line.129"></a> |
| <FONT color="green">130</FONT> * via this property. However, if you require a different mechanism, such as a SASL or External mechanism, you<a name="line.130"></a> |
| <FONT color="green">131</FONT> * must configure that explicitly via this property. See the<a name="line.131"></a> |
| <FONT color="green">132</FONT> * <a href="http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html">JNDI LDAP<a name="line.132"></a> |
| <FONT color="green">133</FONT> * Authentication Mechanisms</a> for more information.<a name="line.133"></a> |
| <FONT color="green">134</FONT> *<a name="line.134"></a> |
| <FONT color="green">135</FONT> * @param authenticationMechanism the type of LDAP authentication to perform.<a name="line.135"></a> |
| <FONT color="green">136</FONT> * @see <a href="http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html"><a name="line.136"></a> |
| <FONT color="green">137</FONT> * http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html</a><a name="line.137"></a> |
| <FONT color="green">138</FONT> */<a name="line.138"></a> |
| <FONT color="green">139</FONT> public void setAuthenticationMechanism(String authenticationMechanism) {<a name="line.139"></a> |
| <FONT color="green">140</FONT> setEnvironmentProperty(Context.SECURITY_AUTHENTICATION, authenticationMechanism);<a name="line.140"></a> |
| <FONT color="green">141</FONT> }<a name="line.141"></a> |
| <FONT color="green">142</FONT> <a name="line.142"></a> |
| <FONT color="green">143</FONT> /**<a name="line.143"></a> |
| <FONT color="green">144</FONT> * Returns the type of LDAP authentication mechanism to use when connecting to the LDAP server.<a name="line.144"></a> |
| <FONT color="green">145</FONT> * This is a wrapper method for getting the JNDI {@link #getEnvironment() environment template}'s<a name="line.145"></a> |
| <FONT color="green">146</FONT> * {@link Context#SECURITY_AUTHENTICATION} property.<a name="line.146"></a> |
| <FONT color="green">147</FONT> * <p/><a name="line.147"></a> |
| <FONT color="green">148</FONT> * If this property remains un-configured (i.e. {@code null} indicating the<a name="line.148"></a> |
| <FONT color="green">149</FONT> * {@link #setAuthenticationMechanism(String)} method wasn't used), this indicates that the default JNDI<a name="line.149"></a> |
| <FONT color="green">150</FONT> * "none" (anonymous) and "simple" authentications are supported automatically. Any non-null value returned<a name="line.150"></a> |
| <FONT color="green">151</FONT> * represents an explicitly configured mechanism (e.g. a SASL or external mechanism). See the<a name="line.151"></a> |
| <FONT color="green">152</FONT> * <a href="http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html">JNDI LDAP<a name="line.152"></a> |
| <FONT color="green">153</FONT> * Authentication Mechanisms</a> for more information.<a name="line.153"></a> |
| <FONT color="green">154</FONT> *<a name="line.154"></a> |
| <FONT color="green">155</FONT> * @return the type of LDAP authentication mechanism to use when connecting to the LDAP server.<a name="line.155"></a> |
| <FONT color="green">156</FONT> * @see <a href="http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html"><a name="line.156"></a> |
| <FONT color="green">157</FONT> * http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html</a><a name="line.157"></a> |
| <FONT color="green">158</FONT> */<a name="line.158"></a> |
| <FONT color="green">159</FONT> public String getAuthenticationMechanism() {<a name="line.159"></a> |
| <FONT color="green">160</FONT> return (String) getEnvironmentProperty(Context.SECURITY_AUTHENTICATION);<a name="line.160"></a> |
| <FONT color="green">161</FONT> }<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> * The name of the ContextFactory class to use. This defaults to the SUN LDAP JNDI implementation<a name="line.164"></a> |
| <FONT color="green">165</FONT> * but can be overridden to use custom LDAP factories.<a name="line.165"></a> |
| <FONT color="green">166</FONT> * <p/><a name="line.166"></a> |
| <FONT color="green">167</FONT> * This is a wrapper method for setting the JNDI environment's {@link Context#INITIAL_CONTEXT_FACTORY} property.<a name="line.167"></a> |
| <FONT color="green">168</FONT> *<a name="line.168"></a> |
| <FONT color="green">169</FONT> * @param contextFactoryClassName the context factory that should be used.<a name="line.169"></a> |
| <FONT color="green">170</FONT> */<a name="line.170"></a> |
| <FONT color="green">171</FONT> public void setContextFactoryClassName(String contextFactoryClassName) {<a name="line.171"></a> |
| <FONT color="green">172</FONT> setEnvironmentProperty(Context.INITIAL_CONTEXT_FACTORY, contextFactoryClassName);<a name="line.172"></a> |
| <FONT color="green">173</FONT> }<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> * Sets the name of the ContextFactory class to use. This defaults to the SUN LDAP JNDI implementation<a name="line.176"></a> |
| <FONT color="green">177</FONT> * but can be overridden to use custom LDAP factories.<a name="line.177"></a> |
| <FONT color="green">178</FONT> * <p/><a name="line.178"></a> |
| <FONT color="green">179</FONT> * This is a wrapper method for getting the JNDI environment's {@link Context#INITIAL_CONTEXT_FACTORY} property.<a name="line.179"></a> |
| <FONT color="green">180</FONT> *<a name="line.180"></a> |
| <FONT color="green">181</FONT> * @return the name of the ContextFactory class to use.<a name="line.181"></a> |
| <FONT color="green">182</FONT> */<a name="line.182"></a> |
| <FONT color="green">183</FONT> public String getContextFactoryClassName() {<a name="line.183"></a> |
| <FONT color="green">184</FONT> return (String) getEnvironmentProperty(Context.INITIAL_CONTEXT_FACTORY);<a name="line.184"></a> |
| <FONT color="green">185</FONT> }<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> * Returns the base JNDI environment template to use when acquiring an LDAP connection (an {@link LdapContext}).<a name="line.188"></a> |
| <FONT color="green">189</FONT> * This property is the base configuration template to use for all connections. This template is then<a name="line.189"></a> |
| <FONT color="green">190</FONT> * merged with appropriate runtime values as necessary in the<a name="line.190"></a> |
| <FONT color="green">191</FONT> * {@link #getLdapContext(Object, Object)} implementation. The merged environment instance is what is used to<a name="line.191"></a> |
| <FONT color="green">192</FONT> * acquire the {@link LdapContext} at runtime.<a name="line.192"></a> |
| <FONT color="green">193</FONT> * <p/><a name="line.193"></a> |
| <FONT color="green">194</FONT> * Most other get/set methods in this class act as thin proxy wrappers that interact with this property. The<a name="line.194"></a> |
| <FONT color="green">195</FONT> * benefit of using them is you have an easier-to-use configuration mechanism compared to setting map properties<a name="line.195"></a> |
| <FONT color="green">196</FONT> * based on JNDI context keys.<a name="line.196"></a> |
| <FONT color="green">197</FONT> *<a name="line.197"></a> |
| <FONT color="green">198</FONT> * @return the base JNDI environment template to use when acquiring an LDAP connection (an {@link LdapContext})<a name="line.198"></a> |
| <FONT color="green">199</FONT> */<a name="line.199"></a> |
| <FONT color="green">200</FONT> public Map getEnvironment() {<a name="line.200"></a> |
| <FONT color="green">201</FONT> return this.environment;<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> /**<a name="line.204"></a> |
| <FONT color="green">205</FONT> * Sets the base JNDI environment template to use when acquiring LDAP connections. It is typically more common<a name="line.205"></a> |
| <FONT color="green">206</FONT> * to use the other get/set methods in this class to set individual environment settings rather than use<a name="line.206"></a> |
| <FONT color="green">207</FONT> * this method, but it is available for advanced users that want full control over the base JNDI environment<a name="line.207"></a> |
| <FONT color="green">208</FONT> * settings.<a name="line.208"></a> |
| <FONT color="green">209</FONT> * <p/><a name="line.209"></a> |
| <FONT color="green">210</FONT> * Note that this template only represents the base/default environment settings. It is then merged with<a name="line.210"></a> |
| <FONT color="green">211</FONT> * appropriate runtime values as necessary in the {@link #getLdapContext(Object, Object)} implementation.<a name="line.211"></a> |
| <FONT color="green">212</FONT> * The merged environment instance is what is used to acquire the connection ({@link LdapContext}) at runtime.<a name="line.212"></a> |
| <FONT color="green">213</FONT> *<a name="line.213"></a> |
| <FONT color="green">214</FONT> * @param env the base JNDI environment template to use when acquiring LDAP connections.<a name="line.214"></a> |
| <FONT color="green">215</FONT> */<a name="line.215"></a> |
| <FONT color="green">216</FONT> @SuppressWarnings({"unchecked"})<a name="line.216"></a> |
| <FONT color="green">217</FONT> public void setEnvironment(Map env) {<a name="line.217"></a> |
| <FONT color="green">218</FONT> this.environment = env;<a name="line.218"></a> |
| <FONT color="green">219</FONT> }<a name="line.219"></a> |
| <FONT color="green">220</FONT> <a name="line.220"></a> |
| <FONT color="green">221</FONT> /**<a name="line.221"></a> |
| <FONT color="green">222</FONT> * Returns the environment property value bound under the specified key.<a name="line.222"></a> |
| <FONT color="green">223</FONT> *<a name="line.223"></a> |
| <FONT color="green">224</FONT> * @param name the name of the environment property<a name="line.224"></a> |
| <FONT color="green">225</FONT> * @return the property value or {@code null} if the value has not been set.<a name="line.225"></a> |
| <FONT color="green">226</FONT> */<a name="line.226"></a> |
| <FONT color="green">227</FONT> private Object getEnvironmentProperty(String name) {<a name="line.227"></a> |
| <FONT color="green">228</FONT> return this.environment.get(name);<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> /**<a name="line.231"></a> |
| <FONT color="green">232</FONT> * Will apply the value to the environment attribute if and only if the value is not null or empty. If it is<a name="line.232"></a> |
| <FONT color="green">233</FONT> * null or empty, the corresponding environment attribute will be removed.<a name="line.233"></a> |
| <FONT color="green">234</FONT> *<a name="line.234"></a> |
| <FONT color="green">235</FONT> * @param name the environment property key<a name="line.235"></a> |
| <FONT color="green">236</FONT> * @param value the environment property value. A null/empty value will trigger removal.<a name="line.236"></a> |
| <FONT color="green">237</FONT> */<a name="line.237"></a> |
| <FONT color="green">238</FONT> private void setEnvironmentProperty(String name, String value) {<a name="line.238"></a> |
| <FONT color="green">239</FONT> if (StringUtils.hasText(value)) {<a name="line.239"></a> |
| <FONT color="green">240</FONT> this.environment.put(name, value);<a name="line.240"></a> |
| <FONT color="green">241</FONT> } else {<a name="line.241"></a> |
| <FONT color="green">242</FONT> this.environment.remove(name);<a name="line.242"></a> |
| <FONT color="green">243</FONT> }<a name="line.243"></a> |
| <FONT color="green">244</FONT> }<a name="line.244"></a> |
| <FONT color="green">245</FONT> <a name="line.245"></a> |
| <FONT color="green">246</FONT> /**<a name="line.246"></a> |
| <FONT color="green">247</FONT> * Returns whether or not connection pooling should be used when possible and appropriate. This property is NOT<a name="line.247"></a> |
| <FONT color="green">248</FONT> * backed by the {@link #getEnvironment() environment template} like most other properties in this class. It<a name="line.248"></a> |
| <FONT color="green">249</FONT> * is a flag to indicate that pooling is preferred. The default value is {@code true}.<a name="line.249"></a> |
| <FONT color="green">250</FONT> * <p/><a name="line.250"></a> |
| <FONT color="green">251</FONT> * However, pooling will only actually be enabled if this property is {@code true} <em>and</em> the connection<a name="line.251"></a> |
| <FONT color="green">252</FONT> * being created is for the {@link #getSystemUsername() systemUsername} user. Connection pooling is not used for<a name="line.252"></a> |
| <FONT color="green">253</FONT> * general authentication attempts by application end-users because the probability of re-use for that same<a name="line.253"></a> |
| <FONT color="green">254</FONT> * user-specific connection after an authentication attempt is extremely low.<a name="line.254"></a> |
| <FONT color="green">255</FONT> * <p/><a name="line.255"></a> |
| <FONT color="green">256</FONT> * If this attribute is {@code true} and it has been determined that the connection is being made with the<a name="line.256"></a> |
| <FONT color="green">257</FONT> * {@link #getSystemUsername() systemUsername}, the<a name="line.257"></a> |
| <FONT color="green">258</FONT> * {@link #getLdapContext(Object, Object)} implementation will set the Sun/Oracle-specific<a name="line.258"></a> |
| <FONT color="green">259</FONT> * {@code com.sun.jndi.ldap.connect.pool} environment property to &quot;{@code true}&quot;. This means setting<a name="line.259"></a> |
| <FONT color="green">260</FONT> * this property is only likely to work if using the Sun/Oracle default context factory class (i.e. not using<a name="line.260"></a> |
| <FONT color="green">261</FONT> * a custom {@link #getContextFactoryClassName() contextFactoryClassName}).<a name="line.261"></a> |
| <FONT color="green">262</FONT> *<a name="line.262"></a> |
| <FONT color="green">263</FONT> * @return whether or not connection pooling should be used when possible and appropriate<a name="line.263"></a> |
| <FONT color="green">264</FONT> */<a name="line.264"></a> |
| <FONT color="green">265</FONT> public boolean isPoolingEnabled() {<a name="line.265"></a> |
| <FONT color="green">266</FONT> return poolingEnabled;<a name="line.266"></a> |
| <FONT color="green">267</FONT> }<a name="line.267"></a> |
| <FONT color="green">268</FONT> <a name="line.268"></a> |
| <FONT color="green">269</FONT> /**<a name="line.269"></a> |
| <FONT color="green">270</FONT> * Sets whether or not connection pooling should be used when possible and appropriate. This property is NOT<a name="line.270"></a> |
| <FONT color="green">271</FONT> * a wrapper to the {@link #getEnvironment() environment template} like most other properties in this class. It<a name="line.271"></a> |
| <FONT color="green">272</FONT> * is a flag to indicate that pooling is preferred. The default value is {@code true}.<a name="line.272"></a> |
| <FONT color="green">273</FONT> * <p/><a name="line.273"></a> |
| <FONT color="green">274</FONT> * However, pooling will only actually be enabled if this property is {@code true} <em>and</em> the connection<a name="line.274"></a> |
| <FONT color="green">275</FONT> * being created is for the {@link #getSystemUsername() systemUsername} user. Connection pooling is not used for<a name="line.275"></a> |
| <FONT color="green">276</FONT> * general authentication attempts by application end-users because the probability of re-use for that same<a name="line.276"></a> |
| <FONT color="green">277</FONT> * user-specific connection after an authentication attempt is extremely low.<a name="line.277"></a> |
| <FONT color="green">278</FONT> * <p/><a name="line.278"></a> |
| <FONT color="green">279</FONT> * If this attribute is {@code true} and it has been determined that the connection is being made with the<a name="line.279"></a> |
| <FONT color="green">280</FONT> * {@link #getSystemUsername() systemUsername}, the<a name="line.280"></a> |
| <FONT color="green">281</FONT> * {@link #getLdapContext(Object, Object)} implementation will set the Sun/Oracle-specific<a name="line.281"></a> |
| <FONT color="green">282</FONT> * {@code com.sun.jndi.ldap.connect.pool} environment property to &quot;{@code true}&quot;. This means setting<a name="line.282"></a> |
| <FONT color="green">283</FONT> * this property is only likely to work if using the Sun/Oracle default context factory class (i.e. not using<a name="line.283"></a> |
| <FONT color="green">284</FONT> * a custom {@link #getContextFactoryClassName() contextFactoryClassName}).<a name="line.284"></a> |
| <FONT color="green">285</FONT> *<a name="line.285"></a> |
| <FONT color="green">286</FONT> * @param poolingEnabled whether or not connection pooling should be used when possible and appropriate<a name="line.286"></a> |
| <FONT color="green">287</FONT> */<a name="line.287"></a> |
| <FONT color="green">288</FONT> public void setPoolingEnabled(boolean poolingEnabled) {<a name="line.288"></a> |
| <FONT color="green">289</FONT> this.poolingEnabled = poolingEnabled;<a name="line.289"></a> |
| <FONT color="green">290</FONT> }<a name="line.290"></a> |
| <FONT color="green">291</FONT> <a name="line.291"></a> |
| <FONT color="green">292</FONT> /**<a name="line.292"></a> |
| <FONT color="green">293</FONT> * Sets the LDAP referral behavior when creating a connection. Defaults to {@code follow}. See the Sun/Oracle LDAP<a name="line.293"></a> |
| <FONT color="green">294</FONT> * <a href="http://java.sun.com/products/jndi/tutorial/ldap/referral/jndi.html">referral documentation</a> for more.<a name="line.294"></a> |
| <FONT color="green">295</FONT> *<a name="line.295"></a> |
| <FONT color="green">296</FONT> * @param referral the referral property.<a name="line.296"></a> |
| <FONT color="green">297</FONT> * @see <a href="http://java.sun.com/products/jndi/tutorial/ldap/referral/jndi.html">Referrals in JNDI</a><a name="line.297"></a> |
| <FONT color="green">298</FONT> */<a name="line.298"></a> |
| <FONT color="green">299</FONT> public void setReferral(String referral) {<a name="line.299"></a> |
| <FONT color="green">300</FONT> setEnvironmentProperty(Context.REFERRAL, referral);<a name="line.300"></a> |
| <FONT color="green">301</FONT> }<a name="line.301"></a> |
| <FONT color="green">302</FONT> <a name="line.302"></a> |
| <FONT color="green">303</FONT> /**<a name="line.303"></a> |
| <FONT color="green">304</FONT> * Returns the LDAP referral behavior when creating a connection. Defaults to {@code follow}.<a name="line.304"></a> |
| <FONT color="green">305</FONT> * See the Sun/Oracle LDAP<a name="line.305"></a> |
| <FONT color="green">306</FONT> * <a href="http://java.sun.com/products/jndi/tutorial/ldap/referral/jndi.html">referral documentation</a> for more.<a name="line.306"></a> |
| <FONT color="green">307</FONT> *<a name="line.307"></a> |
| <FONT color="green">308</FONT> * @return the LDAP referral behavior when creating a connection.<a name="line.308"></a> |
| <FONT color="green">309</FONT> * @see <a href="http://java.sun.com/products/jndi/tutorial/ldap/referral/jndi.html">Referrals in JNDI</a><a name="line.309"></a> |
| <FONT color="green">310</FONT> */<a name="line.310"></a> |
| <FONT color="green">311</FONT> public String getReferral() {<a name="line.311"></a> |
| <FONT color="green">312</FONT> return (String) getEnvironmentProperty(Context.REFERRAL);<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> * The LDAP url to connect to. (e.g. ldap://&lt;ldapDirectoryHostname&gt;:&lt;port&gt;). This must be configured.<a name="line.316"></a> |
| <FONT color="green">317</FONT> *<a name="line.317"></a> |
| <FONT color="green">318</FONT> * @param url the LDAP url to connect to. (e.g. ldap://&lt;ldapDirectoryHostname&gt;:&lt;port&gt;)<a name="line.318"></a> |
| <FONT color="green">319</FONT> */<a name="line.319"></a> |
| <FONT color="green">320</FONT> public void setUrl(String url) {<a name="line.320"></a> |
| <FONT color="green">321</FONT> setEnvironmentProperty(Context.PROVIDER_URL, url);<a name="line.321"></a> |
| <FONT color="green">322</FONT> }<a name="line.322"></a> |
| <FONT color="green">323</FONT> <a name="line.323"></a> |
| <FONT color="green">324</FONT> /**<a name="line.324"></a> |
| <FONT color="green">325</FONT> * Returns the LDAP url to connect to. (e.g. ldap://&lt;ldapDirectoryHostname&gt;:&lt;port&gt;).<a name="line.325"></a> |
| <FONT color="green">326</FONT> * This must be configured.<a name="line.326"></a> |
| <FONT color="green">327</FONT> *<a name="line.327"></a> |
| <FONT color="green">328</FONT> * @return the LDAP url to connect to. (e.g. ldap://&lt;ldapDirectoryHostname&gt;:&lt;port&gt;)<a name="line.328"></a> |
| <FONT color="green">329</FONT> */<a name="line.329"></a> |
| <FONT color="green">330</FONT> public String getUrl() {<a name="line.330"></a> |
| <FONT color="green">331</FONT> return (String) getEnvironmentProperty(Context.PROVIDER_URL);<a name="line.331"></a> |
| <FONT color="green">332</FONT> }<a name="line.332"></a> |
| <FONT color="green">333</FONT> <a name="line.333"></a> |
| <FONT color="green">334</FONT> /**<a name="line.334"></a> |
| <FONT color="green">335</FONT> * Sets the password of the {@link #setSystemUsername(String) systemUsername} that will be used when creating an<a name="line.335"></a> |
| <FONT color="green">336</FONT> * LDAP connection used for authorization queries.<a name="line.336"></a> |
| <FONT color="green">337</FONT> * <p/><a name="line.337"></a> |
| <FONT color="green">338</FONT> * Note that setting this property is not required if the calling LDAP Realm does not perform authorization<a name="line.338"></a> |
| <FONT color="green">339</FONT> * checks.<a name="line.339"></a> |
| <FONT color="green">340</FONT> *<a name="line.340"></a> |
| <FONT color="green">341</FONT> * @param systemPassword the password of the {@link #setSystemUsername(String) systemUsername} that will be used<a name="line.341"></a> |
| <FONT color="green">342</FONT> * when creating an LDAP connection used for authorization queries.<a name="line.342"></a> |
| <FONT color="green">343</FONT> */<a name="line.343"></a> |
| <FONT color="green">344</FONT> public void setSystemPassword(String systemPassword) {<a name="line.344"></a> |
| <FONT color="green">345</FONT> this.systemPassword = systemPassword;<a name="line.345"></a> |
| <FONT color="green">346</FONT> }<a name="line.346"></a> |
| <FONT color="green">347</FONT> <a name="line.347"></a> |
| <FONT color="green">348</FONT> /**<a name="line.348"></a> |
| <FONT color="green">349</FONT> * Returns the password of the {@link #setSystemUsername(String) systemUsername} that will be used when creating an<a name="line.349"></a> |
| <FONT color="green">350</FONT> * LDAP connection used for authorization queries.<a name="line.350"></a> |
| <FONT color="green">351</FONT> * <p/><a name="line.351"></a> |
| <FONT color="green">352</FONT> * Note that setting this property is not required if the calling LDAP Realm does not perform authorization<a name="line.352"></a> |
| <FONT color="green">353</FONT> * checks.<a name="line.353"></a> |
| <FONT color="green">354</FONT> *<a name="line.354"></a> |
| <FONT color="green">355</FONT> * @return the password of the {@link #setSystemUsername(String) systemUsername} that will be used when creating an<a name="line.355"></a> |
| <FONT color="green">356</FONT> * LDAP connection used for authorization queries.<a name="line.356"></a> |
| <FONT color="green">357</FONT> */<a name="line.357"></a> |
| <FONT color="green">358</FONT> public String getSystemPassword() {<a name="line.358"></a> |
| <FONT color="green">359</FONT> return this.systemPassword;<a name="line.359"></a> |
| <FONT color="green">360</FONT> }<a name="line.360"></a> |
| <FONT color="green">361</FONT> <a name="line.361"></a> |
| <FONT color="green">362</FONT> /**<a name="line.362"></a> |
| <FONT color="green">363</FONT> * Sets the system username that will be used when creating an LDAP connection used for authorization queries.<a name="line.363"></a> |
| <FONT color="green">364</FONT> * The user must have the ability to query for authorization data for any application user.<a name="line.364"></a> |
| <FONT color="green">365</FONT> * <p/><a name="line.365"></a> |
| <FONT color="green">366</FONT> * Note that setting this property is not required if the calling LDAP Realm does not perform authorization<a name="line.366"></a> |
| <FONT color="green">367</FONT> * checks.<a name="line.367"></a> |
| <FONT color="green">368</FONT> *<a name="line.368"></a> |
| <FONT color="green">369</FONT> * @param systemUsername the system username that will be used when creating an LDAP connection used for<a name="line.369"></a> |
| <FONT color="green">370</FONT> * authorization queries.<a name="line.370"></a> |
| <FONT color="green">371</FONT> */<a name="line.371"></a> |
| <FONT color="green">372</FONT> public void setSystemUsername(String systemUsername) {<a name="line.372"></a> |
| <FONT color="green">373</FONT> this.systemUsername = systemUsername;<a name="line.373"></a> |
| <FONT color="green">374</FONT> }<a name="line.374"></a> |
| <FONT color="green">375</FONT> <a name="line.375"></a> |
| <FONT color="green">376</FONT> /**<a name="line.376"></a> |
| <FONT color="green">377</FONT> * Returns the system username that will be used when creating an LDAP connection used for authorization queries.<a name="line.377"></a> |
| <FONT color="green">378</FONT> * The user must have the ability to query for authorization data for any application user.<a name="line.378"></a> |
| <FONT color="green">379</FONT> * <p/><a name="line.379"></a> |
| <FONT color="green">380</FONT> * Note that setting this property is not required if the calling LDAP Realm does not perform authorization<a name="line.380"></a> |
| <FONT color="green">381</FONT> * checks.<a name="line.381"></a> |
| <FONT color="green">382</FONT> *<a name="line.382"></a> |
| <FONT color="green">383</FONT> * @return the system username that will be used when creating an LDAP connection used for authorization queries.<a name="line.383"></a> |
| <FONT color="green">384</FONT> */<a name="line.384"></a> |
| <FONT color="green">385</FONT> public String getSystemUsername() {<a name="line.385"></a> |
| <FONT color="green">386</FONT> return systemUsername;<a name="line.386"></a> |
| <FONT color="green">387</FONT> }<a name="line.387"></a> |
| <FONT color="green">388</FONT> <a name="line.388"></a> |
| <FONT color="green">389</FONT> /*--------------------------------------------<a name="line.389"></a> |
| <FONT color="green">390</FONT> | M E T H O D S |<a name="line.390"></a> |
| <FONT color="green">391</FONT> ============================================*/<a name="line.391"></a> |
| <FONT color="green">392</FONT> <a name="line.392"></a> |
| <FONT color="green">393</FONT> /**<a name="line.393"></a> |
| <FONT color="green">394</FONT> * This implementation delegates to {@link #getLdapContext(Object, Object)} using the<a name="line.394"></a> |
| <FONT color="green">395</FONT> * {@link #getSystemUsername() systemUsername} and {@link #getSystemPassword() systemPassword} properties as<a name="line.395"></a> |
| <FONT color="green">396</FONT> * arguments.<a name="line.396"></a> |
| <FONT color="green">397</FONT> *<a name="line.397"></a> |
| <FONT color="green">398</FONT> * @return the system LdapContext<a name="line.398"></a> |
| <FONT color="green">399</FONT> * @throws NamingException if there is a problem connecting to the LDAP directory<a name="line.399"></a> |
| <FONT color="green">400</FONT> */<a name="line.400"></a> |
| <FONT color="green">401</FONT> public LdapContext getSystemLdapContext() throws NamingException {<a name="line.401"></a> |
| <FONT color="green">402</FONT> return getLdapContext((Object)getSystemUsername(), getSystemPassword());<a name="line.402"></a> |
| <FONT color="green">403</FONT> }<a name="line.403"></a> |
| <FONT color="green">404</FONT> <a name="line.404"></a> |
| <FONT color="green">405</FONT> /**<a name="line.405"></a> |
| <FONT color="green">406</FONT> * Deprecated - use {@link #getLdapContext(Object, Object)} instead. This will be removed before Apache Shiro 2.0.<a name="line.406"></a> |
| <FONT color="green">407</FONT> *<a name="line.407"></a> |
| <FONT color="green">408</FONT> * @param username the username to use when creating the connection.<a name="line.408"></a> |
| <FONT color="green">409</FONT> * @param password the password to use when creating the connection.<a name="line.409"></a> |
| <FONT color="green">410</FONT> * @return a {@code LdapContext} bound using the given username and password.<a name="line.410"></a> |
| <FONT color="green">411</FONT> * @throws javax.naming.NamingException if there is an error creating the context.<a name="line.411"></a> |
| <FONT color="green">412</FONT> * @deprecated the {@link #getLdapContext(Object, Object)} method should be used in all cases to ensure more than<a name="line.412"></a> |
| <FONT color="green">413</FONT> * String principals and credentials can be used. Shiro no longer calls this method - it will be<a name="line.413"></a> |
| <FONT color="green">414</FONT> * removed before the 2.0 release.<a name="line.414"></a> |
| <FONT color="green">415</FONT> */<a name="line.415"></a> |
| <FONT color="green">416</FONT> @Deprecated<a name="line.416"></a> |
| <FONT color="green">417</FONT> public LdapContext getLdapContext(String username, String password) throws NamingException {<a name="line.417"></a> |
| <FONT color="green">418</FONT> return getLdapContext((Object) username, password);<a name="line.418"></a> |
| <FONT color="green">419</FONT> }<a name="line.419"></a> |
| <FONT color="green">420</FONT> <a name="line.420"></a> |
| <FONT color="green">421</FONT> /**<a name="line.421"></a> |
| <FONT color="green">422</FONT> * Returns {@code true} if LDAP connection pooling should be used when acquiring a connection based on the specified<a name="line.422"></a> |
| <FONT color="green">423</FONT> * account principal, {@code false} otherwise.<a name="line.423"></a> |
| <FONT color="green">424</FONT> * <p/><a name="line.424"></a> |
| <FONT color="green">425</FONT> * This implementation returns {@code true} only if {@link #isPoolingEnabled()} and the principal equals the<a name="line.425"></a> |
| <FONT color="green">426</FONT> * {@link #getSystemUsername()}. The reasoning behind this is that connection pooling is not desirable for<a name="line.426"></a> |
| <FONT color="green">427</FONT> * general authentication attempts by application end-users because the probability of re-use for that same<a name="line.427"></a> |
| <FONT color="green">428</FONT> * user-specific connection after an authentication attempt is extremely low.<a name="line.428"></a> |
| <FONT color="green">429</FONT> *<a name="line.429"></a> |
| <FONT color="green">430</FONT> * @param principal the principal under which the connection will be made<a name="line.430"></a> |
| <FONT color="green">431</FONT> * @return {@code true} if LDAP connection pooling should be used when acquiring a connection based on the specified<a name="line.431"></a> |
| <FONT color="green">432</FONT> * account principal, {@code false} otherwise.<a name="line.432"></a> |
| <FONT color="green">433</FONT> */<a name="line.433"></a> |
| <FONT color="green">434</FONT> protected boolean isPoolingConnections(Object principal) {<a name="line.434"></a> |
| <FONT color="green">435</FONT> return isPoolingEnabled() && principal != null && principal.equals(getSystemUsername());<a name="line.435"></a> |
| <FONT color="green">436</FONT> }<a name="line.436"></a> |
| <FONT color="green">437</FONT> <a name="line.437"></a> |
| <FONT color="green">438</FONT> /**<a name="line.438"></a> |
| <FONT color="green">439</FONT> * This implementation returns an LdapContext based on the configured JNDI/LDAP environment configuration.<a name="line.439"></a> |
| <FONT color="green">440</FONT> * The environnmet (Map) used at runtime is created by merging the default/configured<a name="line.440"></a> |
| <FONT color="green">441</FONT> * {@link #getEnvironment() environment template} with some runtime values as necessary (e.g. a principal and<a name="line.441"></a> |
| <FONT color="green">442</FONT> * credential available at runtime only).<a name="line.442"></a> |
| <FONT color="green">443</FONT> * <p/><a name="line.443"></a> |
| <FONT color="green">444</FONT> * After the merged Map instance is created, the LdapContext connection is<a name="line.444"></a> |
| <FONT color="green">445</FONT> * {@link #createLdapContext(java.util.Hashtable) created} and returned.<a name="line.445"></a> |
| <FONT color="green">446</FONT> *<a name="line.446"></a> |
| <FONT color="green">447</FONT> * @param principal the principal to use when acquiring a connection to the LDAP directory<a name="line.447"></a> |
| <FONT color="green">448</FONT> * @param credentials the credentials (password, X.509 certificate, etc) to use when acquiring a connection to the<a name="line.448"></a> |
| <FONT color="green">449</FONT> * LDAP directory<a name="line.449"></a> |
| <FONT color="green">450</FONT> * @return the acquired {@code LdapContext} connection bound using the specified principal and credentials.<a name="line.450"></a> |
| <FONT color="green">451</FONT> * @throws NamingException<a name="line.451"></a> |
| <FONT color="green">452</FONT> * @throws IllegalStateException<a name="line.452"></a> |
| <FONT color="green">453</FONT> */<a name="line.453"></a> |
| <FONT color="green">454</FONT> public LdapContext getLdapContext(Object principal, Object credentials) throws NamingException,<a name="line.454"></a> |
| <FONT color="green">455</FONT> IllegalStateException {<a name="line.455"></a> |
| <FONT color="green">456</FONT> <a name="line.456"></a> |
| <FONT color="green">457</FONT> String url = getUrl();<a name="line.457"></a> |
| <FONT color="green">458</FONT> if (url == null) {<a name="line.458"></a> |
| <FONT color="green">459</FONT> throw new IllegalStateException("An LDAP URL must be specified of the form ldap://<hostname>:<port>");<a name="line.459"></a> |
| <FONT color="green">460</FONT> }<a name="line.460"></a> |
| <FONT color="green">461</FONT> <a name="line.461"></a> |
| <FONT color="green">462</FONT> //copy the environment template into the runtime instance that will be further edited based on<a name="line.462"></a> |
| <FONT color="green">463</FONT> //the method arguments and other class attributes.<a name="line.463"></a> |
| <FONT color="green">464</FONT> Hashtable<String, Object> env = new Hashtable<String, Object>(this.environment);<a name="line.464"></a> |
| <FONT color="green">465</FONT> <a name="line.465"></a> |
| <FONT color="green">466</FONT> Object authcMech = getAuthenticationMechanism();<a name="line.466"></a> |
| <FONT color="green">467</FONT> if (authcMech == null && (principal != null || credentials != null)) {<a name="line.467"></a> |
| <FONT color="green">468</FONT> //authenticationMechanism has not been set, but either a principal and/or credentials were<a name="line.468"></a> |
| <FONT color="green">469</FONT> //supplied, indicating that at least a 'simple' authentication attempt is indeed occurring - the Shiro<a name="line.469"></a> |
| <FONT color="green">470</FONT> //end-user just didn't configure it explicitly. So we set it to be 'simple' here as a convenience;<a name="line.470"></a> |
| <FONT color="green">471</FONT> //the Sun provider implementation already does this same logic, but by repeating that logic here, we ensure<a name="line.471"></a> |
| <FONT color="green">472</FONT> //this convenience exists regardless of provider implementation):<a name="line.472"></a> |
| <FONT color="green">473</FONT> env.put(Context.SECURITY_AUTHENTICATION, SIMPLE_AUTHENTICATION_MECHANISM_NAME);<a name="line.473"></a> |
| <FONT color="green">474</FONT> }<a name="line.474"></a> |
| <FONT color="green">475</FONT> if (principal != null) {<a name="line.475"></a> |
| <FONT color="green">476</FONT> env.put(Context.SECURITY_PRINCIPAL, principal);<a name="line.476"></a> |
| <FONT color="green">477</FONT> }<a name="line.477"></a> |
| <FONT color="green">478</FONT> if (credentials != null) {<a name="line.478"></a> |
| <FONT color="green">479</FONT> env.put(Context.SECURITY_CREDENTIALS, credentials);<a name="line.479"></a> |
| <FONT color="green">480</FONT> }<a name="line.480"></a> |
| <FONT color="green">481</FONT> <a name="line.481"></a> |
| <FONT color="green">482</FONT> boolean pooling = isPoolingConnections(principal);<a name="line.482"></a> |
| <FONT color="green">483</FONT> if (pooling) {<a name="line.483"></a> |
| <FONT color="green">484</FONT> env.put(SUN_CONNECTION_POOLING_PROPERTY, "true");<a name="line.484"></a> |
| <FONT color="green">485</FONT> }<a name="line.485"></a> |
| <FONT color="green">486</FONT> <a name="line.486"></a> |
| <FONT color="green">487</FONT> if (log.isDebugEnabled()) {<a name="line.487"></a> |
| <FONT color="green">488</FONT> log.debug("Initializing LDAP context using URL [{}] and principal [{}] with pooling {}",<a name="line.488"></a> |
| <FONT color="green">489</FONT> new Object[]{url, principal, (pooling ? "enabled" : "disabled")});<a name="line.489"></a> |
| <FONT color="green">490</FONT> }<a name="line.490"></a> |
| <FONT color="green">491</FONT> <a name="line.491"></a> |
| <FONT color="green">492</FONT> // validate the config before creating the context<a name="line.492"></a> |
| <FONT color="green">493</FONT> validateAuthenticationInfo(env);<a name="line.493"></a> |
| <FONT color="green">494</FONT> <a name="line.494"></a> |
| <FONT color="green">495</FONT> return createLdapContext(env);<a name="line.495"></a> |
| <FONT color="green">496</FONT> }<a name="line.496"></a> |
| <FONT color="green">497</FONT> <a name="line.497"></a> |
| <FONT color="green">498</FONT> /**<a name="line.498"></a> |
| <FONT color="green">499</FONT> * Creates and returns a new {@link javax.naming.ldap.InitialLdapContext} instance. This method exists primarily<a name="line.499"></a> |
| <FONT color="green">500</FONT> * to support testing where a mock LdapContext can be returned instead of actually creating a connection, but<a name="line.500"></a> |
| <FONT color="green">501</FONT> * subclasses are free to provide a different implementation if necessary.<a name="line.501"></a> |
| <FONT color="green">502</FONT> *<a name="line.502"></a> |
| <FONT color="green">503</FONT> * @param env the JNDI environment settings used to create the LDAP connection<a name="line.503"></a> |
| <FONT color="green">504</FONT> * @return an LdapConnection<a name="line.504"></a> |
| <FONT color="green">505</FONT> * @throws NamingException if a problem occurs creating the connection<a name="line.505"></a> |
| <FONT color="green">506</FONT> */<a name="line.506"></a> |
| <FONT color="green">507</FONT> protected LdapContext createLdapContext(Hashtable env) throws NamingException {<a name="line.507"></a> |
| <FONT color="green">508</FONT> return new InitialLdapContext(env, null);<a name="line.508"></a> |
| <FONT color="green">509</FONT> }<a name="line.509"></a> |
| <FONT color="green">510</FONT> <a name="line.510"></a> |
| <FONT color="green">511</FONT> <a name="line.511"></a> |
| <FONT color="green">512</FONT> /**<a name="line.512"></a> |
| <FONT color="green">513</FONT> * Validates the configuration in the JNDI <code>environment</code> settings and throws an exception if a problem<a name="line.513"></a> |
| <FONT color="green">514</FONT> * exists.<a name="line.514"></a> |
| <FONT color="green">515</FONT> * <p/><a name="line.515"></a> |
| <FONT color="green">516</FONT> * This implementation will throw a {@link AuthenticationException} if the authentication mechanism is set to<a name="line.516"></a> |
| <FONT color="green">517</FONT> * 'simple', the principal is non-empty, and the credentials are empty (as per<a name="line.517"></a> |
| <FONT color="green">518</FONT> * <a href="http://tools.ietf.org/html/rfc4513#section-5.1.2">rfc4513 section-5.1.2</a>).<a name="line.518"></a> |
| <FONT color="green">519</FONT> *<a name="line.519"></a> |
| <FONT color="green">520</FONT> * @param environment the JNDI environment settings to be validated<a name="line.520"></a> |
| <FONT color="green">521</FONT> * @throws AuthenticationException if a configuration problem is detected<a name="line.521"></a> |
| <FONT color="green">522</FONT> */<a name="line.522"></a> |
| <FONT color="green">523</FONT> protected void validateAuthenticationInfo(Hashtable<String, Object> environment)<a name="line.523"></a> |
| <FONT color="green">524</FONT> throws AuthenticationException<a name="line.524"></a> |
| <FONT color="green">525</FONT> {<a name="line.525"></a> |
| <FONT color="green">526</FONT> // validate when using Simple auth both principal and credentials are set<a name="line.526"></a> |
| <FONT color="green">527</FONT> if(SIMPLE_AUTHENTICATION_MECHANISM_NAME.equals(environment.get(Context.SECURITY_AUTHENTICATION))) {<a name="line.527"></a> |
| <FONT color="green">528</FONT> <a name="line.528"></a> |
| <FONT color="green">529</FONT> // only validate credentials if we have a non-empty principal<a name="line.529"></a> |
| <FONT color="green">530</FONT> if( environment.get(Context.SECURITY_PRINCIPAL) != null &&<a name="line.530"></a> |
| <FONT color="green">531</FONT> StringUtils.hasText( String.valueOf( environment.get(Context.SECURITY_PRINCIPAL) ))) {<a name="line.531"></a> |
| <FONT color="green">532</FONT> <a name="line.532"></a> |
| <FONT color="green">533</FONT> Object credentials = environment.get(Context.SECURITY_CREDENTIALS);<a name="line.533"></a> |
| <FONT color="green">534</FONT> <a name="line.534"></a> |
| <FONT color="green">535</FONT> // from the FAQ, we need to check for empty credentials:<a name="line.535"></a> |
| <FONT color="green">536</FONT> // http://docs.oracle.com/javase/tutorial/jndi/ldap/faq.html<a name="line.536"></a> |
| <FONT color="green">537</FONT> if( credentials == null ||<a name="line.537"></a> |
| <FONT color="green">538</FONT> (credentials instanceof byte[] && ((byte[])credentials).length <= 0) || // empty byte[]<a name="line.538"></a> |
| <FONT color="green">539</FONT> (credentials instanceof char[] && ((char[])credentials).length <= 0) || // empty char[]<a name="line.539"></a> |
| <FONT color="green">540</FONT> (String.class.isInstance(credentials) && !StringUtils.hasText(String.valueOf(credentials)))) {<a name="line.540"></a> |
| <FONT color="green">541</FONT> <a name="line.541"></a> |
| <FONT color="green">542</FONT> throw new javax.naming.AuthenticationException("LDAP Simple authentication requires both a "<a name="line.542"></a> |
| <FONT color="green">543</FONT> + "principal and credentials.");<a name="line.543"></a> |
| <FONT color="green">544</FONT> }<a name="line.544"></a> |
| <FONT color="green">545</FONT> }<a name="line.545"></a> |
| <FONT color="green">546</FONT> }<a name="line.546"></a> |
| <FONT color="green">547</FONT> }<a name="line.547"></a> |
| <FONT color="green">548</FONT> <a name="line.548"></a> |
| <FONT color="green">549</FONT> }<a name="line.549"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
