Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.0 / shiro-crypto-hash / xref / org / apache / shiro / crypto / hash / SimpleHash.html
blob: 9131f3821e93736be5f46cc100efa4ab5f2af799 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>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 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.crypto.hash;
<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.codec.Base64;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.CodecException;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Hex;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.UnknownAlgorithmException;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils;
<a class="jxr_linenumber" name="L27" href="#L27">27</a>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.security.MessageDigest;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.security.NoSuchAlgorithmException;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * A {@code Hash} implementation that allows any {@link java.security.MessageDigest MessageDigest} algorithm name to</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * be used. This class is a less type-safe variant than the other {@code AbstractHash} subclasses</em>
<a class="jxr_linenumber" name="L35" href="#L35">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 class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * implementations do not represent an algorithm that you may want to use.</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L38" href="#L38">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 class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * {@code AbstractHash} only to retain backwards-compatibility.</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @since 1.1</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L43" href="#L43">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 class="jxr_linenumber" name="L44" href="#L44">44</a>
<a class="jxr_linenumber" name="L45" href="#L45">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 class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * The {@link java.security.MessageDigest MessageDigest} algorithm name to use when performing the hash.</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String algorithmName;
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * The hashed data</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> byte[] bytes;
<a class="jxr_linenumber" name="L56" href="#L56">56</a>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Supplied salt, if any.</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> <strong class="jxr_keyword">private</strong> ByteSource salt;
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * Number of hash iterations to perform. Defaults to 1 in the constructor.</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> iterations;
<a class="jxr_linenumber" name="L66" href="#L66">66</a>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * Cached value of the {@link #toHex() toHex()} call so multiple calls won't incur repeated overhead.</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> String hexEncoded = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L71" href="#L71">71</a>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Cached value of the {@link #toBase64() toBase64()} call so multiple calls won't incur repeated overhead.</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">transient</strong> String base64Encoded = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L76" href="#L76">76</a>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * Creates an new instance with only its {@code algorithmName} set - no hashing is performed.</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Because all other constructors in this class hash the {@code source} constructor argument, this</em>
<a class="jxr_linenumber" name="L81" href="#L81">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 class="jxr_linenumber" name="L82" href="#L82">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 class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * you can then immediately call {@link #setBytes setBytes} to have a fully-initialized instance.</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L85" href="#L85">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 class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * is not, a {@link UnknownAlgorithmException} will be thrown when the hash is performed (not at instantiation).</em>
<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"> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * performing the hash.</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @see UnknownAlgorithmException</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/crypto/hash/SimpleHash.html">SimpleHash</a>(String algorithmName) {
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">this</strong>.algorithmName = algorithmName;
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">this</strong>.iterations = DEFAULT_ITERATIONS;
<a class="jxr_linenumber" name="L95" href="#L95">95</a> }
<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"> * Creates an {@code algorithmName}-specific hash of the specified {@code source} with no {@code salt} using a</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * single hash iteration.</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L101" href="#L101">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 class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Please see the</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * {@link #SimpleHash(String algorithmName, Object source, Object salt, int numIterations) SimpleHashHash(algorithmName, Object,Object,int)}</em>
<a class="jxr_linenumber" name="L105" href="#L105">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 class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * types.</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * performing the hash.</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @param source the object to be hashed.</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @throws org.apache.shiro.codec.CodecException</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * if the specified {@code source} cannot be converted into a byte array (byte[]).</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the {@code algorithmName} is not available.</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L115" href="#L115">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 class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_comment">//noinspection NullableProblems</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">this</strong>(algorithmName, source, <strong class="jxr_keyword">null</strong>, DEFAULT_ITERATIONS);
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
<a class="jxr_linenumber" name="L119" href="#L119">119</a>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * Creates an {@code algorithmName}-specific hash of the specified {@code source} using the given {@code salt}</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * using a single hash iteration.</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L124" href="#L124">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 class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * Please see the</em>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * {@link #SimpleHash(String algorithmName, Object source, Object salt, int numIterations) SimpleHashHash(algorithmName, Object,Object,int)}</em>
<a class="jxr_linenumber" name="L128" href="#L128">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 class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * types.</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * performing the hash.</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @param source the source object to be hashed.</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @param salt the salt to use for the hash</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @throws CodecException if either constructor argument cannot be converted into a byte array.</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the {@code algorithmName} is not available.</em>
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L138" href="#L138">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 class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">this</strong>(algorithmName, source, salt, DEFAULT_ITERATIONS);
<a class="jxr_linenumber" name="L140" href="#L140">140</a> }
<a class="jxr_linenumber" name="L141" href="#L141">141</a>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * Creates an {@code algorithmName}-specific hash of the specified {@code source} using the given</em>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * {@code salt} a total of {@code hashIterations} times.</em>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * By default, this class only supports Object method arguments of</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * type {@code byte[]}, {@code char[]}, {@link String}, {@link java.io.File File},</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * {@link java.io.InputStream InputStream} or {@link org.apache.shiro.util.ByteSource ByteSource}. If either</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * argument is anything other than these types a {@link org.apache.shiro.codec.CodecException CodecException}</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * will be thrown.</em>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L152" href="#L152">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 class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * {@link #toBytes(Object) toBytes(Object)} method to support those specific types. Your other option is to</em>
<a class="jxr_linenumber" name="L154" href="#L154">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 class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * constructor}.</em>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when</em>
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * performing the hash.</em>
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @param source the source object to be hashed.</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @param salt the salt to use for the hash</em>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @param hashIterations the number of times the {@code source} argument hashed for attack resiliency.</em>
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @throws CodecException if either Object constructor argument cannot be converted into a byte array.</em>
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the {@code algorithmName} is not available.</em>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L165" href="#L165">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 class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">throws</strong> CodecException, UnknownAlgorithmException {
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(algorithmName)) {
<a class="jxr_linenumber" name="L168" href="#L168">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 class="jxr_linenumber" name="L169" href="#L169">169</a> }
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">this</strong>.algorithmName = algorithmName;
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">this</strong>.iterations = Math.max(DEFAULT_ITERATIONS, hashIterations);
<a class="jxr_linenumber" name="L172" href="#L172">172</a> ByteSource saltBytes = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">if</strong> (salt != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L174" href="#L174">174</a> saltBytes = convertSaltToBytes(salt);
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">this</strong>.salt = saltBytes;
<a class="jxr_linenumber" name="L176" href="#L176">176</a> }
<a class="jxr_linenumber" name="L177" href="#L177">177</a> ByteSource sourceBytes = convertSourceToBytes(source);
<a class="jxr_linenumber" name="L178" href="#L178">178</a> hash(sourceBytes, saltBytes, hashIterations);
<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
<a class="jxr_linenumber" name="L180" href="#L180">180</a>
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L182" href="#L182">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 class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * This implementation merely delegates to the convenience {@link #toByteSource(Object)} method for generic</em>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * conversion. Can be overridden by subclasses for source-specific conversion.</em>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * @param source the source object to be hashed.</em>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @return the source's bytes in the form of a {@code ByteSource} instance.</em>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">protected</strong> ByteSource convertSourceToBytes(Object source) {
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">return</strong> toByteSource(source);
<a class="jxr_linenumber" name="L193" href="#L193">193</a> }
<a class="jxr_linenumber" name="L194" href="#L194">194</a>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L196" href="#L196">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 class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * This implementation merely delegates to the convenience {@link #toByteSource(Object)} method for generic</em>
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * conversion. Can be overridden by subclasses for salt-specific conversion.</em>
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * @param salt the salt to be use for the hash.</em>
<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @return the salt's bytes in the form of a {@code ByteSource} instance.</em>
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">protected</strong> ByteSource convertSaltToBytes(Object salt) {
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">return</strong> toByteSource(salt);
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L210" href="#L210">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 class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * @param o the Object to convert into a {@code ByteSource} instance.</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @return the {@code ByteSource} representation of the specified object's bytes.</em>
<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">protected</strong> ByteSource toByteSource(Object o) {
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">if</strong> (o == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L219" href="#L219">219</a> }
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">if</strong> (o instanceof ByteSource) {
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">return</strong> (ByteSource) o;
<a class="jxr_linenumber" name="L222" href="#L222">222</a> }
<a class="jxr_linenumber" name="L223" href="#L223">223</a> byte[] bytes = toBytes(o);
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">return</strong> ByteSource.Util.bytes(bytes);
<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
<a class="jxr_linenumber" name="L226" href="#L226">226</a>
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> hash(ByteSource source, ByteSource salt, <strong class="jxr_keyword">int</strong> hashIterations) <strong class="jxr_keyword">throws</strong> CodecException, UnknownAlgorithmException {
<a class="jxr_linenumber" name="L228" href="#L228">228</a> byte[] saltBytes = salt != <strong class="jxr_keyword">null</strong> ? salt.getBytes() : <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L229" href="#L229">229</a> byte[] hashedBytes = hash(source.getBytes(), saltBytes, hashIterations);
<a class="jxr_linenumber" name="L230" href="#L230">230</a> setBytes(hashedBytes);
<a class="jxr_linenumber" name="L231" href="#L231">231</a> }
<a class="jxr_linenumber" name="L232" href="#L232">232</a>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * Returns the {@link java.security.MessageDigest MessageDigest} algorithm name to use when performing the hash.</em>
<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"> * @return the {@link java.security.MessageDigest MessageDigest} algorithm name to use when performing the hash.</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> <strong class="jxr_keyword">public</strong> String getAlgorithmName() {
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.algorithmName;
<a class="jxr_linenumber" name="L240" href="#L240">240</a> }
<a class="jxr_linenumber" name="L241" href="#L241">241</a>
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">public</strong> ByteSource getSalt() {
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.salt;
<a class="jxr_linenumber" name="L244" href="#L244">244</a> }
<a class="jxr_linenumber" name="L245" href="#L245">245</a>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getIterations() {
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.iterations;
<a class="jxr_linenumber" name="L248" href="#L248">248</a> }
<a class="jxr_linenumber" name="L249" href="#L249">249</a>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">public</strong> byte[] getBytes() {
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.bytes;
<a class="jxr_linenumber" name="L252" href="#L252">252</a> }
<a class="jxr_linenumber" name="L253" href="#L253">253</a>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * Sets the raw bytes stored by this hash instance.</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L257" href="#L257">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 class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * constructing a Hash instance when the hashed value is already known.</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * @param alreadyHashedBytes the raw already-hashed bytes to store in this instance.</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setBytes(byte[] alreadyHashedBytes) {
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">this</strong>.bytes = alreadyHashedBytes;
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">this</strong>.hexEncoded = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">this</strong>.base64Encoded = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * Sets the iterations used to previously compute AN ALREADY GENERATED HASH.</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L271" href="#L271">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 class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * invoked when re-constructing a hash instance from an already-hashed value.</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * @param iterations the number of hash iterations used to previously create the hash/digest.</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setIterations(<strong class="jxr_keyword">int</strong> iterations) {
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">this</strong>.iterations = Math.max(DEFAULT_ITERATIONS, iterations);
<a class="jxr_linenumber" name="L279" href="#L279">279</a> }
<a class="jxr_linenumber" name="L280" href="#L280">280</a>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * Sets the salt used to previously compute AN ALREADY GENERATED HASH.</em>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L284" href="#L284">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 class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * ever be invoked when re-constructing a hash instance from an already-hashed value.</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @param salt the salt used to previously create the hash/digest.</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSalt(ByteSource salt) {
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">this</strong>.salt = salt;
<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"> * Returns the JDK MessageDigest instance to use for executing the hash.</em>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * @param algorithmName the algorithm to use for the hash, provided by subclasses.</em>
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * @return the MessageDigest object for the specified {@code algorithm}.</em>
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the specified algorithm name is not available.</em>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">protected</strong> MessageDigest getDigest(String algorithmName) <strong class="jxr_keyword">throws</strong> UnknownAlgorithmException {
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">return</strong> MessageDigest.getInstance(algorithmName);
<a class="jxr_linenumber" name="L304" href="#L304">304</a> } <strong class="jxr_keyword">catch</strong> (NoSuchAlgorithmException e) {
<a class="jxr_linenumber" name="L305" href="#L305">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 class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnknownAlgorithmException(msg, e);
<a class="jxr_linenumber" name="L307" href="#L307">307</a> }
<a class="jxr_linenumber" name="L308" href="#L308">308</a> }
<a class="jxr_linenumber" name="L309" href="#L309">309</a>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * Hashes the specified byte array without a salt for a single iteration.</em>
<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * @param bytes the bytes to hash.</em>
<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * @return the hashed bytes.</em>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the configured {@link #getAlgorithmName() algorithmName} is not available.</em>
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">protected</strong> byte[] hash(byte[] bytes) <strong class="jxr_keyword">throws</strong> UnknownAlgorithmException {
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">return</strong> hash(bytes, <strong class="jxr_keyword">null</strong>, DEFAULT_ITERATIONS);
<a class="jxr_linenumber" name="L319" href="#L319">319</a> }
<a class="jxr_linenumber" name="L320" href="#L320">320</a>
<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * Hashes the specified byte array using the given {@code salt} for a single iteration.</em>
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * @param bytes the bytes to hash</em>
<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * @param salt the salt to use for the initial hash</em>
<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * @return the hashed bytes</em>
<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the configured {@link #getAlgorithmName() algorithmName} is not available.</em>
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">protected</strong> byte[] hash(byte[] bytes, byte[] salt) <strong class="jxr_keyword">throws</strong> UnknownAlgorithmException {
<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong class="jxr_keyword">return</strong> hash(bytes, salt, DEFAULT_ITERATIONS);
<a class="jxr_linenumber" name="L331" href="#L331">331</a> }
<a class="jxr_linenumber" name="L332" href="#L332">332</a>
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * Hashes the specified byte array using the given {@code salt} for the specified number of iterations.</em>
<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @param bytes the bytes to hash</em>
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * @param salt the salt to use for the initial hash</em>
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * @param hashIterations the number of times the the {@code bytes} will be hashed (for attack resiliency).</em>
<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> * @return the hashed bytes.</em>
<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em class="jxr_javadoccomment"> * @throws UnknownAlgorithmException if the {@link #getAlgorithmName() algorithmName} is not available.</em>
<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L342" href="#L342">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 class="jxr_linenumber" name="L343" href="#L343">343</a> MessageDigest digest = getDigest(getAlgorithmName());
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">if</strong> (salt != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L345" href="#L345">345</a> digest.reset();
<a class="jxr_linenumber" name="L346" href="#L346">346</a> digest.update(salt);
<a class="jxr_linenumber" name="L347" href="#L347">347</a> }
<a class="jxr_linenumber" name="L348" href="#L348">348</a> byte[] hashed = digest.digest(bytes);
<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">int</strong> iterations = hashIterations - 1; <em class="jxr_comment">//already hashed once above</em>
<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_comment">//iterate remaining number:</em>
<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; iterations; i++) {
<a class="jxr_linenumber" name="L352" href="#L352">352</a> digest.reset();
<a class="jxr_linenumber" name="L353" href="#L353">353</a> hashed = digest.digest(hashed);
<a class="jxr_linenumber" name="L354" href="#L354">354</a> }
<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">return</strong> hashed;
<a class="jxr_linenumber" name="L356" href="#L356">356</a> }
<a class="jxr_linenumber" name="L357" href="#L357">357</a>
<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEmpty() {
<a class="jxr_linenumber" name="L359" href="#L359">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 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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment"> * Returns a hex-encoded string of the underlying {@link #getBytes byte array}.</em>
<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * This implementation caches the resulting hex string so multiple calls to this method remain efficient.</em>
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * However, calling {@link #setBytes setBytes} will null the cached value, forcing it to be recalculated the</em>
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> * next time this method is called.</em>
<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * @return a hex-encoded string of the underlying {@link #getBytes byte array}.</em>
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">public</strong> String toHex() {
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.hexEncoded == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">this</strong>.hexEncoded = Hex.encodeToString(getBytes());
<a class="jxr_linenumber" name="L374" href="#L374">374</a> }
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.hexEncoded;
<a class="jxr_linenumber" name="L376" href="#L376">376</a> }
<a class="jxr_linenumber" name="L377" href="#L377">377</a>
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> * Returns a Base64-encoded string of the underlying {@link #getBytes byte array}.</em>
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> * This implementation caches the resulting Base64 string so multiple calls to this method remain efficient.</em>
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * However, calling {@link #setBytes setBytes} will null the cached value, forcing it to be recalculated the</em>
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> * next time this method is called.</em>
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * @return a Base64-encoded string of the underlying {@link #getBytes byte array}.</em>
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong class="jxr_keyword">public</strong> String toBase64() {
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.base64Encoded == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_comment">//cache result in case this method is called multiple times.</em>
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">this</strong>.base64Encoded = Base64.encodeToString(getBytes());
<a class="jxr_linenumber" name="L391" href="#L391">391</a> }
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.base64Encoded;
<a class="jxr_linenumber" name="L393" href="#L393">393</a> }
<a class="jxr_linenumber" name="L394" href="#L394">394</a>
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * Simple implementation that merely returns {@link #toHex() toHex()}.</em>
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * @return the {@link #toHex() toHex()} value.</em>
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L400" href="#L400">400</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">return</strong> toHex();
<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 {@code true} if the specified object is a Hash and its {@link #getBytes byte array} is identical to</em>
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * this Hash's byte array, {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * @param o the object (Hash) to check for equality.</em>
<a class="jxr_linenumber" name="L409" href="#L409">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 class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * this Hash's byte array, {@code false} otherwise.</em>
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object o) {
<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">if</strong> (o instanceof Hash) {
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html">Hash</a> other = (Hash) o;
<a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong class="jxr_keyword">return</strong> MessageDigest.isEqual(getBytes(), other.getBytes());
<a class="jxr_linenumber" name="L416" href="#L416">416</a> }
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L418" href="#L418">418</a> }
<a class="jxr_linenumber" name="L419" href="#L419">419</a>
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * Simply returns toHex().hashCode();</em>
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * @return toHex().hashCode()</em>
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a class="jxr_linenumber" name="L426" href="#L426">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 class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">return</strong> 0;
<a class="jxr_linenumber" name="L428" href="#L428">428</a> }
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">return</strong> Arrays.hashCode(<strong class="jxr_keyword">this</strong>.bytes);
<a class="jxr_linenumber" name="L430" href="#L430">430</a> }
<a class="jxr_linenumber" name="L431" href="#L431">431</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>