blob: a56b6b8ce984ded81aedc76f24c37cf11402b9cc [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>SimpleHash xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/crypto/hash/SimpleHash.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.crypto.hash;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Base64;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.CodecException;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Hex;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.UnknownAlgorithmException;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils;
<a name="27" href="#27">27</a>
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.security.MessageDigest;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.security.NoSuchAlgorithmException;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a name="31" href="#31">31</a>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * A {@code Hash} implementation that allows any {@link java.security.MessageDigest MessageDigest} algorithm name to</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * be used. This class is a less type-safe variant than the other {@code AbstractHash} subclasses</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * (e.g. {@link Sha512Hash}, etc), but it does allow for any algorithm name to be specified in case the other subclass</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * implementations do not represent an algorithm that you may want to use.</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * As of Shiro 1.1, this class effectively replaces the (now-deprecated) {@link AbstractHash} class. It subclasses</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * {@code AbstractHash} only to retain backwards-compatibility.</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @since 1.1</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/shiro/crypto/hash/AbstractHash.html">AbstractHash</a> {
<a name="44" href="#44">44</a>
<a name="45" href="#45">45</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_ITERATIONS = 1;
<a name="46" href="#46">46</a>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * The {@link java.security.MessageDigest MessageDigest} algorithm name to use when performing the hash.</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em>
<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String algorithmName;
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * The hashed data</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em>
<a name="55" href="#55">55</a> <strong class="jxr_keyword">private</strong> byte[] bytes;
<a name="56" href="#56">56</a>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Supplied salt, if any.</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em>
<a name="60" href="#60">60</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> salt;
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Number of hash iterations to perform. Defaults to 1 in the constructor.</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
<a name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> iterations;
<a name="66" href="#66">66</a>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Cached value of the {@link #toHex() toHex()} call so multiple calls won't incur repeated overhead.</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em>
<a name="70" href="#70">70</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> String hexEncoded = <strong class="jxr_keyword">null</strong>;
<a name="71" href="#71">71</a>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * Cached value of the {@link #toBase64() toBase64()} call so multiple calls won't incur repeated overhead.</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> */</em>
<a name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> String base64Encoded = <strong class="jxr_keyword">null</strong>;
<a name="76" href="#76">76</a>
<a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em>
<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * Creates an new instance with only its {@code algorithmName} set - no hashing is performed.</em>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Because all other constructors in this class hash the {@code source} constructor argument, this</em>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * constructor is useful in scenarios when you have a byte array that you know is already hashed and</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * just want to set the bytes in their raw form directly on an instance. After using this constructor,</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * you can then immediately call {@link #setBytes setBytes} to have a fully-initialized instance.</em>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * &lt;b&gt;N.B.&lt;/b&gt;The algorithm identified by the {@code algorithmName} parameter must be available on the JVM. If it</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * is not, a {@link UnknownAlgorithmException} will be thrown when the hash is performed (not at instantiation).</em>
<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> *</em>
<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when</em>
<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * performing the hash.</em>
<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @see UnknownAlgorithmException</em>
<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em>
<a name="92" href="#92">92</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a>(String algorithmName) {
<a name="93" href="#93">93</a> <strong class="jxr_keyword">this</strong>.algorithmName = algorithmName;
<a name="94" href="#94">94</a> <strong class="jxr_keyword">this</strong>.iterations = DEFAULT_ITERATIONS;
<a name="95" href="#95">95</a> }
<a name="96" href="#96">96</a>
<a name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em>
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Creates an {@code algorithmName}-specific hash of the specified {@code source} with no {@code salt} using a</em>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * single hash iteration.</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * This is a convenience constructor that merely executes &lt;code&gt;this( algorithmName, source, null, 1);&lt;/code&gt;.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Please see the</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * {@link #SimpleHash(String algorithmName, Object source, Object salt, int numIterations) SimpleHashHash(algorithmName, Object,Object,int)}</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * constructor for the types of Objects that may be passed into this constructor, as well as how to support further</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * types.</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> *</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * performing the hash.</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @param source the object to be hashed.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.codec.CodecException</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * if the specified {@code source} cannot be converted into a byte array (byte[]).</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the {@code algorithmName} is not available.</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em>
<a name="115" href="#115">115</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a>(String algorithmName, Object source) <strong class="jxr_keyword">throws</strong> CodecException, UnknownAlgorithmException {
<a name="116" href="#116">116</a> <em class="jxr_comment">//noinspection NullableProblems</em>
<a name="117" href="#117">117</a> <strong class="jxr_keyword">this</strong>(algorithmName, source, <strong class="jxr_keyword">null</strong>, DEFAULT_ITERATIONS);
<a name="118" href="#118">118</a> }
<a name="119" href="#119">119</a>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">/**</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * Creates an {@code algorithmName}-specific hash of the specified {@code source} using the given {@code salt}</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * using a single hash iteration.</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * It is a convenience constructor that merely executes &lt;code&gt;this( algorithmName, source, salt, 1);&lt;/code&gt;.</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * Please see the</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * {@link #SimpleHash(String algorithmName, Object source, Object salt, int numIterations) SimpleHashHash(algorithmName, Object,Object,int)}</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * constructor for the types of Objects that may be passed into this constructor, as well as how to support further</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * types.</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> *</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * performing the hash.</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * @param source the source object to be hashed.</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @param salt the salt to use for the hash</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @throws CodecException if either constructor argument cannot be converted into a byte array.</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the {@code algorithmName} is not available.</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> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a>(String algorithmName, Object source, Object salt) <strong class="jxr_keyword">throws</strong> CodecException, UnknownAlgorithmException {
<a name="139" href="#139">139</a> <strong class="jxr_keyword">this</strong>(algorithmName, source, salt, DEFAULT_ITERATIONS);
<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"> * Creates an {@code algorithmName}-specific hash of the specified {@code source} using the given</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * {@code salt} a total of {@code hashIterations} times.</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * By default, this class only supports Object method arguments of</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * type {@code byte[]}, {@code char[]}, {@link String}, {@link java.io.File File},</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * {@link java.io.InputStream InputStream} or {@link org.apache.shiro.util.ByteSource ByteSource}. If either</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * argument is anything other than these types a {@link org.apache.shiro.codec.CodecException CodecException}</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * will be thrown.</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * If you want to be able to hash other object types, or use other salt types, you need to override the</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * {@link #toBytes(Object) toBytes(Object)} method to support those specific types. Your other option is to</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * convert your arguments to one of the default supported types first before passing them in to this</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * constructor}.</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> *</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * performing the hash.</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * @param source the source object to be hashed.</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param salt the salt to use for the hash</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @param hashIterations the number of times the {@code source} argument hashed for attack resiliency.</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @throws CodecException if either Object constructor argument cannot be converted into a byte array.</em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the {@code algorithmName} is not available.</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> */</em>
<a name="165" href="#165">165</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a>(String algorithmName, Object source, Object salt, <strong class="jxr_keyword">int</strong> hashIterations)
<a name="166" href="#166">166</a> <strong class="jxr_keyword">throws</strong> CodecException, <a href="../../../../../org/apache/shiro/crypto/UnknownAlgorithmException.html">UnknownAlgorithmException</a> {
<a name="167" href="#167">167</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(algorithmName)) {
<a name="168" href="#168">168</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"algorithmName argument cannot be null or empty."</span>);
<a name="169" href="#169">169</a> }
<a name="170" href="#170">170</a> <strong class="jxr_keyword">this</strong>.algorithmName = algorithmName;
<a name="171" href="#171">171</a> <strong class="jxr_keyword">this</strong>.iterations = Math.max(DEFAULT_ITERATIONS, hashIterations);
<a name="172" href="#172">172</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> saltBytes = <strong class="jxr_keyword">null</strong>;
<a name="173" href="#173">173</a> <strong class="jxr_keyword">if</strong> (salt != <strong class="jxr_keyword">null</strong>) {
<a name="174" href="#174">174</a> saltBytes = convertSaltToBytes(salt);
<a name="175" href="#175">175</a> <strong class="jxr_keyword">this</strong>.salt = saltBytes;
<a name="176" href="#176">176</a> }
<a name="177" href="#177">177</a> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> sourceBytes = convertSourceToBytes(source);
<a name="178" href="#178">178</a> hash(sourceBytes, saltBytes, hashIterations);
<a name="179" href="#179">179</a> }
<a name="180" href="#180">180</a>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">/**</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * Acquires the specified {@code source} argument's bytes and returns them in the form of a {@code ByteSource} instance.</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * This implementation merely delegates to the convenience {@link #toByteSource(Object)} method for generic</em>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> * conversion. Can be overridden by subclasses for source-specific conversion.</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment"> *</em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * @param source the source object to be hashed.</em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * @return the source's bytes in the form of a {@code ByteSource} instance.</em>
<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> */</em>
<a name="191" href="#191">191</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> convertSourceToBytes(Object source) {
<a name="192" href="#192">192</a> <strong class="jxr_keyword">return</strong> toByteSource(source);
<a name="193" href="#193">193</a> }
<a name="194" href="#194">194</a>
<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">/**</em>
<a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * Acquires the specified {@code salt} argument's bytes and returns them in the form of a {@code ByteSource} instance.</em>
<a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * This implementation merely delegates to the convenience {@link #toByteSource(Object)} method for generic</em>
<a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * conversion. Can be overridden by subclasses for salt-specific conversion.</em>
<a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> *</em>
<a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * @param salt the salt to be use for the hash.</em>
<a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> * @return the salt's bytes in the form of a {@code ByteSource} instance.</em>
<a name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment"> */</em>
<a name="205" href="#205">205</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> convertSaltToBytes(Object salt) {
<a name="206" href="#206">206</a> <strong class="jxr_keyword">return</strong> toByteSource(salt);
<a name="207" href="#207">207</a> }
<a name="208" href="#208">208</a>
<a name="209" href="#209">209</a> <em class="jxr_javadoccomment">/**</em>
<a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * Converts a given object into a {@code ByteSource} instance. Assumes the object can be converted to bytes.</em>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> *</em>
<a name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * @param o the Object to convert into a {@code ByteSource} instance.</em>
<a name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * @return the {@code ByteSource} representation of the specified object's bytes.</em>
<a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> */</em>
<a name="216" href="#216">216</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> toByteSource(Object o) {
<a name="217" href="#217">217</a> <strong class="jxr_keyword">if</strong> (o == <strong class="jxr_keyword">null</strong>) {
<a name="218" href="#218">218</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="219" href="#219">219</a> }
<a name="220" href="#220">220</a> <strong class="jxr_keyword">if</strong> (o instanceof ByteSource) {
<a name="221" href="#221">221</a> <strong class="jxr_keyword">return</strong> (ByteSource) o;
<a name="222" href="#222">222</a> }
<a name="223" href="#223">223</a> byte[] bytes = toBytes(o);
<a name="224" href="#224">224</a> <strong class="jxr_keyword">return</strong> ByteSource.Util.bytes(bytes);
<a name="225" href="#225">225</a> }
<a name="226" href="#226">226</a>
<a name="227" href="#227">227</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> hash(<a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> source, <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> salt, <strong class="jxr_keyword">int</strong> hashIterations) <strong class="jxr_keyword">throws</strong> CodecException, UnknownAlgorithmException {
<a name="228" href="#228">228</a> byte[] saltBytes = salt != <strong class="jxr_keyword">null</strong> ? salt.getBytes() : <strong class="jxr_keyword">null</strong>;
<a name="229" href="#229">229</a> byte[] hashedBytes = hash(source.getBytes(), saltBytes, hashIterations);
<a name="230" href="#230">230</a> setBytes(hashedBytes);
<a name="231" href="#231">231</a> }
<a name="232" href="#232">232</a>
<a name="233" href="#233">233</a> <em class="jxr_javadoccomment">/**</em>
<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * Returns the {@link java.security.MessageDigest MessageDigest} algorithm name to use when performing the hash.</em>
<a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> *</em>
<a name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @return the {@link java.security.MessageDigest MessageDigest} algorithm name to use when performing the hash.</em>
<a name="237" href="#237">237</a> <em class="jxr_javadoccomment"> */</em>
<a name="238" href="#238">238</a> <strong class="jxr_keyword">public</strong> String getAlgorithmName() {
<a name="239" href="#239">239</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.algorithmName;
<a name="240" href="#240">240</a> }
<a name="241" href="#241">241</a>
<a name="242" href="#242">242</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> getSalt() {
<a name="243" href="#243">243</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.salt;
<a name="244" href="#244">244</a> }
<a name="245" href="#245">245</a>
<a name="246" href="#246">246</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getIterations() {
<a name="247" href="#247">247</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.iterations;
<a name="248" href="#248">248</a> }
<a name="249" href="#249">249</a>
<a name="250" href="#250">250</a> <strong class="jxr_keyword">public</strong> byte[] getBytes() {
<a name="251" href="#251">251</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.bytes;
<a name="252" href="#252">252</a> }
<a name="253" href="#253">253</a>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">/**</em>
<a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * Sets the raw bytes stored by this hash instance.</em>
<a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * The bytes are kept in raw form - they will not be hashed/changed. This is primarily a utility method for</em>
<a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * constructing a Hash instance when the hashed value is already known.</em>
<a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> *</em>
<a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * @param alreadyHashedBytes the raw already-hashed bytes to store in this instance.</em>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment"> */</em>
<a name="262" href="#262">262</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setBytes(byte[] alreadyHashedBytes) {
<a name="263" href="#263">263</a> <strong class="jxr_keyword">this</strong>.bytes = alreadyHashedBytes;
<a name="264" href="#264">264</a> <strong class="jxr_keyword">this</strong>.hexEncoded = <strong class="jxr_keyword">null</strong>;
<a name="265" href="#265">265</a> <strong class="jxr_keyword">this</strong>.base64Encoded = <strong class="jxr_keyword">null</strong>;
<a name="266" href="#266">266</a> }
<a name="267" href="#267">267</a>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">/**</em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * Sets the iterations used to previously compute AN ALREADY GENERATED HASH.</em>
<a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * This is provided &lt;em&gt;ONLY&lt;/em&gt; to reconstitute an already-created Hash instance. It should ONLY ever be</em>
<a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * invoked when re-constructing a hash instance from an already-hashed value.</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> *</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> * @param iterations the number of hash iterations used to previously create the hash/digest.</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> */</em>
<a name="277" href="#277">277</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setIterations(<strong class="jxr_keyword">int</strong> iterations) {
<a name="278" href="#278">278</a> <strong class="jxr_keyword">this</strong>.iterations = Math.max(DEFAULT_ITERATIONS, iterations);
<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"> * Sets the salt used to previously compute AN ALREADY GENERATED HASH.</em>
<a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * This is provided &lt;em&gt;ONLY&lt;/em&gt; to reconstitute a Hash instance that has already been computed. It should ONLY</em>
<a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * ever be invoked when re-constructing a hash instance from an already-hashed value.</em>
<a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> *</em>
<a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * @param salt the salt used to previously create the hash/digest.</em>
<a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> */</em>
<a name="290" href="#290">290</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSalt(<a href="../../../../../org/apache/shiro/util/ByteSource.html">ByteSource</a> salt) {
<a name="291" href="#291">291</a> <strong class="jxr_keyword">this</strong>.salt = salt;
<a name="292" href="#292">292</a> }
<a name="293" href="#293">293</a>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em>
<a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * Returns the JDK MessageDigest instance to use for executing the hash.</em>
<a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> *</em>
<a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * @param algorithmName the algorithm to use for the hash, provided by subclasses.</em>
<a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * @return the MessageDigest object for the specified {@code algorithm}.</em>
<a name="299" href="#299">299</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the specified algorithm name is not available.</em>
<a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> */</em>
<a name="301" href="#301">301</a> <strong class="jxr_keyword">protected</strong> MessageDigest getDigest(String algorithmName) <strong class="jxr_keyword">throws</strong> UnknownAlgorithmException {
<a name="302" href="#302">302</a> <strong class="jxr_keyword">try</strong> {
<a name="303" href="#303">303</a> <strong class="jxr_keyword">return</strong> MessageDigest.getInstance(algorithmName);
<a name="304" href="#304">304</a> } <strong class="jxr_keyword">catch</strong> (NoSuchAlgorithmException e) {
<a name="305" href="#305">305</a> String msg = <span class="jxr_string">"No native '"</span> + algorithmName + <span class="jxr_string">"' MessageDigest instance available on the current JVM."</span>;
<a name="306" href="#306">306</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/crypto/UnknownAlgorithmException.html">UnknownAlgorithmException</a>(msg, e);
<a name="307" href="#307">307</a> }
<a name="308" href="#308">308</a> }
<a name="309" href="#309">309</a>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">/**</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * Hashes the specified byte array without a salt for a single iteration.</em>
<a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> *</em>
<a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> * @param bytes the bytes to hash.</em>
<a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * @return the hashed bytes.</em>
<a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the configured {@link #getAlgorithmName() algorithmName} is not available.</em>
<a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> */</em>
<a name="317" href="#317">317</a> <strong class="jxr_keyword">protected</strong> byte[] hash(byte[] bytes) <strong class="jxr_keyword">throws</strong> UnknownAlgorithmException {
<a name="318" href="#318">318</a> <strong class="jxr_keyword">return</strong> hash(bytes, <strong class="jxr_keyword">null</strong>, DEFAULT_ITERATIONS);
<a name="319" href="#319">319</a> }
<a name="320" href="#320">320</a>
<a name="321" href="#321">321</a> <em class="jxr_javadoccomment">/**</em>
<a name="322" href="#322">322</a> <em class="jxr_javadoccomment"> * Hashes the specified byte array using the given {@code salt} for a single iteration.</em>
<a name="323" href="#323">323</a> <em class="jxr_javadoccomment"> *</em>
<a name="324" href="#324">324</a> <em class="jxr_javadoccomment"> * @param bytes the bytes to hash</em>
<a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * @param salt the salt to use for the initial hash</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * @return the hashed bytes</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the configured {@link #getAlgorithmName() algorithmName} is not available.</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> */</em>
<a name="329" href="#329">329</a> <strong class="jxr_keyword">protected</strong> byte[] hash(byte[] bytes, byte[] salt) <strong class="jxr_keyword">throws</strong> UnknownAlgorithmException {
<a name="330" href="#330">330</a> <strong class="jxr_keyword">return</strong> hash(bytes, salt, DEFAULT_ITERATIONS);
<a name="331" href="#331">331</a> }
<a name="332" href="#332">332</a>
<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">/**</em>
<a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> * Hashes the specified byte array using the given {@code salt} for the specified number of iterations.</em>
<a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> *</em>
<a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * @param bytes the bytes to hash</em>
<a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> * @param salt the salt to use for the initial hash</em>
<a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> * @param hashIterations the number of times the the {@code bytes} will be hashed (for attack resiliency).</em>
<a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * @return the hashed bytes.</em>
<a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the {@link #getAlgorithmName() algorithmName} is not available.</em>
<a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> */</em>
<a name="342" href="#342">342</a> <strong class="jxr_keyword">protected</strong> byte[] hash(byte[] bytes, byte[] salt, <strong class="jxr_keyword">int</strong> hashIterations) <strong class="jxr_keyword">throws</strong> UnknownAlgorithmException {
<a name="343" href="#343">343</a> MessageDigest digest = getDigest(getAlgorithmName());
<a name="344" href="#344">344</a> <strong class="jxr_keyword">if</strong> (salt != <strong class="jxr_keyword">null</strong>) {
<a name="345" href="#345">345</a> digest.reset();
<a name="346" href="#346">346</a> digest.update(salt);
<a name="347" href="#347">347</a> }
<a name="348" href="#348">348</a> byte[] hashed = digest.digest(bytes);
<a name="349" href="#349">349</a> <strong class="jxr_keyword">int</strong> iterations = hashIterations - DEFAULT_ITERATIONS; <em class="jxr_comment">//already hashed once above</em>
<a name="350" href="#350">350</a> <em class="jxr_comment">//iterate remaining number:</em>
<a name="351" href="#351">351</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; iterations; i++) {
<a name="352" href="#352">352</a> digest.reset();
<a name="353" href="#353">353</a> hashed = digest.digest(hashed);
<a name="354" href="#354">354</a> }
<a name="355" href="#355">355</a> <strong class="jxr_keyword">return</strong> hashed;
<a name="356" href="#356">356</a> }
<a name="357" href="#357">357</a>
<a name="358" href="#358">358</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEmpty() {
<a name="359" href="#359">359</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.bytes == <strong class="jxr_keyword">null</strong> || <strong class="jxr_keyword">this</strong>.bytes.length == 0;
<a name="360" href="#360">360</a> }
<a name="361" href="#361">361</a>
<a name="362" href="#362">362</a> <em class="jxr_javadoccomment">/**</em>
<a name="363" href="#363">363</a> <em class="jxr_javadoccomment"> * Returns a hex-encoded string of the underlying {@link #getBytes byte array}.</em>
<a name="364" href="#364">364</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="365" href="#365">365</a> <em class="jxr_javadoccomment"> * This implementation caches the resulting hex string so multiple calls to this method remain efficient.</em>
<a name="366" href="#366">366</a> <em class="jxr_javadoccomment"> * However, calling {@link #setBytes setBytes} will null the cached value, forcing it to be recalculated the</em>
<a name="367" href="#367">367</a> <em class="jxr_javadoccomment"> * next time this method is called.</em>
<a name="368" href="#368">368</a> <em class="jxr_javadoccomment"> *</em>
<a name="369" href="#369">369</a> <em class="jxr_javadoccomment"> * @return a hex-encoded string of the underlying {@link #getBytes byte array}.</em>
<a name="370" href="#370">370</a> <em class="jxr_javadoccomment"> */</em>
<a name="371" href="#371">371</a> <strong class="jxr_keyword">public</strong> String toHex() {
<a name="372" href="#372">372</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.hexEncoded == <strong class="jxr_keyword">null</strong>) {
<a name="373" href="#373">373</a> <strong class="jxr_keyword">this</strong>.hexEncoded = Hex.encodeToString(getBytes());
<a name="374" href="#374">374</a> }
<a name="375" href="#375">375</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.hexEncoded;
<a name="376" href="#376">376</a> }
<a name="377" href="#377">377</a>
<a name="378" href="#378">378</a> <em class="jxr_javadoccomment">/**</em>
<a name="379" href="#379">379</a> <em class="jxr_javadoccomment"> * Returns a Base64-encoded string of the underlying {@link #getBytes byte array}.</em>
<a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * This implementation caches the resulting Base64 string so multiple calls to this method remain efficient.</em>
<a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * However, calling {@link #setBytes setBytes} will null the cached value, forcing it to be recalculated the</em>
<a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> * next time this method is called.</em>
<a name="384" href="#384">384</a> <em class="jxr_javadoccomment"> *</em>
<a name="385" href="#385">385</a> <em class="jxr_javadoccomment"> * @return a Base64-encoded string of the underlying {@link #getBytes byte array}.</em>
<a name="386" href="#386">386</a> <em class="jxr_javadoccomment"> */</em>
<a name="387" href="#387">387</a> <strong class="jxr_keyword">public</strong> String toBase64() {
<a name="388" href="#388">388</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.base64Encoded == <strong class="jxr_keyword">null</strong>) {
<a name="389" href="#389">389</a> <em class="jxr_comment">//cache result in case this method is called multiple times.</em>
<a name="390" href="#390">390</a> <strong class="jxr_keyword">this</strong>.base64Encoded = Base64.encodeToString(getBytes());
<a name="391" href="#391">391</a> }
<a name="392" href="#392">392</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.base64Encoded;
<a name="393" href="#393">393</a> }
<a name="394" href="#394">394</a>
<a name="395" href="#395">395</a> <em class="jxr_javadoccomment">/**</em>
<a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> * Simple implementation that merely returns {@link #toHex() toHex()}.</em>
<a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> *</em>
<a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> * @return the {@link #toHex() toHex()} value.</em>
<a name="399" href="#399">399</a> <em class="jxr_javadoccomment"> */</em>
<a name="400" href="#400">400</a> <strong class="jxr_keyword">public</strong> String toString() {
<a name="401" href="#401">401</a> <strong class="jxr_keyword">return</strong> toHex();
<a name="402" href="#402">402</a> }
<a name="403" href="#403">403</a>
<a name="404" href="#404">404</a> <em class="jxr_javadoccomment">/**</em>
<a name="405" href="#405">405</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the specified object is a Hash and its {@link #getBytes byte array} is identical to</em>
<a name="406" href="#406">406</a> <em class="jxr_javadoccomment"> * this Hash's byte array, {@code false} otherwise.</em>
<a name="407" href="#407">407</a> <em class="jxr_javadoccomment"> *</em>
<a name="408" href="#408">408</a> <em class="jxr_javadoccomment"> * @param o the object (Hash) to check for equality.</em>
<a name="409" href="#409">409</a> <em class="jxr_javadoccomment"> * @return {@code true} if the specified object is a Hash and its {@link #getBytes byte array} is identical to</em>
<a name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * this Hash's byte array, {@code false} otherwise.</em>
<a name="411" href="#411">411</a> <em class="jxr_javadoccomment"> */</em>
<a name="412" href="#412">412</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object o) {
<a name="413" href="#413">413</a> <strong class="jxr_keyword">if</strong> (o instanceof Hash) {
<a name="414" href="#414">414</a> <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html">Hash</a> other = (Hash) o;
<a name="415" href="#415">415</a> <strong class="jxr_keyword">return</strong> Arrays.equals(getBytes(), other.getBytes());
<a name="416" href="#416">416</a> }
<a name="417" href="#417">417</a> <strong class="jxr_keyword">return</strong> false;
<a name="418" href="#418">418</a> }
<a name="419" href="#419">419</a>
<a name="420" href="#420">420</a> <em class="jxr_javadoccomment">/**</em>
<a name="421" href="#421">421</a> <em class="jxr_javadoccomment"> * Simply returns toHex().hashCode();</em>
<a name="422" href="#422">422</a> <em class="jxr_javadoccomment"> *</em>
<a name="423" href="#423">423</a> <em class="jxr_javadoccomment"> * @return toHex().hashCode()</em>
<a name="424" href="#424">424</a> <em class="jxr_javadoccomment"> */</em>
<a name="425" href="#425">425</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a name="426" href="#426">426</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.bytes == <strong class="jxr_keyword">null</strong> || <strong class="jxr_keyword">this</strong>.bytes.length == 0) {
<a name="427" href="#427">427</a> <strong class="jxr_keyword">return</strong> 0;
<a name="428" href="#428">428</a> }
<a name="429" href="#429">429</a> <strong class="jxr_keyword">return</strong> Arrays.hashCode(<strong class="jxr_keyword">this</strong>.bytes);
<a name="430" href="#430">430</a> }
<a name="431" href="#431">431</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>