blob: 4899c729850609f2812f5ced19599d682755ea0c [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">/*</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.activedirectory;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authc.AuthenticationInfo;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.authc.AuthenticationToken;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.authc.SimpleAuthenticationInfo;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.authc.UsernamePasswordToken;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.authz.AuthorizationInfo;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.authz.SimpleAuthorizationInfo;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.shiro.realm.Realm;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.shiro.realm.ldap.AbstractLdapRealm;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.shiro.realm.ldap.LdapContextFactory;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.shiro.realm.ldap.LdapUtils;</a>
<span class="sourceLineNo">031</span><a id="line.31">import org.apache.shiro.subject.PrincipalCollection;</a>
<span class="sourceLineNo">032</span><a id="line.32">import org.slf4j.Logger;</a>
<span class="sourceLineNo">033</span><a id="line.33">import org.slf4j.LoggerFactory;</a>
<span class="sourceLineNo">034</span><a id="line.34"></a>
<span class="sourceLineNo">035</span><a id="line.35">import javax.naming.NamingEnumeration;</a>
<span class="sourceLineNo">036</span><a id="line.36">import javax.naming.NamingException;</a>
<span class="sourceLineNo">037</span><a id="line.37">import javax.naming.directory.Attribute;</a>
<span class="sourceLineNo">038</span><a id="line.38">import javax.naming.directory.Attributes;</a>
<span class="sourceLineNo">039</span><a id="line.39">import javax.naming.directory.SearchControls;</a>
<span class="sourceLineNo">040</span><a id="line.40">import javax.naming.directory.SearchResult;</a>
<span class="sourceLineNo">041</span><a id="line.41">import javax.naming.ldap.LdapContext;</a>
<span class="sourceLineNo">042</span><a id="line.42">import java.util.*;</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44"></a>
<span class="sourceLineNo">045</span><a id="line.45">/**</a>
<span class="sourceLineNo">046</span><a id="line.46"> * A {@link Realm} that authenticates with an active directory LDAP</a>
<span class="sourceLineNo">047</span><a id="line.47"> * server to determine the roles for a particular user. This implementation</a>
<span class="sourceLineNo">048</span><a id="line.48"> * queries for the user's groups and then maps the group names to roles using the</a>
<span class="sourceLineNo">049</span><a id="line.49"> * {@link #groupRolesMap}.</a>
<span class="sourceLineNo">050</span><a id="line.50"> *</a>
<span class="sourceLineNo">051</span><a id="line.51"> * @since 0.1</a>
<span class="sourceLineNo">052</span><a id="line.52"> */</a>
<span class="sourceLineNo">053</span><a id="line.53">public class ActiveDirectoryRealm extends AbstractLdapRealm {</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> //TODO - complete JavaDoc</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> /*--------------------------------------------</a>
<span class="sourceLineNo">058</span><a id="line.58"> | C O N S T A N T S |</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 static final Logger log = LoggerFactory.getLogger(ActiveDirectoryRealm.class);</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> private static final String ROLE_NAMES_DELIMETER = ",";</a>
<span class="sourceLineNo">064</span><a id="line.64"></a>
<span class="sourceLineNo">065</span><a id="line.65"> /*--------------------------------------------</a>
<span class="sourceLineNo">066</span><a id="line.66"> | I N S T A N C E V A R I A B L E S |</a>
<span class="sourceLineNo">067</span><a id="line.67"> ============================================*/</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> /**</a>
<span class="sourceLineNo">070</span><a id="line.70"> * Mapping from fully qualified active directory</a>
<span class="sourceLineNo">071</span><a id="line.71"> * group names (e.g. CN=Group,OU=Company,DC=MyDomain,DC=local)</a>
<span class="sourceLineNo">072</span><a id="line.72"> * as returned by the active directory LDAP server to role names.</a>
<span class="sourceLineNo">073</span><a id="line.73"> */</a>
<span class="sourceLineNo">074</span><a id="line.74"> private Map&lt;String, String&gt; groupRolesMap;</a>
<span class="sourceLineNo">075</span><a id="line.75"></a>
<span class="sourceLineNo">076</span><a id="line.76"> /*--------------------------------------------</a>
<span class="sourceLineNo">077</span><a id="line.77"> | C O N S T R U C T O R S |</a>
<span class="sourceLineNo">078</span><a id="line.78"> ============================================*/</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> public void setGroupRolesMap(Map&lt;String, String&gt; groupRolesMap) {</a>
<span class="sourceLineNo">081</span><a id="line.81"> this.groupRolesMap = groupRolesMap;</a>
<span class="sourceLineNo">082</span><a id="line.82"> }</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"> | M E T H O D S |</a>
<span class="sourceLineNo">086</span><a id="line.86"> ============================================*/</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"></a>
<span class="sourceLineNo">089</span><a id="line.89"> /**</a>
<span class="sourceLineNo">090</span><a id="line.90"> * Builds an {@link AuthenticationInfo} object by querying the active directory LDAP context for the</a>
<span class="sourceLineNo">091</span><a id="line.91"> * specified username. This method binds to the LDAP server using the provided username and password -</a>
<span class="sourceLineNo">092</span><a id="line.92"> * which if successful, indicates that the password is correct.</a>
<span class="sourceLineNo">093</span><a id="line.93"> * &lt;p/&gt;</a>
<span class="sourceLineNo">094</span><a id="line.94"> * This method can be overridden by subclasses to query the LDAP server in a more complex way.</a>
<span class="sourceLineNo">095</span><a id="line.95"> *</a>
<span class="sourceLineNo">096</span><a id="line.96"> * @param token the authentication token provided by the user.</a>
<span class="sourceLineNo">097</span><a id="line.97"> * @param ldapContextFactory the factory used to build connections to the LDAP server.</a>
<span class="sourceLineNo">098</span><a id="line.98"> * @return an {@link AuthenticationInfo} instance containing information retrieved from LDAP.</a>
<span class="sourceLineNo">099</span><a id="line.99"> * @throws NamingException if any LDAP errors occur during the search.</a>
<span class="sourceLineNo">100</span><a id="line.100"> */</a>
<span class="sourceLineNo">101</span><a id="line.101"> protected AuthenticationInfo queryForAuthenticationInfo(AuthenticationToken token, LdapContextFactory ldapContextFactory) throws NamingException {</a>
<span class="sourceLineNo">102</span><a id="line.102"></a>
<span class="sourceLineNo">103</span><a id="line.103"> UsernamePasswordToken upToken = (UsernamePasswordToken) token;</a>
<span class="sourceLineNo">104</span><a id="line.104"></a>
<span class="sourceLineNo">105</span><a id="line.105"> // Binds using the username and password provided by the user.</a>
<span class="sourceLineNo">106</span><a id="line.106"> LdapContext ctx = null;</a>
<span class="sourceLineNo">107</span><a id="line.107"> try {</a>
<span class="sourceLineNo">108</span><a id="line.108"> ctx = ldapContextFactory.getLdapContext(upToken.getUsername(), String.valueOf(upToken.getPassword()));</a>
<span class="sourceLineNo">109</span><a id="line.109"> } finally {</a>
<span class="sourceLineNo">110</span><a id="line.110"> LdapUtils.closeContext(ctx);</a>
<span class="sourceLineNo">111</span><a id="line.111"> }</a>
<span class="sourceLineNo">112</span><a id="line.112"></a>
<span class="sourceLineNo">113</span><a id="line.113"> return buildAuthenticationInfo(upToken.getUsername(), upToken.getPassword());</a>
<span class="sourceLineNo">114</span><a id="line.114"> }</a>
<span class="sourceLineNo">115</span><a id="line.115"></a>
<span class="sourceLineNo">116</span><a id="line.116"> protected AuthenticationInfo buildAuthenticationInfo(String username, char[] password) {</a>
<span class="sourceLineNo">117</span><a id="line.117"> return new SimpleAuthenticationInfo(username, password, getName());</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>
<span class="sourceLineNo">122</span><a id="line.122"> * Builds an {@link org.apache.shiro.authz.AuthorizationInfo} object by querying the active directory LDAP context for the</a>
<span class="sourceLineNo">123</span><a id="line.123"> * groups that a user is a member of. The groups are then translated to role names by using the</a>
<span class="sourceLineNo">124</span><a id="line.124"> * configured {@link #groupRolesMap}.</a>
<span class="sourceLineNo">125</span><a id="line.125"> * &lt;p/&gt;</a>
<span class="sourceLineNo">126</span><a id="line.126"> * This implementation expects the &lt;tt&gt;principal&lt;/tt&gt; argument to be a String username.</a>
<span class="sourceLineNo">127</span><a id="line.127"> * &lt;p/&gt;</a>
<span class="sourceLineNo">128</span><a id="line.128"> * Subclasses can override this method to determine authorization data (roles, permissions, etc) in a more</a>
<span class="sourceLineNo">129</span><a id="line.129"> * complex way. Note that this default implementation does not support permissions, only roles.</a>
<span class="sourceLineNo">130</span><a id="line.130"> *</a>
<span class="sourceLineNo">131</span><a id="line.131"> * @param principals the principal of the Subject whose account is being retrieved.</a>
<span class="sourceLineNo">132</span><a id="line.132"> * @param ldapContextFactory the factory used to create LDAP connections.</a>
<span class="sourceLineNo">133</span><a id="line.133"> * @return the AuthorizationInfo for the given Subject principal.</a>
<span class="sourceLineNo">134</span><a id="line.134"> * @throws NamingException if an error occurs when searching the LDAP server.</a>
<span class="sourceLineNo">135</span><a id="line.135"> */</a>
<span class="sourceLineNo">136</span><a id="line.136"> protected AuthorizationInfo queryForAuthorizationInfo(PrincipalCollection principals, LdapContextFactory ldapContextFactory) throws NamingException {</a>
<span class="sourceLineNo">137</span><a id="line.137"></a>
<span class="sourceLineNo">138</span><a id="line.138"> String username = (String) getAvailablePrincipal(principals);</a>
<span class="sourceLineNo">139</span><a id="line.139"></a>
<span class="sourceLineNo">140</span><a id="line.140"> // Perform context search</a>
<span class="sourceLineNo">141</span><a id="line.141"> LdapContext ldapContext = ldapContextFactory.getSystemLdapContext();</a>
<span class="sourceLineNo">142</span><a id="line.142"></a>
<span class="sourceLineNo">143</span><a id="line.143"> Set&lt;String&gt; roleNames;</a>
<span class="sourceLineNo">144</span><a id="line.144"></a>
<span class="sourceLineNo">145</span><a id="line.145"> try {</a>
<span class="sourceLineNo">146</span><a id="line.146"> roleNames = getRoleNamesForUser(username, ldapContext);</a>
<span class="sourceLineNo">147</span><a id="line.147"> } finally {</a>
<span class="sourceLineNo">148</span><a id="line.148"> LdapUtils.closeContext(ldapContext);</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"> return buildAuthorizationInfo(roleNames);</a>
<span class="sourceLineNo">152</span><a id="line.152"> }</a>
<span class="sourceLineNo">153</span><a id="line.153"></a>
<span class="sourceLineNo">154</span><a id="line.154"> protected AuthorizationInfo buildAuthorizationInfo(Set&lt;String&gt; roleNames) {</a>
<span class="sourceLineNo">155</span><a id="line.155"> return new SimpleAuthorizationInfo(roleNames);</a>
<span class="sourceLineNo">156</span><a id="line.156"> }</a>
<span class="sourceLineNo">157</span><a id="line.157"></a>
<span class="sourceLineNo">158</span><a id="line.158"> protected Set&lt;String&gt; getRoleNamesForUser(String username, LdapContext ldapContext) throws NamingException {</a>
<span class="sourceLineNo">159</span><a id="line.159"> Set&lt;String&gt; roleNames;</a>
<span class="sourceLineNo">160</span><a id="line.160"> roleNames = new LinkedHashSet&lt;String&gt;();</a>
<span class="sourceLineNo">161</span><a id="line.161"></a>
<span class="sourceLineNo">162</span><a id="line.162"> SearchControls searchCtls = new SearchControls();</a>
<span class="sourceLineNo">163</span><a id="line.163"> searchCtls.setSearchScope(SearchControls.SUBTREE_SCOPE);</a>
<span class="sourceLineNo">164</span><a id="line.164"></a>
<span class="sourceLineNo">165</span><a id="line.165"> String userPrincipalName = username;</a>
<span class="sourceLineNo">166</span><a id="line.166"> if (principalSuffix != null &amp;&amp; !userPrincipalName.toLowerCase(Locale.ROOT).endsWith(principalSuffix.toLowerCase(Locale.ROOT))) {</a>
<span class="sourceLineNo">167</span><a id="line.167"> userPrincipalName += principalSuffix;</a>
<span class="sourceLineNo">168</span><a id="line.168"> }</a>
<span class="sourceLineNo">169</span><a id="line.169"></a>
<span class="sourceLineNo">170</span><a id="line.170"> Object[] searchArguments = new Object[]{userPrincipalName};</a>
<span class="sourceLineNo">171</span><a id="line.171"></a>
<span class="sourceLineNo">172</span><a id="line.172"> NamingEnumeration answer = ldapContext.search(searchBase, searchFilter, searchArguments, searchCtls);</a>
<span class="sourceLineNo">173</span><a id="line.173"></a>
<span class="sourceLineNo">174</span><a id="line.174"> while (answer.hasMoreElements()) {</a>
<span class="sourceLineNo">175</span><a id="line.175"> SearchResult sr = (SearchResult) answer.next();</a>
<span class="sourceLineNo">176</span><a id="line.176"></a>
<span class="sourceLineNo">177</span><a id="line.177"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">178</span><a id="line.178"> log.debug("Retrieving group names for user [" + sr.getName() + "]");</a>
<span class="sourceLineNo">179</span><a id="line.179"> }</a>
<span class="sourceLineNo">180</span><a id="line.180"></a>
<span class="sourceLineNo">181</span><a id="line.181"> Attributes attrs = sr.getAttributes();</a>
<span class="sourceLineNo">182</span><a id="line.182"></a>
<span class="sourceLineNo">183</span><a id="line.183"> if (attrs != null) {</a>
<span class="sourceLineNo">184</span><a id="line.184"> NamingEnumeration ae = attrs.getAll();</a>
<span class="sourceLineNo">185</span><a id="line.185"> while (ae.hasMore()) {</a>
<span class="sourceLineNo">186</span><a id="line.186"> Attribute attr = (Attribute) ae.next();</a>
<span class="sourceLineNo">187</span><a id="line.187"></a>
<span class="sourceLineNo">188</span><a id="line.188"> if (attr.getID().equals("memberOf")) {</a>
<span class="sourceLineNo">189</span><a id="line.189"></a>
<span class="sourceLineNo">190</span><a id="line.190"> Collection&lt;String&gt; groupNames = LdapUtils.getAllAttributeValues(attr);</a>
<span class="sourceLineNo">191</span><a id="line.191"></a>
<span class="sourceLineNo">192</span><a id="line.192"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">193</span><a id="line.193"> log.debug("Groups found for user [" + username + "]: " + groupNames);</a>
<span class="sourceLineNo">194</span><a id="line.194"> }</a>
<span class="sourceLineNo">195</span><a id="line.195"></a>
<span class="sourceLineNo">196</span><a id="line.196"> Collection&lt;String&gt; rolesForGroups = getRoleNamesForGroups(groupNames);</a>
<span class="sourceLineNo">197</span><a id="line.197"> roleNames.addAll(rolesForGroups);</a>
<span class="sourceLineNo">198</span><a id="line.198"> }</a>
<span class="sourceLineNo">199</span><a id="line.199"> }</a>
<span class="sourceLineNo">200</span><a id="line.200"> }</a>
<span class="sourceLineNo">201</span><a id="line.201"> }</a>
<span class="sourceLineNo">202</span><a id="line.202"> return roleNames;</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"> /**</a>
<span class="sourceLineNo">206</span><a id="line.206"> * This method is called by the default implementation to translate Active Directory group names</a>
<span class="sourceLineNo">207</span><a id="line.207"> * to role names. This implementation uses the {@link #groupRolesMap} to map group names to role names.</a>
<span class="sourceLineNo">208</span><a id="line.208"> *</a>
<span class="sourceLineNo">209</span><a id="line.209"> * @param groupNames the group names that apply to the current user.</a>
<span class="sourceLineNo">210</span><a id="line.210"> * @return a collection of roles that are implied by the given role names.</a>
<span class="sourceLineNo">211</span><a id="line.211"> */</a>
<span class="sourceLineNo">212</span><a id="line.212"> protected Collection&lt;String&gt; getRoleNamesForGroups(Collection&lt;String&gt; groupNames) {</a>
<span class="sourceLineNo">213</span><a id="line.213"> Set&lt;String&gt; roleNames = new HashSet&lt;String&gt;(groupNames.size());</a>
<span class="sourceLineNo">214</span><a id="line.214"></a>
<span class="sourceLineNo">215</span><a id="line.215"> if (groupRolesMap != null) {</a>
<span class="sourceLineNo">216</span><a id="line.216"> for (String groupName : groupNames) {</a>
<span class="sourceLineNo">217</span><a id="line.217"> String strRoleNames = groupRolesMap.get(groupName);</a>
<span class="sourceLineNo">218</span><a id="line.218"> if (strRoleNames != null) {</a>
<span class="sourceLineNo">219</span><a id="line.219"> for (String roleName : strRoleNames.split(ROLE_NAMES_DELIMETER)) {</a>
<span class="sourceLineNo">220</span><a id="line.220"></a>
<span class="sourceLineNo">221</span><a id="line.221"> if (log.isDebugEnabled()) {</a>
<span class="sourceLineNo">222</span><a id="line.222"> log.debug("User is member of group [" + groupName + "] so adding role [" + roleName + "]");</a>
<span class="sourceLineNo">223</span><a id="line.223"> }</a>
<span class="sourceLineNo">224</span><a id="line.224"></a>
<span class="sourceLineNo">225</span><a id="line.225"> roleNames.add(roleName);</a>
<span class="sourceLineNo">226</span><a id="line.226"></a>
<span class="sourceLineNo">227</span><a id="line.227"> }</a>
<span class="sourceLineNo">228</span><a id="line.228"> }</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"> return roleNames;</a>
<span class="sourceLineNo">232</span><a id="line.232"> }</a>
<span class="sourceLineNo">233</span><a id="line.233"></a>
<span class="sourceLineNo">234</span><a id="line.234">}</a>
</pre>
</div>
</main>
</body>
</html>