| <!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>SimpleCredentialsMatcher xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authc/credential/SimpleCredentialsMatcher.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.authc.credential; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.CodecSupport; |
| <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> java.util.Arrays; |
| <a name="28" href="#28">28</a> |
| <a name="29" href="#29">29</a> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * Simple CredentialsMatcher implementation. Supports direct (plain) comparison for credentials of type</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * byte[], char[], and Strings, and if the arguments do not match these types, then reverts back to simple</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <code>Object.equals</code> comparison.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p>Hashing comparisons (the most common technique used in secure applications) are not supported by this class, but</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * instead by the {@link org.apache.shiro.authc.credential.HashedCredentialsMatcher HashedCredentialsMatcher}.</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @see org.apache.shiro.authc.credential.HashedCredentialsMatcher</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/authc/credential/SimpleCredentialsMatcher.html">SimpleCredentialsMatcher</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/codec/CodecSupport.html">CodecSupport</a> implements <a href="../../../../../org/apache/shiro/authc/credential/CredentialsMatcher.html">CredentialsMatcher</a> { |
| <a name="42" href="#42">42</a> |
| <a name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(SimpleCredentialsMatcher.<strong class="jxr_keyword">class</strong>); |
| <a name="44" href="#44">44</a> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Returns the {@code token}'s credentials.</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * <p>This default implementation merely returns</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * {@link AuthenticationToken#getCredentials() authenticationToken.getCredentials()} and exists as a template hook</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * if subclasses wish to obtain the credentials in a different way or convert them to a different format before</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * returning.</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @param token the {@code AuthenticationToken} submitted during the authentication attempt.</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @return the {@code token}'s associated credentials.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="56" href="#56">56</a> <strong class="jxr_keyword">protected</strong> Object getCredentials(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token) { |
| <a name="57" href="#57">57</a> <strong class="jxr_keyword">return</strong> token.getCredentials(); |
| <a name="58" href="#58">58</a> } |
| <a name="59" href="#59">59</a> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Returns the {@code account}'s credentials.</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * <p>This default implementation merely returns</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * {@link AuthenticationInfo#getCredentials() account.getCredentials()} and exists as a template hook if subclasses</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * wish to obtain the credentials in a different way or convert them to a different format before</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * returning.</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @param info the {@code AuthenticationInfo} stored in the data store to be compared against the submitted authentication</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * token's credentials.</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @return the {@code account}'s associated credentials.</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="72" href="#72">72</a> <strong class="jxr_keyword">protected</strong> Object getCredentials(<a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) { |
| <a name="73" href="#73">73</a> <strong class="jxr_keyword">return</strong> info.getCredentials(); |
| <a name="74" href="#74">74</a> } |
| <a name="75" href="#75">75</a> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the {@code tokenCredentials} argument is logically equal to the</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * {@code accountCredentials} argument.</em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * <p>If both arguments are either a byte array (byte[]), char array (char[]) or String, they will be both be</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * converted to raw byte arrays via the {@link #toBytes toBytes} method first, and then resulting byte arrays</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * are compared via {@link Arrays#equals(byte[], byte[]) Arrays.equals(byte[],byte[])}.</p></em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * <p>If either argument cannot be converted to a byte array as described, a simple Object <code>equals</code></em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * comparison is made.</p></em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * <p>Subclasses should override this method for more explicit equality checks.</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @param tokenCredentials the {@code AuthenticationToken}'s associated credentials.</em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @param accountCredentials the {@code AuthenticationInfo}'s stored credentials.</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @return {@code true} if the {@code tokenCredentials} are equal to the {@code accountCredentials}.</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="93" href="#93">93</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> equals(Object tokenCredentials, Object accountCredentials) { |
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a name="95" href="#95">95</a> log.debug(<span class="jxr_string">"Performing credentials equality check for tokenCredentials of type ["</span> + |
| <a name="96" href="#96">96</a> tokenCredentials.getClass().getName() + <span class="jxr_string">" and accountCredentials of type ["</span> + |
| <a name="97" href="#97">97</a> accountCredentials.getClass().getName() + <span class="jxr_string">"]"</span>); |
| <a name="98" href="#98">98</a> } |
| <a name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (isByteSource(tokenCredentials) && isByteSource(accountCredentials)) { |
| <a name="100" href="#100">100</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) { |
| <a name="101" href="#101">101</a> log.debug(<span class="jxr_string">"Both credentials arguments can be easily converted to byte arrays. Performing "</span> + |
| <a name="102" href="#102">102</a> <span class="jxr_string">"array equals comparison"</span>); |
| <a name="103" href="#103">103</a> } |
| <a name="104" href="#104">104</a> byte[] tokenBytes = toBytes(tokenCredentials); |
| <a name="105" href="#105">105</a> byte[] accountBytes = toBytes(accountCredentials); |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">return</strong> Arrays.equals(tokenBytes, accountBytes); |
| <a name="107" href="#107">107</a> } <strong class="jxr_keyword">else</strong> { |
| <a name="108" href="#108">108</a> <strong class="jxr_keyword">return</strong> accountCredentials.equals(tokenCredentials); |
| <a name="109" href="#109">109</a> } |
| <a name="110" href="#110">110</a> } |
| <a name="111" href="#111">111</a> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * This implementation acquires the {@code token}'s credentials</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * (via {@link #getCredentials(AuthenticationToken) getCredentials(token)})</em> |
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * and then the {@code account}'s credentials</em> |
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * (via {@link #getCredentials(org.apache.shiro.authc.AuthenticationInfo) getCredentials(account)}) and then passes both of</em> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * them to the {@link #equals(Object,Object) equals(tokenCredentials, accountCredentials)} method for equality</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * comparison.</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @param token the {@code AuthenticationToken} submitted during the authentication attempt.</em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param info the {@code AuthenticationInfo} stored in the system matching the token principal.</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @return {@code true} if the provided token credentials are equal to the stored account credentials,</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * {@code false} otherwise</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">boolean</strong> doCredentialsMatch(<a href="../../../../../org/apache/shiro/authc/AuthenticationToken.html">AuthenticationToken</a> token, <a href="../../../../../org/apache/shiro/authc/AuthenticationInfo.html">AuthenticationInfo</a> info) { |
| <a name="126" href="#126">126</a> Object tokenCredentials = getCredentials(token); |
| <a name="127" href="#127">127</a> Object accountCredentials = getCredentials(info); |
| <a name="128" href="#128">128</a> <strong class="jxr_keyword">return</strong> equals(tokenCredentials, accountCredentials); |
| <a name="129" href="#129">129</a> } |
| <a name="130" href="#130">130</a> |
| <a name="131" href="#131">131</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
