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