blob: 5e4ce70ee9f57df4cb8d8e6b79838f3c4653a741 [file] [log] [blame]
<!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">package org.apache.archiva.redback.authentication.ldap;</a>
<span class="sourceLineNo">002</span><a id="line.2"></a>
<span class="sourceLineNo">003</span><a id="line.3">/*</a>
<span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a>
<span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">013</span><a id="line.13"> *</a>
<span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a>
<span class="sourceLineNo">020</span><a id="line.20"> */</a>
<span class="sourceLineNo">021</span><a id="line.21"></a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.archiva.redback.authentication.AbstractAuthenticator;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.common.ldap.LdapUtils;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.archiva.redback.common.ldap.connection.DefaultLdapConnection;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.archiva.redback.common.ldap.connection.LdapConnection;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.archiva.redback.common.ldap.user.UserMapper;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.archiva.redback.common.ldap.connection.LdapConnectionFactory;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.redback.configuration.UserConfiguration;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.configuration.UserConfigurationKeys;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.commons.lang3.StringUtils;</a>
<span class="sourceLineNo">031</span><a id="line.31">import org.apache.archiva.redback.authentication.AuthenticationDataSource;</a>
<span class="sourceLineNo">032</span><a id="line.32">import org.apache.archiva.redback.authentication.AuthenticationException;</a>
<span class="sourceLineNo">033</span><a id="line.33">import org.apache.archiva.redback.authentication.AuthenticationResult;</a>
<span class="sourceLineNo">034</span><a id="line.34">import org.apache.archiva.redback.authentication.Authenticator;</a>
<span class="sourceLineNo">035</span><a id="line.35">import org.apache.archiva.redback.authentication.PasswordBasedAuthenticationDataSource;</a>
<span class="sourceLineNo">036</span><a id="line.36">import org.apache.archiva.redback.common.ldap.connection.LdapException;</a>
<span class="sourceLineNo">037</span><a id="line.37">import org.apache.archiva.redback.users.ldap.service.LdapCacheService;</a>
<span class="sourceLineNo">038</span><a id="line.38">import org.slf4j.Logger;</a>
<span class="sourceLineNo">039</span><a id="line.39">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">040</span><a id="line.40">import org.springframework.stereotype.Service;</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42">import javax.inject.Inject;</a>
<span class="sourceLineNo">043</span><a id="line.43">import javax.inject.Named;</a>
<span class="sourceLineNo">044</span><a id="line.44">import javax.naming.NamingEnumeration;</a>
<span class="sourceLineNo">045</span><a id="line.45">import javax.naming.NamingException;</a>
<span class="sourceLineNo">046</span><a id="line.46">import javax.naming.directory.DirContext;</a>
<span class="sourceLineNo">047</span><a id="line.47">import javax.naming.directory.SearchControls;</a>
<span class="sourceLineNo">048</span><a id="line.48">import javax.naming.directory.SearchResult;</a>
<span class="sourceLineNo">049</span><a id="line.49"></a>
<span class="sourceLineNo">050</span><a id="line.50">/**</a>
<span class="sourceLineNo">051</span><a id="line.51"> * LdapBindAuthenticator:</a>
<span class="sourceLineNo">052</span><a id="line.52"> *</a>
<span class="sourceLineNo">053</span><a id="line.53"> * @author: Jesse McConnell</a>
<span class="sourceLineNo">054</span><a id="line.54"> */</a>
<span class="sourceLineNo">055</span><a id="line.55">@Service( "authenticator#ldap" )</a>
<span class="sourceLineNo">056</span><a id="line.56">public class LdapBindAuthenticator</a>
<span class="sourceLineNo">057</span><a id="line.57"> extends AbstractAuthenticator</a>
<span class="sourceLineNo">058</span><a id="line.58"> implements Authenticator</a>
<span class="sourceLineNo">059</span><a id="line.59">{</a>
<span class="sourceLineNo">060</span><a id="line.60"></a>
<span class="sourceLineNo">061</span><a id="line.61"> private Logger log = LoggerFactory.getLogger( getClass() );</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> @Inject</a>
<span class="sourceLineNo">064</span><a id="line.64"> @Named( value = "userMapper#ldap" )</a>
<span class="sourceLineNo">065</span><a id="line.65"> private UserMapper mapper;</a>
<span class="sourceLineNo">066</span><a id="line.66"></a>
<span class="sourceLineNo">067</span><a id="line.67"> @Inject</a>
<span class="sourceLineNo">068</span><a id="line.68"> @Named( value = "ldapConnectionFactory#configurable" )</a>
<span class="sourceLineNo">069</span><a id="line.69"> private LdapConnectionFactory connectionFactory;</a>
<span class="sourceLineNo">070</span><a id="line.70"></a>
<span class="sourceLineNo">071</span><a id="line.71"> @Inject</a>
<span class="sourceLineNo">072</span><a id="line.72"> @Named( value = "userConfiguration#default" )</a>
<span class="sourceLineNo">073</span><a id="line.73"> private UserConfiguration config;</a>
<span class="sourceLineNo">074</span><a id="line.74"></a>
<span class="sourceLineNo">075</span><a id="line.75"> @Inject</a>
<span class="sourceLineNo">076</span><a id="line.76"> private LdapCacheService ldapCacheService;</a>
<span class="sourceLineNo">077</span><a id="line.77"></a>
<span class="sourceLineNo">078</span><a id="line.78"> public String getId()</a>
<span class="sourceLineNo">079</span><a id="line.79"> {</a>
<span class="sourceLineNo">080</span><a id="line.80"> return "LdapBindAuthenticator";</a>
<span class="sourceLineNo">081</span><a id="line.81"> }</a>
<span class="sourceLineNo">082</span><a id="line.82"></a>
<span class="sourceLineNo">083</span><a id="line.83"> public AuthenticationResult authenticate( AuthenticationDataSource s )</a>
<span class="sourceLineNo">084</span><a id="line.84"> throws AuthenticationException</a>
<span class="sourceLineNo">085</span><a id="line.85"> {</a>
<span class="sourceLineNo">086</span><a id="line.86"> PasswordBasedAuthenticationDataSource source = (PasswordBasedAuthenticationDataSource) s;</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> if ( !config.getBoolean( UserConfigurationKeys.LDAP_BIND_AUTHENTICATOR_ENABLED ) || (</a>
<span class="sourceLineNo">089</span><a id="line.89"> !config.getBoolean( UserConfigurationKeys.LDAP_BIND_AUTHENTICATOR_ALLOW_EMPTY_PASSWORDS, false )</a>
<span class="sourceLineNo">090</span><a id="line.90"> &amp;&amp; StringUtils.isEmpty( source.getPassword() ) ) )</a>
<span class="sourceLineNo">091</span><a id="line.91"> {</a>
<span class="sourceLineNo">092</span><a id="line.92"> return new AuthenticationResult( false, source.getUsername(), null );</a>
<span class="sourceLineNo">093</span><a id="line.93"> }</a>
<span class="sourceLineNo">094</span><a id="line.94"></a>
<span class="sourceLineNo">095</span><a id="line.95"> SearchControls ctls = new SearchControls();</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> ctls.setCountLimit( 1 );</a>
<span class="sourceLineNo">098</span><a id="line.98"></a>
<span class="sourceLineNo">099</span><a id="line.99"> ctls.setDerefLinkFlag( true );</a>
<span class="sourceLineNo">100</span><a id="line.100"> ctls.setSearchScope( SearchControls.SUBTREE_SCOPE );</a>
<span class="sourceLineNo">101</span><a id="line.101"></a>
<span class="sourceLineNo">102</span><a id="line.102"> String filter = "(&amp;(objectClass=" + mapper.getUserObjectClass() + ")" + ( mapper.getUserFilter() != null</a>
<span class="sourceLineNo">103</span><a id="line.103"> ? mapper.getUserFilter()</a>
<span class="sourceLineNo">104</span><a id="line.104"> : "" ) + "(" + mapper.getUserIdAttribute() + "=" + LdapUtils.encodeFilterValue( source.getUsername() ) + "))";</a>
<span class="sourceLineNo">105</span><a id="line.105"></a>
<span class="sourceLineNo">106</span><a id="line.106"> log.debug( "Searching for users with filter: '{}' from base dn: {}", filter, mapper.getUserBaseDn() );</a>
<span class="sourceLineNo">107</span><a id="line.107"></a>
<span class="sourceLineNo">108</span><a id="line.108"> LdapConnection ldapConnection = null;</a>
<span class="sourceLineNo">109</span><a id="line.109"> LdapConnection authLdapConnection = null;</a>
<span class="sourceLineNo">110</span><a id="line.110"> NamingEnumeration&lt;SearchResult&gt; results = null;</a>
<span class="sourceLineNo">111</span><a id="line.111"> try</a>
<span class="sourceLineNo">112</span><a id="line.112"> {</a>
<span class="sourceLineNo">113</span><a id="line.113"> ldapConnection = getLdapConnection();</a>
<span class="sourceLineNo">114</span><a id="line.114"> // check the cache for user's userDn in the ldap server</a>
<span class="sourceLineNo">115</span><a id="line.115"> String userDn = ldapCacheService.getLdapUserDn( source.getUsername() );</a>
<span class="sourceLineNo">116</span><a id="line.116"></a>
<span class="sourceLineNo">117</span><a id="line.117"> if ( userDn == null )</a>
<span class="sourceLineNo">118</span><a id="line.118"> {</a>
<span class="sourceLineNo">119</span><a id="line.119"> log.debug( "userDn for user {} not found in cache. Retrieving from ldap server..",</a>
<span class="sourceLineNo">120</span><a id="line.120"> source.getUsername() );</a>
<span class="sourceLineNo">121</span><a id="line.121"></a>
<span class="sourceLineNo">122</span><a id="line.122"> DirContext context = ldapConnection.getDirContext();</a>
<span class="sourceLineNo">123</span><a id="line.123"></a>
<span class="sourceLineNo">124</span><a id="line.124"> results = context.search( mapper.getUserBaseDn(), filter, ctls );</a>
<span class="sourceLineNo">125</span><a id="line.125"></a>
<span class="sourceLineNo">126</span><a id="line.126"> boolean moreElements = results.hasMoreElements();</a>
<span class="sourceLineNo">127</span><a id="line.127"></a>
<span class="sourceLineNo">128</span><a id="line.128"> log.debug( "Found user '{}': {}", source.getUsername(), moreElements );</a>
<span class="sourceLineNo">129</span><a id="line.129"></a>
<span class="sourceLineNo">130</span><a id="line.130"> if ( moreElements )</a>
<span class="sourceLineNo">131</span><a id="line.131"> {</a>
<span class="sourceLineNo">132</span><a id="line.132"> try {</a>
<span class="sourceLineNo">133</span><a id="line.133"> SearchResult result = results.nextElement();</a>
<span class="sourceLineNo">134</span><a id="line.134"></a>
<span class="sourceLineNo">135</span><a id="line.135"> userDn = result.getNameInNamespace();</a>
<span class="sourceLineNo">136</span><a id="line.136"></a>
<span class="sourceLineNo">137</span><a id="line.137"> log.debug("Adding userDn {} for user {} to the cache..", userDn, source.getUsername());</a>
<span class="sourceLineNo">138</span><a id="line.138"></a>
<span class="sourceLineNo">139</span><a id="line.139"> // REDBACK-289/MRM-1488 cache the ldap user's userDn to lessen calls to ldap server</a>
<span class="sourceLineNo">140</span><a id="line.140"> ldapCacheService.addLdapUserDn(source.getUsername(), userDn);</a>
<span class="sourceLineNo">141</span><a id="line.141"> } catch (Exception e) {</a>
<span class="sourceLineNo">142</span><a id="line.142"> log.error("Error occured on LDAP result retrieval: {}, {}", userDn, e.getMessage());</a>
<span class="sourceLineNo">143</span><a id="line.143"> return new AuthenticationResult( false, source.getUsername(), e);</a>
<span class="sourceLineNo">144</span><a id="line.144"> }</a>
<span class="sourceLineNo">145</span><a id="line.145"> }</a>
<span class="sourceLineNo">146</span><a id="line.146"> else</a>
<span class="sourceLineNo">147</span><a id="line.147"> {</a>
<span class="sourceLineNo">148</span><a id="line.148"> return new AuthenticationResult( false, source.getUsername(), null );</a>
<span class="sourceLineNo">149</span><a id="line.149"> }</a>
<span class="sourceLineNo">150</span><a id="line.150"> }</a>
<span class="sourceLineNo">151</span><a id="line.151"></a>
<span class="sourceLineNo">152</span><a id="line.152"> log.debug( "Attempting Authenication: {}", userDn );</a>
<span class="sourceLineNo">153</span><a id="line.153"></a>
<span class="sourceLineNo">154</span><a id="line.154"> authLdapConnection = connectionFactory.getConnection( userDn, source.getPassword() );</a>
<span class="sourceLineNo">155</span><a id="line.155"></a>
<span class="sourceLineNo">156</span><a id="line.156"> log.info( "user '{}' authenticated", source.getUsername() );</a>
<span class="sourceLineNo">157</span><a id="line.157"></a>
<span class="sourceLineNo">158</span><a id="line.158"> return new AuthenticationResult( true, source.getUsername(), null );</a>
<span class="sourceLineNo">159</span><a id="line.159"> }</a>
<span class="sourceLineNo">160</span><a id="line.160"> catch ( LdapException e )</a>
<span class="sourceLineNo">161</span><a id="line.161"> {</a>
<span class="sourceLineNo">162</span><a id="line.162"> return new AuthenticationResult( false, source.getUsername(), e );</a>
<span class="sourceLineNo">163</span><a id="line.163"> }</a>
<span class="sourceLineNo">164</span><a id="line.164"> catch ( NamingException e )</a>
<span class="sourceLineNo">165</span><a id="line.165"> {</a>
<span class="sourceLineNo">166</span><a id="line.166"> return new AuthenticationResult( false, source.getUsername(), e );</a>
<span class="sourceLineNo">167</span><a id="line.167"> }</a>
<span class="sourceLineNo">168</span><a id="line.168"> finally</a>
<span class="sourceLineNo">169</span><a id="line.169"> {</a>
<span class="sourceLineNo">170</span><a id="line.170"> closeNamingEnumeration( results );</a>
<span class="sourceLineNo">171</span><a id="line.171"> closeLdapConnection( ldapConnection );</a>
<span class="sourceLineNo">172</span><a id="line.172"> if ( authLdapConnection != null )</a>
<span class="sourceLineNo">173</span><a id="line.173"> {</a>
<span class="sourceLineNo">174</span><a id="line.174"> closeLdapConnection( authLdapConnection );</a>
<span class="sourceLineNo">175</span><a id="line.175"> }</a>
<span class="sourceLineNo">176</span><a id="line.176"> }</a>
<span class="sourceLineNo">177</span><a id="line.177"> }</a>
<span class="sourceLineNo">178</span><a id="line.178"></a>
<span class="sourceLineNo">179</span><a id="line.179"> public boolean supportsDataSource( AuthenticationDataSource source )</a>
<span class="sourceLineNo">180</span><a id="line.180"> {</a>
<span class="sourceLineNo">181</span><a id="line.181"> return ( source instanceof PasswordBasedAuthenticationDataSource );</a>
<span class="sourceLineNo">182</span><a id="line.182"> }</a>
<span class="sourceLineNo">183</span><a id="line.183"></a>
<span class="sourceLineNo">184</span><a id="line.184"> private LdapConnection getLdapConnection()</a>
<span class="sourceLineNo">185</span><a id="line.185"> throws LdapException</a>
<span class="sourceLineNo">186</span><a id="line.186"> {</a>
<span class="sourceLineNo">187</span><a id="line.187"> return connectionFactory.getConnection();</a>
<span class="sourceLineNo">188</span><a id="line.188"> }</a>
<span class="sourceLineNo">189</span><a id="line.189"></a>
<span class="sourceLineNo">190</span><a id="line.190"> private void closeLdapConnection( LdapConnection ldapConnection )</a>
<span class="sourceLineNo">191</span><a id="line.191"> {</a>
<span class="sourceLineNo">192</span><a id="line.192"> if ( ldapConnection != null )</a>
<span class="sourceLineNo">193</span><a id="line.193"> {</a>
<span class="sourceLineNo">194</span><a id="line.194"> try</a>
<span class="sourceLineNo">195</span><a id="line.195"> {</a>
<span class="sourceLineNo">196</span><a id="line.196"> ldapConnection.close();</a>
<span class="sourceLineNo">197</span><a id="line.197"> }</a>
<span class="sourceLineNo">198</span><a id="line.198"> catch ( NamingException e )</a>
<span class="sourceLineNo">199</span><a id="line.199"> {</a>
<span class="sourceLineNo">200</span><a id="line.200"> log.error( "Could not close connection: {}", e.getMessage( ), e );</a>
<span class="sourceLineNo">201</span><a id="line.201"> }</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"> private void closeNamingEnumeration( NamingEnumeration&lt;SearchResult&gt; results )</a>
<span class="sourceLineNo">206</span><a id="line.206"> {</a>
<span class="sourceLineNo">207</span><a id="line.207"> try</a>
<span class="sourceLineNo">208</span><a id="line.208"> {</a>
<span class="sourceLineNo">209</span><a id="line.209"> if ( results != null )</a>
<span class="sourceLineNo">210</span><a id="line.210"> {</a>
<span class="sourceLineNo">211</span><a id="line.211"> results.close();</a>
<span class="sourceLineNo">212</span><a id="line.212"> }</a>
<span class="sourceLineNo">213</span><a id="line.213"> }</a>
<span class="sourceLineNo">214</span><a id="line.214"> catch ( NamingException e )</a>
<span class="sourceLineNo">215</span><a id="line.215"> {</a>
<span class="sourceLineNo">216</span><a id="line.216"> log.warn( "skip exception closing naming search result {}", e.getMessage() );</a>
<span class="sourceLineNo">217</span><a id="line.217"> }</a>
<span class="sourceLineNo">218</span><a id="line.218"> }</a>
<span class="sourceLineNo">219</span><a id="line.219"></a>
<span class="sourceLineNo">220</span><a id="line.220"> @Override</a>
<span class="sourceLineNo">221</span><a id="line.221"> public boolean isValid() {</a>
<span class="sourceLineNo">222</span><a id="line.222"> return connectionFactory.isValid();</a>
<span class="sourceLineNo">223</span><a id="line.223"> }</a>
<span class="sourceLineNo">224</span><a id="line.224">}</a>
</pre>
</div>
</main>
</body>
</html>