blob: 31e09a315ebafb97976128160d661f63ec1c49a6 [file] [log] [blame]
<!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.crypto.hash.format;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.codec.Base64;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.crypto.hash.Hash;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.crypto.hash.SimpleHash;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.util.ByteSource;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.shiro.util.StringUtils;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * The {@code Shiro1CryptFormat} is a fully reversible<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;a href="http://packages.python.org/passlib/modular_crypt_format.html"&gt;Modular Crypt Format&lt;/a&gt; (MCF). Because it is<a name="line.29"></a>
<span class="sourceLineNo">030</span> * fully reversible (i.e. Hash -&amp;gt; String, String -&amp;gt; Hash), it does NOT use the traditional MCF encoding alphabet<a name="line.30"></a>
<span class="sourceLineNo">031</span> * (the traditional MCF encoding, aka H64, is bit-destructive and cannot be reversed). Instead, it uses fully<a name="line.31"></a>
<span class="sourceLineNo">032</span> * reversible Base64 encoding for the Hash digest and any salt value.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;h2&gt;Format&lt;/h2&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;Hash instances formatted with this implementation will result in a String with the following dollar-sign ($)<a name="line.34"></a>
<span class="sourceLineNo">035</span> * delimited format:&lt;/p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;pre&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;b&gt;$&lt;/b&gt;mcfFormatId&lt;b&gt;$&lt;/b&gt;algorithmName&lt;b&gt;$&lt;/b&gt;iterationCount&lt;b&gt;$&lt;/b&gt;base64EncodedSalt&lt;b&gt;$&lt;/b&gt;base64EncodedDigest<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;/pre&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p&gt;Each token is defined as follows:&lt;/p&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;table&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;tr&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;th&gt;Position&lt;/th&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;th&gt;Token&lt;/th&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;th&gt;Description&lt;/th&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;th&gt;Required?&lt;/th&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;/tr&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;tr&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;td&gt;1&lt;/td&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;td&gt;{@code mcfFormatId}&lt;/td&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;td&gt;The Modular Crypt Format identifier for this implementation, equal to &lt;b&gt;{@code shiro1}&lt;/b&gt;.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * ( This implies that all {@code shiro1} MCF-formatted strings will always begin with the prefix<a name="line.51"></a>
<span class="sourceLineNo">052</span> * {@code $shiro1$} ).&lt;/td&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;td&gt;true&lt;/td&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;/tr&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;tr&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;td&gt;2&lt;/td&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;td&gt;{@code algorithmName}&lt;/td&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;td&gt;The name of the hash algorithm used to perform the hash. This is an algorithm name understood by<a name="line.58"></a>
<span class="sourceLineNo">059</span> * {@code MessageDigest}.{@link java.security.MessageDigest#getInstance(String) getInstance}, for example<a name="line.59"></a>
<span class="sourceLineNo">060</span> * {@code MD5}, {@code SHA-256}, {@code SHA-256}, etc.&lt;/td&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;td&gt;true&lt;/td&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span> * &lt;/tr&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;tr&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> * &lt;td&gt;3&lt;/td&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;td&gt;{@code iterationCount}&lt;/td&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;td&gt;The number of hash iterations performed.&lt;/td&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;td&gt;true (1 &lt;= N &lt;= Integer.MAX_VALUE)&lt;/td&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> * &lt;/tr&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> * &lt;tr&gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;td&gt;4&lt;/td&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;td&gt;{@code base64EncodedSalt}&lt;/td&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * &lt;td&gt;The Base64-encoded salt byte array. This token only exists if a salt was used to perform the hash.&lt;/td&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span> * &lt;td&gt;false&lt;/td&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;/tr&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> * &lt;tr&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> * &lt;td&gt;5&lt;/td&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> * &lt;td&gt;{@code base64EncodedDigest}&lt;/td&gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span> * &lt;td&gt;The Base64-encoded digest byte array. This is the actual hash result.&lt;/td&gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span> * &lt;td&gt;true&lt;/td&gt;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;/tr&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;/table&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> *<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @see ModularCryptFormat<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @see ParsableHashFormat<a name="line.84"></a>
<span class="sourceLineNo">085</span> *<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @since 1.2<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span>public class Shiro1CryptFormat implements ModularCryptFormat, ParsableHashFormat {<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> public static final String ID = "shiro1";<a name="line.90"></a>
<span class="sourceLineNo">091</span> public static final String MCF_PREFIX = TOKEN_DELIMITER + ID + TOKEN_DELIMITER;<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> public Shiro1CryptFormat() {<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> public String getId() {<a name="line.96"></a>
<span class="sourceLineNo">097</span> return ID;<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> public String format(Hash hash) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (hash == null) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> return null;<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> String algorithmName = hash.getAlgorithmName();<a name="line.105"></a>
<span class="sourceLineNo">106</span> ByteSource salt = hash.getSalt();<a name="line.106"></a>
<span class="sourceLineNo">107</span> int iterations = hash.getIterations();<a name="line.107"></a>
<span class="sourceLineNo">108</span> StringBuilder sb = new StringBuilder(MCF_PREFIX).append(algorithmName).append(TOKEN_DELIMITER).append(iterations).append(TOKEN_DELIMITER);<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> if (salt != null) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> sb.append(salt.toBase64());<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> sb.append(TOKEN_DELIMITER);<a name="line.114"></a>
<span class="sourceLineNo">115</span> sb.append(hash.toBase64());<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> return sb.toString();<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> public Hash parse(String formatted) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> if (formatted == null) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> return null;<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (!formatted.startsWith(MCF_PREFIX)) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> //TODO create a HashFormatException class<a name="line.125"></a>
<span class="sourceLineNo">126</span> String msg = "The argument is not a valid '" + ID + "' formatted hash.";<a name="line.126"></a>
<span class="sourceLineNo">127</span> throw new IllegalArgumentException(msg);<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> String suffix = formatted.substring(MCF_PREFIX.length());<a name="line.130"></a>
<span class="sourceLineNo">131</span> String[] parts = suffix.split("\\$");<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> //last part is always the digest/checksum, Base64-encoded:<a name="line.133"></a>
<span class="sourceLineNo">134</span> int i = parts.length-1;<a name="line.134"></a>
<span class="sourceLineNo">135</span> String digestBase64 = parts[i--];<a name="line.135"></a>
<span class="sourceLineNo">136</span> //second-to-last part is always the salt, Base64-encoded:<a name="line.136"></a>
<span class="sourceLineNo">137</span> String saltBase64 = parts[i--];<a name="line.137"></a>
<span class="sourceLineNo">138</span> String iterationsString = parts[i--];<a name="line.138"></a>
<span class="sourceLineNo">139</span> String algorithmName = parts[i];<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> byte[] digest = Base64.decode(digestBase64);<a name="line.141"></a>
<span class="sourceLineNo">142</span> ByteSource salt = null;<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> if (StringUtils.hasLength(saltBase64)) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> byte[] saltBytes = Base64.decode(saltBase64);<a name="line.145"></a>
<span class="sourceLineNo">146</span> salt = ByteSource.Util.bytes(saltBytes);<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> int iterations;<a name="line.149"></a>
<span class="sourceLineNo">150</span> try {<a name="line.150"></a>
<span class="sourceLineNo">151</span> iterations = Integer.parseInt(iterationsString);<a name="line.151"></a>
<span class="sourceLineNo">152</span> } catch (NumberFormatException e) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> String msg = "Unable to parse formatted hash string: " + formatted;<a name="line.153"></a>
<span class="sourceLineNo">154</span> throw new IllegalArgumentException(msg, e);<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> SimpleHash hash = new SimpleHash(algorithmName);<a name="line.157"></a>
<span class="sourceLineNo">158</span> hash.setBytes(digest);<a name="line.158"></a>
<span class="sourceLineNo">159</span> if (salt != null) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> hash.setSalt(salt);<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> hash.setIterations(iterations);<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> return hash;<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span>}<a name="line.166"></a>
</pre>
</div>
</body>
</html>