Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.0-RC2 / xref / org / apache / shiro / realm / ldap / DefaultLdapRealm.html
blob: 80d9557eeb6a23a698b37ac59da2847903db6a55 [file] [log] [blame]
<!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=UTF-8" />
<title>DefaultLdapRealm xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/realm/ldap/DefaultLdapRealm.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.realm.ldap;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.SimpleAuthenticationInfo;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.credential.AllowAllCredentialsMatcher;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authz.AuthorizationInfo;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.ldap.UnsupportedAuthenticationMechanismException;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.realm.AuthorizingRealm;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="L34" href="#L34">34</a>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> javax.naming.AuthenticationNotSupportedException;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> javax.naming.NamingException;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> javax.naming.ldap.LdapContext;
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * An LDAP {@link org.apache.shiro.realm.Realm Realm} implementation utilizing Sun's/Oracle's</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * &lt;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>"&gt;JNDI API as an LDAP API&lt;/a&gt;. This is</em>
<a class="jxr_linenumber" name="L42" href="#L42">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 class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * support for many years.</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * This realm implementation and its backing {@link JndiLdapContextFactory} should cover 99% of all Shiro-related LDAP</em>
<a class="jxr_linenumber" name="L46" href="#L46">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 class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * creating your own realm using an alternative, perhaps more robust, LDAP communication API, such as the</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://directory.apache.org/api/" target="alexandria_uri">http://directory.apache.org/api/</a>"&gt;Apache LDAP API&lt;/a&gt;.</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * &lt;h2&gt;Authentication&lt;/h2&gt;</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * During an authentication attempt, if the submitted {@code AuthenticationToken}'s</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.authc.AuthenticationToken#getPrincipal() principal} is a simple username, but the</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * LDAP directory expects a complete User Distinguished Name (User DN) to establish a connection, the</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * {@link #setUserDnTemplate(String) userDnTemplate} property must be configured. If not configured,</em>
<a class="jxr_linenumber" name="L54" href="#L54">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 class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * environments (maybe Microsoft ActiveDirectory being the exception).</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * &lt;h2&gt;Authorization&lt;/h2&gt;</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * By default, authorization is effectively disabled due to the default</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * {@link #doGetAuthorizationInfo(org.apache.shiro.subject.PrincipalCollection)} implementation returning {@code null}.</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * If you wish to perform authorization based on an LDAP schema, you must subclass this one</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * and override that method to reflect your organization's data model.</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * &lt;h2&gt;Configuration&lt;/h2&gt;</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * This class primarily provides the {@link #setUserDnTemplate(String) userDnTemplate} property to allow you to specify</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * the your LDAP server's User DN format. Most other configuration is performed via the nested</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * {@link LdapContextFactory contextFactory} property.</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * For example, defining this realm in Shiro .ini:</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * [main]</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * ldapRealm = org.apache.shiro.realm.ldap.DefaultLdapRealm</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * ldapRealm.userDnTemplate = uid={0},ou=users,dc=mycompany,dc=com</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * ldapRealm.contextFactory.url = ldap://ldapHost:389</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * ldapRealm.contextFactory.authenticationMechanism = DIGEST-MD5</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * ldapRealm.contextFactory.environment[some.obscure.jndi.key] = some value</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * ...</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * The default {@link #setContextFactory contextFactory} instance is a {@link JndiLdapContextFactory}. See that</em>
<a class="jxr_linenumber" name="L77" href="#L77">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 class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * properties as necessary.</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @see JndiLdapContextFactory</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * @since 1.3</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapRealm.html">DefaultLdapRealm</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/realm/AuthorizingRealm.html">AuthorizingRealm</a> {
<a class="jxr_linenumber" name="L85" href="#L85">85</a>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(DefaultLdapRealm.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">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 class="jxr_linenumber" name="L89" href="#L89">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 class="jxr_linenumber" name="L90" href="#L90">90</a>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> String userDnPrefix;
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">private</strong> String userDnSuffix;
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L95" href="#L95">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 class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * The LdapContextFactory instance used to acquire {@link javax.naming.ldap.LdapContext LdapContext}'s at runtime</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * to acquire connections to the LDAP directory to perform authentication attempts and authorizatino queries.</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html">LdapContextFactory</a> contextFactory;
<a class="jxr_linenumber" name="L102" href="#L102">102</a>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_comment"> | C O N S T R U C T O R S |</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Default no-argument constructor that defaults the internal {@link LdapContextFactory} instance to a</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * {@link JndiLdapContextFactory}.</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/realm/ldap/DefaultLdapRealm.html">DefaultLdapRealm</a>() {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_comment">//Credentials Matching is not necessary - the LDAP directory will do it automatically:</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> setCredentialsMatcher(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/authc/credential/AllowAllCredentialsMatcher.html">AllowAllCredentialsMatcher</a>());
<a class="jxr_linenumber" name="L114" href="#L114">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 class="jxr_linenumber" name="L115" href="#L115">115</a> setAuthenticationTokenClass(AuthenticationToken.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L116" href="#L116">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 class="jxr_linenumber" name="L117" href="#L117">117</a> }
<a class="jxr_linenumber" name="L118" href="#L118">118</a>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L120" href="#L120">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 class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L124" href="#L124">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 class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * {@link #getUserDnTemplate() userDnTemplate} has been configured. If configured, this value is the text that</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * occurs before the {@link #USERDN_SUBSTITUTION_TOKEN} in the {@link #getUserDnTemplate() userDnTemplate} value.</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L128" href="#L128">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 class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * {@link #getUserDnTemplate() userDnTemplate} has been configured.</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">protected</strong> String getUserDnPrefix() {
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">return</strong> userDnPrefix;
<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
<a class="jxr_linenumber" name="L134" href="#L134">134</a>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L136" href="#L136">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 class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * {@link #getUserDnTemplate() userDnTemplate} has been configured. If configured, this value is the text that</em>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * occurs after the {@link #USERDN_SUBSTITUTION_TOKEN} in the {@link #getUserDnTemplate() userDnTemplate} value.</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L140" href="#L140">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 class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * {@link #getUserDnTemplate() userDnTemplate} has been configured.</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">protected</strong> String getUserDnSuffix() {
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">return</strong> userDnSuffix;
<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
<a class="jxr_linenumber" name="L146" href="#L146">146</a>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_comment"> | M E T H O D S |</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L152" href="#L152">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 class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * fully-qualified unique user identifier which is required to establish a connection with the LDAP</em>
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * directory to authenticate users and query for authorization information.</em>
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * &lt;h2&gt;Usage&lt;/h2&gt;</em>
<a class="jxr_linenumber" name="L156" href="#L156">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 class="jxr_linenumber" name="L157" href="#L157">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 class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * but you use a &lt;b&gt;{@code {0}}&lt;/b&gt; placeholder token in the string representing the location where the</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * user's submitted principal (usually a username or uid) will be substituted at runtime.</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * For example, if your directory</em>
<a class="jxr_linenumber" name="L162" href="#L162">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 class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * this:</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;uid=jsmith,ou=users,dc=mycompany,dc=com&lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * in which case you would set this property with the following template value:</em>
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;uid=&lt;b&gt;{0}&lt;/b&gt;,ou=users,dc=mycompany,dc=com&lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * If no template is configured, the raw {@code AuthenticationToken}</em>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken#getPrincipal() principal} will be used as the LDAP principal. This is likely</em>
<a class="jxr_linenumber" name="L173" href="#L173">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 class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * ensure you set this property to match your environment!</em>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @param template the User Distinguished Name template to use for runtime substitution</em>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if the template is null, empty, or does not contain the</em>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * {@code {0}} substitution token.</em>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @see LdapContextFactory#getLdapContext(Object,Object)</em>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L181" href="#L181">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 class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(template)) {
<a class="jxr_linenumber" name="L183" href="#L183">183</a> String msg = <span class="jxr_string">"User DN template cannot be null or empty."</span>;
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(msg);
<a class="jxr_linenumber" name="L185" href="#L185">185</a> }
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">int</strong> index = template.indexOf(USERDN_SUBSTITUTION_TOKEN);
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">if</strong> (index &lt; 0) {
<a class="jxr_linenumber" name="L188" href="#L188">188</a> String msg = <span class="jxr_string">"User DN template must contain the '"</span> +
<a class="jxr_linenumber" name="L189" href="#L189">189</a> USERDN_SUBSTITUTION_TOKEN + <span class="jxr_string">"' replacement token to understand where to "</span> +
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <span class="jxr_string">"insert the runtime authentication principal."</span>;
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(msg);
<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
<a class="jxr_linenumber" name="L193" href="#L193">193</a> String prefix = template.substring(0, index);
<a class="jxr_linenumber" name="L194" href="#L194">194</a> String suffix = template.substring(prefix.length() + USERDN_SUBSTITUTION_TOKEN.length());
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) {
<a class="jxr_linenumber" name="L196" href="#L196">196</a> log.debug(<span class="jxr_string">"Determined user DN prefix [{}] and suffix [{}]"</span>, prefix, suffix);
<a class="jxr_linenumber" name="L197" href="#L197">197</a> }
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">this</strong>.userDnPrefix = prefix;
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">this</strong>.userDnSuffix = suffix;
<a class="jxr_linenumber" name="L200" href="#L200">200</a> }
<a class="jxr_linenumber" name="L201" href="#L201">201</a>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L203" href="#L203">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 class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * {@link #setUserDnTemplate(String) setUserDnTemplate} JavaDoc for a full explanation.</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * @return the User Distinguished Name (DN) template to use when creating User DNs at runtime.</em>
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">public</strong> String getUserDnTemplate() {
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">return</strong> getUserDn(USERDN_SUBSTITUTION_TOKEN);
<a class="jxr_linenumber" name="L210" href="#L210">210</a> }
<a class="jxr_linenumber" name="L211" href="#L211">211</a>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * Returns the LDAP User Distinguished Name (DN) to use when acquiring an</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * {@link javax.naming.ldap.LdapContext LdapContext} from the {@link LdapContextFactory}.</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * If the the {@link #getUserDnTemplate() userDnTemplate} property has been set, this implementation will construct</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * the User DN by substituting the specified {@code principal} into the configured template. If the</em>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * {@link #getUserDnTemplate() userDnTemplate} has not been set, the method argument will be returned directly</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * (indicating that the submitted authentication token principal &lt;em&gt;is&lt;/em&gt; the User DN).</em>
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * @param principal the principal to substitute into the configured {@link #getUserDnTemplate() userDnTemplate}.</em>
<a class="jxr_linenumber" name="L222" href="#L222">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 class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if the method argument is null or empty</em>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException if the {@link #getUserDnTemplate userDnTemplate} has not been set.</em>
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * @see LdapContextFactory#getLdapContext(Object, Object)</em>
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">protected</strong> String getUserDn(String principal) <strong class="jxr_keyword">throws</strong> IllegalArgumentException, IllegalStateException {
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(principal)) {
<a class="jxr_linenumber" name="L229" href="#L229">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 class="jxr_linenumber" name="L230" href="#L230">230</a> }
<a class="jxr_linenumber" name="L231" href="#L231">231</a> String prefix = getUserDnPrefix();
<a class="jxr_linenumber" name="L232" href="#L232">232</a> String suffix = getUserDnSuffix();
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">if</strong> (prefix == <strong class="jxr_keyword">null</strong> &amp;&amp; suffix == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L234" href="#L234">234</a> log.debug(<span class="jxr_string">"userDnTemplate property has not been configured, indicating the submitted "</span> +
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <span class="jxr_string">"AuthenticationToken's principal is the same as the User DN. Returning the method argument "</span> +
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <span class="jxr_string">"as is."</span>);
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">return</strong> principal;
<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
<a class="jxr_linenumber" name="L239" href="#L239">239</a>
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">int</strong> prefixLength = prefix != <strong class="jxr_keyword">null</strong> ? prefix.length() : 0;
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">int</strong> suffixLength = suffix != <strong class="jxr_keyword">null</strong> ? suffix.length() : 0;
<a class="jxr_linenumber" name="L242" href="#L242">242</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(prefixLength + principal.length() + suffixLength);
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">if</strong> (prefixLength &gt; 0) {
<a class="jxr_linenumber" name="L244" href="#L244">244</a> sb.append(prefix);
<a class="jxr_linenumber" name="L245" href="#L245">245</a> }
<a class="jxr_linenumber" name="L246" href="#L246">246</a> sb.append(principal);
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">if</strong> (suffixLength &gt; 0) {
<a class="jxr_linenumber" name="L248" href="#L248">248</a> sb.append(suffix);
<a class="jxr_linenumber" name="L249" href="#L249">249</a> }
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">return</strong> sb.toString();
<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
<a class="jxr_linenumber" name="L252" href="#L252">252</a>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * Sets the LdapContextFactory instance used to acquire connections to the LDAP directory during authentication</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * attempts and authorization queries. Unless specified otherwise, the default is a {@link JndiLdapContextFactory}</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * instance.</em>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @param contextFactory the LdapContextFactory instance used to acquire connections to the LDAP directory during</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * authentication attempts and authorization queries</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L262" href="#L262">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 class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">this</strong>.contextFactory = contextFactory;
<a class="jxr_linenumber" name="L264" href="#L264">264</a> }
<a class="jxr_linenumber" name="L265" href="#L265">265</a>
<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * Returns the LdapContextFactory instance used to acquire connections to the LDAP directory during authentication</em>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * attempts and authorization queries. Unless specified otherwise, the default is a {@link JndiLdapContextFactory}</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * instance.</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @return the LdapContextFactory instance used to acquire connections to the LDAP directory during</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * authentication attempts and authorization queries</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html">LdapContextFactory</a> getContextFactory() {
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.contextFactory;
<a class="jxr_linenumber" name="L276" href="#L276">276</a> }
<a class="jxr_linenumber" name="L277" href="#L277">277</a>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_comment">/*--------------------------------------------</em>
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_comment"> | M E T H O D S |</em>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_comment"> ============================================*/</em>
<a class="jxr_linenumber" name="L281" href="#L281">281</a>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * Delegates to {@link #queryForAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken, LdapContextFactory)},</em>
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * wrapping any {@link NamingException}s in a Shiro {@link AuthenticationException} to satisfy the parent method</em>
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * signature.</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @param token the authentication token containing the user's principal and credentials.</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @return the {@link AuthenticationInfo} acquired after a successful authentication attempt</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @throws AuthenticationException if the authentication attempt fails or if a</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * {@link NamingException} occurs.</em>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L292" href="#L292">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 class="jxr_linenumber" name="L293" href="#L293">293</a> <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info;
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L295" href="#L295">295</a> info = queryForAuthenticationInfo(token, getContextFactory());
<a class="jxr_linenumber" name="L296" href="#L296">296</a> } <strong class="jxr_keyword">catch</strong> (AuthenticationNotSupportedException e) {
<a class="jxr_linenumber" name="L297" href="#L297">297</a> String msg = <span class="jxr_string">"Unsupported configured authentication mechanism"</span>;
<a class="jxr_linenumber" name="L298" href="#L298">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 class="jxr_linenumber" name="L299" href="#L299">299</a> } <strong class="jxr_keyword">catch</strong> (javax.naming.AuthenticationException e) {
<a class="jxr_linenumber" name="L300" href="#L300">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 class="jxr_linenumber" name="L301" href="#L301">301</a> } <strong class="jxr_keyword">catch</strong> (NamingException e) {
<a class="jxr_linenumber" name="L302" href="#L302">302</a> String msg = <span class="jxr_string">"LDAP naming error while attempting to authenticate user."</span>;
<a class="jxr_linenumber" name="L303" href="#L303">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 class="jxr_linenumber" name="L304" href="#L304">304</a> }
<a class="jxr_linenumber" name="L305" href="#L305">305</a>
<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">return</strong> info;
<a class="jxr_linenumber" name="L307" href="#L307">307</a> }
<a class="jxr_linenumber" name="L308" href="#L308">308</a>
<a class="jxr_linenumber" name="L309" href="#L309">309</a>
<a class="jxr_linenumber" name="L310" href="#L310">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 class="jxr_linenumber" name="L311" href="#L311">311</a> <a href="../../../../../org/apache/shiro/authz/AuthorizationInfo.html">AuthorizationInfo</a> info;
<a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L313" href="#L313">313</a> info = queryForAuthorizationInfo(principals, getContextFactory());
<a class="jxr_linenumber" name="L314" href="#L314">314</a> } <strong class="jxr_keyword">catch</strong> (NamingException e) {
<a class="jxr_linenumber" name="L315" href="#L315">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 class="jxr_linenumber" name="L316" href="#L316">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 class="jxr_linenumber" name="L317" href="#L317">317</a> }
<a class="jxr_linenumber" name="L318" href="#L318">318</a>
<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">return</strong> info;
<a class="jxr_linenumber" name="L320" href="#L320">320</a> }
<a class="jxr_linenumber" name="L321" href="#L321">321</a>
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * Returns the principal to use when creating the LDAP connection for an authentication attempt.</em>
<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * This implementation uses a heuristic: it checks to see if the specified token's</em>
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken#getPrincipal() principal} is a {@code String}, and if so,</em>
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * {@link #getUserDn(String) converts it} from what is</em>
<a class="jxr_linenumber" name="L328" href="#L328">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 class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * expect the authentication connection to present a User DN and not an unqualified username or uid.</em>
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L331" href="#L331">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 class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * underlying {@link LdapContextFactory} implementation and the raw principal is returned directly.</em>
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * @param token the {@link AuthenticationToken} submitted during the authentication process</em>
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * @return the User DN or raw principal to use to acquire the LdapContext.</em>
<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @see LdapContextFactory#getLdapContext(Object, Object)</em>
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">protected</strong> Object getLdapPrincipal(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) {
<a class="jxr_linenumber" name="L339" href="#L339">339</a> Object principal = token.getPrincipal();
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">if</strong> (principal instanceof String) {
<a class="jxr_linenumber" name="L341" href="#L341">341</a> String sPrincipal = (String) principal;
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">return</strong> getUserDn(sPrincipal);
<a class="jxr_linenumber" name="L343" href="#L343">343</a> }
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">return</strong> principal;
<a class="jxr_linenumber" name="L345" href="#L345">345</a> }
<a class="jxr_linenumber" name="L346" href="#L346">346</a>
<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> * This implementation opens an LDAP connection using the token's</em>
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * {@link #getLdapPrincipal(org.apache.shiro.authc.AuthenticationToken) discovered principal} and provided</em>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken#getCredentials() credentials}. If the connection opens successfully, the</em>
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * authentication attempt is immediately considered successful and a new</em>
<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * {@link AuthenticationInfo} instance is</em>
<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> * {@link #createAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken, Object, Object, javax.naming.ldap.LdapContext) created}</em>
<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment"> * and returned. If the connection cannot be opened, either because LDAP authentication failed or some other</em>
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * JNDI problem, an {@link NamingException} will be thrown.</em>
<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * @param token the submitted authentication token that triggered the authentication attempt.</em>
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * @param ldapContextFactory factory used to retrieve LDAP connections.</em>
<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> * @return an {@link AuthenticationInfo} instance representing the authenticated user's information.</em>
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment"> * @throws NamingException if any LDAP errors occur.</em>
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L362" href="#L362">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 class="jxr_linenumber" name="L363" href="#L363">363</a> <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html">LdapContextFactory</a> ldapContextFactory)
<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L365" href="#L365">365</a>
<a class="jxr_linenumber" name="L366" href="#L366">366</a> Object principal = token.getPrincipal();
<a class="jxr_linenumber" name="L367" href="#L367">367</a> Object credentials = token.getCredentials();
<a class="jxr_linenumber" name="L368" href="#L368">368</a>
<a class="jxr_linenumber" name="L369" href="#L369">369</a> log.debug(<span class="jxr_string">"Authenticating user '{}' through LDAP"</span>, principal);
<a class="jxr_linenumber" name="L370" href="#L370">370</a>
<a class="jxr_linenumber" name="L371" href="#L371">371</a> principal = getLdapPrincipal(token);
<a class="jxr_linenumber" name="L372" href="#L372">372</a>
<a class="jxr_linenumber" name="L373" href="#L373">373</a> LdapContext ctx = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L375" href="#L375">375</a> ctx = ldapContextFactory.getLdapContext(principal, credentials);
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_comment">//context was opened successfully, which means their credentials were valid. Return the AuthenticationInfo:</em>
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">return</strong> createAuthenticationInfo(token, principal, credentials, ctx);
<a class="jxr_linenumber" name="L378" href="#L378">378</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L379" href="#L379">379</a> LdapUtils.closeContext(ctx);
<a class="jxr_linenumber" name="L380" href="#L380">380</a> }
<a class="jxr_linenumber" name="L381" href="#L381">381</a> }
<a class="jxr_linenumber" name="L382" href="#L382">382</a>
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> * Returns the {@link AuthenticationInfo} resulting from a Subject's successful LDAP authentication attempt.</em>
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * This implementation ignores the {@code ldapPrincipal}, {@code ldapCredentials}, and the opened</em>
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * {@code ldapContext} arguments and merely returns an {@code AuthenticationInfo} instance mirroring the</em>
<a class="jxr_linenumber" name="L388" href="#L388">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 class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * a successful authentication attempt, which means the provided principal and credentials were correct, and can</em>
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * be used directly to populate the (now verified) {@code AuthenticationInfo}.</em>
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * Subclasses however are free to override this method for more advanced construction logic.</em>
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * @param token the submitted {@code AuthenticationToken} that resulted in a successful authentication</em>
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * @param ldapPrincipal the LDAP principal used when creating the LDAP connection. Unlike the token's</em>
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken#getPrincipal() principal}, this value is usually a constructed</em>
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * User DN and not a simple username or uid. The exact value is depending on the</em>
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * configured</em>
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> * &lt;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>"&gt;</em>
<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * LDAP authentication mechanism&lt;/a&gt; in use.</em>
<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * @param ldapCredentials the LDAP credentials used when creating the LDAP connection.</em>
<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> * @param ldapContext the LdapContext created that resulted in a successful authentication. It can be used</em>
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> * further by subclasses for more complex operations. It does not need to be closed -</em>
<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * it will be closed automatically after this method returns.</em>
<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * @return the {@link AuthenticationInfo} resulting from a Subject's successful LDAP authentication attempt.</em>
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * @throws NamingException if there was any problem using the {@code LdapContext}</em>
<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L408" href="#L408">408</a> @SuppressWarnings({<span class="jxr_string">"UnusedDeclaration"</span>})
<a class="jxr_linenumber" name="L409" href="#L409">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 class="jxr_linenumber" name="L410" href="#L410">410</a> Object ldapCredentials, LdapContext ldapContext)
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L412" href="#L412">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 class="jxr_linenumber" name="L413" href="#L413">413</a> }
<a class="jxr_linenumber" name="L414" href="#L414">414</a>
<a class="jxr_linenumber" name="L415" href="#L415">415</a>
<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment"> * Method that should be implemented by subclasses to build an</em>
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> * {@link AuthorizationInfo} object by querying the LDAP context for the</em>
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> * specified principal.&lt;/p&gt;</em>
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * @param principals the principals of the Subject whose AuthenticationInfo should be queried from the LDAP server.</em>
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * @param ldapContextFactory factory used to retrieve LDAP connections.</em>
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * @return an {@link AuthorizationInfo} instance containing information retrieved from the LDAP server.</em>
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> * @throws NamingException if any LDAP errors occur during the search.</em>
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L426" href="#L426">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 class="jxr_linenumber" name="L427" href="#L427">427</a> <a href="../../../../../org/apache/shiro/realm/ldap/LdapContextFactory.html">LdapContextFactory</a> ldapContextFactory) <strong class="jxr_keyword">throws</strong> NamingException {
<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L429" href="#L429">429</a> }
<a class="jxr_linenumber" name="L430" href="#L430">430</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>