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