| <!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.authc.credential;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.crypto.hash.Hash;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.util.ByteSource;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">/**</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * A {@code HashingPasswordService} is a {@link PasswordService} that performs password encryption and comparisons</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * based on cryptographic {@link Hash}es.</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> *</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * @since 1.2</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> */</a> |
| <span class="sourceLineNo">030</span><a id="line.30">public interface HashingPasswordService extends PasswordService {</a> |
| <span class="sourceLineNo">031</span><a id="line.31"></a> |
| <span class="sourceLineNo">032</span><a id="line.32"> /**</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * Hashes the specified plaintext password using internal hashing configuration settings pertinent to password</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * hashing.</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> * <p/></a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * Note</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * that this method is only likely to be used in more complex environments that wish to format and/or save the</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * returned {@code Hash} object in a custom manner. Most applications will find the</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * {@link #encryptPassword(Object) encryptPassword} method suitable enough for safety</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * and ease-of-use.</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * <h3>Usage</h3></a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * The input argument type can be any 'byte backed' {@code Object} - almost always either a</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * String or character array representing passwords (character arrays are often a safer way to represent passwords</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * as they can be cleared/nulled-out after use. Any argument type supported by</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * {@link ByteSource.Util#isCompatible(Object)} is valid.</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * <p/></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * Regardless of your choice of using Strings or character arrays to represent submitted passwords, you can wrap</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * either as a {@code ByteSource} by using {@link ByteSource.Util}, for example, when the passwords are captured as</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * Strings:</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * <pre></a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * ByteSource passwordBytes = ByteSource.Util.bytes(submittedPasswordString);</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * Hash hashedPassword = hashingPasswordService.hashPassword(passwordBytes);</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * </pre></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * or, identically, when captured as a character array:</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * <pre></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * ByteSource passwordBytes = ByteSource.Util.bytes(submittedPasswordCharacterArray);</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * Hash hashedPassword = hashingPasswordService.hashPassword(passwordBytes);</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * </pre></a> |
| <span class="sourceLineNo">059</span><a id="line.59"> *</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @param plaintext the raw password as 'byte-backed' object (String, character array, {@link ByteSource},</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * etc) usually acquired from your application's 'new user' or 'password reset' workflow.</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @return the hashed password.</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * @throws IllegalArgumentException if the argument cannot be easily converted to bytes as defined by</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * {@link ByteSource.Util#isCompatible(Object)}.</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * @see ByteSource.Util#isCompatible(Object)</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * @see #encryptPassword(Object)</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> */</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> Hash hashPassword(Object plaintext) throws IllegalArgumentException;</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"> * Returns {@code true} if the {@code submittedPlaintext} password matches the existing {@code savedPasswordHash},</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * {@code false} otherwise. Note that this method is only likely to be used in more complex environments that</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * save hashes in a custom manner. Most applications will find the</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * {@link #passwordsMatch(Object, String) passwordsMatch(plaintext,string)} method</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * sufficient if {@link #encryptPassword(Object) encrypting passwords as Strings}.</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * <h3>Usage</h3></a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * The {@code submittedPlaintext} argument type can be any 'byte backed' {@code Object} - almost always either a</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * String or character array representing passwords (character arrays are often a safer way to represent passwords</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * as they can be cleared/nulled-out after use. Any argument type supported by</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * {@link ByteSource.Util#isCompatible(Object)} is valid.</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> *</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * @param plaintext a raw/plaintext password submitted by an end user/Subject.</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * @param savedPasswordHash the previously hashed password known to be associated with an account.</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * This value is expected to have been previously generated from the</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * {@link #hashPassword(Object) hashPassword} method (typically</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * when the account is created or the account's password is reset).</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * @return {@code true} if the {@code plaintext} password matches the existing {@code savedPasswordHash},</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * {@code false} otherwise.</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> */</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> boolean passwordsMatch(Object plaintext, Hash savedPasswordHash);</a> |
| <span class="sourceLineNo">091</span><a id="line.91">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
