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