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