| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.shiro.crypto.hash;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>/**<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * A {@code HashService} hashes input sources utilizing a particular hashing strategy.<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * <p/><a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * A {@code HashService} sits at a higher architectural level than Shiro's simple {@link Hash} classes: it allows<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * for salting and iteration-related strategies to be configured and internalized in a<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * single component that can be re-used in multiple places in the application.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * <p/><a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * For example, for the most secure hashes, it is highly recommended to use a randomly generated salt, potentially<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * paired with an configuration-specific private salt, in addition to using multiple hash iterations.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <p/><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * While one can do this easily enough using Shiro's {@link Hash} implementations directly, this direct approach could<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * quickly lead to copy-and-paste behavior. For example, consider this logic which might need to repeated in an<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * application:<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <pre><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * int numHashIterations = ...<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * ByteSource privateSalt = ...<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * ByteSource randomSalt = {@link org.apache.shiro.crypto.RandomNumberGenerator randomNumberGenerator}.nextBytes();<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * ByteSource combined = combine(privateSalt, randomSalt);<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Hash hash = Sha512Hash(source, combined, numHashIterations);<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * save(hash);<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * </pre><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * In this example, often only the input source will change during runtime, while the hashing strategy (how salts<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * are generated or acquired, how many hash iterations will be performed, etc) usually remain consistent. A HashService<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * internalizes this logic so the above becomes simply this:<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <pre><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * HashRequest request = new HashRequest.Builder().source(source).build();<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Hash result = hashService.hash(request);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * save(result);<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * </pre><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @since 1.2<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>public interface HashService {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Computes a hash based on the given request.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> *<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <h3>Salt Notice</h3><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> *<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * If a salt accompanies the return value<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * (i.e. <code>returnedHash.{@link org.apache.shiro.crypto.hash.Hash#getSalt() getSalt()} != null</code>), this<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * same exact salt <b><em>MUST</em></b> be presented back to the {@code HashService} if hash<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * comparison/verification will be performed at a later time (for example, for password hash or file checksum<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * comparison).<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <p/><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * For additional security, the {@code HashService}'s internal implementation may use more complex salting<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * strategies than what would be achieved by computing a {@code Hash} manually.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <p/><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * In summary, if a {@link HashService} returns a salt in a returned Hash, it is expected that the same salt<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * will be provided to the same {@code HashService} instance.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> *<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @param request the request to process<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @return the hashed data<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @see Hash#getSalt()<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> */<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> Hash computeHash(HashRequest request);<a name="line.76"></a> |
| <span class="sourceLineNo">077</span>}<a name="line.77"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
