| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.realm.ldap;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.authc.AuthenticationException;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.authc.AuthenticationInfo;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.authc.AuthenticationToken;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.authc.SimpleAuthenticationInfo;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.authc.credential.AllowAllCredentialsMatcher;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.authz.AuthorizationException;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.shiro.authz.AuthorizationInfo;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.shiro.ldap.UnsupportedAuthenticationMechanismException;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.shiro.realm.AuthorizingRealm;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.apache.shiro.subject.PrincipalCollection;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import org.apache.shiro.util.StringUtils;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import org.slf4j.Logger;<a name="line.32"></a> |
| <FONT color="green">033</FONT> import org.slf4j.LoggerFactory;<a name="line.33"></a> |
| <FONT color="green">034</FONT> <a name="line.34"></a> |
| <FONT color="green">035</FONT> import javax.naming.AuthenticationNotSupportedException;<a name="line.35"></a> |
| <FONT color="green">036</FONT> import javax.naming.NamingException;<a name="line.36"></a> |
| <FONT color="green">037</FONT> import javax.naming.ldap.LdapContext;<a name="line.37"></a> |
| <FONT color="green">038</FONT> <a name="line.38"></a> |
| <FONT color="green">039</FONT> /**<a name="line.39"></a> |
| <FONT color="green">040</FONT> * An LDAP {@link org.apache.shiro.realm.Realm Realm} implementation utilizing Sun's/Oracle's<a name="line.40"></a> |
| <FONT color="green">041</FONT> * <a href="http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/jndi.html">JNDI API as an LDAP API</a>. This is<a name="line.41"></a> |
| <FONT color="green">042</FONT> * Shiro's default implementation for supporting LDAP, as using the JNDI API has been a common approach for Java LDAP<a name="line.42"></a> |
| <FONT color="green">043</FONT> * support for many years.<a name="line.43"></a> |
| <FONT color="green">044</FONT> * <p/><a name="line.44"></a> |
| <FONT color="green">045</FONT> * This realm implementation and its backing {@link JndiLdapContextFactory} should cover 99% of all Shiro-related LDAP<a name="line.45"></a> |
| <FONT color="green">046</FONT> * authentication and authorization needs. However, if it does not suit your needs, you might want to look into<a name="line.46"></a> |
| <FONT color="green">047</FONT> * creating your own realm using an alternative, perhaps more robust, LDAP communication API, such as the<a name="line.47"></a> |
| <FONT color="green">048</FONT> * <a href="http://directory.apache.org/api/">Apache LDAP API</a>.<a name="line.48"></a> |
| <FONT color="green">049</FONT> * <h2>Authentication</h2><a name="line.49"></a> |
| <FONT color="green">050</FONT> * During an authentication attempt, if the submitted {@code AuthenticationToken}'s<a name="line.50"></a> |
| <FONT color="green">051</FONT> * {@link org.apache.shiro.authc.AuthenticationToken#getPrincipal() principal} is a simple username, but the<a name="line.51"></a> |
| <FONT color="green">052</FONT> * LDAP directory expects a complete User Distinguished Name (User DN) to establish a connection, the<a name="line.52"></a> |
| <FONT color="green">053</FONT> * {@link #setUserDnTemplate(String) userDnTemplate} property must be configured. If not configured,<a name="line.53"></a> |
| <FONT color="green">054</FONT> * the property will pass the simple username directly as the User DN, which is often incorrect in most LDAP<a name="line.54"></a> |
| <FONT color="green">055</FONT> * environments (maybe Microsoft ActiveDirectory being the exception).<a name="line.55"></a> |
| <FONT color="green">056</FONT> * <h2>Authorization</h2><a name="line.56"></a> |
| <FONT color="green">057</FONT> * By default, authorization is effectively disabled due to the default<a name="line.57"></a> |
| <FONT color="green">058</FONT> * {@link #doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)} implementation returning {@code null}.<a name="line.58"></a> |
| <FONT color="green">059</FONT> * If you wish to perform authorization based on an LDAP schema, you must subclass this one<a name="line.59"></a> |
| <FONT color="green">060</FONT> * and override that method to reflect your organization's data model.<a name="line.60"></a> |
| <FONT color="green">061</FONT> * <h2>Configuration</h2><a name="line.61"></a> |
| <FONT color="green">062</FONT> * This class primarily provides the {@link #setUserDnTemplate(String) userDnTemplate} property to allow you to specify<a name="line.62"></a> |
| <FONT color="green">063</FONT> * the your LDAP server's User DN format. Most other configuration is performed via the nested<a name="line.63"></a> |
| <FONT color="green">064</FONT> * {@link LdapContextFactory contextFactory} property.<a name="line.64"></a> |
| <FONT color="green">065</FONT> * <p/><a name="line.65"></a> |
| <FONT color="green">066</FONT> * For example, defining this realm in Shiro .ini:<a name="line.66"></a> |
| <FONT color="green">067</FONT> * <pre><a name="line.67"></a> |
| <FONT color="green">068</FONT> * [main]<a name="line.68"></a> |
| <FONT color="green">069</FONT> * ldapRealm = org.apache.shiro.realm.ldap.JndiLdapRealm<a name="line.69"></a> |
| <FONT color="green">070</FONT> * ldapRealm.userDnTemplate = uid={0},ou=users,dc=mycompany,dc=com<a name="line.70"></a> |
| <FONT color="green">071</FONT> * ldapRealm.contextFactory.url = ldap://ldapHost:389<a name="line.71"></a> |
| <FONT color="green">072</FONT> * ldapRealm.contextFactory.authenticationMechanism = DIGEST-MD5<a name="line.72"></a> |
| <FONT color="green">073</FONT> * ldapRealm.contextFactory.environment[some.obscure.jndi.key] = some value<a name="line.73"></a> |
| <FONT color="green">074</FONT> * ...<a name="line.74"></a> |
| <FONT color="green">075</FONT> * </pre><a name="line.75"></a> |
| <FONT color="green">076</FONT> * The default {@link #setContextFactory contextFactory} instance is a {@link JndiLdapContextFactory}. See that<a name="line.76"></a> |
| <FONT color="green">077</FONT> * class's JavaDoc for more information on configuring the LDAP connection as well as specifying JNDI environment<a name="line.77"></a> |
| <FONT color="green">078</FONT> * properties as necessary.<a name="line.78"></a> |
| <FONT color="green">079</FONT> *<a name="line.79"></a> |
| <FONT color="green">080</FONT> * @see JndiLdapContextFactory<a name="line.80"></a> |
| <FONT color="green">081</FONT> *<a name="line.81"></a> |
| <FONT color="green">082</FONT> * @since 1.1<a name="line.82"></a> |
| <FONT color="green">083</FONT> */<a name="line.83"></a> |
| <FONT color="green">084</FONT> public class JndiLdapRealm extends AuthorizingRealm {<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> private static final Logger log = LoggerFactory.getLogger(JndiLdapRealm.class);<a name="line.86"></a> |
| <FONT color="green">087</FONT> <a name="line.87"></a> |
| <FONT color="green">088</FONT> //The zero index currently means nothing, but could be utilized in the future for other substitution techniques.<a name="line.88"></a> |
| <FONT color="green">089</FONT> private static final String USERDN_SUBSTITUTION_TOKEN = "{0}";<a name="line.89"></a> |
| <FONT color="green">090</FONT> <a name="line.90"></a> |
| <FONT color="green">091</FONT> private String userDnPrefix;<a name="line.91"></a> |
| <FONT color="green">092</FONT> private String userDnSuffix;<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> /*--------------------------------------------<a name="line.94"></a> |
| <FONT color="green">095</FONT> | I N S T A N C E V A R I A B L E S |<a name="line.95"></a> |
| <FONT color="green">096</FONT> ============================================*/<a name="line.96"></a> |
| <FONT color="green">097</FONT> /**<a name="line.97"></a> |
| <FONT color="green">098</FONT> * The LdapContextFactory instance used to acquire {@link javax.naming.ldap.LdapContext LdapContext}'s at runtime<a name="line.98"></a> |
| <FONT color="green">099</FONT> * to acquire connections to the LDAP directory to perform authentication attempts and authorizatino queries.<a name="line.99"></a> |
| <FONT color="green">100</FONT> */<a name="line.100"></a> |
| <FONT color="green">101</FONT> private LdapContextFactory contextFactory;<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 defaults the internal {@link LdapContextFactory} instance to a<a name="line.108"></a> |
| <FONT color="green">109</FONT> * {@link JndiLdapContextFactory}.<a name="line.109"></a> |
| <FONT color="green">110</FONT> */<a name="line.110"></a> |
| <FONT color="green">111</FONT> public JndiLdapRealm() {<a name="line.111"></a> |
| <FONT color="green">112</FONT> //Credentials Matching is not necessary - the LDAP directory will do it automatically:<a name="line.112"></a> |
| <FONT color="green">113</FONT> setCredentialsMatcher(new AllowAllCredentialsMatcher());<a name="line.113"></a> |
| <FONT color="green">114</FONT> //Any Object principal and Object credentials may be passed to the LDAP provider, so accept any token:<a name="line.114"></a> |
| <FONT color="green">115</FONT> setAuthenticationTokenClass(AuthenticationToken.class);<a name="line.115"></a> |
| <FONT color="green">116</FONT> this.contextFactory = new JndiLdapContextFactory();<a name="line.116"></a> |
| <FONT color="green">117</FONT> }<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 C C E S S O R S / M O D I F I E R S |<a name="line.120"></a> |
| <FONT color="green">121</FONT> ============================================*/<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> * Returns the User DN prefix to use when building a runtime User DN value or {@code null} if no<a name="line.124"></a> |
| <FONT color="green">125</FONT> * {@link #getUserDnTemplate() userDnTemplate} has been configured. If configured, this value is the text that<a name="line.125"></a> |
| <FONT color="green">126</FONT> * occurs before the {@link #USERDN_SUBSTITUTION_TOKEN} in the {@link #getUserDnTemplate() userDnTemplate} value.<a name="line.126"></a> |
| <FONT color="green">127</FONT> *<a name="line.127"></a> |
| <FONT color="green">128</FONT> * @return the the User DN prefix to use when building a runtime User DN value or {@code null} if no<a name="line.128"></a> |
| <FONT color="green">129</FONT> * {@link #getUserDnTemplate() userDnTemplate} has been configured.<a name="line.129"></a> |
| <FONT color="green">130</FONT> */<a name="line.130"></a> |
| <FONT color="green">131</FONT> protected String getUserDnPrefix() {<a name="line.131"></a> |
| <FONT color="green">132</FONT> return userDnPrefix;<a name="line.132"></a> |
| <FONT color="green">133</FONT> }<a name="line.133"></a> |
| <FONT color="green">134</FONT> <a name="line.134"></a> |
| <FONT color="green">135</FONT> /**<a name="line.135"></a> |
| <FONT color="green">136</FONT> * Returns the User DN suffix to use when building a runtime User DN value. or {@code null} if no<a name="line.136"></a> |
| <FONT color="green">137</FONT> * {@link #getUserDnTemplate() userDnTemplate} has been configured. If configured, this value is the text that<a name="line.137"></a> |
| <FONT color="green">138</FONT> * occurs after the {@link #USERDN_SUBSTITUTION_TOKEN} in the {@link #getUserDnTemplate() userDnTemplate} value.<a name="line.138"></a> |
| <FONT color="green">139</FONT> *<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @return the User DN suffix to use when building a runtime User DN value or {@code null} if no<a name="line.140"></a> |
| <FONT color="green">141</FONT> * {@link #getUserDnTemplate() userDnTemplate} has been configured.<a name="line.141"></a> |
| <FONT color="green">142</FONT> */<a name="line.142"></a> |
| <FONT color="green">143</FONT> protected String getUserDnSuffix() {<a name="line.143"></a> |
| <FONT color="green">144</FONT> return userDnSuffix;<a name="line.144"></a> |
| <FONT color="green">145</FONT> }<a name="line.145"></a> |
| <FONT color="green">146</FONT> <a name="line.146"></a> |
| <FONT color="green">147</FONT> /*--------------------------------------------<a name="line.147"></a> |
| <FONT color="green">148</FONT> | M E T H O D S |<a name="line.148"></a> |
| <FONT color="green">149</FONT> ============================================*/<a name="line.149"></a> |
| <FONT color="green">150</FONT> <a name="line.150"></a> |
| <FONT color="green">151</FONT> /**<a name="line.151"></a> |
| <FONT color="green">152</FONT> * Sets the User Distinguished Name (DN) template to use when creating User DNs at runtime. A User DN is an LDAP<a name="line.152"></a> |
| <FONT color="green">153</FONT> * fully-qualified unique user identifier which is required to establish a connection with the LDAP<a name="line.153"></a> |
| <FONT color="green">154</FONT> * directory to authenticate users and query for authorization information.<a name="line.154"></a> |
| <FONT color="green">155</FONT> * <h2>Usage</h2><a name="line.155"></a> |
| <FONT color="green">156</FONT> * User DN formats are unique to the LDAP directory's schema, and each environment differs - you will need to<a name="line.156"></a> |
| <FONT color="green">157</FONT> * specify the format corresponding to your directory. You do this by specifying the full User DN as normal, but<a name="line.157"></a> |
| <FONT color="green">158</FONT> * but you use a <b>{@code {0}}</b> placeholder token in the string representing the location where the<a name="line.158"></a> |
| <FONT color="green">159</FONT> * user's submitted principal (usually a username or uid) will be substituted at runtime.<a name="line.159"></a> |
| <FONT color="green">160</FONT> * <p/><a name="line.160"></a> |
| <FONT color="green">161</FONT> * For example, if your directory<a name="line.161"></a> |
| <FONT color="green">162</FONT> * uses an LDAP {@code uid} attribute to represent usernames, the User DN for the {@code jsmith} user may look like<a name="line.162"></a> |
| <FONT color="green">163</FONT> * this:<a name="line.163"></a> |
| <FONT color="green">164</FONT> * <p/><a name="line.164"></a> |
| <FONT color="green">165</FONT> * <pre>uid=jsmith,ou=users,dc=mycompany,dc=com</pre><a name="line.165"></a> |
| <FONT color="green">166</FONT> * <p/><a name="line.166"></a> |
| <FONT color="green">167</FONT> * in which case you would set this property with the following template value:<a name="line.167"></a> |
| <FONT color="green">168</FONT> * <p/><a name="line.168"></a> |
| <FONT color="green">169</FONT> * <pre>uid=<b>{0}</b>,ou=users,dc=mycompany,dc=com</pre><a name="line.169"></a> |
| <FONT color="green">170</FONT> * <p/><a name="line.170"></a> |
| <FONT color="green">171</FONT> * If no template is configured, the raw {@code AuthenticationToken}<a name="line.171"></a> |
| <FONT color="green">172</FONT> * {@link AuthenticationToken#getPrincipal() principal} will be used as the LDAP principal. This is likely<a name="line.172"></a> |
| <FONT color="green">173</FONT> * incorrect as most LDAP directories expect a fully-qualified User DN as opposed to the raw uid or username. So,<a name="line.173"></a> |
| <FONT color="green">174</FONT> * ensure you set this property to match your environment!<a name="line.174"></a> |
| <FONT color="green">175</FONT> *<a name="line.175"></a> |
| <FONT color="green">176</FONT> * @param template the User Distinguished Name template to use for runtime substitution<a name="line.176"></a> |
| <FONT color="green">177</FONT> * @throws IllegalArgumentException if the template is null, empty, or does not contain the<a name="line.177"></a> |
| <FONT color="green">178</FONT> * {@code {0}} substitution token.<a name="line.178"></a> |
| <FONT color="green">179</FONT> * @see LdapContextFactory#getLdapContext(Object,Object)<a name="line.179"></a> |
| <FONT color="green">180</FONT> */<a name="line.180"></a> |
| <FONT color="green">181</FONT> public void setUserDnTemplate(String template) throws IllegalArgumentException {<a name="line.181"></a> |
| <FONT color="green">182</FONT> if (!StringUtils.hasText(template)) {<a name="line.182"></a> |
| <FONT color="green">183</FONT> String msg = "User DN template cannot be null or empty.";<a name="line.183"></a> |
| <FONT color="green">184</FONT> throw new IllegalArgumentException(msg);<a name="line.184"></a> |
| <FONT color="green">185</FONT> }<a name="line.185"></a> |
| <FONT color="green">186</FONT> int index = template.indexOf(USERDN_SUBSTITUTION_TOKEN);<a name="line.186"></a> |
| <FONT color="green">187</FONT> if (index < 0) {<a name="line.187"></a> |
| <FONT color="green">188</FONT> String msg = "User DN template must contain the '" +<a name="line.188"></a> |
| <FONT color="green">189</FONT> USERDN_SUBSTITUTION_TOKEN + "' replacement token to understand where to " +<a name="line.189"></a> |
| <FONT color="green">190</FONT> "insert the runtime authentication principal.";<a name="line.190"></a> |
| <FONT color="green">191</FONT> throw new IllegalArgumentException(msg);<a name="line.191"></a> |
| <FONT color="green">192</FONT> }<a name="line.192"></a> |
| <FONT color="green">193</FONT> String prefix = template.substring(0, index);<a name="line.193"></a> |
| <FONT color="green">194</FONT> String suffix = template.substring(prefix.length() + USERDN_SUBSTITUTION_TOKEN.length());<a name="line.194"></a> |
| <FONT color="green">195</FONT> if (log.isDebugEnabled()) {<a name="line.195"></a> |
| <FONT color="green">196</FONT> log.debug("Determined user DN prefix [{}] and suffix [{}]", prefix, suffix);<a name="line.196"></a> |
| <FONT color="green">197</FONT> }<a name="line.197"></a> |
| <FONT color="green">198</FONT> this.userDnPrefix = prefix;<a name="line.198"></a> |
| <FONT color="green">199</FONT> this.userDnSuffix = suffix;<a name="line.199"></a> |
| <FONT color="green">200</FONT> }<a name="line.200"></a> |
| <FONT color="green">201</FONT> <a name="line.201"></a> |
| <FONT color="green">202</FONT> /**<a name="line.202"></a> |
| <FONT color="green">203</FONT> * Returns the User Distinguished Name (DN) template to use when creating User DNs at runtime - see the<a name="line.203"></a> |
| <FONT color="green">204</FONT> * {@link #setUserDnTemplate(String) setUserDnTemplate} JavaDoc for a full explanation.<a name="line.204"></a> |
| <FONT color="green">205</FONT> *<a name="line.205"></a> |
| <FONT color="green">206</FONT> * @return the User Distinguished Name (DN) template to use when creating User DNs at runtime.<a name="line.206"></a> |
| <FONT color="green">207</FONT> */<a name="line.207"></a> |
| <FONT color="green">208</FONT> public String getUserDnTemplate() {<a name="line.208"></a> |
| <FONT color="green">209</FONT> return getUserDn(USERDN_SUBSTITUTION_TOKEN);<a name="line.209"></a> |
| <FONT color="green">210</FONT> }<a name="line.210"></a> |
| <FONT color="green">211</FONT> <a name="line.211"></a> |
| <FONT color="green">212</FONT> /**<a name="line.212"></a> |
| <FONT color="green">213</FONT> * Returns the LDAP User Distinguished Name (DN) to use when acquiring an<a name="line.213"></a> |
| <FONT color="green">214</FONT> * {@link javax.naming.ldap.LdapContext LdapContext} from the {@link LdapContextFactory}.<a name="line.214"></a> |
| <FONT color="green">215</FONT> * <p/><a name="line.215"></a> |
| <FONT color="green">216</FONT> * If the the {@link #getUserDnTemplate() userDnTemplate} property has been set, this implementation will construct<a name="line.216"></a> |
| <FONT color="green">217</FONT> * the User DN by substituting the specified {@code principal} into the configured template. If the<a name="line.217"></a> |
| <FONT color="green">218</FONT> * {@link #getUserDnTemplate() userDnTemplate} has not been set, the method argument will be returned directly<a name="line.218"></a> |
| <FONT color="green">219</FONT> * (indicating that the submitted authentication token principal <em>is</em> the User DN).<a name="line.219"></a> |
| <FONT color="green">220</FONT> *<a name="line.220"></a> |
| <FONT color="green">221</FONT> * @param principal the principal to substitute into the configured {@link #getUserDnTemplate() userDnTemplate}.<a name="line.221"></a> |
| <FONT color="green">222</FONT> * @return the constructed User DN to use at runtime when acquiring an {@link javax.naming.ldap.LdapContext}.<a name="line.222"></a> |
| <FONT color="green">223</FONT> * @throws IllegalArgumentException if the method argument is null or empty<a name="line.223"></a> |
| <FONT color="green">224</FONT> * @throws IllegalStateException if the {@link #getUserDnTemplate userDnTemplate} has not been set.<a name="line.224"></a> |
| <FONT color="green">225</FONT> * @see LdapContextFactory#getLdapContext(Object, Object)<a name="line.225"></a> |
| <FONT color="green">226</FONT> */<a name="line.226"></a> |
| <FONT color="green">227</FONT> protected String getUserDn(String principal) throws IllegalArgumentException, IllegalStateException {<a name="line.227"></a> |
| <FONT color="green">228</FONT> if (!StringUtils.hasText(principal)) {<a name="line.228"></a> |
| <FONT color="green">229</FONT> throw new IllegalArgumentException("User principal cannot be null or empty for User DN construction.");<a name="line.229"></a> |
| <FONT color="green">230</FONT> }<a name="line.230"></a> |
| <FONT color="green">231</FONT> String prefix = getUserDnPrefix();<a name="line.231"></a> |
| <FONT color="green">232</FONT> String suffix = getUserDnSuffix();<a name="line.232"></a> |
| <FONT color="green">233</FONT> if (prefix == null && suffix == null) {<a name="line.233"></a> |
| <FONT color="green">234</FONT> log.debug("userDnTemplate property has not been configured, indicating the submitted " +<a name="line.234"></a> |
| <FONT color="green">235</FONT> "AuthenticationToken's principal is the same as the User DN. Returning the method argument " +<a name="line.235"></a> |
| <FONT color="green">236</FONT> "as is.");<a name="line.236"></a> |
| <FONT color="green">237</FONT> return principal;<a name="line.237"></a> |
| <FONT color="green">238</FONT> }<a name="line.238"></a> |
| <FONT color="green">239</FONT> <a name="line.239"></a> |
| <FONT color="green">240</FONT> int prefixLength = prefix != null ? prefix.length() : 0;<a name="line.240"></a> |
| <FONT color="green">241</FONT> int suffixLength = suffix != null ? suffix.length() : 0;<a name="line.241"></a> |
| <FONT color="green">242</FONT> StringBuilder sb = new StringBuilder(prefixLength + principal.length() + suffixLength);<a name="line.242"></a> |
| <FONT color="green">243</FONT> if (prefixLength > 0) {<a name="line.243"></a> |
| <FONT color="green">244</FONT> sb.append(prefix);<a name="line.244"></a> |
| <FONT color="green">245</FONT> }<a name="line.245"></a> |
| <FONT color="green">246</FONT> sb.append(principal);<a name="line.246"></a> |
| <FONT color="green">247</FONT> if (suffixLength > 0) {<a name="line.247"></a> |
| <FONT color="green">248</FONT> sb.append(suffix);<a name="line.248"></a> |
| <FONT color="green">249</FONT> }<a name="line.249"></a> |
| <FONT color="green">250</FONT> return sb.toString();<a name="line.250"></a> |
| <FONT color="green">251</FONT> }<a name="line.251"></a> |
| <FONT color="green">252</FONT> <a name="line.252"></a> |
| <FONT color="green">253</FONT> /**<a name="line.253"></a> |
| <FONT color="green">254</FONT> * Sets the LdapContextFactory instance used to acquire connections to the LDAP directory during authentication<a name="line.254"></a> |
| <FONT color="green">255</FONT> * attempts and authorization queries. Unless specified otherwise, the default is a {@link JndiLdapContextFactory}<a name="line.255"></a> |
| <FONT color="green">256</FONT> * instance.<a name="line.256"></a> |
| <FONT color="green">257</FONT> *<a name="line.257"></a> |
| <FONT color="green">258</FONT> * @param contextFactory the LdapContextFactory instance used to acquire connections to the LDAP directory during<a name="line.258"></a> |
| <FONT color="green">259</FONT> * authentication attempts and authorization queries<a name="line.259"></a> |
| <FONT color="green">260</FONT> */<a name="line.260"></a> |
| <FONT color="green">261</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.261"></a> |
| <FONT color="green">262</FONT> public void setContextFactory(LdapContextFactory contextFactory) {<a name="line.262"></a> |
| <FONT color="green">263</FONT> this.contextFactory = contextFactory;<a name="line.263"></a> |
| <FONT color="green">264</FONT> }<a name="line.264"></a> |
| <FONT color="green">265</FONT> <a name="line.265"></a> |
| <FONT color="green">266</FONT> /**<a name="line.266"></a> |
| <FONT color="green">267</FONT> * Returns the LdapContextFactory instance used to acquire connections to the LDAP directory during authentication<a name="line.267"></a> |
| <FONT color="green">268</FONT> * attempts and authorization queries. Unless specified otherwise, the default is a {@link JndiLdapContextFactory}<a name="line.268"></a> |
| <FONT color="green">269</FONT> * instance.<a name="line.269"></a> |
| <FONT color="green">270</FONT> *<a name="line.270"></a> |
| <FONT color="green">271</FONT> * @return the LdapContextFactory instance used to acquire connections to the LDAP directory during<a name="line.271"></a> |
| <FONT color="green">272</FONT> * authentication attempts and authorization queries<a name="line.272"></a> |
| <FONT color="green">273</FONT> */<a name="line.273"></a> |
| <FONT color="green">274</FONT> public LdapContextFactory getContextFactory() {<a name="line.274"></a> |
| <FONT color="green">275</FONT> return this.contextFactory;<a name="line.275"></a> |
| <FONT color="green">276</FONT> }<a name="line.276"></a> |
| <FONT color="green">277</FONT> <a name="line.277"></a> |
| <FONT color="green">278</FONT> /*--------------------------------------------<a name="line.278"></a> |
| <FONT color="green">279</FONT> | M E T H O D S |<a name="line.279"></a> |
| <FONT color="green">280</FONT> ============================================*/<a name="line.280"></a> |
| <FONT color="green">281</FONT> <a name="line.281"></a> |
| <FONT color="green">282</FONT> /**<a name="line.282"></a> |
| <FONT color="green">283</FONT> * Delegates to {@link #queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken, LdapContextFactory)},<a name="line.283"></a> |
| <FONT color="green">284</FONT> * wrapping any {@link NamingException}s in a Shiro {@link AuthenticationException} to satisfy the parent method<a name="line.284"></a> |
| <FONT color="green">285</FONT> * signature.<a name="line.285"></a> |
| <FONT color="green">286</FONT> *<a name="line.286"></a> |
| <FONT color="green">287</FONT> * @param token the authentication token containing the user's principal and credentials.<a name="line.287"></a> |
| <FONT color="green">288</FONT> * @return the {@link AuthenticationInfo} acquired after a successful authentication attempt<a name="line.288"></a> |
| <FONT color="green">289</FONT> * @throws AuthenticationException if the authentication attempt fails or if a<a name="line.289"></a> |
| <FONT color="green">290</FONT> * {@link NamingException} occurs.<a name="line.290"></a> |
| <FONT color="green">291</FONT> */<a name="line.291"></a> |
| <FONT color="green">292</FONT> protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {<a name="line.292"></a> |
| <FONT color="green">293</FONT> AuthenticationInfo info;<a name="line.293"></a> |
| <FONT color="green">294</FONT> try {<a name="line.294"></a> |
| <FONT color="green">295</FONT> info = queryForAuthenticationInfo(token, getContextFactory());<a name="line.295"></a> |
| <FONT color="green">296</FONT> } catch (AuthenticationNotSupportedException e) {<a name="line.296"></a> |
| <FONT color="green">297</FONT> String msg = "Unsupported configured authentication mechanism";<a name="line.297"></a> |
| <FONT color="green">298</FONT> throw new UnsupportedAuthenticationMechanismException(msg, e);<a name="line.298"></a> |
| <FONT color="green">299</FONT> } catch (javax.naming.AuthenticationException e) {<a name="line.299"></a> |
| <FONT color="green">300</FONT> throw new AuthenticationException("LDAP authentication failed.", e);<a name="line.300"></a> |
| <FONT color="green">301</FONT> } catch (NamingException e) {<a name="line.301"></a> |
| <FONT color="green">302</FONT> String msg = "LDAP naming error while attempting to authenticate user.";<a name="line.302"></a> |
| <FONT color="green">303</FONT> throw new AuthenticationException(msg, e);<a name="line.303"></a> |
| <FONT color="green">304</FONT> }<a name="line.304"></a> |
| <FONT color="green">305</FONT> <a name="line.305"></a> |
| <FONT color="green">306</FONT> return info;<a name="line.306"></a> |
| <FONT color="green">307</FONT> }<a name="line.307"></a> |
| <FONT color="green">308</FONT> <a name="line.308"></a> |
| <FONT color="green">309</FONT> <a name="line.309"></a> |
| <FONT color="green">310</FONT> protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {<a name="line.310"></a> |
| <FONT color="green">311</FONT> AuthorizationInfo info;<a name="line.311"></a> |
| <FONT color="green">312</FONT> try {<a name="line.312"></a> |
| <FONT color="green">313</FONT> info = queryForAuthorizationInfo(principals, getContextFactory());<a name="line.313"></a> |
| <FONT color="green">314</FONT> } catch (NamingException e) {<a name="line.314"></a> |
| <FONT color="green">315</FONT> String msg = "LDAP naming error while attempting to retrieve authorization for user [" + principals + "].";<a name="line.315"></a> |
| <FONT color="green">316</FONT> throw new AuthorizationException(msg, e);<a name="line.316"></a> |
| <FONT color="green">317</FONT> }<a name="line.317"></a> |
| <FONT color="green">318</FONT> <a name="line.318"></a> |
| <FONT color="green">319</FONT> return info;<a name="line.319"></a> |
| <FONT color="green">320</FONT> }<a name="line.320"></a> |
| <FONT color="green">321</FONT> <a name="line.321"></a> |
| <FONT color="green">322</FONT> /**<a name="line.322"></a> |
| <FONT color="green">323</FONT> * Returns the principal to use when creating the LDAP connection for an authentication attempt.<a name="line.323"></a> |
| <FONT color="green">324</FONT> * <p/><a name="line.324"></a> |
| <FONT color="green">325</FONT> * This implementation uses a heuristic: it checks to see if the specified token's<a name="line.325"></a> |
| <FONT color="green">326</FONT> * {@link AuthenticationToken#getPrincipal() principal} is a {@code String}, and if so,<a name="line.326"></a> |
| <FONT color="green">327</FONT> * {@link #getUserDn(String) converts it} from what is<a name="line.327"></a> |
| <FONT color="green">328</FONT> * assumed to be a raw uid or username {@code String} into a User DN {@code String}. Almost all LDAP directories<a name="line.328"></a> |
| <FONT color="green">329</FONT> * expect the authentication connection to present a User DN and not an unqualified username or uid.<a name="line.329"></a> |
| <FONT color="green">330</FONT> * <p/><a name="line.330"></a> |
| <FONT color="green">331</FONT> * If the token's {@code principal} is not a String, it is assumed to already be in the format supported by the<a name="line.331"></a> |
| <FONT color="green">332</FONT> * underlying {@link LdapContextFactory} implementation and the raw principal is returned directly.<a name="line.332"></a> |
| <FONT color="green">333</FONT> *<a name="line.333"></a> |
| <FONT color="green">334</FONT> * @param token the {@link AuthenticationToken} submitted during the authentication process<a name="line.334"></a> |
| <FONT color="green">335</FONT> * @return the User DN or raw principal to use to acquire the LdapContext.<a name="line.335"></a> |
| <FONT color="green">336</FONT> * @see LdapContextFactory#getLdapContext(Object, Object)<a name="line.336"></a> |
| <FONT color="green">337</FONT> */<a name="line.337"></a> |
| <FONT color="green">338</FONT> protected Object getLdapPrincipal(AuthenticationToken token) {<a name="line.338"></a> |
| <FONT color="green">339</FONT> Object principal = token.getPrincipal();<a name="line.339"></a> |
| <FONT color="green">340</FONT> if (principal instanceof String) {<a name="line.340"></a> |
| <FONT color="green">341</FONT> String sPrincipal = (String) principal;<a name="line.341"></a> |
| <FONT color="green">342</FONT> return getUserDn(sPrincipal);<a name="line.342"></a> |
| <FONT color="green">343</FONT> }<a name="line.343"></a> |
| <FONT color="green">344</FONT> return principal;<a name="line.344"></a> |
| <FONT color="green">345</FONT> }<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> * This implementation opens an LDAP connection using the token's<a name="line.348"></a> |
| <FONT color="green">349</FONT> * {@link #getLdapPrincipal(org.apache.shiro.authc.AuthenticationToken) discovered principal} and provided<a name="line.349"></a> |
| <FONT color="green">350</FONT> * {@link AuthenticationToken#getCredentials() credentials}. If the connection opens successfully, the<a name="line.350"></a> |
| <FONT color="green">351</FONT> * authentication attempt is immediately considered successful and a new<a name="line.351"></a> |
| <FONT color="green">352</FONT> * {@link AuthenticationInfo} instance is<a name="line.352"></a> |
| <FONT color="green">353</FONT> * {@link #createAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken, Object, Object, javax.naming.ldap.LdapContext) created}<a name="line.353"></a> |
| <FONT color="green">354</FONT> * and returned. If the connection cannot be opened, either because LDAP authentication failed or some other<a name="line.354"></a> |
| <FONT color="green">355</FONT> * JNDI problem, an {@link NamingException} will be thrown.<a name="line.355"></a> |
| <FONT color="green">356</FONT> *<a name="line.356"></a> |
| <FONT color="green">357</FONT> * @param token the submitted authentication token that triggered the authentication attempt.<a name="line.357"></a> |
| <FONT color="green">358</FONT> * @param ldapContextFactory factory used to retrieve LDAP connections.<a name="line.358"></a> |
| <FONT color="green">359</FONT> * @return an {@link AuthenticationInfo} instance representing the authenticated user's information.<a name="line.359"></a> |
| <FONT color="green">360</FONT> * @throws NamingException if any LDAP errors occur.<a name="line.360"></a> |
| <FONT color="green">361</FONT> */<a name="line.361"></a> |
| <FONT color="green">362</FONT> protected AuthenticationInfo queryForAuthenticationInfo(AuthenticationToken token,<a name="line.362"></a> |
| <FONT color="green">363</FONT> LdapContextFactory ldapContextFactory)<a name="line.363"></a> |
| <FONT color="green">364</FONT> throws NamingException {<a name="line.364"></a> |
| <FONT color="green">365</FONT> <a name="line.365"></a> |
| <FONT color="green">366</FONT> Object principal = token.getPrincipal();<a name="line.366"></a> |
| <FONT color="green">367</FONT> Object credentials = token.getCredentials();<a name="line.367"></a> |
| <FONT color="green">368</FONT> <a name="line.368"></a> |
| <FONT color="green">369</FONT> log.debug("Authenticating user '{}' through LDAP", principal);<a name="line.369"></a> |
| <FONT color="green">370</FONT> <a name="line.370"></a> |
| <FONT color="green">371</FONT> principal = getLdapPrincipal(token);<a name="line.371"></a> |
| <FONT color="green">372</FONT> <a name="line.372"></a> |
| <FONT color="green">373</FONT> LdapContext ctx = null;<a name="line.373"></a> |
| <FONT color="green">374</FONT> try {<a name="line.374"></a> |
| <FONT color="green">375</FONT> ctx = ldapContextFactory.getLdapContext(principal, credentials);<a name="line.375"></a> |
| <FONT color="green">376</FONT> //context was opened successfully, which means their credentials were valid. Return the AuthenticationInfo:<a name="line.376"></a> |
| <FONT color="green">377</FONT> return createAuthenticationInfo(token, principal, credentials, ctx);<a name="line.377"></a> |
| <FONT color="green">378</FONT> } finally {<a name="line.378"></a> |
| <FONT color="green">379</FONT> LdapUtils.closeContext(ctx);<a name="line.379"></a> |
| <FONT color="green">380</FONT> }<a name="line.380"></a> |
| <FONT color="green">381</FONT> }<a name="line.381"></a> |
| <FONT color="green">382</FONT> <a name="line.382"></a> |
| <FONT color="green">383</FONT> /**<a name="line.383"></a> |
| <FONT color="green">384</FONT> * Returns the {@link AuthenticationInfo} resulting from a Subject's successful LDAP authentication attempt.<a name="line.384"></a> |
| <FONT color="green">385</FONT> * <p/><a name="line.385"></a> |
| <FONT color="green">386</FONT> * This implementation ignores the {@code ldapPrincipal}, {@code ldapCredentials}, and the opened<a name="line.386"></a> |
| <FONT color="green">387</FONT> * {@code ldapContext} arguments and merely returns an {@code AuthenticationInfo} instance mirroring the<a name="line.387"></a> |
| <FONT color="green">388</FONT> * submitted token's principal and credentials. This is acceptable because this method is only ever invoked after<a name="line.388"></a> |
| <FONT color="green">389</FONT> * a successful authentication attempt, which means the provided principal and credentials were correct, and can<a name="line.389"></a> |
| <FONT color="green">390</FONT> * be used directly to populate the (now verified) {@code AuthenticationInfo}.<a name="line.390"></a> |
| <FONT color="green">391</FONT> * <p/><a name="line.391"></a> |
| <FONT color="green">392</FONT> * Subclasses however are free to override this method for more advanced construction logic.<a name="line.392"></a> |
| <FONT color="green">393</FONT> *<a name="line.393"></a> |
| <FONT color="green">394</FONT> * @param token the submitted {@code AuthenticationToken} that resulted in a successful authentication<a name="line.394"></a> |
| <FONT color="green">395</FONT> * @param ldapPrincipal the LDAP principal used when creating the LDAP connection. Unlike the token's<a name="line.395"></a> |
| <FONT color="green">396</FONT> * {@link AuthenticationToken#getPrincipal() principal}, this value is usually a constructed<a name="line.396"></a> |
| <FONT color="green">397</FONT> * User DN and not a simple username or uid. The exact value is depending on the<a name="line.397"></a> |
| <FONT color="green">398</FONT> * configured<a name="line.398"></a> |
| <FONT color="green">399</FONT> * <a href="http://download-llnw.oracle.com/javase/tutorial/jndi/ldap/auth_mechs.html"><a name="line.399"></a> |
| <FONT color="green">400</FONT> * LDAP authentication mechanism</a> in use.<a name="line.400"></a> |
| <FONT color="green">401</FONT> * @param ldapCredentials the LDAP credentials used when creating the LDAP connection.<a name="line.401"></a> |
| <FONT color="green">402</FONT> * @param ldapContext the LdapContext created that resulted in a successful authentication. It can be used<a name="line.402"></a> |
| <FONT color="green">403</FONT> * further by subclasses for more complex operations. It does not need to be closed -<a name="line.403"></a> |
| <FONT color="green">404</FONT> * it will be closed automatically after this method returns.<a name="line.404"></a> |
| <FONT color="green">405</FONT> * @return the {@link AuthenticationInfo} resulting from a Subject's successful LDAP authentication attempt.<a name="line.405"></a> |
| <FONT color="green">406</FONT> * @throws NamingException if there was any problem using the {@code LdapContext}<a name="line.406"></a> |
| <FONT color="green">407</FONT> */<a name="line.407"></a> |
| <FONT color="green">408</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.408"></a> |
| <FONT color="green">409</FONT> protected AuthenticationInfo createAuthenticationInfo(AuthenticationToken token, Object ldapPrincipal,<a name="line.409"></a> |
| <FONT color="green">410</FONT> Object ldapCredentials, LdapContext ldapContext)<a name="line.410"></a> |
| <FONT color="green">411</FONT> throws NamingException {<a name="line.411"></a> |
| <FONT color="green">412</FONT> return new SimpleAuthenticationInfo(token.getPrincipal(), token.getCredentials(), getName());<a name="line.412"></a> |
| <FONT color="green">413</FONT> }<a name="line.413"></a> |
| <FONT color="green">414</FONT> <a name="line.414"></a> |
| <FONT color="green">415</FONT> <a name="line.415"></a> |
| <FONT color="green">416</FONT> /**<a name="line.416"></a> |
| <FONT color="green">417</FONT> * Method that should be implemented by subclasses to build an<a name="line.417"></a> |
| <FONT color="green">418</FONT> * {@link AuthorizationInfo} object by querying the LDAP context for the<a name="line.418"></a> |
| <FONT color="green">419</FONT> * specified principal.</p><a name="line.419"></a> |
| <FONT color="green">420</FONT> *<a name="line.420"></a> |
| <FONT color="green">421</FONT> * @param principals the principals of the Subject whose AuthenticationInfo should be queried from the LDAP server.<a name="line.421"></a> |
| <FONT color="green">422</FONT> * @param ldapContextFactory factory used to retrieve LDAP connections.<a name="line.422"></a> |
| <FONT color="green">423</FONT> * @return an {@link AuthorizationInfo} instance containing information retrieved from the LDAP server.<a name="line.423"></a> |
| <FONT color="green">424</FONT> * @throws NamingException if any LDAP errors occur during the search.<a name="line.424"></a> |
| <FONT color="green">425</FONT> */<a name="line.425"></a> |
| <FONT color="green">426</FONT> protected AuthorizationInfo queryForAuthorizationInfo(PrincipalCollection principals,<a name="line.426"></a> |
| <FONT color="green">427</FONT> LdapContextFactory ldapContextFactory) throws NamingException {<a name="line.427"></a> |
| <FONT color="green">428</FONT> return null;<a name="line.428"></a> |
| <FONT color="green">429</FONT> }<a name="line.429"></a> |
| <FONT color="green">430</FONT> }<a name="line.430"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
