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