blob: 6b0355907f6c41e036109339c427ec246adbeb2c [file] [log] [blame]
<!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=UTF-8" />
<title>HashedCredentialsMatcherTest xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../testapidocs/org/apache/shiro/authc/credential/HashedCredentialsMatcherTest.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.authc.credential;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationInfo;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.AuthenticationToken;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.SimpleAuthenticationInfo;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.UsernamePasswordToken;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.SecureRandomNumberGenerator;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.Sha1Hash;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.PrincipalCollection;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.SimplePrincipalCollection;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.junit.Test;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.junit.Assert.assertTrue;
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Tests for the {@link org.apache.shiro.authc.credential.HashedCredentialsMatcher} class.</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/authc/credential/HashedCredentialsMatcherTest.html">HashedCredentialsMatcherTest</a> {
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * Test new Shiro 1.1 functionality, where the salt is obtained from the stored account information, as it</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * should be. See &lt;a href="https://issues.apache.org/jira/browse/SHIRO-186"&gt;SHIRO-186&lt;/a&gt;</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> @Test
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testSaltedAuthenticationInfo() {
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_comment">//use SHA-1 hashing in this test:</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> HashedCredentialsMatcher matcher = <strong class="jxr_keyword">new</strong> HashedCredentialsMatcher(Sha1Hash.ALGORITHM_NAME);
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_comment">//simulate a user account with a SHA-1 hashed and salted password:</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> ByteSource salt = <strong class="jxr_keyword">new</strong> SecureRandomNumberGenerator().nextBytes();
<a class="jxr_linenumber" name="L50" href="#L50">50</a> Object hashedPassword = <strong class="jxr_keyword">new</strong> Sha1Hash(<span class="jxr_string">"password"</span>, salt);
<a class="jxr_linenumber" name="L51" href="#L51">51</a> SimpleAuthenticationInfo account = <strong class="jxr_keyword">new</strong> SimpleAuthenticationInfo(<span class="jxr_string">"username"</span>, hashedPassword, salt, <span class="jxr_string">"realmName"</span>);
<a class="jxr_linenumber" name="L52" href="#L52">52</a>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_comment">//simulate a username/password (plaintext) token created in response to a login attempt:</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> AuthenticationToken token = <strong class="jxr_keyword">new</strong> UsernamePasswordToken(<span class="jxr_string">"username"</span>, <span class="jxr_string">"password"</span>);
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_comment">//verify the hashed token matches what is in the account:</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> assertTrue(matcher.doCredentialsMatch(token, account));
<a class="jxr_linenumber" name="L58" href="#L58">58</a> }
<a class="jxr_linenumber" name="L59" href="#L59">59</a>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Test backwards compatibility of unsalted credentials before</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * &lt;a href="https://issues.apache.org/jira/browse/SHIRO-186"&gt;SHIRO-186&lt;/a&gt; edits.</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> @Test
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testBackwardsCompatibleUnsaltedAuthenticationInfo() {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> HashedCredentialsMatcher matcher = <strong class="jxr_keyword">new</strong> HashedCredentialsMatcher(Sha1Hash.ALGORITHM_NAME);
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_comment">//simulate an account with SHA-1 hashed password (no salt)</em>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">final</strong> String username = <span class="jxr_string">"username"</span>;
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">final</strong> String password = <span class="jxr_string">"password"</span>;
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">final</strong> Object hashedPassword = <strong class="jxr_keyword">new</strong> Sha1Hash(password).getBytes();
<a class="jxr_linenumber" name="L72" href="#L72">72</a> AuthenticationInfo account = <strong class="jxr_keyword">new</strong> AuthenticationInfo() {
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> PrincipalCollection getPrincipals() {
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> SimplePrincipalCollection(username, <span class="jxr_string">"realmName"</span>);
<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
<a class="jxr_linenumber" name="L76" href="#L76">76</a>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">public</strong> Object getCredentials() {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">return</strong> hashedPassword;
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a> };
<a class="jxr_linenumber" name="L81" href="#L81">81</a>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_comment">//simulate a username/password (plaintext) token created in response to a login attempt:</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> AuthenticationToken token = <strong class="jxr_keyword">new</strong> UsernamePasswordToken(<span class="jxr_string">"username"</span>, <span class="jxr_string">"password"</span>);
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_comment">//verify the hashed token matches what is in the account:</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> assertTrue(matcher.doCredentialsMatch(token, account));
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
<a class="jxr_linenumber" name="L88" href="#L88">88</a>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Test backwards compatibility of salted credentials before</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * &lt;a href="https://issues.apache.org/jira/browse/SHIRO-186"&gt;SHIRO-186&lt;/a&gt; edits.</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> @Test
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> testBackwardsCompatibleSaltedAuthenticationInfo() {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> HashedCredentialsMatcher matcher = <strong class="jxr_keyword">new</strong> HashedCredentialsMatcher(Sha1Hash.ALGORITHM_NAME);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_comment">//enable this for Shiro 1.0 backwards compatibility:</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> matcher.setHashSalted(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L98" href="#L98">98</a>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_comment">//simulate an account with SHA-1 hashed password, using the username as the salt</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_comment">//(BAD IDEA, but backwards-compatible):</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">final</strong> String username = <span class="jxr_string">"username"</span>;
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">final</strong> String password = <span class="jxr_string">"password"</span>;
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">final</strong> Object hashedPassword = <strong class="jxr_keyword">new</strong> Sha1Hash(password, username).getBytes();
<a class="jxr_linenumber" name="L104" href="#L104">104</a> AuthenticationInfo account = <strong class="jxr_keyword">new</strong> AuthenticationInfo() {
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">public</strong> PrincipalCollection getPrincipals() {
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> SimplePrincipalCollection(username, <span class="jxr_string">"realmName"</span>);
<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">public</strong> Object getCredentials() {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> hashedPassword;
<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
<a class="jxr_linenumber" name="L112" href="#L112">112</a> };
<a class="jxr_linenumber" name="L113" href="#L113">113</a>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_comment">//simulate a username/password (plaintext) token created in response to a login attempt:</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> AuthenticationToken token = <strong class="jxr_keyword">new</strong> UsernamePasswordToken(<span class="jxr_string">"username"</span>, <span class="jxr_string">"password"</span>);
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_comment">//verify the hashed token matches what is in the account:</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> assertTrue(matcher.doCredentialsMatch(token, account));
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>