| <!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>BasicHttpAuthenticationFilter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.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.web.filter.authc; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Base64; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="26" href="#26">26</a> |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; |
| <a name="31" href="#31">31</a> |
| <a name="32" href="#32">32</a> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Requires the requesting user to be {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated} for the</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * request to continue, and if they're not, requires the user to login via the HTTP Basic protocol-specific challenge.</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Upon successful login, they're allowed to continue on to the requested resource/url.</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * This implementation is a 'clean room' Java implementation of Basic HTTP Authentication specification per</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <a href="ftp://ftp.isi.edu/in-notes/rfc2617.txt">RFC 2617</a>.</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Basic authentication functions as follows:</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * <li>A request comes in for a resource that requires authentication.</li></em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <li>The server replies with a 401 response status, sets the <code>WWW-Authenticate</code> header, and the contents of a</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * page informing the user that the incoming resource requires authentication.</li></em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <li>Upon receiving this <code>WWW-Authenticate</code> challenge from the server, the client then takes a</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * username and a password and puts them in the following format:</em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <p><code>username:password</code></p></li></em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <li>This token is then base 64 encoded.</li></em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <li>The client then sends another request for the same resource with the following header:<br/></em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <p><code>Authorization: Basic <em>Base64_encoded_username_and_password</em></code></p></li></em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * The {@link #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method will</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * only be called if the subject making the request is not</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated}</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @see <a href="ftp://ftp.isi.edu/in-notes/rfc2617.txt">RFC 2617</a></em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://en.wikipedia.org/wiki/Basic_access_authentication" target="alexandria_uri">http://en.wikipedia.org/wiki/Basic_access_authentication</a>">Basic Access Authentication</a></em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/shiro/web/filter/authc/BasicHttpAuthenticationFilter.html">BasicHttpAuthenticationFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/shiro/web/filter/authc/AuthenticatingFilter.html">AuthenticatingFilter</a> { |
| <a name="62" href="#62">62</a> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * This class's private logger.</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(BasicHttpAuthenticationFilter.<strong class="jxr_keyword">class</strong>); |
| <a name="67" href="#67">67</a> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * HTTP Authorization header, equal to <code>Authorization</code></em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="71" href="#71">71</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String AUTHORIZATION_HEADER = <span class="jxr_string">"Authorization"</span>; |
| <a name="72" href="#72">72</a> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * HTTP Authentication header, equal to <code>WWW-Authenticate</code></em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="76" href="#76">76</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String AUTHENTICATE_HEADER = <span class="jxr_string">"WWW-Authenticate"</span>; |
| <a name="77" href="#77">77</a> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * The name that is displayed during the challenge process of authentication, defauls to <code>application</code></em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * and can be overridden by the {@link #setApplicationName(String) setApplicationName} method.</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">private</strong> String applicationName = <span class="jxr_string">"application"</span>; |
| <a name="83" href="#83">83</a> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * The authcScheme to look for in the <code>Authorization</code> header, defaults to <code>BASIC</code></em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="87" href="#87">87</a> <strong class="jxr_keyword">private</strong> String authcScheme = HttpServletRequest.BASIC_AUTH; |
| <a name="88" href="#88">88</a> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * The authzScheme value to look for in the <code>Authorization</code> header, defaults to <code>BASIC</code></em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="92" href="#92">92</a> <strong class="jxr_keyword">private</strong> String authzScheme = HttpServletRequest.BASIC_AUTH; |
| <a name="93" href="#93">93</a> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * Returns the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * Per RFC 2617, this name name is displayed to the end user when they are asked to authenticate. Unless overridden</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * by the {@link #setApplicationName(String) setApplicationName(String)} method, the default value is 'application'.</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * Please see {@link #setApplicationName(String) setApplicationName(String)} for an example of how this functions.</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @return the name to use in the ServletResponse's 'WWW-Authenticate' header.</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="104" href="#104">104</a> <strong class="jxr_keyword">public</strong> String getApplicationName() { |
| <a name="105" href="#105">105</a> <strong class="jxr_keyword">return</strong> applicationName; |
| <a name="106" href="#106">106</a> } |
| <a name="107" href="#107">107</a> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * Sets the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * Per RFC 2617, this name name is displayed to the end user when they are asked to authenticate. Unless overridden</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * by this method, the default value is &quot;application&quot;</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * For example, setting this property to the value <b><code>Awesome Webapp</code></b> will result in the</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * following header:</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * <code>WWW-Authenticate: Basic realm=&quot;<b>Awesome Webapp</b>&quot;</code></em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Side note: As you can see from the header text, the HTTP Basic specification calls</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * this the authentication 'realm', but we call this the 'applicationName' instead to avoid confusion with</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * Shiro's Realm constructs.</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @param applicationName the name to use in the ServletResponse's 'WWW-Authenticate' header.</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="125" href="#125">125</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setApplicationName(String applicationName) { |
| <a name="126" href="#126">126</a> <strong class="jxr_keyword">this</strong>.applicationName = applicationName; |
| <a name="127" href="#127">127</a> } |
| <a name="128" href="#128">128</a> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * Returns the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating</em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * a login request.</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * Unless overridden by the {@link #setAuthzScheme(String) setAuthzScheme(String)} method, the</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * default value is <code>BASIC</code>.</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @return the Http 'Authorization' header value that this filter will respond to as indicating a login request</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="138" href="#138">138</a> <strong class="jxr_keyword">public</strong> String getAuthzScheme() { |
| <a name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> authzScheme; |
| <a name="140" href="#140">140</a> } |
| <a name="141" href="#141">141</a> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Sets the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating a</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * login request.</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * Unless overridden by this method, the default value is <code>BASIC</code></em> |
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @param authzScheme the HTTP <code>Authorization</code> header value that this filter will respond to as</em> |
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * indicating a login request.</em> |
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="151" href="#151">151</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthzScheme(String authzScheme) { |
| <a name="152" href="#152">152</a> <strong class="jxr_keyword">this</strong>.authzScheme = authzScheme; |
| <a name="153" href="#153">153</a> } |
| <a name="154" href="#154">154</a> |
| <a name="155" href="#155">155</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * Returns the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending</em> |
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * the HTTP Basic challenge response. The default value is <code>BASIC</code>.</em> |
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * @return the HTTP <code>WWW-Authenticate</code> header scheme that this filter will use when sending the HTTP</em> |
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * Basic challenge response.</em> |
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @see #sendChallenge</em> |
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="163" href="#163">163</a> <strong class="jxr_keyword">public</strong> String getAuthcScheme() { |
| <a name="164" href="#164">164</a> <strong class="jxr_keyword">return</strong> authcScheme; |
| <a name="165" href="#165">165</a> } |
| <a name="166" href="#166">166</a> |
| <a name="167" href="#167">167</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * Sets the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending the</em> |
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * HTTP Basic challenge response. The default value is <code>BASIC</code>.</em> |
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @param authcScheme the HTTP <code>WWW-Authenticate</code> header scheme that this filter will use when</em> |
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * sending the Http Basic challenge response.</em> |
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * @see #sendChallenge</em> |
| <a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="175" href="#175">175</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthcScheme(String authcScheme) { |
| <a name="176" href="#176">176</a> <strong class="jxr_keyword">this</strong>.authcScheme = authcScheme; |
| <a name="177" href="#177">177</a> } |
| <a name="178" href="#178">178</a> |
| <a name="179" href="#179">179</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * Processes unauthenticated requests. It handles the two-stage request/challenge authentication protocol.</em> |
| <a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * @param request incoming ServletRequest</em> |
| <a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * @param response outgoing ServletResponse</em> |
| <a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * @return true if the request should be processed; false if the request should not continue to be processed</em> |
| <a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="186" href="#186">186</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> onAccessDenied(ServletRequest request, ServletResponse response) <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="187" href="#187">187</a> <strong class="jxr_keyword">boolean</strong> loggedIn = false; <em class="jxr_comment">//false by default or we wouldn't be in this method</em> |
| <a name="188" href="#188">188</a> <strong class="jxr_keyword">if</strong> (isLoginAttempt(request, response)) { |
| <a name="189" href="#189">189</a> loggedIn = executeLogin(request, response); |
| <a name="190" href="#190">190</a> } |
| <a name="191" href="#191">191</a> <strong class="jxr_keyword">if</strong> (!loggedIn) { |
| <a name="192" href="#192">192</a> sendChallenge(request, response); |
| <a name="193" href="#193">193</a> } |
| <a name="194" href="#194">194</a> <strong class="jxr_keyword">return</strong> loggedIn; |
| <a name="195" href="#195">195</a> } |
| <a name="196" href="#196">196</a> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * Determines whether the incoming request is an attempt to log in.</em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * The default implementation obtains the value of the request's</em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * {@link #AUTHORIZATION_HEADER AUTHORIZATION_HEADER}, and if it is not <code>null</code>, delegates</em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * to {@link #isLoginAttempt(String) isLoginAttempt(authzHeaderValue)}. If the header is <code>null</code>,</em> |
| <a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * <code>false</code> is returned.</em> |
| <a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * @param request incoming ServletRequest</em> |
| <a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * @param response outgoing ServletResponse</em> |
| <a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * @return true if the incoming request is an attempt to log in based, false otherwise</em> |
| <a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="209" href="#209">209</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isLoginAttempt(ServletRequest request, ServletResponse response) { |
| <a name="210" href="#210">210</a> String authzHeader = getAuthzHeader(request); |
| <a name="211" href="#211">211</a> <strong class="jxr_keyword">return</strong> authzHeader != <strong class="jxr_keyword">null</strong> && isLoginAttempt(authzHeader); |
| <a name="212" href="#212">212</a> } |
| <a name="213" href="#213">213</a> |
| <a name="214" href="#214">214</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * Delegates to {@link #isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse) isLoginAttempt}.</em> |
| <a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="217" href="#217">217</a> @Override |
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isLoginRequest(ServletRequest request, ServletResponse response) { |
| <a name="219" href="#219">219</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.isLoginAttempt(request, response); |
| <a name="220" href="#220">220</a> } |
| <a name="221" href="#221">221</a> |
| <a name="222" href="#222">222</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * Returns the {@link #AUTHORIZATION_HEADER AUTHORIZATION_HEADER} from the specified ServletRequest.</em> |
| <a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * This implementation merely casts the request to an <code>HttpServletRequest</code> and returns the header:</em> |
| <a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> * <code>HttpServletRequest httpRequest = {@link WebUtils#toHttp(javax.servlet.ServletRequest) toHttp(reaquest)};<br/></em> |
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment"> * return httpRequest.getHeader({@link #AUTHORIZATION_HEADER AUTHORIZATION_HEADER});</code></em> |
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * @return the <code>Authorization</code> header's value.</em> |
| <a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="233" href="#233">233</a> <strong class="jxr_keyword">protected</strong> String getAuthzHeader(ServletRequest request) { |
| <a name="234" href="#234">234</a> HttpServletRequest httpRequest = WebUtils.toHttp(request); |
| <a name="235" href="#235">235</a> <strong class="jxr_keyword">return</strong> httpRequest.getHeader(AUTHORIZATION_HEADER); |
| <a name="236" href="#236">236</a> } |
| <a name="237" href="#237">237</a> |
| <a name="238" href="#238">238</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * Default implementation that returns <code>true</code> if the specified <code>authzHeader</code></em> |
| <a name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * starts with the same (case-insensitive) characters specified by the</em> |
| <a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * {@link #getAuthzScheme() authzScheme}, <code>false</code> otherwise.</em> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * That is:</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * <code>String authzScheme = getAuthzScheme().toLowerCase();<br/></em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * return authzHeader.toLowerCase().startsWith(authzScheme);</code></em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * @param authzHeader the 'Authorization' header value (guaranteed to be non-null if the</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * {@link #isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method is not overriden).</em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the authzHeader value matches that configured as defined by</em> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * the {@link #getAuthzScheme() authzScheme}.</em> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="253" href="#253">253</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isLoginAttempt(String authzHeader) { |
| <a name="254" href="#254">254</a> String authzScheme = getAuthzScheme().toLowerCase(); |
| <a name="255" href="#255">255</a> <strong class="jxr_keyword">return</strong> authzHeader.toLowerCase().startsWith(authzScheme); |
| <a name="256" href="#256">256</a> } |
| <a name="257" href="#257">257</a> |
| <a name="258" href="#258">258</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * Builds the challenge for authorization by setting a HTTP <code>401</code> (Unauthorized) status as well as the</em> |
| <a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * response's {@link #AUTHENTICATE_HEADER AUTHENTICATE_HEADER}.</em> |
| <a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="262" href="#262">262</a> <em class="jxr_javadoccomment"> * The header value constructed is equal to:</em> |
| <a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * <code>{@link #getAuthcScheme() getAuthcScheme()} + " realm=\"" + {@link #getApplicationName() getApplicationName()} + "\"";</code></em> |
| <a name="265" href="#265">265</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * @param request incoming ServletRequest, ignored by this implementation</em> |
| <a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * @param response outgoing ServletResponse</em> |
| <a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * @return false - this sends the challenge to be sent back</em> |
| <a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="270" href="#270">270</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> sendChallenge(ServletRequest request, ServletResponse response) { |
| <a name="271" href="#271">271</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a name="272" href="#272">272</a> log.debug(<span class="jxr_string">"Authentication required: sending 401 Authentication challenge response."</span>); |
| <a name="273" href="#273">273</a> } |
| <a name="274" href="#274">274</a> HttpServletResponse httpResponse = WebUtils.toHttp(response); |
| <a name="275" href="#275">275</a> httpResponse.setStatus(HttpServletResponse.SC_UNAUTHORIZED); |
| <a name="276" href="#276">276</a> String authcHeader = getAuthcScheme() + <span class="jxr_string">" realm=\""</span> + getApplicationName() + <span class="jxr_string">"\""</span>; |
| <a name="277" href="#277">277</a> httpResponse.setHeader(AUTHENTICATE_HEADER, authcHeader); |
| <a name="278" href="#278">278</a> <strong class="jxr_keyword">return</strong> false; |
| <a name="279" href="#279">279</a> } |
| <a name="280" href="#280">280</a> |
| <a name="281" href="#281">281</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * Creates an AuthenticationToken for use during login attempt with the provided credentials in the http header.</em> |
| <a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * This implementation:</em> |
| <a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * <ol><li>acquires the username and password based on the request's</em> |
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authorization header} via the</em> |
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * {@link #getPrincipalsAndCredentials(String, javax.servlet.ServletRequest) getPrincipalsAndCredentials} method</li></em> |
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * <li>The return value of that method is converted to an <code>AuthenticationToken</code> via the</em> |
| <a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> * {@link #createToken(String, String, javax.servlet.ServletRequest, javax.servlet.ServletResponse) createToken} method</li></em> |
| <a name="290" href="#290">290</a> <em class="jxr_javadoccomment"> * <li>The created <code>AuthenticationToken</code> is returned.</li></em> |
| <a name="291" href="#291">291</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a name="292" href="#292">292</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="293" href="#293">293</a> <em class="jxr_javadoccomment"> * @param request incoming ServletRequest</em> |
| <a name="294" href="#294">294</a> <em class="jxr_javadoccomment"> * @param response outgoing ServletResponse</em> |
| <a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * @return the AuthenticationToken used to execute the login attempt</em> |
| <a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="297" href="#297">297</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> createToken(ServletRequest request, ServletResponse response) { |
| <a name="298" href="#298">298</a> String authorizationHeader = getAuthzHeader(request); |
| <a name="299" href="#299">299</a> <strong class="jxr_keyword">if</strong> (authorizationHeader == <strong class="jxr_keyword">null</strong> || authorizationHeader.length() == 0) { |
| <a name="300" href="#300">300</a> <em class="jxr_comment">// Create an empty authentication token since there is no</em> |
| <a name="301" href="#301">301</a> <em class="jxr_comment">// Authorization header.</em> |
| <a name="302" href="#302">302</a> <strong class="jxr_keyword">return</strong> createToken(<span class="jxr_string">""</span>, <span class="jxr_string">""</span>, request, response); |
| <a name="303" href="#303">303</a> } |
| <a name="304" href="#304">304</a> |
| <a name="305" href="#305">305</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a name="306" href="#306">306</a> log.debug(<span class="jxr_string">"Attempting to execute login with headers ["</span> + authorizationHeader + <span class="jxr_string">"]"</span>); |
| <a name="307" href="#307">307</a> } |
| <a name="308" href="#308">308</a> |
| <a name="309" href="#309">309</a> String[] prinCred = getPrincipalsAndCredentials(authorizationHeader, request); |
| <a name="310" href="#310">310</a> <strong class="jxr_keyword">if</strong> (prinCred == <strong class="jxr_keyword">null</strong> || prinCred.length < 2) { |
| <a name="311" href="#311">311</a> <em class="jxr_comment">// Create an authentication token with an empty password,</em> |
| <a name="312" href="#312">312</a> <em class="jxr_comment">// since one hasn't been provided in the request.</em> |
| <a name="313" href="#313">313</a> String username = prinCred == <strong class="jxr_keyword">null</strong> || prinCred.length == 0 ? <span class="jxr_string">""</span> : prinCred[0]; |
| <a name="314" href="#314">314</a> <strong class="jxr_keyword">return</strong> createToken(username, <span class="jxr_string">""</span>, request, response); |
| <a name="315" href="#315">315</a> } |
| <a name="316" href="#316">316</a> |
| <a name="317" href="#317">317</a> String username = prinCred[0]; |
| <a name="318" href="#318">318</a> String password = prinCred[1]; |
| <a name="319" href="#319">319</a> |
| <a name="320" href="#320">320</a> <strong class="jxr_keyword">return</strong> createToken(username, password, request, response); |
| <a name="321" href="#321">321</a> } |
| <a name="322" href="#322">322</a> |
| <a name="323" href="#323">323</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="324" href="#324">324</a> <em class="jxr_javadoccomment"> * Returns the username obtained from the</em> |
| <a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authorizationHeader}.</em> |
| <a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * Once the {@code authzHeader} is split per the RFC (based on the space character ' '), the resulting split tokens</em> |
| <a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * are translated into the username/password pair by the</em> |
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * {@link #getPrincipalsAndCredentials(String, String) getPrincipalsAndCredentials(scheme,encoded)} method.</em> |
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> * @param authorizationHeader the authorization header obtained from the request.</em> |
| <a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a name="333" href="#333">333</a> <em class="jxr_javadoccomment"> * @return the username (index 0)/password pair (index 1) submitted by the user for the given header value and request.</em> |
| <a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> * @see #getAuthzHeader(javax.servlet.ServletRequest)</em> |
| <a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="336" href="#336">336</a> <strong class="jxr_keyword">protected</strong> String[] getPrincipalsAndCredentials(String authorizationHeader, ServletRequest request) { |
| <a name="337" href="#337">337</a> <strong class="jxr_keyword">if</strong> (authorizationHeader == <strong class="jxr_keyword">null</strong>) { |
| <a name="338" href="#338">338</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="339" href="#339">339</a> } |
| <a name="340" href="#340">340</a> String[] authTokens = authorizationHeader.split(<span class="jxr_string">" "</span>); |
| <a name="341" href="#341">341</a> <strong class="jxr_keyword">if</strong> (authTokens == <strong class="jxr_keyword">null</strong> || authTokens.length < 2) { |
| <a name="342" href="#342">342</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="343" href="#343">343</a> } |
| <a name="344" href="#344">344</a> <strong class="jxr_keyword">return</strong> getPrincipalsAndCredentials(authTokens[0], authTokens[1]); |
| <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"> * Returns the username and password pair based on the specified <code>encoded</code> String obtained from</em> |
| <a name="349" href="#349">349</a> <em class="jxr_javadoccomment"> * the request's authorization header.</em> |
| <a name="350" href="#350">350</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="351" href="#351">351</a> <em class="jxr_javadoccomment"> * Per RFC 2617, the default implementation first Base64 decodes the string and then splits the resulting decoded</em> |
| <a name="352" href="#352">352</a> <em class="jxr_javadoccomment"> * string into two based on the ":" character. That is:</em> |
| <a name="353" href="#353">353</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="354" href="#354">354</a> <em class="jxr_javadoccomment"> * <code>String decoded = Base64.decodeToString(encoded);<br/></em> |
| <a name="355" href="#355">355</a> <em class="jxr_javadoccomment"> * return decoded.split(":");</code></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 scheme the {@link #getAuthcScheme() authcScheme} found in the request</em> |
| <a name="358" href="#358">358</a> <em class="jxr_javadoccomment"> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authzHeader}. It is ignored by this implementation,</em> |
| <a name="359" href="#359">359</a> <em class="jxr_javadoccomment"> * but available to overriding implementations should they find it useful.</em> |
| <a name="360" href="#360">360</a> <em class="jxr_javadoccomment"> * @param encoded the Base64-encoded username:password value found after the scheme in the header</em> |
| <a name="361" href="#361">361</a> <em class="jxr_javadoccomment"> * @return the username (index 0)/password (index 1) pair obtained from the encoded header data.</em> |
| <a name="362" href="#362">362</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="363" href="#363">363</a> <strong class="jxr_keyword">protected</strong> String[] getPrincipalsAndCredentials(String scheme, String encoded) { |
| <a name="364" href="#364">364</a> String decoded = Base64.decodeToString(encoded); |
| <a name="365" href="#365">365</a> <strong class="jxr_keyword">return</strong> decoded.split(<span class="jxr_string">":"</span>, 2); |
| <a name="366" href="#366">366</a> } |
| <a name="367" href="#367">367</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
| |
