| <!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>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 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.web.filter.authc; |
| <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.AuthenticationToken; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Base64; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.util.WebUtils; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.Locale; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * Requires the requesting user to be {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated} for the</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</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 class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Upon successful login, they're allowed to continue on to the requested resource/url.</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * This implementation is a 'clean room' Java implementation of Basic HTTP Authentication specification per</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * <a href="ftp://ftp.isi.edu/in-notes/rfc2617.txt">RFC 2617</a>.</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Basic authentication functions as follows:</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * <li>A request comes in for a resource that requires authentication.</li></em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</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 class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * page informing the user that the incoming resource requires authentication.</li></em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * <li>Upon receiving this <code>WWW-Authenticate</code> challenge from the server, the client then takes a</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * username and a password and puts them in the following format:</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <p><code>username:password</code></p></li></em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * <li>This token is then base 64 encoded.</li></em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <li>The client then sends another request for the same resource with the following header:<br/></em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * <p><code>Authorization: Basic <em>Base64_encoded_username_and_password</em></code></p></li></em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * The {@link #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method will</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * only be called if the subject making the request is not</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated}</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @see <a href="ftp://ftp.isi.edu/in-notes/rfc2617.txt">RFC 2617</a></em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</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 class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</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 class="jxr_linenumber" name="L65" href="#L65">65</a> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * This class's private logger.</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</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 class="jxr_linenumber" name="L70" href="#L70">70</a> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * HTTP Authorization header, equal to <code>Authorization</code></em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</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 class="jxr_linenumber" name="L75" href="#L75">75</a> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * HTTP Authentication header, equal to <code>WWW-Authenticate</code></em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</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 class="jxr_linenumber" name="L80" href="#L80">80</a> |
| <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"> * The name that is displayed during the challenge process of authentication, defauls to <code>application</code></em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * and can be overridden by the {@link #setApplicationName(String) setApplicationName} method.</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">private</strong> String applicationName = <span class="jxr_string">"application"</span>; |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * The authcScheme to look for in the <code>Authorization</code> header, defaults to <code>BASIC</code></em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">private</strong> String authcScheme = HttpServletRequest.BASIC_AUTH; |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * The authzScheme value to look for in the <code>Authorization</code> header, defaults to <code>BASIC</code></em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">private</strong> String authzScheme = HttpServletRequest.BASIC_AUTH; |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> |
| <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"> * Returns the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</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 class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * by the {@link #setApplicationName(String) setApplicationName(String)} method, the default value is 'application'.</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Please see {@link #setApplicationName(String) setApplicationName(String)} for an example of how this functions.</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @return the name to use in the ServletResponse's 'WWW-Authenticate' header.</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">public</strong> String getApplicationName() { |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">return</strong> applicationName; |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> } |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * Sets the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</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 class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * by this method, the default value is &quot;application&quot;</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</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 class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * following header:</em> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * <code>WWW-Authenticate: Basic realm=&quot;<b>Awesome Webapp</b>&quot;</code></em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * Side note: As you can see from the header text, the HTTP Basic specification calls</em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * this the authentication 'realm', but we call this the 'applicationName' instead to avoid confusion with</em> |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * Shiro's Realm constructs.</em> |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @param applicationName the name to use in the ServletResponse's 'WWW-Authenticate' header.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setApplicationName(String applicationName) { |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">this</strong>.applicationName = applicationName; |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> } |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</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 class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * a login request.</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Unless overridden by the {@link #setAuthzScheme(String) setAuthzScheme(String)} method, the</em> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * default value is <code>BASIC</code>.</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @return the Http 'Authorization' header value that this filter will respond to as indicating a login request</em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">public</strong> String getAuthzScheme() { |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">return</strong> authzScheme; |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> } |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</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 class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * login request.</em> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Unless overridden by this method, the default value is <code>BASIC</code></em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @param authzScheme the HTTP <code>Authorization</code> header value that this filter will respond to as</em> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * indicating a login request.</em> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthzScheme(String authzScheme) { |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">this</strong>.authzScheme = authzScheme; |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> } |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</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 class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * the HTTP Basic challenge response. The default value is <code>BASIC</code>.</em> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</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 class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * Basic challenge response.</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @see #sendChallenge</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">public</strong> String getAuthcScheme() { |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">return</strong> authcScheme; |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> } |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</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 class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * HTTP Basic challenge response. The default value is <code>BASIC</code>.</em> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @param authcScheme the HTTP <code>WWW-Authenticate</code> header scheme that this filter will use when</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * sending the Http Basic challenge response.</em> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @see #sendChallenge</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAuthcScheme(String authcScheme) { |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">this</strong>.authcScheme = authcScheme; |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> } |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * The Basic authentication filter can be configured with a list of HTTP methods to which it should apply. This</em> |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * method ensures that authentication is <em>only</em> required for those HTTP methods specified. For example,</em> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * if you had the configuration:</em> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * [urls]</em> |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * /basic/** = authcBasic[POST,PUT,DELETE]</em> |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * then a GET request would not required authentication but a POST would.</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * @param request The current HTTP servlet request.</em> |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * @param response The current HTTP servlet response.</em> |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * @param mappedValue The array of configured HTTP methods as strings. This is empty if no methods are configured.</em> |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) { |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> HttpServletRequest httpRequest = WebUtils.toHttp(request); |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> String httpMethod = httpRequest.getMethod(); |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_comment">// Check whether the current request's method requires authentication.</em> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_comment">// If no methods have been configured, then all of them require auth,</em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_comment">// otherwise only the declared ones need authentication.</em> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> Set<String> methods = httpMethodsFromOptions((String[])mappedValue); |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">boolean</strong> authcRequired = methods.size() == 0; |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">for</strong> (String m : methods) { |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">if</strong> (httpMethod.toUpperCase(Locale.ENGLISH).equals(m)) { <em class="jxr_comment">// list of methods is in upper case</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> authcRequired = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> } |
| <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> <strong class="jxr_keyword">if</strong> (authcRequired) { |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.isAccessAllowed(request, response, mappedValue); |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> } |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> } |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> } |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">private</strong> Set<String> httpMethodsFromOptions(String[] options) { |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> Set<String> methods = <strong class="jxr_keyword">new</strong> HashSet<String>(); |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">if</strong> (options != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">for</strong> (String option : options) { |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_comment">// to be backwards compatible with 1.3, we can ONLY check for known args</em> |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_comment">// ideally we would just validate HTTP methods, but someone could already be using this for webdav</em> |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> (!option.equalsIgnoreCase(PERMISSIVE)) { |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> methods.add(option.toUpperCase(Locale.ENGLISH)); |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> } |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> } |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> } |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">return</strong> methods; |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> } |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * Processes unauthenticated requests. It handles the two-stage request/challenge authentication protocol.</em> |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @param request incoming ServletRequest</em> |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * @param response outgoing ServletResponse</em> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</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 class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L242" href="#L242">242</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 class="jxr_linenumber" name="L243" href="#L243">243</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 class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">if</strong> (isLoginAttempt(request, response)) { |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> loggedIn = executeLogin(request, response); |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> } |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">if</strong> (!loggedIn) { |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> sendChallenge(request, response); |
| <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> loggedIn; |
| <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"> * Determines whether the incoming request is an attempt to log in.</em> |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * The default implementation obtains the value of the request's</em> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * {@link #AUTHORIZATION_HEADER AUTHORIZATION_HEADER}, and if it is not <code>null</code>, delegates</em> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * to {@link #isLoginAttempt(String) isLoginAttempt(authzHeaderValue)}. If the header is <code>null</code>,</em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * <code>false</code> is returned.</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> <em class="jxr_javadoccomment"> * @param request incoming ServletRequest</em> |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * @param response outgoing ServletResponse</em> |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * @return true if the incoming request is an attempt to log in based, false otherwise</em> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isLoginAttempt(ServletRequest request, ServletResponse response) { |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> String authzHeader = getAuthzHeader(request); |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">return</strong> authzHeader != <strong class="jxr_keyword">null</strong> && isLoginAttempt(authzHeader); |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> } |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> |
| <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"> * Delegates to {@link #isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse) isLoginAttempt}.</em> |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> @Override |
| <a class="jxr_linenumber" name="L274" href="#L274">274</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 class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.isLoginAttempt(request, response); |
| <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_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * Returns the {@link #AUTHORIZATION_HEADER AUTHORIZATION_HEADER} from the specified ServletRequest.</em> |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * This implementation merely casts the request to an <code>HttpServletRequest</code> and returns the header:</em> |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * <code>HttpServletRequest httpRequest = {@link WebUtils#toHttp(javax.servlet.ServletRequest) toHttp(reaquest)};<br/></em> |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * return httpRequest.getHeader({@link #AUTHORIZATION_HEADER AUTHORIZATION_HEADER});</code></em> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * @param request the incoming <code>ServletRequest</code></em> |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @return the <code>Authorization</code> header's value.</em> |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">protected</strong> String getAuthzHeader(ServletRequest request) { |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> HttpServletRequest httpRequest = WebUtils.toHttp(request); |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">return</strong> httpRequest.getHeader(AUTHORIZATION_HEADER); |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> } |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * Default implementation that returns <code>true</code> if the specified <code>authzHeader</code></em> |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * starts with the same (case-insensitive) characters specified by the</em> |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * {@link #getAuthzScheme() authzScheme}, <code>false</code> otherwise.</em> |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * That is:</em> |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * <code>String authzScheme = getAuthzScheme().toLowerCase();<br/></em> |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * return authzHeader.toLowerCase().startsWith(authzScheme);</code></em> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * @param authzHeader the 'Authorization' header value (guaranteed to be non-null if the</em> |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * {@link #isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method is not overriden).</em> |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the authzHeader value matches that configured as defined by</em> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * the {@link #getAuthzScheme() authzScheme}.</em> |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isLoginAttempt(String authzHeader) { |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_comment">//SHIRO-415: use English Locale:</em> |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> String authzScheme = getAuthzScheme().toLowerCase(Locale.ENGLISH); |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">return</strong> authzHeader.toLowerCase(Locale.ENGLISH).startsWith(authzScheme); |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> } |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L316" href="#L316">316</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 class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * response's {@link #AUTHENTICATE_HEADER AUTHENTICATE_HEADER}.</em> |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * The header value constructed is equal to:</em> |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * <code>{@link #getAuthcScheme() getAuthcScheme()} + " realm=\"" + {@link #getApplicationName() getApplicationName()} + "\"";</code></em> |
| <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"> * @param request incoming ServletRequest, ignored by this implementation</em> |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * @param response outgoing ServletResponse</em> |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * @return false - this sends the challenge to be sent back</em> |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> sendChallenge(ServletRequest request, ServletResponse response) { |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> log.debug(<span class="jxr_string">"Authentication required: sending 401 Authentication challenge response."</span>); |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> } |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> HttpServletResponse httpResponse = WebUtils.toHttp(response); |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> httpResponse.setStatus(HttpServletResponse.SC_UNAUTHORIZED); |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> String authcHeader = getAuthcScheme() + <span class="jxr_string">" realm=\""</span> + getApplicationName() + <span class="jxr_string">"\""</span>; |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> httpResponse.setHeader(AUTHENTICATE_HEADER, authcHeader); |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">return</strong> false; |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> } |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * Creates an AuthenticationToken for use during login attempt with the provided credentials in the http header.</em> |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> * This implementation:</em> |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * <ol><li>acquires the username and password based on the request's</em> |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authorization header} via the</em> |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * {@link #getPrincipalsAndCredentials(String, javax.servlet.ServletRequest) getPrincipalsAndCredentials} method</li></em> |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * <li>The return value of that method is converted to an <code>AuthenticationToken</code> via the</em> |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * {@link #createToken(String, String, javax.servlet.ServletRequest, javax.servlet.ServletResponse) createToken} method</li></em> |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> * <li>The created <code>AuthenticationToken</code> is returned.</li></em> |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> * @param request incoming ServletRequest</em> |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * @param response outgoing ServletResponse</em> |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * @return the AuthenticationToken used to execute the login attempt</em> |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> createToken(ServletRequest request, ServletResponse response) { |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> String authorizationHeader = getAuthzHeader(request); |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">if</strong> (authorizationHeader == <strong class="jxr_keyword">null</strong> || authorizationHeader.length() == 0) { |
| <a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_comment">// Create an empty authentication token since there is no</em> |
| <a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_comment">// Authorization header.</em> |
| <a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">return</strong> createToken(<span class="jxr_string">""</span>, <span class="jxr_string">""</span>, request, response); |
| <a class="jxr_linenumber" name="L360" href="#L360">360</a> } |
| <a class="jxr_linenumber" name="L361" href="#L361">361</a> |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a class="jxr_linenumber" name="L363" href="#L363">363</a> log.debug(<span class="jxr_string">"Attempting to execute login with headers ["</span> + authorizationHeader + <span class="jxr_string">"]"</span>); |
| <a class="jxr_linenumber" name="L364" href="#L364">364</a> } |
| <a class="jxr_linenumber" name="L365" href="#L365">365</a> |
| <a class="jxr_linenumber" name="L366" href="#L366">366</a> String[] prinCred = getPrincipalsAndCredentials(authorizationHeader, request); |
| <a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">if</strong> (prinCred == <strong class="jxr_keyword">null</strong> || prinCred.length < 2) { |
| <a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_comment">// Create an authentication token with an empty password,</em> |
| <a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_comment">// since one hasn't been provided in the request.</em> |
| <a class="jxr_linenumber" name="L370" href="#L370">370</a> String username = prinCred == <strong class="jxr_keyword">null</strong> || prinCred.length == 0 ? <span class="jxr_string">""</span> : prinCred[0]; |
| <a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">return</strong> createToken(username, <span class="jxr_string">""</span>, request, response); |
| <a class="jxr_linenumber" name="L372" href="#L372">372</a> } |
| <a class="jxr_linenumber" name="L373" href="#L373">373</a> |
| <a class="jxr_linenumber" name="L374" href="#L374">374</a> String username = prinCred[0]; |
| <a class="jxr_linenumber" name="L375" href="#L375">375</a> String password = prinCred[1]; |
| <a class="jxr_linenumber" name="L376" href="#L376">376</a> |
| <a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">return</strong> createToken(username, password, request, response); |
| <a class="jxr_linenumber" name="L378" href="#L378">378</a> } |
| <a class="jxr_linenumber" name="L379" href="#L379">379</a> |
| <a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> * Returns the username obtained from the</em> |
| <a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authorizationHeader}.</em> |
| <a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L384" href="#L384">384</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 class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * are translated into the username/password pair by the</em> |
| <a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * {@link #getPrincipalsAndCredentials(String, String) getPrincipalsAndCredentials(scheme,encoded)} method.</em> |
| <a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * @param authorizationHeader the authorization header obtained from the request.</em> |
| <a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * @param request the incoming ServletRequest</em> |
| <a class="jxr_linenumber" name="L390" href="#L390">390</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 class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * @see #getAuthzHeader(javax.servlet.ServletRequest)</em> |
| <a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">protected</strong> String[] getPrincipalsAndCredentials(String authorizationHeader, ServletRequest request) { |
| <a class="jxr_linenumber" name="L394" href="#L394">394</a> <strong class="jxr_keyword">if</strong> (authorizationHeader == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L396" href="#L396">396</a> } |
| <a class="jxr_linenumber" name="L397" href="#L397">397</a> String[] authTokens = authorizationHeader.split(<span class="jxr_string">" "</span>); |
| <a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">if</strong> (authTokens == <strong class="jxr_keyword">null</strong> || authTokens.length < 2) { |
| <a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L400" href="#L400">400</a> } |
| <a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">return</strong> getPrincipalsAndCredentials(authTokens[0], authTokens[1]); |
| <a class="jxr_linenumber" name="L402" href="#L402">402</a> } |
| <a class="jxr_linenumber" name="L403" href="#L403">403</a> |
| <a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * Returns the username and password pair based on the specified <code>encoded</code> String obtained from</em> |
| <a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * the request's authorization header.</em> |
| <a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * Per RFC 2617, the default implementation first Base64 decodes the string and then splits the resulting decoded</em> |
| <a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> * string into two based on the ":" character. That is:</em> |
| <a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> * <code>String decoded = Base64.decodeToString(encoded);<br/></em> |
| <a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> * return decoded.split(":");</code></em> |
| <a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> * @param scheme the {@link #getAuthcScheme() authcScheme} found in the request</em> |
| <a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authzHeader}. It is ignored by this implementation,</em> |
| <a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> * but available to overriding implementations should they find it useful.</em> |
| <a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment"> * @param encoded the Base64-encoded username:password value found after the scheme in the header</em> |
| <a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> * @return the username (index 0)/password (index 1) pair obtained from the encoded header data.</em> |
| <a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong class="jxr_keyword">protected</strong> String[] getPrincipalsAndCredentials(String scheme, String encoded) { |
| <a class="jxr_linenumber" name="L421" href="#L421">421</a> String decoded = Base64.decodeToString(encoded); |
| <a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">return</strong> decoded.split(<span class="jxr_string">":"</span>, 2); |
| <a class="jxr_linenumber" name="L423" href="#L423">423</a> } |
| <a class="jxr_linenumber" name="L424" href="#L424">424</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
