| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.crypto.hash;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.util.ByteSource;</a> |
| <span class="sourceLineNo">022</span><a id="line.22"></a> |
| <span class="sourceLineNo">023</span><a id="line.23">/**</a> |
| <span class="sourceLineNo">024</span><a id="line.24"> * Simple implementation of {@link HashRequest} that can be used when interacting with a {@link HashService}.</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> *</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * @since 1.2</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> */</a> |
| <span class="sourceLineNo">028</span><a id="line.28">public class SimpleHashRequest implements HashRequest {</a> |
| <span class="sourceLineNo">029</span><a id="line.29"></a> |
| <span class="sourceLineNo">030</span><a id="line.30"> private final ByteSource source; //cannot be null - this is the source to hash.</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> private final ByteSource salt; //null = no salt specified</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> private final int iterations; //0 = not specified by the requestor; let the HashService decide.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> private final String algorithmName; //null = let the HashService decide.</a> |
| <span class="sourceLineNo">034</span><a id="line.34"></a> |
| <span class="sourceLineNo">035</span><a id="line.35"> /**</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * Creates a new SimpleHashRequest instance.</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> *</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * @param algorithmName the name of the hash algorithm to use. This is often null as the</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * {@link HashService} implementation is usually configured with an appropriate algorithm name, but this</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * can be non-null if the hash service's algorithm should be overridden with a specific one for the duration</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * of the request.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> *</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * @param source the source to be hashed</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @param salt any public salt which should be used when computing the hash</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * @param iterations the number of hash iterations to execute. Zero (0) indicates no iterations were specified</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * for the request, at which point the number of iterations is decided by the {@code HashService}</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * @throws NullPointerException if {@code source} is null or empty.</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> */</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> public SimpleHashRequest(String algorithmName, ByteSource source, ByteSource salt, int iterations) {</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> if (source == null) {</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> throw new NullPointerException("source argument cannot be null");</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> }</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> this.source = source;</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> this.salt = salt;</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> this.algorithmName = algorithmName;</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> this.iterations = Math.max(0, iterations);</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> }</a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> public ByteSource getSource() {</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> return this.source;</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> }</a> |
| <span class="sourceLineNo">062</span><a id="line.62"></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> public ByteSource getSalt() {</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> return this.salt;</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> }</a> |
| <span class="sourceLineNo">066</span><a id="line.66"></a> |
| <span class="sourceLineNo">067</span><a id="line.67"> public int getIterations() {</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> return iterations;</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> }</a> |
| <span class="sourceLineNo">070</span><a id="line.70"></a> |
| <span class="sourceLineNo">071</span><a id="line.71"> public String getAlgorithmName() {</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> return algorithmName;</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> }</a> |
| <span class="sourceLineNo">074</span><a id="line.74">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
