| <!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"> * A Cryptographic {@code Hash} represents a one-way conversion algorithm that transforms an input source to an</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * underlying byte array. Hex and Base64-encoding output of the hashed bytes are automatically supported by the</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * inherited {@link #toHex() toHex()} and {@link #toBase64() toBase64()} methods.</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * <p/></a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * The bytes returned by the parent interface's {@link #getBytes() getBytes()} are the hashed value of the</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * original input source, also known as the 'checksum' or 'digest'.</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> *</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * @see Md2Hash</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * @see Md5Hash</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * @see Sha1Hash</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * @see Sha256Hash</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * @see Sha384Hash</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * @see Sha512Hash</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * @since 0.9</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> */</a> |
| <span class="sourceLineNo">039</span><a id="line.39">public interface Hash extends ByteSource {</a> |
| <span class="sourceLineNo">040</span><a id="line.40"></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> /**</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * Returns the name of the algorithm used to hash the input source, for example, {@code SHA-256}, {@code MD5}, etc.</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * <p/></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * The name is expected to be a {@link java.security.MessageDigest MessageDigest} algorithm name.</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> *</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * @return the the name of the algorithm used to hash the input source, for example, {@code SHA-256}, {@code MD5}, etc.</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * @since 1.1</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> */</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> String getAlgorithmName();</a> |
| <span class="sourceLineNo">050</span><a id="line.50"></a> |
| <span class="sourceLineNo">051</span><a id="line.51"> /**</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * Returns a salt used to compute the hash or {@code null} if no salt was used.</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> *</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * @return a salt used to compute the hash or {@code null} if no salt was used.</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * @since 1.2</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> */</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> ByteSource getSalt();</a> |
| <span class="sourceLineNo">058</span><a id="line.58"></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> /**</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * Returns the number of hash iterations used to compute the hash.</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> *</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @return the number of hash iterations used to compute the hash.</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * @since 1.2</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> */</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> int getIterations();</a> |
| <span class="sourceLineNo">066</span><a id="line.66"></a> |
| <span class="sourceLineNo">067</span><a id="line.67">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
