| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> |
| <title>PasswordService xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/authc/credential/PasswordService.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.authc.credential; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource; |
| <a name="22" href="#22">22</a> |
| <a name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * A {@code PasswordService} supports common use cases when using passwords as a credentials mechanism.</em> |
| <a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * Most importantly, implementations of this interface are expected to employ best-practices to ensure that</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * passwords remain as safe as possible in application environments.</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * <h2>Usage</h2></em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * A {@code PasswordService} is used at two different times during an application's lifecycle:</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <li>When creating a user account or resetting their password</li></em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <li>When a user logs in, when passwords must be compared</li></em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <h3>Account Creation or Password Reset</h3></em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Whenever you create a new user account or reset that account's password, we must translate the end-user submitted</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * raw/plaintext password value to a string format that is much safer to store. You do that by calling the</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * {@link #encryptPassword(Object)} method to create the safer value. For</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * example:</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * String submittedPlaintextPassword = ...</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * String encryptedValue = passwordService.encryptPassword(submittedPlaintextPassword);</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * userAccount.setPassword(encryptedValue);</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * userAccount.save(); //create or update to your data store</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Be sure to save this encrypted password in your data store and never the original/raw submitted password.</em> |
| <a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <h3>Login Password Comparison</h3></em> |
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Shiro performs the comparison during login automatically. Along with your {@code PasswordService}, you just</em> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * have to configure a {@link PasswordMatcher} on a realm that has password-based accounts. During a login attempt,</em> |
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * shiro will use the {@code PasswordMatcher} and the {@code PasswordService} to automatically compare submitted</em> |
| <a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * passwords.</em> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * For example, if using Shiro's INI, here is how you might configure the PasswordMatcher and PasswordService:</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * [main]</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * passwordService = org.apache.shiro.authc.credential.DefaultPasswordService</em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * # configure the passwordService to use the settings you desire</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * passwordMatcher = org.apache.shiro.authc.credential.PasswordMatcher</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * passwordMatcher.passwordService = $passwordService</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * # Finally, set the matcher on a realm that requires password matching for account authentication:</em> |
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * myRealm = ...</em> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * myRealm.credentialsMatcher = $passwordMatcher</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @see DefaultPasswordService</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @see PasswordMatcher</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @since 1.2</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="72" href="#72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../org/apache/shiro/authc/credential/PasswordService.html">PasswordService</a> { |
| <a name="73" href="#73">73</a> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * Converts the specified plaintext password (usually acquired from your application's 'new user' or 'password reset'</em> |
| <a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * workflow) into a formatted string safe for storage. The returned string can be safely saved with the</em> |
| <a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * corresponding user account record (e.g. as a 'password' attribute).</em> |
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * It is expected that the String returned from this method will be presented to the</em> |
| <a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * {@link #passwordsMatch(Object, String) passwordsMatch(plaintext,encrypted)} method when performing a</em> |
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * password comparison check.</em> |
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <h3>Usage</h3></em> |
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * The input argument type can be any 'byte backed' {@code Object} - almost always either a</em> |
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * String or character array representing passwords (character arrays are often a safer way to represent passwords</em> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * as they can be cleared/nulled-out after use. Any argument type supported by</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * {@link ByteSource.Util#isCompatible(Object)} is valid.</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * For example:</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * String rawPassword = ...</em> |
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * String encryptedValue = passwordService.encryptPassword(rawPassword);</em> |
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * or, identically:</em> |
| <a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * char[] rawPasswordChars = ...</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * String encryptedValue = passwordService.encryptPassword(rawPasswordChars);</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * The resulting {@code encryptedValue} should be stored with the account to be retrieved later during a</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * login attempt. For example:</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * String encryptedValue = passwordService.encryptPassword(rawPassword);</em> |
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * userAccount.setPassword(encryptedValue);</em> |
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * userAccount.save(); //create or update to your data store</em> |
| <a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @param plaintextPassword the raw password as 'byte-backed' object (String, character array, {@link ByteSource},</em> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * etc) usually acquired from your application's 'new user' or 'password reset' workflow.</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @return the encrypted password, formatted for storage.</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if the argument cannot be easily converted to bytes as defined by</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * {@link ByteSource.Util#isCompatible(Object)}.</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @see ByteSource.Util#isCompatible(Object)</em> |
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="115" href="#115">115</a> String encryptPassword(Object plaintextPassword) <strong class="jxr_keyword">throws</strong> IllegalArgumentException; |
| <a name="116" href="#116">116</a> |
| <a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Returns {@code true} if the {@code submittedPlaintext} password matches the existing {@code saved} password,</em> |
| <a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em> |
| <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * <h3>Usage</h3></em> |
| <a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * The {@code submittedPlaintext} argument type can be any 'byte backed' {@code Object} - almost always either a</em> |
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * String or character array representing passwords (character arrays are often a safer way to represent passwords</em> |
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * as they can be cleared/nulled-out after use. Any argument type supported by</em> |
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * {@link ByteSource.Util#isCompatible(Object)} is valid.</em> |
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * For example:</em> |
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * String submittedPassword = ...</em> |
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * passwordService.passwordsMatch(submittedPassword, encryptedPassword);</em> |
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * or similarly:</em> |
| <a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * char[] submittedPasswordCharacters = ...</em> |
| <a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * passwordService.passwordsMatch(submittedPasswordCharacters, encryptedPassword);</em> |
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * @param submittedPlaintext a raw/plaintext password submitted by an end user/Subject.</em> |
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * @param encrypted the previously encrypted password known to be associated with an account.</em> |
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * This value is expected to have been previously generated from the</em> |
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * {@link #encryptPassword(Object) encryptPassword} method (typically</em> |
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * when the account is created or the account's password is reset).</em> |
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * @return {@code true} if the {@code submittedPlaintext} password matches the existing {@code saved} password,</em> |
| <a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * {@code false} otherwise.</em> |
| <a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @see ByteSource.Util#isCompatible(Object)</em> |
| <a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="146" href="#146">146</a> <strong class="jxr_keyword">boolean</strong> passwordsMatch(Object submittedPlaintext, String encrypted); |
| <a name="147" href="#147">147</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
