| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.crypto.hash;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.codec.Base64;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.codec.CodecException;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.codec.Hex;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.crypto.UnknownAlgorithmException;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.util.ByteSource;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.util.StringUtils;<a name="line.26"></a> |
| <FONT color="green">027</FONT> <a name="line.27"></a> |
| <FONT color="green">028</FONT> import java.security.MessageDigest;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import java.security.NoSuchAlgorithmException;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import java.util.Arrays;<a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> /**<a name="line.32"></a> |
| <FONT color="green">033</FONT> * A {@code Hash} implementation that allows any {@link java.security.MessageDigest MessageDigest} algorithm name to<a name="line.33"></a> |
| <FONT color="green">034</FONT> * be used. This class is a less type-safe variant than the other {@code AbstractHash} subclasses<a name="line.34"></a> |
| <FONT color="green">035</FONT> * (e.g. {@link Sha512Hash}, etc), but it does allow for any algorithm name to be specified in case the other subclass<a name="line.35"></a> |
| <FONT color="green">036</FONT> * implementations do not represent an algorithm that you may want to use.<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <p/><a name="line.37"></a> |
| <FONT color="green">038</FONT> * As of Shiro 1.1, this class effectively replaces the (now-deprecated) {@link AbstractHash} class. It subclasses<a name="line.38"></a> |
| <FONT color="green">039</FONT> * {@code AbstractHash} only to retain backwards-compatibility.<a name="line.39"></a> |
| <FONT color="green">040</FONT> *<a name="line.40"></a> |
| <FONT color="green">041</FONT> * @since 1.1<a name="line.41"></a> |
| <FONT color="green">042</FONT> */<a name="line.42"></a> |
| <FONT color="green">043</FONT> public class SimpleHash extends AbstractHash {<a name="line.43"></a> |
| <FONT color="green">044</FONT> <a name="line.44"></a> |
| <FONT color="green">045</FONT> private static final int DEFAULT_ITERATIONS = 1;<a name="line.45"></a> |
| <FONT color="green">046</FONT> <a name="line.46"></a> |
| <FONT color="green">047</FONT> /**<a name="line.47"></a> |
| <FONT color="green">048</FONT> * The {@link java.security.MessageDigest MessageDigest} algorithm name to use when performing the hash.<a name="line.48"></a> |
| <FONT color="green">049</FONT> */<a name="line.49"></a> |
| <FONT color="green">050</FONT> private final String algorithmName;<a name="line.50"></a> |
| <FONT color="green">051</FONT> <a name="line.51"></a> |
| <FONT color="green">052</FONT> /**<a name="line.52"></a> |
| <FONT color="green">053</FONT> * The hashed data<a name="line.53"></a> |
| <FONT color="green">054</FONT> */<a name="line.54"></a> |
| <FONT color="green">055</FONT> private byte[] bytes;<a name="line.55"></a> |
| <FONT color="green">056</FONT> <a name="line.56"></a> |
| <FONT color="green">057</FONT> /**<a name="line.57"></a> |
| <FONT color="green">058</FONT> * Supplied salt, if any.<a name="line.58"></a> |
| <FONT color="green">059</FONT> */<a name="line.59"></a> |
| <FONT color="green">060</FONT> private ByteSource salt;<a name="line.60"></a> |
| <FONT color="green">061</FONT> <a name="line.61"></a> |
| <FONT color="green">062</FONT> /**<a name="line.62"></a> |
| <FONT color="green">063</FONT> * Number of hash iterations to perform. Defaults to 1 in the constructor.<a name="line.63"></a> |
| <FONT color="green">064</FONT> */<a name="line.64"></a> |
| <FONT color="green">065</FONT> private int iterations;<a name="line.65"></a> |
| <FONT color="green">066</FONT> <a name="line.66"></a> |
| <FONT color="green">067</FONT> /**<a name="line.67"></a> |
| <FONT color="green">068</FONT> * Cached value of the {@link #toHex() toHex()} call so multiple calls won't incur repeated overhead.<a name="line.68"></a> |
| <FONT color="green">069</FONT> */<a name="line.69"></a> |
| <FONT color="green">070</FONT> private transient String hexEncoded = null;<a name="line.70"></a> |
| <FONT color="green">071</FONT> <a name="line.71"></a> |
| <FONT color="green">072</FONT> /**<a name="line.72"></a> |
| <FONT color="green">073</FONT> * Cached value of the {@link #toBase64() toBase64()} call so multiple calls won't incur repeated overhead.<a name="line.73"></a> |
| <FONT color="green">074</FONT> */<a name="line.74"></a> |
| <FONT color="green">075</FONT> private transient String base64Encoded = null;<a name="line.75"></a> |
| <FONT color="green">076</FONT> <a name="line.76"></a> |
| <FONT color="green">077</FONT> /**<a name="line.77"></a> |
| <FONT color="green">078</FONT> * Creates an new instance with only its {@code algorithmName} set - no hashing is performed.<a name="line.78"></a> |
| <FONT color="green">079</FONT> * <p/><a name="line.79"></a> |
| <FONT color="green">080</FONT> * Because all other constructors in this class hash the {@code source} constructor argument, this<a name="line.80"></a> |
| <FONT color="green">081</FONT> * constructor is useful in scenarios when you have a byte array that you know is already hashed and<a name="line.81"></a> |
| <FONT color="green">082</FONT> * just want to set the bytes in their raw form directly on an instance. After using this constructor,<a name="line.82"></a> |
| <FONT color="green">083</FONT> * you can then immediately call {@link #setBytes setBytes} to have a fully-initialized instance.<a name="line.83"></a> |
| <FONT color="green">084</FONT> * <p/><a name="line.84"></a> |
| <FONT color="green">085</FONT> * <b>N.B.</b>The algorithm identified by the {@code algorithmName} parameter must be available on the JVM. If it<a name="line.85"></a> |
| <FONT color="green">086</FONT> * is not, a {@link UnknownAlgorithmException} will be thrown when the hash is performed (not at instantiation).<a name="line.86"></a> |
| <FONT color="green">087</FONT> *<a name="line.87"></a> |
| <FONT color="green">088</FONT> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when<a name="line.88"></a> |
| <FONT color="green">089</FONT> * performing the hash.<a name="line.89"></a> |
| <FONT color="green">090</FONT> * @see UnknownAlgorithmException<a name="line.90"></a> |
| <FONT color="green">091</FONT> */<a name="line.91"></a> |
| <FONT color="green">092</FONT> public SimpleHash(String algorithmName) {<a name="line.92"></a> |
| <FONT color="green">093</FONT> this.algorithmName = algorithmName;<a name="line.93"></a> |
| <FONT color="green">094</FONT> this.iterations = DEFAULT_ITERATIONS;<a name="line.94"></a> |
| <FONT color="green">095</FONT> }<a name="line.95"></a> |
| <FONT color="green">096</FONT> <a name="line.96"></a> |
| <FONT color="green">097</FONT> /**<a name="line.97"></a> |
| <FONT color="green">098</FONT> * Creates an {@code algorithmName}-specific hash of the specified {@code source} with no {@code salt} using a<a name="line.98"></a> |
| <FONT color="green">099</FONT> * single hash iteration.<a name="line.99"></a> |
| <FONT color="green">100</FONT> * <p/><a name="line.100"></a> |
| <FONT color="green">101</FONT> * This is a convenience constructor that merely executes <code>this( algorithmName, source, null, 1);</code>.<a name="line.101"></a> |
| <FONT color="green">102</FONT> * <p/><a name="line.102"></a> |
| <FONT color="green">103</FONT> * Please see the<a name="line.103"></a> |
| <FONT color="green">104</FONT> * {@link #SimpleHash(String algorithmName, Object source, Object salt, int numIterations) SimpleHashHash(algorithmName, Object,Object,int)}<a name="line.104"></a> |
| <FONT color="green">105</FONT> * constructor for the types of Objects that may be passed into this constructor, as well as how to support further<a name="line.105"></a> |
| <FONT color="green">106</FONT> * types.<a name="line.106"></a> |
| <FONT color="green">107</FONT> *<a name="line.107"></a> |
| <FONT color="green">108</FONT> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when<a name="line.108"></a> |
| <FONT color="green">109</FONT> * performing the hash.<a name="line.109"></a> |
| <FONT color="green">110</FONT> * @param source the object to be hashed.<a name="line.110"></a> |
| <FONT color="green">111</FONT> * @throws org.apache.shiro.codec.CodecException<a name="line.111"></a> |
| <FONT color="green">112</FONT> * if the specified {@code source} cannot be converted into a byte array (byte[]).<a name="line.112"></a> |
| <FONT color="green">113</FONT> * @throws UnknownAlgorithmException if the {@code algorithmName} is not available.<a name="line.113"></a> |
| <FONT color="green">114</FONT> */<a name="line.114"></a> |
| <FONT color="green">115</FONT> public SimpleHash(String algorithmName, Object source) throws CodecException, UnknownAlgorithmException {<a name="line.115"></a> |
| <FONT color="green">116</FONT> //noinspection NullableProblems<a name="line.116"></a> |
| <FONT color="green">117</FONT> this(algorithmName, source, null, DEFAULT_ITERATIONS);<a name="line.117"></a> |
| <FONT color="green">118</FONT> }<a name="line.118"></a> |
| <FONT color="green">119</FONT> <a name="line.119"></a> |
| <FONT color="green">120</FONT> /**<a name="line.120"></a> |
| <FONT color="green">121</FONT> * Creates an {@code algorithmName}-specific hash of the specified {@code source} using the given {@code salt}<a name="line.121"></a> |
| <FONT color="green">122</FONT> * using a single hash iteration.<a name="line.122"></a> |
| <FONT color="green">123</FONT> * <p/><a name="line.123"></a> |
| <FONT color="green">124</FONT> * It is a convenience constructor that merely executes <code>this( algorithmName, source, salt, 1);</code>.<a name="line.124"></a> |
| <FONT color="green">125</FONT> * <p/><a name="line.125"></a> |
| <FONT color="green">126</FONT> * Please see the<a name="line.126"></a> |
| <FONT color="green">127</FONT> * {@link #SimpleHash(String algorithmName, Object source, Object salt, int numIterations) SimpleHashHash(algorithmName, Object,Object,int)}<a name="line.127"></a> |
| <FONT color="green">128</FONT> * constructor for the types of Objects that may be passed into this constructor, as well as how to support further<a name="line.128"></a> |
| <FONT color="green">129</FONT> * types.<a name="line.129"></a> |
| <FONT color="green">130</FONT> *<a name="line.130"></a> |
| <FONT color="green">131</FONT> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when<a name="line.131"></a> |
| <FONT color="green">132</FONT> * performing the hash.<a name="line.132"></a> |
| <FONT color="green">133</FONT> * @param source the source object to be hashed.<a name="line.133"></a> |
| <FONT color="green">134</FONT> * @param salt the salt to use for the hash<a name="line.134"></a> |
| <FONT color="green">135</FONT> * @throws CodecException if either constructor argument cannot be converted into a byte array.<a name="line.135"></a> |
| <FONT color="green">136</FONT> * @throws UnknownAlgorithmException if the {@code algorithmName} is not available.<a name="line.136"></a> |
| <FONT color="green">137</FONT> */<a name="line.137"></a> |
| <FONT color="green">138</FONT> public SimpleHash(String algorithmName, Object source, Object salt) throws CodecException, UnknownAlgorithmException {<a name="line.138"></a> |
| <FONT color="green">139</FONT> this(algorithmName, source, salt, DEFAULT_ITERATIONS);<a name="line.139"></a> |
| <FONT color="green">140</FONT> }<a name="line.140"></a> |
| <FONT color="green">141</FONT> <a name="line.141"></a> |
| <FONT color="green">142</FONT> /**<a name="line.142"></a> |
| <FONT color="green">143</FONT> * Creates an {@code algorithmName}-specific hash of the specified {@code source} using the given<a name="line.143"></a> |
| <FONT color="green">144</FONT> * {@code salt} a total of {@code hashIterations} times.<a name="line.144"></a> |
| <FONT color="green">145</FONT> * <p/><a name="line.145"></a> |
| <FONT color="green">146</FONT> * By default, this class only supports Object method arguments of<a name="line.146"></a> |
| <FONT color="green">147</FONT> * type {@code byte[]}, {@code char[]}, {@link String}, {@link java.io.File File},<a name="line.147"></a> |
| <FONT color="green">148</FONT> * {@link java.io.InputStream InputStream} or {@link org.apache.shiro.util.ByteSource ByteSource}. If either<a name="line.148"></a> |
| <FONT color="green">149</FONT> * argument is anything other than these types a {@link org.apache.shiro.codec.CodecException CodecException}<a name="line.149"></a> |
| <FONT color="green">150</FONT> * will be thrown.<a name="line.150"></a> |
| <FONT color="green">151</FONT> * <p/><a name="line.151"></a> |
| <FONT color="green">152</FONT> * If you want to be able to hash other object types, or use other salt types, you need to override the<a name="line.152"></a> |
| <FONT color="green">153</FONT> * {@link #toBytes(Object) toBytes(Object)} method to support those specific types. Your other option is to<a name="line.153"></a> |
| <FONT color="green">154</FONT> * convert your arguments to one of the default supported types first before passing them in to this<a name="line.154"></a> |
| <FONT color="green">155</FONT> * constructor}.<a name="line.155"></a> |
| <FONT color="green">156</FONT> *<a name="line.156"></a> |
| <FONT color="green">157</FONT> * @param algorithmName the {@link java.security.MessageDigest MessageDigest} algorithm name to use when<a name="line.157"></a> |
| <FONT color="green">158</FONT> * performing the hash.<a name="line.158"></a> |
| <FONT color="green">159</FONT> * @param source the source object to be hashed.<a name="line.159"></a> |
| <FONT color="green">160</FONT> * @param salt the salt to use for the hash<a name="line.160"></a> |
| <FONT color="green">161</FONT> * @param hashIterations the number of times the {@code source} argument hashed for attack resiliency.<a name="line.161"></a> |
| <FONT color="green">162</FONT> * @throws CodecException if either Object constructor argument cannot be converted into a byte array.<a name="line.162"></a> |
| <FONT color="green">163</FONT> * @throws UnknownAlgorithmException if the {@code algorithmName} is not available.<a name="line.163"></a> |
| <FONT color="green">164</FONT> */<a name="line.164"></a> |
| <FONT color="green">165</FONT> public SimpleHash(String algorithmName, Object source, Object salt, int hashIterations)<a name="line.165"></a> |
| <FONT color="green">166</FONT> throws CodecException, UnknownAlgorithmException {<a name="line.166"></a> |
| <FONT color="green">167</FONT> if (!StringUtils.hasText(algorithmName)) {<a name="line.167"></a> |
| <FONT color="green">168</FONT> throw new NullPointerException("algorithmName argument cannot be null or empty.");<a name="line.168"></a> |
| <FONT color="green">169</FONT> }<a name="line.169"></a> |
| <FONT color="green">170</FONT> this.algorithmName = algorithmName;<a name="line.170"></a> |
| <FONT color="green">171</FONT> this.iterations = Math.max(DEFAULT_ITERATIONS, hashIterations);<a name="line.171"></a> |
| <FONT color="green">172</FONT> ByteSource saltBytes = null;<a name="line.172"></a> |
| <FONT color="green">173</FONT> if (salt != null) {<a name="line.173"></a> |
| <FONT color="green">174</FONT> saltBytes = convertSaltToBytes(salt);<a name="line.174"></a> |
| <FONT color="green">175</FONT> this.salt = saltBytes;<a name="line.175"></a> |
| <FONT color="green">176</FONT> }<a name="line.176"></a> |
| <FONT color="green">177</FONT> ByteSource sourceBytes = convertSourceToBytes(source);<a name="line.177"></a> |
| <FONT color="green">178</FONT> hash(sourceBytes, saltBytes, hashIterations);<a name="line.178"></a> |
| <FONT color="green">179</FONT> }<a name="line.179"></a> |
| <FONT color="green">180</FONT> <a name="line.180"></a> |
| <FONT color="green">181</FONT> /**<a name="line.181"></a> |
| <FONT color="green">182</FONT> * Acquires the specified {@code source} argument's bytes and returns them in the form of a {@code ByteSource} instance.<a name="line.182"></a> |
| <FONT color="green">183</FONT> * <p/><a name="line.183"></a> |
| <FONT color="green">184</FONT> * This implementation merely delegates to the convenience {@link #toByteSource(Object)} method for generic<a name="line.184"></a> |
| <FONT color="green">185</FONT> * conversion. Can be overridden by subclasses for source-specific conversion.<a name="line.185"></a> |
| <FONT color="green">186</FONT> *<a name="line.186"></a> |
| <FONT color="green">187</FONT> * @param source the source object to be hashed.<a name="line.187"></a> |
| <FONT color="green">188</FONT> * @return the source's bytes in the form of a {@code ByteSource} instance.<a name="line.188"></a> |
| <FONT color="green">189</FONT> * @since 1.2<a name="line.189"></a> |
| <FONT color="green">190</FONT> */<a name="line.190"></a> |
| <FONT color="green">191</FONT> protected ByteSource convertSourceToBytes(Object source) {<a name="line.191"></a> |
| <FONT color="green">192</FONT> return toByteSource(source);<a name="line.192"></a> |
| <FONT color="green">193</FONT> }<a name="line.193"></a> |
| <FONT color="green">194</FONT> <a name="line.194"></a> |
| <FONT color="green">195</FONT> /**<a name="line.195"></a> |
| <FONT color="green">196</FONT> * Acquires the specified {@code salt} argument's bytes and returns them in the form of a {@code ByteSource} instance.<a name="line.196"></a> |
| <FONT color="green">197</FONT> * <p/><a name="line.197"></a> |
| <FONT color="green">198</FONT> * This implementation merely delegates to the convenience {@link #toByteSource(Object)} method for generic<a name="line.198"></a> |
| <FONT color="green">199</FONT> * conversion. Can be overridden by subclasses for salt-specific conversion.<a name="line.199"></a> |
| <FONT color="green">200</FONT> *<a name="line.200"></a> |
| <FONT color="green">201</FONT> * @param salt the salt to be use for the hash.<a name="line.201"></a> |
| <FONT color="green">202</FONT> * @return the salt's bytes in the form of a {@code ByteSource} instance.<a name="line.202"></a> |
| <FONT color="green">203</FONT> * @since 1.2<a name="line.203"></a> |
| <FONT color="green">204</FONT> */<a name="line.204"></a> |
| <FONT color="green">205</FONT> protected ByteSource convertSaltToBytes(Object salt) {<a name="line.205"></a> |
| <FONT color="green">206</FONT> return toByteSource(salt);<a name="line.206"></a> |
| <FONT color="green">207</FONT> }<a name="line.207"></a> |
| <FONT color="green">208</FONT> <a name="line.208"></a> |
| <FONT color="green">209</FONT> /**<a name="line.209"></a> |
| <FONT color="green">210</FONT> * Converts a given object into a {@code ByteSource} instance. Assumes the object can be converted to bytes.<a name="line.210"></a> |
| <FONT color="green">211</FONT> *<a name="line.211"></a> |
| <FONT color="green">212</FONT> * @param o the Object to convert into a {@code ByteSource} instance.<a name="line.212"></a> |
| <FONT color="green">213</FONT> * @return the {@code ByteSource} representation of the specified object's bytes.<a name="line.213"></a> |
| <FONT color="green">214</FONT> * @since 1.2<a name="line.214"></a> |
| <FONT color="green">215</FONT> */<a name="line.215"></a> |
| <FONT color="green">216</FONT> protected ByteSource toByteSource(Object o) {<a name="line.216"></a> |
| <FONT color="green">217</FONT> if (o == null) {<a name="line.217"></a> |
| <FONT color="green">218</FONT> return null;<a name="line.218"></a> |
| <FONT color="green">219</FONT> }<a name="line.219"></a> |
| <FONT color="green">220</FONT> if (o instanceof ByteSource) {<a name="line.220"></a> |
| <FONT color="green">221</FONT> return (ByteSource) o;<a name="line.221"></a> |
| <FONT color="green">222</FONT> }<a name="line.222"></a> |
| <FONT color="green">223</FONT> byte[] bytes = toBytes(o);<a name="line.223"></a> |
| <FONT color="green">224</FONT> return ByteSource.Util.bytes(bytes);<a name="line.224"></a> |
| <FONT color="green">225</FONT> }<a name="line.225"></a> |
| <FONT color="green">226</FONT> <a name="line.226"></a> |
| <FONT color="green">227</FONT> private void hash(ByteSource source, ByteSource salt, int hashIterations) throws CodecException, UnknownAlgorithmException {<a name="line.227"></a> |
| <FONT color="green">228</FONT> byte[] saltBytes = salt != null ? salt.getBytes() : null;<a name="line.228"></a> |
| <FONT color="green">229</FONT> byte[] hashedBytes = hash(source.getBytes(), saltBytes, hashIterations);<a name="line.229"></a> |
| <FONT color="green">230</FONT> setBytes(hashedBytes);<a name="line.230"></a> |
| <FONT color="green">231</FONT> }<a name="line.231"></a> |
| <FONT color="green">232</FONT> <a name="line.232"></a> |
| <FONT color="green">233</FONT> /**<a name="line.233"></a> |
| <FONT color="green">234</FONT> * Returns the {@link java.security.MessageDigest MessageDigest} algorithm name to use when performing the hash.<a name="line.234"></a> |
| <FONT color="green">235</FONT> *<a name="line.235"></a> |
| <FONT color="green">236</FONT> * @return the {@link java.security.MessageDigest MessageDigest} algorithm name to use when performing the hash.<a name="line.236"></a> |
| <FONT color="green">237</FONT> */<a name="line.237"></a> |
| <FONT color="green">238</FONT> public String getAlgorithmName() {<a name="line.238"></a> |
| <FONT color="green">239</FONT> return this.algorithmName;<a name="line.239"></a> |
| <FONT color="green">240</FONT> }<a name="line.240"></a> |
| <FONT color="green">241</FONT> <a name="line.241"></a> |
| <FONT color="green">242</FONT> public ByteSource getSalt() {<a name="line.242"></a> |
| <FONT color="green">243</FONT> return this.salt;<a name="line.243"></a> |
| <FONT color="green">244</FONT> }<a name="line.244"></a> |
| <FONT color="green">245</FONT> <a name="line.245"></a> |
| <FONT color="green">246</FONT> public int getIterations() {<a name="line.246"></a> |
| <FONT color="green">247</FONT> return this.iterations;<a name="line.247"></a> |
| <FONT color="green">248</FONT> }<a name="line.248"></a> |
| <FONT color="green">249</FONT> <a name="line.249"></a> |
| <FONT color="green">250</FONT> public byte[] getBytes() {<a name="line.250"></a> |
| <FONT color="green">251</FONT> return this.bytes;<a name="line.251"></a> |
| <FONT color="green">252</FONT> }<a name="line.252"></a> |
| <FONT color="green">253</FONT> <a name="line.253"></a> |
| <FONT color="green">254</FONT> /**<a name="line.254"></a> |
| <FONT color="green">255</FONT> * Sets the raw bytes stored by this hash instance.<a name="line.255"></a> |
| <FONT color="green">256</FONT> * <p/><a name="line.256"></a> |
| <FONT color="green">257</FONT> * The bytes are kept in raw form - they will not be hashed/changed. This is primarily a utility method for<a name="line.257"></a> |
| <FONT color="green">258</FONT> * constructing a Hash instance when the hashed value is already known.<a name="line.258"></a> |
| <FONT color="green">259</FONT> *<a name="line.259"></a> |
| <FONT color="green">260</FONT> * @param alreadyHashedBytes the raw already-hashed bytes to store in this instance.<a name="line.260"></a> |
| <FONT color="green">261</FONT> */<a name="line.261"></a> |
| <FONT color="green">262</FONT> public void setBytes(byte[] alreadyHashedBytes) {<a name="line.262"></a> |
| <FONT color="green">263</FONT> this.bytes = alreadyHashedBytes;<a name="line.263"></a> |
| <FONT color="green">264</FONT> this.hexEncoded = null;<a name="line.264"></a> |
| <FONT color="green">265</FONT> this.base64Encoded = null;<a name="line.265"></a> |
| <FONT color="green">266</FONT> }<a name="line.266"></a> |
| <FONT color="green">267</FONT> <a name="line.267"></a> |
| <FONT color="green">268</FONT> /**<a name="line.268"></a> |
| <FONT color="green">269</FONT> * Sets the iterations used to previously compute AN ALREADY GENERATED HASH.<a name="line.269"></a> |
| <FONT color="green">270</FONT> * <p/><a name="line.270"></a> |
| <FONT color="green">271</FONT> * This is provided <em>ONLY</em> to reconstitute an already-created Hash instance. It should ONLY ever be<a name="line.271"></a> |
| <FONT color="green">272</FONT> * invoked when re-constructing a hash instance from an already-hashed value.<a name="line.272"></a> |
| <FONT color="green">273</FONT> *<a name="line.273"></a> |
| <FONT color="green">274</FONT> * @param iterations the number of hash iterations used to previously create the hash/digest.<a name="line.274"></a> |
| <FONT color="green">275</FONT> * @since 1.2<a name="line.275"></a> |
| <FONT color="green">276</FONT> */<a name="line.276"></a> |
| <FONT color="green">277</FONT> public void setIterations(int iterations) {<a name="line.277"></a> |
| <FONT color="green">278</FONT> this.iterations = Math.max(DEFAULT_ITERATIONS, iterations);<a name="line.278"></a> |
| <FONT color="green">279</FONT> }<a name="line.279"></a> |
| <FONT color="green">280</FONT> <a name="line.280"></a> |
| <FONT color="green">281</FONT> /**<a name="line.281"></a> |
| <FONT color="green">282</FONT> * Sets the salt used to previously compute AN ALREADY GENERATED HASH.<a name="line.282"></a> |
| <FONT color="green">283</FONT> * <p/><a name="line.283"></a> |
| <FONT color="green">284</FONT> * This is provided <em>ONLY</em> to reconstitute a Hash instance that has already been computed. It should ONLY<a name="line.284"></a> |
| <FONT color="green">285</FONT> * ever be invoked when re-constructing a hash instance from an already-hashed value.<a name="line.285"></a> |
| <FONT color="green">286</FONT> *<a name="line.286"></a> |
| <FONT color="green">287</FONT> * @param salt the salt used to previously create the hash/digest.<a name="line.287"></a> |
| <FONT color="green">288</FONT> * @since 1.2<a name="line.288"></a> |
| <FONT color="green">289</FONT> */<a name="line.289"></a> |
| <FONT color="green">290</FONT> public void setSalt(ByteSource salt) {<a name="line.290"></a> |
| <FONT color="green">291</FONT> this.salt = salt;<a name="line.291"></a> |
| <FONT color="green">292</FONT> }<a name="line.292"></a> |
| <FONT color="green">293</FONT> <a name="line.293"></a> |
| <FONT color="green">294</FONT> /**<a name="line.294"></a> |
| <FONT color="green">295</FONT> * Returns the JDK MessageDigest instance to use for executing the hash.<a name="line.295"></a> |
| <FONT color="green">296</FONT> *<a name="line.296"></a> |
| <FONT color="green">297</FONT> * @param algorithmName the algorithm to use for the hash, provided by subclasses.<a name="line.297"></a> |
| <FONT color="green">298</FONT> * @return the MessageDigest object for the specified {@code algorithm}.<a name="line.298"></a> |
| <FONT color="green">299</FONT> * @throws UnknownAlgorithmException if the specified algorithm name is not available.<a name="line.299"></a> |
| <FONT color="green">300</FONT> */<a name="line.300"></a> |
| <FONT color="green">301</FONT> protected MessageDigest getDigest(String algorithmName) throws UnknownAlgorithmException {<a name="line.301"></a> |
| <FONT color="green">302</FONT> try {<a name="line.302"></a> |
| <FONT color="green">303</FONT> return MessageDigest.getInstance(algorithmName);<a name="line.303"></a> |
| <FONT color="green">304</FONT> } catch (NoSuchAlgorithmException e) {<a name="line.304"></a> |
| <FONT color="green">305</FONT> String msg = "No native '" + algorithmName + "' MessageDigest instance available on the current JVM.";<a name="line.305"></a> |
| <FONT color="green">306</FONT> throw new UnknownAlgorithmException(msg, e);<a name="line.306"></a> |
| <FONT color="green">307</FONT> }<a name="line.307"></a> |
| <FONT color="green">308</FONT> }<a name="line.308"></a> |
| <FONT color="green">309</FONT> <a name="line.309"></a> |
| <FONT color="green">310</FONT> /**<a name="line.310"></a> |
| <FONT color="green">311</FONT> * Hashes the specified byte array without a salt for a single iteration.<a name="line.311"></a> |
| <FONT color="green">312</FONT> *<a name="line.312"></a> |
| <FONT color="green">313</FONT> * @param bytes the bytes to hash.<a name="line.313"></a> |
| <FONT color="green">314</FONT> * @return the hashed bytes.<a name="line.314"></a> |
| <FONT color="green">315</FONT> * @throws UnknownAlgorithmException if the configured {@link #getAlgorithmName() algorithmName} is not available.<a name="line.315"></a> |
| <FONT color="green">316</FONT> */<a name="line.316"></a> |
| <FONT color="green">317</FONT> protected byte[] hash(byte[] bytes) throws UnknownAlgorithmException {<a name="line.317"></a> |
| <FONT color="green">318</FONT> return hash(bytes, null, DEFAULT_ITERATIONS);<a name="line.318"></a> |
| <FONT color="green">319</FONT> }<a name="line.319"></a> |
| <FONT color="green">320</FONT> <a name="line.320"></a> |
| <FONT color="green">321</FONT> /**<a name="line.321"></a> |
| <FONT color="green">322</FONT> * Hashes the specified byte array using the given {@code salt} for a single iteration.<a name="line.322"></a> |
| <FONT color="green">323</FONT> *<a name="line.323"></a> |
| <FONT color="green">324</FONT> * @param bytes the bytes to hash<a name="line.324"></a> |
| <FONT color="green">325</FONT> * @param salt the salt to use for the initial hash<a name="line.325"></a> |
| <FONT color="green">326</FONT> * @return the hashed bytes<a name="line.326"></a> |
| <FONT color="green">327</FONT> * @throws UnknownAlgorithmException if the configured {@link #getAlgorithmName() algorithmName} is not available.<a name="line.327"></a> |
| <FONT color="green">328</FONT> */<a name="line.328"></a> |
| <FONT color="green">329</FONT> protected byte[] hash(byte[] bytes, byte[] salt) throws UnknownAlgorithmException {<a name="line.329"></a> |
| <FONT color="green">330</FONT> return hash(bytes, salt, DEFAULT_ITERATIONS);<a name="line.330"></a> |
| <FONT color="green">331</FONT> }<a name="line.331"></a> |
| <FONT color="green">332</FONT> <a name="line.332"></a> |
| <FONT color="green">333</FONT> /**<a name="line.333"></a> |
| <FONT color="green">334</FONT> * Hashes the specified byte array using the given {@code salt} for the specified number of iterations.<a name="line.334"></a> |
| <FONT color="green">335</FONT> *<a name="line.335"></a> |
| <FONT color="green">336</FONT> * @param bytes the bytes to hash<a name="line.336"></a> |
| <FONT color="green">337</FONT> * @param salt the salt to use for the initial hash<a name="line.337"></a> |
| <FONT color="green">338</FONT> * @param hashIterations the number of times the the {@code bytes} will be hashed (for attack resiliency).<a name="line.338"></a> |
| <FONT color="green">339</FONT> * @return the hashed bytes.<a name="line.339"></a> |
| <FONT color="green">340</FONT> * @throws UnknownAlgorithmException if the {@link #getAlgorithmName() algorithmName} is not available.<a name="line.340"></a> |
| <FONT color="green">341</FONT> */<a name="line.341"></a> |
| <FONT color="green">342</FONT> protected byte[] hash(byte[] bytes, byte[] salt, int hashIterations) throws UnknownAlgorithmException {<a name="line.342"></a> |
| <FONT color="green">343</FONT> MessageDigest digest = getDigest(getAlgorithmName());<a name="line.343"></a> |
| <FONT color="green">344</FONT> if (salt != null) {<a name="line.344"></a> |
| <FONT color="green">345</FONT> digest.reset();<a name="line.345"></a> |
| <FONT color="green">346</FONT> digest.update(salt);<a name="line.346"></a> |
| <FONT color="green">347</FONT> }<a name="line.347"></a> |
| <FONT color="green">348</FONT> byte[] hashed = digest.digest(bytes);<a name="line.348"></a> |
| <FONT color="green">349</FONT> int iterations = hashIterations - DEFAULT_ITERATIONS; //already hashed once above<a name="line.349"></a> |
| <FONT color="green">350</FONT> //iterate remaining number:<a name="line.350"></a> |
| <FONT color="green">351</FONT> for (int i = 0; i < iterations; i++) {<a name="line.351"></a> |
| <FONT color="green">352</FONT> digest.reset();<a name="line.352"></a> |
| <FONT color="green">353</FONT> hashed = digest.digest(hashed);<a name="line.353"></a> |
| <FONT color="green">354</FONT> }<a name="line.354"></a> |
| <FONT color="green">355</FONT> return hashed;<a name="line.355"></a> |
| <FONT color="green">356</FONT> }<a name="line.356"></a> |
| <FONT color="green">357</FONT> <a name="line.357"></a> |
| <FONT color="green">358</FONT> public boolean isEmpty() {<a name="line.358"></a> |
| <FONT color="green">359</FONT> return this.bytes == null || this.bytes.length == 0;<a name="line.359"></a> |
| <FONT color="green">360</FONT> }<a name="line.360"></a> |
| <FONT color="green">361</FONT> <a name="line.361"></a> |
| <FONT color="green">362</FONT> /**<a name="line.362"></a> |
| <FONT color="green">363</FONT> * Returns a hex-encoded string of the underlying {@link #getBytes byte array}.<a name="line.363"></a> |
| <FONT color="green">364</FONT> * <p/><a name="line.364"></a> |
| <FONT color="green">365</FONT> * This implementation caches the resulting hex string so multiple calls to this method remain efficient.<a name="line.365"></a> |
| <FONT color="green">366</FONT> * However, calling {@link #setBytes setBytes} will null the cached value, forcing it to be recalculated the<a name="line.366"></a> |
| <FONT color="green">367</FONT> * next time this method is called.<a name="line.367"></a> |
| <FONT color="green">368</FONT> *<a name="line.368"></a> |
| <FONT color="green">369</FONT> * @return a hex-encoded string of the underlying {@link #getBytes byte array}.<a name="line.369"></a> |
| <FONT color="green">370</FONT> */<a name="line.370"></a> |
| <FONT color="green">371</FONT> public String toHex() {<a name="line.371"></a> |
| <FONT color="green">372</FONT> if (this.hexEncoded == null) {<a name="line.372"></a> |
| <FONT color="green">373</FONT> this.hexEncoded = Hex.encodeToString(getBytes());<a name="line.373"></a> |
| <FONT color="green">374</FONT> }<a name="line.374"></a> |
| <FONT color="green">375</FONT> return this.hexEncoded;<a name="line.375"></a> |
| <FONT color="green">376</FONT> }<a name="line.376"></a> |
| <FONT color="green">377</FONT> <a name="line.377"></a> |
| <FONT color="green">378</FONT> /**<a name="line.378"></a> |
| <FONT color="green">379</FONT> * Returns a Base64-encoded string of the underlying {@link #getBytes byte array}.<a name="line.379"></a> |
| <FONT color="green">380</FONT> * <p/><a name="line.380"></a> |
| <FONT color="green">381</FONT> * This implementation caches the resulting Base64 string so multiple calls to this method remain efficient.<a name="line.381"></a> |
| <FONT color="green">382</FONT> * However, calling {@link #setBytes setBytes} will null the cached value, forcing it to be recalculated the<a name="line.382"></a> |
| <FONT color="green">383</FONT> * next time this method is called.<a name="line.383"></a> |
| <FONT color="green">384</FONT> *<a name="line.384"></a> |
| <FONT color="green">385</FONT> * @return a Base64-encoded string of the underlying {@link #getBytes byte array}.<a name="line.385"></a> |
| <FONT color="green">386</FONT> */<a name="line.386"></a> |
| <FONT color="green">387</FONT> public String toBase64() {<a name="line.387"></a> |
| <FONT color="green">388</FONT> if (this.base64Encoded == null) {<a name="line.388"></a> |
| <FONT color="green">389</FONT> //cache result in case this method is called multiple times.<a name="line.389"></a> |
| <FONT color="green">390</FONT> this.base64Encoded = Base64.encodeToString(getBytes());<a name="line.390"></a> |
| <FONT color="green">391</FONT> }<a name="line.391"></a> |
| <FONT color="green">392</FONT> return this.base64Encoded;<a name="line.392"></a> |
| <FONT color="green">393</FONT> }<a name="line.393"></a> |
| <FONT color="green">394</FONT> <a name="line.394"></a> |
| <FONT color="green">395</FONT> /**<a name="line.395"></a> |
| <FONT color="green">396</FONT> * Simple implementation that merely returns {@link #toHex() toHex()}.<a name="line.396"></a> |
| <FONT color="green">397</FONT> *<a name="line.397"></a> |
| <FONT color="green">398</FONT> * @return the {@link #toHex() toHex()} value.<a name="line.398"></a> |
| <FONT color="green">399</FONT> */<a name="line.399"></a> |
| <FONT color="green">400</FONT> public String toString() {<a name="line.400"></a> |
| <FONT color="green">401</FONT> return toHex();<a name="line.401"></a> |
| <FONT color="green">402</FONT> }<a name="line.402"></a> |
| <FONT color="green">403</FONT> <a name="line.403"></a> |
| <FONT color="green">404</FONT> /**<a name="line.404"></a> |
| <FONT color="green">405</FONT> * Returns {@code true} if the specified object is a Hash and its {@link #getBytes byte array} is identical to<a name="line.405"></a> |
| <FONT color="green">406</FONT> * this Hash's byte array, {@code false} otherwise.<a name="line.406"></a> |
| <FONT color="green">407</FONT> *<a name="line.407"></a> |
| <FONT color="green">408</FONT> * @param o the object (Hash) to check for equality.<a name="line.408"></a> |
| <FONT color="green">409</FONT> * @return {@code true} if the specified object is a Hash and its {@link #getBytes byte array} is identical to<a name="line.409"></a> |
| <FONT color="green">410</FONT> * this Hash's byte array, {@code false} otherwise.<a name="line.410"></a> |
| <FONT color="green">411</FONT> */<a name="line.411"></a> |
| <FONT color="green">412</FONT> public boolean equals(Object o) {<a name="line.412"></a> |
| <FONT color="green">413</FONT> if (o instanceof Hash) {<a name="line.413"></a> |
| <FONT color="green">414</FONT> Hash other = (Hash) o;<a name="line.414"></a> |
| <FONT color="green">415</FONT> return Arrays.equals(getBytes(), other.getBytes());<a name="line.415"></a> |
| <FONT color="green">416</FONT> }<a name="line.416"></a> |
| <FONT color="green">417</FONT> return false;<a name="line.417"></a> |
| <FONT color="green">418</FONT> }<a name="line.418"></a> |
| <FONT color="green">419</FONT> <a name="line.419"></a> |
| <FONT color="green">420</FONT> /**<a name="line.420"></a> |
| <FONT color="green">421</FONT> * Simply returns toHex().hashCode();<a name="line.421"></a> |
| <FONT color="green">422</FONT> *<a name="line.422"></a> |
| <FONT color="green">423</FONT> * @return toHex().hashCode()<a name="line.423"></a> |
| <FONT color="green">424</FONT> */<a name="line.424"></a> |
| <FONT color="green">425</FONT> public int hashCode() {<a name="line.425"></a> |
| <FONT color="green">426</FONT> if (this.bytes == null || this.bytes.length == 0) {<a name="line.426"></a> |
| <FONT color="green">427</FONT> return 0;<a name="line.427"></a> |
| <FONT color="green">428</FONT> }<a name="line.428"></a> |
| <FONT color="green">429</FONT> return Arrays.hashCode(this.bytes);<a name="line.429"></a> |
| <FONT color="green">430</FONT> }<a name="line.430"></a> |
| <FONT color="green">431</FONT> }<a name="line.431"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
