| <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.tools.hasher;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.commons.cli.*;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.authc.credential.DefaultPasswordService;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.codec.Base64;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.codec.Hex;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.crypto.SecureRandomNumberGenerator;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.crypto.UnknownAlgorithmException;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.shiro.crypto.hash.SimpleHash;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.shiro.crypto.hash.format.*;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.shiro.io.ResourceUtils;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.apache.shiro.util.ByteSource;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import org.apache.shiro.util.JavaEnvironment;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import org.apache.shiro.util.StringUtils;<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> import java.io.File;<a name="line.34"></a> |
| <FONT color="green">035</FONT> import java.io.IOException;<a name="line.35"></a> |
| <FONT color="green">036</FONT> import java.util.Arrays;<a name="line.36"></a> |
| <FONT color="green">037</FONT> <a name="line.37"></a> |
| <FONT color="green">038</FONT> /**<a name="line.38"></a> |
| <FONT color="green">039</FONT> * Commandline line utility to hash data such as strings, passwords, resources (files, urls, etc).<a name="line.39"></a> |
| <FONT color="green">040</FONT> * <p/><a name="line.40"></a> |
| <FONT color="green">041</FONT> * Usage:<a name="line.41"></a> |
| <FONT color="green">042</FONT> * <pre><a name="line.42"></a> |
| <FONT color="green">043</FONT> * java -jar shiro-tools-hasher<em>-version</em>-cli.jar<a name="line.43"></a> |
| <FONT color="green">044</FONT> * </pre><a name="line.44"></a> |
| <FONT color="green">045</FONT> * This will print out all supported options with documentation.<a name="line.45"></a> |
| <FONT color="green">046</FONT> *<a name="line.46"></a> |
| <FONT color="green">047</FONT> * @since 1.2<a name="line.47"></a> |
| <FONT color="green">048</FONT> */<a name="line.48"></a> |
| <FONT color="green">049</FONT> public final class Hasher {<a name="line.49"></a> |
| <FONT color="green">050</FONT> <a name="line.50"></a> |
| <FONT color="green">051</FONT> private static final String HEX_PREFIX = "0x";<a name="line.51"></a> |
| <FONT color="green">052</FONT> private static final String DEFAULT_ALGORITHM_NAME = "MD5";<a name="line.52"></a> |
| <FONT color="green">053</FONT> private static final String DEFAULT_PASSWORD_ALGORITHM_NAME = DefaultPasswordService.DEFAULT_HASH_ALGORITHM;<a name="line.53"></a> |
| <FONT color="green">054</FONT> private static final int DEFAULT_GENERATED_SALT_SIZE = 128;<a name="line.54"></a> |
| <FONT color="green">055</FONT> private static final int DEFAULT_NUM_ITERATIONS = 1;<a name="line.55"></a> |
| <FONT color="green">056</FONT> private static final int DEFAULT_PASSWORD_NUM_ITERATIONS = DefaultPasswordService.DEFAULT_HASH_ITERATIONS;<a name="line.56"></a> |
| <FONT color="green">057</FONT> <a name="line.57"></a> |
| <FONT color="green">058</FONT> private static final Option ALGORITHM = new Option("a", "algorithm", true, "hash algorithm name. Defaults to SHA-256 when password hashing, MD5 otherwise.");<a name="line.58"></a> |
| <FONT color="green">059</FONT> private static final Option DEBUG = new Option("d", "debug", false, "show additional error (stack trace) information.");<a name="line.59"></a> |
| <FONT color="green">060</FONT> private static final Option FORMAT = new Option("f", "format", true, "hash output format. Defaults to 'shiro1' when password hashing, 'hex' otherwise. See below for more information.");<a name="line.60"></a> |
| <FONT color="green">061</FONT> private static final Option HELP = new Option("help", "help", false, "show this help message.");<a name="line.61"></a> |
| <FONT color="green">062</FONT> private static final Option ITERATIONS = new Option("i", "iterations", true, "number of hash iterations. Defaults to " + DEFAULT_PASSWORD_NUM_ITERATIONS + " when password hashing, 1 otherwise.");<a name="line.62"></a> |
| <FONT color="green">063</FONT> private static final Option PASSWORD = new Option("p", "password", false, "hash a password (disable typing echo)");<a name="line.63"></a> |
| <FONT color="green">064</FONT> private static final Option PASSWORD_NC = new Option("pnc", "pnoconfirm", false, "hash a password (disable typing echo) but disable password confirmation prompt.");<a name="line.64"></a> |
| <FONT color="green">065</FONT> private static final Option RESOURCE = new Option("r", "resource", false, "read and hash the resource located at <value>. See below for more information.");<a name="line.65"></a> |
| <FONT color="green">066</FONT> private static final Option SALT = new Option("s", "salt", true, "use the specified salt. <arg> is plaintext.");<a name="line.66"></a> |
| <FONT color="green">067</FONT> private static final Option SALT_BYTES = new Option("sb", "saltbytes", true, "use the specified salt bytes. <arg> is hex or base64 encoded text.");<a name="line.67"></a> |
| <FONT color="green">068</FONT> private static final Option SALT_GEN = new Option("gs", "gensalt", false, "generate and use a random salt. Defaults to true when password hashing, false otherwise.");<a name="line.68"></a> |
| <FONT color="green">069</FONT> private static final Option NO_SALT_GEN = new Option("ngs", "nogensalt", false, "do NOT generate and use a random salt (valid during password hashing).");<a name="line.69"></a> |
| <FONT color="green">070</FONT> private static final Option SALT_GEN_SIZE = new Option("gss", "gensaltsize", true, "the number of salt bits (not bytes!) to generate. Defaults to 128.");<a name="line.70"></a> |
| <FONT color="green">071</FONT> <a name="line.71"></a> |
| <FONT color="green">072</FONT> private static final String SALT_MUTEX_MSG = createMutexMessage(SALT, SALT_BYTES);<a name="line.72"></a> |
| <FONT color="green">073</FONT> <a name="line.73"></a> |
| <FONT color="green">074</FONT> private static final HashFormatFactory HASH_FORMAT_FACTORY = new DefaultHashFormatFactory();<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> static {<a name="line.76"></a> |
| <FONT color="green">077</FONT> ALGORITHM.setArgName("name");<a name="line.77"></a> |
| <FONT color="green">078</FONT> SALT_GEN_SIZE.setArgName("numBits");<a name="line.78"></a> |
| <FONT color="green">079</FONT> ITERATIONS.setArgName("num");<a name="line.79"></a> |
| <FONT color="green">080</FONT> SALT.setArgName("sval");<a name="line.80"></a> |
| <FONT color="green">081</FONT> SALT_BYTES.setArgName("encTxt");<a name="line.81"></a> |
| <FONT color="green">082</FONT> }<a name="line.82"></a> |
| <FONT color="green">083</FONT> <a name="line.83"></a> |
| <FONT color="green">084</FONT> public static void main(String[] args) {<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> CommandLineParser parser = new PosixParser();<a name="line.86"></a> |
| <FONT color="green">087</FONT> <a name="line.87"></a> |
| <FONT color="green">088</FONT> Options options = new Options();<a name="line.88"></a> |
| <FONT color="green">089</FONT> options.addOption(HELP).addOption(DEBUG).addOption(ALGORITHM).addOption(ITERATIONS);<a name="line.89"></a> |
| <FONT color="green">090</FONT> options.addOption(RESOURCE).addOption(PASSWORD).addOption(PASSWORD_NC);<a name="line.90"></a> |
| <FONT color="green">091</FONT> options.addOption(SALT).addOption(SALT_BYTES).addOption(SALT_GEN).addOption(SALT_GEN_SIZE).addOption(NO_SALT_GEN);<a name="line.91"></a> |
| <FONT color="green">092</FONT> options.addOption(FORMAT);<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> boolean debug = false;<a name="line.94"></a> |
| <FONT color="green">095</FONT> String algorithm = null; //user unspecified<a name="line.95"></a> |
| <FONT color="green">096</FONT> int iterations = 0; //0 means unspecified by the end-user<a name="line.96"></a> |
| <FONT color="green">097</FONT> boolean resource = false;<a name="line.97"></a> |
| <FONT color="green">098</FONT> boolean password = false;<a name="line.98"></a> |
| <FONT color="green">099</FONT> boolean passwordConfirm = true;<a name="line.99"></a> |
| <FONT color="green">100</FONT> String saltString = null;<a name="line.100"></a> |
| <FONT color="green">101</FONT> String saltBytesString = null;<a name="line.101"></a> |
| <FONT color="green">102</FONT> boolean generateSalt = false;<a name="line.102"></a> |
| <FONT color="green">103</FONT> int generatedSaltSize = DEFAULT_GENERATED_SALT_SIZE;<a name="line.103"></a> |
| <FONT color="green">104</FONT> <a name="line.104"></a> |
| <FONT color="green">105</FONT> String formatString = null;<a name="line.105"></a> |
| <FONT color="green">106</FONT> <a name="line.106"></a> |
| <FONT color="green">107</FONT> char[] passwordChars = null;<a name="line.107"></a> |
| <FONT color="green">108</FONT> <a name="line.108"></a> |
| <FONT color="green">109</FONT> try {<a name="line.109"></a> |
| <FONT color="green">110</FONT> CommandLine line = parser.parse(options, args);<a name="line.110"></a> |
| <FONT color="green">111</FONT> <a name="line.111"></a> |
| <FONT color="green">112</FONT> if (line.hasOption(HELP.getOpt())) {<a name="line.112"></a> |
| <FONT color="green">113</FONT> printHelpAndExit(options, null, debug, 0);<a name="line.113"></a> |
| <FONT color="green">114</FONT> }<a name="line.114"></a> |
| <FONT color="green">115</FONT> if (line.hasOption(DEBUG.getOpt())) {<a name="line.115"></a> |
| <FONT color="green">116</FONT> debug = true;<a name="line.116"></a> |
| <FONT color="green">117</FONT> }<a name="line.117"></a> |
| <FONT color="green">118</FONT> if (line.hasOption(ALGORITHM.getOpt())) {<a name="line.118"></a> |
| <FONT color="green">119</FONT> algorithm = line.getOptionValue(ALGORITHM.getOpt());<a name="line.119"></a> |
| <FONT color="green">120</FONT> }<a name="line.120"></a> |
| <FONT color="green">121</FONT> if (line.hasOption(ITERATIONS.getOpt())) {<a name="line.121"></a> |
| <FONT color="green">122</FONT> iterations = getRequiredPositiveInt(line, ITERATIONS);<a name="line.122"></a> |
| <FONT color="green">123</FONT> }<a name="line.123"></a> |
| <FONT color="green">124</FONT> if (line.hasOption(PASSWORD.getOpt())) {<a name="line.124"></a> |
| <FONT color="green">125</FONT> password = true;<a name="line.125"></a> |
| <FONT color="green">126</FONT> generateSalt = true;<a name="line.126"></a> |
| <FONT color="green">127</FONT> }<a name="line.127"></a> |
| <FONT color="green">128</FONT> if (line.hasOption(RESOURCE.getOpt())) {<a name="line.128"></a> |
| <FONT color="green">129</FONT> resource = true;<a name="line.129"></a> |
| <FONT color="green">130</FONT> }<a name="line.130"></a> |
| <FONT color="green">131</FONT> if (line.hasOption(PASSWORD_NC.getOpt())) {<a name="line.131"></a> |
| <FONT color="green">132</FONT> password = true;<a name="line.132"></a> |
| <FONT color="green">133</FONT> generateSalt = true;<a name="line.133"></a> |
| <FONT color="green">134</FONT> passwordConfirm = false;<a name="line.134"></a> |
| <FONT color="green">135</FONT> }<a name="line.135"></a> |
| <FONT color="green">136</FONT> if (line.hasOption(SALT.getOpt())) {<a name="line.136"></a> |
| <FONT color="green">137</FONT> saltString = line.getOptionValue(SALT.getOpt());<a name="line.137"></a> |
| <FONT color="green">138</FONT> }<a name="line.138"></a> |
| <FONT color="green">139</FONT> if (line.hasOption(SALT_BYTES.getOpt())) {<a name="line.139"></a> |
| <FONT color="green">140</FONT> saltBytesString = line.getOptionValue(SALT_BYTES.getOpt());<a name="line.140"></a> |
| <FONT color="green">141</FONT> }<a name="line.141"></a> |
| <FONT color="green">142</FONT> if (line.hasOption(NO_SALT_GEN.getOpt())) {<a name="line.142"></a> |
| <FONT color="green">143</FONT> generateSalt = false;<a name="line.143"></a> |
| <FONT color="green">144</FONT> }<a name="line.144"></a> |
| <FONT color="green">145</FONT> if (line.hasOption(SALT_GEN.getOpt())) {<a name="line.145"></a> |
| <FONT color="green">146</FONT> generateSalt = true;<a name="line.146"></a> |
| <FONT color="green">147</FONT> }<a name="line.147"></a> |
| <FONT color="green">148</FONT> if (line.hasOption(SALT_GEN_SIZE.getOpt())) {<a name="line.148"></a> |
| <FONT color="green">149</FONT> generateSalt = true;<a name="line.149"></a> |
| <FONT color="green">150</FONT> generatedSaltSize = getRequiredPositiveInt(line, SALT_GEN_SIZE);<a name="line.150"></a> |
| <FONT color="green">151</FONT> if (generatedSaltSize % 8 != 0) {<a name="line.151"></a> |
| <FONT color="green">152</FONT> throw new IllegalArgumentException("Generated salt size must be a multiple of 8 (e.g. 128, 192, 256, 512, etc).");<a name="line.152"></a> |
| <FONT color="green">153</FONT> }<a name="line.153"></a> |
| <FONT color="green">154</FONT> }<a name="line.154"></a> |
| <FONT color="green">155</FONT> if (line.hasOption(FORMAT.getOpt())) {<a name="line.155"></a> |
| <FONT color="green">156</FONT> formatString = line.getOptionValue(FORMAT.getOpt());<a name="line.156"></a> |
| <FONT color="green">157</FONT> }<a name="line.157"></a> |
| <FONT color="green">158</FONT> <a name="line.158"></a> |
| <FONT color="green">159</FONT> String sourceValue;<a name="line.159"></a> |
| <FONT color="green">160</FONT> <a name="line.160"></a> |
| <FONT color="green">161</FONT> Object source;<a name="line.161"></a> |
| <FONT color="green">162</FONT> <a name="line.162"></a> |
| <FONT color="green">163</FONT> if (password) {<a name="line.163"></a> |
| <FONT color="green">164</FONT> passwordChars = readPassword(passwordConfirm);<a name="line.164"></a> |
| <FONT color="green">165</FONT> source = passwordChars;<a name="line.165"></a> |
| <FONT color="green">166</FONT> } else {<a name="line.166"></a> |
| <FONT color="green">167</FONT> String[] remainingArgs = line.getArgs();<a name="line.167"></a> |
| <FONT color="green">168</FONT> if (remainingArgs == null || remainingArgs.length != 1) {<a name="line.168"></a> |
| <FONT color="green">169</FONT> printHelpAndExit(options, null, debug, -1);<a name="line.169"></a> |
| <FONT color="green">170</FONT> }<a name="line.170"></a> |
| <FONT color="green">171</FONT> <a name="line.171"></a> |
| <FONT color="green">172</FONT> assert remainingArgs != null;<a name="line.172"></a> |
| <FONT color="green">173</FONT> sourceValue = toString(remainingArgs);<a name="line.173"></a> |
| <FONT color="green">174</FONT> <a name="line.174"></a> |
| <FONT color="green">175</FONT> if (resource) {<a name="line.175"></a> |
| <FONT color="green">176</FONT> if (!ResourceUtils.hasResourcePrefix(sourceValue)) {<a name="line.176"></a> |
| <FONT color="green">177</FONT> source = toFile(sourceValue);<a name="line.177"></a> |
| <FONT color="green">178</FONT> } else {<a name="line.178"></a> |
| <FONT color="green">179</FONT> source = ResourceUtils.getInputStreamForPath(sourceValue);<a name="line.179"></a> |
| <FONT color="green">180</FONT> }<a name="line.180"></a> |
| <FONT color="green">181</FONT> } else {<a name="line.181"></a> |
| <FONT color="green">182</FONT> source = sourceValue;<a name="line.182"></a> |
| <FONT color="green">183</FONT> }<a name="line.183"></a> |
| <FONT color="green">184</FONT> }<a name="line.184"></a> |
| <FONT color="green">185</FONT> <a name="line.185"></a> |
| <FONT color="green">186</FONT> if (algorithm == null) {<a name="line.186"></a> |
| <FONT color="green">187</FONT> if (password) {<a name="line.187"></a> |
| <FONT color="green">188</FONT> algorithm = DEFAULT_PASSWORD_ALGORITHM_NAME;<a name="line.188"></a> |
| <FONT color="green">189</FONT> } else {<a name="line.189"></a> |
| <FONT color="green">190</FONT> algorithm = DEFAULT_ALGORITHM_NAME;<a name="line.190"></a> |
| <FONT color="green">191</FONT> }<a name="line.191"></a> |
| <FONT color="green">192</FONT> }<a name="line.192"></a> |
| <FONT color="green">193</FONT> <a name="line.193"></a> |
| <FONT color="green">194</FONT> if (iterations < DEFAULT_NUM_ITERATIONS) {<a name="line.194"></a> |
| <FONT color="green">195</FONT> //Iterations were not specified. Default to 350,000 when password hashing, and 1 for everything else:<a name="line.195"></a> |
| <FONT color="green">196</FONT> if (password) {<a name="line.196"></a> |
| <FONT color="green">197</FONT> iterations = DEFAULT_PASSWORD_NUM_ITERATIONS;<a name="line.197"></a> |
| <FONT color="green">198</FONT> } else {<a name="line.198"></a> |
| <FONT color="green">199</FONT> iterations = DEFAULT_NUM_ITERATIONS;<a name="line.199"></a> |
| <FONT color="green">200</FONT> }<a name="line.200"></a> |
| <FONT color="green">201</FONT> }<a name="line.201"></a> |
| <FONT color="green">202</FONT> <a name="line.202"></a> |
| <FONT color="green">203</FONT> ByteSource salt = getSalt(saltString, saltBytesString, generateSalt, generatedSaltSize);<a name="line.203"></a> |
| <FONT color="green">204</FONT> <a name="line.204"></a> |
| <FONT color="green">205</FONT> SimpleHash hash = new SimpleHash(algorithm, source, salt, iterations);<a name="line.205"></a> |
| <FONT color="green">206</FONT> <a name="line.206"></a> |
| <FONT color="green">207</FONT> if (formatString == null) {<a name="line.207"></a> |
| <FONT color="green">208</FONT> //Output format was not specified. Default to 'shiro1' when password hashing, and 'hex' for<a name="line.208"></a> |
| <FONT color="green">209</FONT> //everything else:<a name="line.209"></a> |
| <FONT color="green">210</FONT> if (password) {<a name="line.210"></a> |
| <FONT color="green">211</FONT> formatString = Shiro1CryptFormat.class.getName();<a name="line.211"></a> |
| <FONT color="green">212</FONT> } else {<a name="line.212"></a> |
| <FONT color="green">213</FONT> formatString = HexFormat.class.getName();<a name="line.213"></a> |
| <FONT color="green">214</FONT> }<a name="line.214"></a> |
| <FONT color="green">215</FONT> }<a name="line.215"></a> |
| <FONT color="green">216</FONT> <a name="line.216"></a> |
| <FONT color="green">217</FONT> HashFormat format = HASH_FORMAT_FACTORY.getInstance(formatString);<a name="line.217"></a> |
| <FONT color="green">218</FONT> <a name="line.218"></a> |
| <FONT color="green">219</FONT> if (format == null) {<a name="line.219"></a> |
| <FONT color="green">220</FONT> throw new IllegalArgumentException("Unrecognized hash format '" + formatString + "'.");<a name="line.220"></a> |
| <FONT color="green">221</FONT> }<a name="line.221"></a> |
| <FONT color="green">222</FONT> <a name="line.222"></a> |
| <FONT color="green">223</FONT> String output = format.format(hash);<a name="line.223"></a> |
| <FONT color="green">224</FONT> <a name="line.224"></a> |
| <FONT color="green">225</FONT> System.out.println(output);<a name="line.225"></a> |
| <FONT color="green">226</FONT> <a name="line.226"></a> |
| <FONT color="green">227</FONT> } catch (IllegalArgumentException iae) {<a name="line.227"></a> |
| <FONT color="green">228</FONT> exit(iae, debug);<a name="line.228"></a> |
| <FONT color="green">229</FONT> } catch (UnknownAlgorithmException uae) {<a name="line.229"></a> |
| <FONT color="green">230</FONT> exit(uae, debug);<a name="line.230"></a> |
| <FONT color="green">231</FONT> } catch (IOException ioe) {<a name="line.231"></a> |
| <FONT color="green">232</FONT> exit(ioe, debug);<a name="line.232"></a> |
| <FONT color="green">233</FONT> } catch (Exception e) {<a name="line.233"></a> |
| <FONT color="green">234</FONT> printHelpAndExit(options, e, debug, -1);<a name="line.234"></a> |
| <FONT color="green">235</FONT> } finally {<a name="line.235"></a> |
| <FONT color="green">236</FONT> if (passwordChars != null && passwordChars.length > 0) {<a name="line.236"></a> |
| <FONT color="green">237</FONT> for (int i = 0; i < passwordChars.length; i++) {<a name="line.237"></a> |
| <FONT color="green">238</FONT> passwordChars[i] = ' ';<a name="line.238"></a> |
| <FONT color="green">239</FONT> }<a name="line.239"></a> |
| <FONT color="green">240</FONT> }<a name="line.240"></a> |
| <FONT color="green">241</FONT> }<a name="line.241"></a> |
| <FONT color="green">242</FONT> }<a name="line.242"></a> |
| <FONT color="green">243</FONT> <a name="line.243"></a> |
| <FONT color="green">244</FONT> private static String createMutexMessage(Option... options) {<a name="line.244"></a> |
| <FONT color="green">245</FONT> StringBuilder sb = new StringBuilder();<a name="line.245"></a> |
| <FONT color="green">246</FONT> sb.append("The ");<a name="line.246"></a> |
| <FONT color="green">247</FONT> <a name="line.247"></a> |
| <FONT color="green">248</FONT> for (int i = 0; i < options.length; i++) {<a name="line.248"></a> |
| <FONT color="green">249</FONT> if (i > 0) {<a name="line.249"></a> |
| <FONT color="green">250</FONT> sb.append(", ");<a name="line.250"></a> |
| <FONT color="green">251</FONT> }<a name="line.251"></a> |
| <FONT color="green">252</FONT> Option o = options[0];<a name="line.252"></a> |
| <FONT color="green">253</FONT> sb.append("-").append(o.getOpt()).append("/--").append(o.getLongOpt());<a name="line.253"></a> |
| <FONT color="green">254</FONT> }<a name="line.254"></a> |
| <FONT color="green">255</FONT> sb.append(" and generated salt options are mutually exclusive. Only one of them may be used at a time");<a name="line.255"></a> |
| <FONT color="green">256</FONT> return sb.toString();<a name="line.256"></a> |
| <FONT color="green">257</FONT> }<a name="line.257"></a> |
| <FONT color="green">258</FONT> <a name="line.258"></a> |
| <FONT color="green">259</FONT> private static void exit(Exception e, boolean debug) {<a name="line.259"></a> |
| <FONT color="green">260</FONT> printException(e, debug);<a name="line.260"></a> |
| <FONT color="green">261</FONT> System.exit(-1);<a name="line.261"></a> |
| <FONT color="green">262</FONT> }<a name="line.262"></a> |
| <FONT color="green">263</FONT> <a name="line.263"></a> |
| <FONT color="green">264</FONT> private static int getRequiredPositiveInt(CommandLine line, Option option) {<a name="line.264"></a> |
| <FONT color="green">265</FONT> String iterVal = line.getOptionValue(option.getOpt());<a name="line.265"></a> |
| <FONT color="green">266</FONT> try {<a name="line.266"></a> |
| <FONT color="green">267</FONT> return Integer.parseInt(iterVal);<a name="line.267"></a> |
| <FONT color="green">268</FONT> } catch (NumberFormatException e) {<a name="line.268"></a> |
| <FONT color="green">269</FONT> String msg = "'" + option.getLongOpt() + "' value must be a positive integer.";<a name="line.269"></a> |
| <FONT color="green">270</FONT> throw new IllegalArgumentException(msg, e);<a name="line.270"></a> |
| <FONT color="green">271</FONT> }<a name="line.271"></a> |
| <FONT color="green">272</FONT> }<a name="line.272"></a> |
| <FONT color="green">273</FONT> <a name="line.273"></a> |
| <FONT color="green">274</FONT> private static ByteSource getSalt(String saltString, String saltBytesString, boolean generateSalt, int generatedSaltSize) {<a name="line.274"></a> |
| <FONT color="green">275</FONT> <a name="line.275"></a> |
| <FONT color="green">276</FONT> if (saltString != null) {<a name="line.276"></a> |
| <FONT color="green">277</FONT> if (generateSalt || (saltBytesString != null)) {<a name="line.277"></a> |
| <FONT color="green">278</FONT> throw new IllegalArgumentException(SALT_MUTEX_MSG);<a name="line.278"></a> |
| <FONT color="green">279</FONT> }<a name="line.279"></a> |
| <FONT color="green">280</FONT> return ByteSource.Util.bytes(saltString);<a name="line.280"></a> |
| <FONT color="green">281</FONT> }<a name="line.281"></a> |
| <FONT color="green">282</FONT> <a name="line.282"></a> |
| <FONT color="green">283</FONT> if (saltBytesString != null) {<a name="line.283"></a> |
| <FONT color="green">284</FONT> if (generateSalt) {<a name="line.284"></a> |
| <FONT color="green">285</FONT> throw new IllegalArgumentException(SALT_MUTEX_MSG);<a name="line.285"></a> |
| <FONT color="green">286</FONT> }<a name="line.286"></a> |
| <FONT color="green">287</FONT> <a name="line.287"></a> |
| <FONT color="green">288</FONT> String value = saltBytesString;<a name="line.288"></a> |
| <FONT color="green">289</FONT> boolean base64 = true;<a name="line.289"></a> |
| <FONT color="green">290</FONT> if (saltBytesString.startsWith(HEX_PREFIX)) {<a name="line.290"></a> |
| <FONT color="green">291</FONT> //hex:<a name="line.291"></a> |
| <FONT color="green">292</FONT> base64 = false;<a name="line.292"></a> |
| <FONT color="green">293</FONT> value = value.substring(HEX_PREFIX.length());<a name="line.293"></a> |
| <FONT color="green">294</FONT> }<a name="line.294"></a> |
| <FONT color="green">295</FONT> byte[] bytes;<a name="line.295"></a> |
| <FONT color="green">296</FONT> if (base64) {<a name="line.296"></a> |
| <FONT color="green">297</FONT> bytes = Base64.decode(value);<a name="line.297"></a> |
| <FONT color="green">298</FONT> } else {<a name="line.298"></a> |
| <FONT color="green">299</FONT> bytes = Hex.decode(value);<a name="line.299"></a> |
| <FONT color="green">300</FONT> }<a name="line.300"></a> |
| <FONT color="green">301</FONT> return ByteSource.Util.bytes(bytes);<a name="line.301"></a> |
| <FONT color="green">302</FONT> }<a name="line.302"></a> |
| <FONT color="green">303</FONT> <a name="line.303"></a> |
| <FONT color="green">304</FONT> if (generateSalt) {<a name="line.304"></a> |
| <FONT color="green">305</FONT> SecureRandomNumberGenerator generator = new SecureRandomNumberGenerator();<a name="line.305"></a> |
| <FONT color="green">306</FONT> int byteSize = generatedSaltSize / 8; //generatedSaltSize is in *bits* - convert to byte size:<a name="line.306"></a> |
| <FONT color="green">307</FONT> return generator.nextBytes(byteSize);<a name="line.307"></a> |
| <FONT color="green">308</FONT> }<a name="line.308"></a> |
| <FONT color="green">309</FONT> <a name="line.309"></a> |
| <FONT color="green">310</FONT> //no salt used:<a name="line.310"></a> |
| <FONT color="green">311</FONT> return null;<a name="line.311"></a> |
| <FONT color="green">312</FONT> }<a name="line.312"></a> |
| <FONT color="green">313</FONT> <a name="line.313"></a> |
| <FONT color="green">314</FONT> private static void printException(Exception e, boolean debug) {<a name="line.314"></a> |
| <FONT color="green">315</FONT> if (e != null) {<a name="line.315"></a> |
| <FONT color="green">316</FONT> System.out.println();<a name="line.316"></a> |
| <FONT color="green">317</FONT> if (debug) {<a name="line.317"></a> |
| <FONT color="green">318</FONT> System.out.println("Error: ");<a name="line.318"></a> |
| <FONT color="green">319</FONT> e.printStackTrace(System.out);<a name="line.319"></a> |
| <FONT color="green">320</FONT> System.out.println(e.getMessage());<a name="line.320"></a> |
| <FONT color="green">321</FONT> <a name="line.321"></a> |
| <FONT color="green">322</FONT> } else {<a name="line.322"></a> |
| <FONT color="green">323</FONT> System.out.println("Error: " + e.getMessage());<a name="line.323"></a> |
| <FONT color="green">324</FONT> System.out.println();<a name="line.324"></a> |
| <FONT color="green">325</FONT> System.out.println("Specify -d or --debug for more information.");<a name="line.325"></a> |
| <FONT color="green">326</FONT> }<a name="line.326"></a> |
| <FONT color="green">327</FONT> }<a name="line.327"></a> |
| <FONT color="green">328</FONT> }<a name="line.328"></a> |
| <FONT color="green">329</FONT> <a name="line.329"></a> |
| <FONT color="green">330</FONT> private static void printHelp(Options options, Exception e, boolean debug) {<a name="line.330"></a> |
| <FONT color="green">331</FONT> HelpFormatter help = new HelpFormatter();<a name="line.331"></a> |
| <FONT color="green">332</FONT> String command = "java -jar shiro-tools-hasher-<version>.jar [options] [<value>]";<a name="line.332"></a> |
| <FONT color="green">333</FONT> String header = "\nPrint a cryptographic hash (aka message digest) of the specified <value>.\n--\nOptions:";<a name="line.333"></a> |
| <FONT color="green">334</FONT> String footer = "\n" +<a name="line.334"></a> |
| <FONT color="green">335</FONT> "<value> is optional only when hashing passwords (see below). It is\n" +<a name="line.335"></a> |
| <FONT color="green">336</FONT> "required all other times." +<a name="line.336"></a> |
| <FONT color="green">337</FONT> "\n\n" +<a name="line.337"></a> |
| <FONT color="green">338</FONT> "Password Hashing:\n" +<a name="line.338"></a> |
| <FONT color="green">339</FONT> "---------------------------------\n" +<a name="line.339"></a> |
| <FONT color="green">340</FONT> "Specify the -p/--password option and DO NOT enter a <value>. You will\n" +<a name="line.340"></a> |
| <FONT color="green">341</FONT> "be prompted for a password and characters will not echo as you type." +<a name="line.341"></a> |
| <FONT color="green">342</FONT> "\n\n" +<a name="line.342"></a> |
| <FONT color="green">343</FONT> "Salting:\n" +<a name="line.343"></a> |
| <FONT color="green">344</FONT> "---------------------------------\n" +<a name="line.344"></a> |
| <FONT color="green">345</FONT> "Specifying a salt:" +<a name="line.345"></a> |
| <FONT color="green">346</FONT> "\n\n" +<a name="line.346"></a> |
| <FONT color="green">347</FONT> "You may specify a salt using the -s/--salt option followed by the salt\n" +<a name="line.347"></a> |
| <FONT color="green">348</FONT> "value. If the salt value is a base64 or hex string representing a\n" +<a name="line.348"></a> |
| <FONT color="green">349</FONT> "byte array, you must specify the -sb/--saltbytes option to indicate this,\n" +<a name="line.349"></a> |
| <FONT color="green">350</FONT> "otherwise the text value bytes will be used directly." +<a name="line.350"></a> |
| <FONT color="green">351</FONT> "\n\n" +<a name="line.351"></a> |
| <FONT color="green">352</FONT> "When using -sb/--saltbytes, the -s/--salt value is expected to be a\n" +<a name="line.352"></a> |
| <FONT color="green">353</FONT> "base64-encoded string by default. If the value is a hex-encoded string,\n" +<a name="line.353"></a> |
| <FONT color="green">354</FONT> "you must prefix the string with 0x (zero x) to indicate a hex value." +<a name="line.354"></a> |
| <FONT color="green">355</FONT> "\n\n" +<a name="line.355"></a> |
| <FONT color="green">356</FONT> "Generating a salt:" +<a name="line.356"></a> |
| <FONT color="green">357</FONT> "\n\n" +<a name="line.357"></a> |
| <FONT color="green">358</FONT> "Use the -sg/--saltgenerated option if you don't want to specify a salt,\n" +<a name="line.358"></a> |
| <FONT color="green">359</FONT> "but want a strong random salt to be generated and used during hashing.\n" +<a name="line.359"></a> |
| <FONT color="green">360</FONT> "The generated salt size defaults to 128 bits. You may specify\n" +<a name="line.360"></a> |
| <FONT color="green">361</FONT> "a different size by using the -sgs/--saltgeneratedsize option followed by\n" +<a name="line.361"></a> |
| <FONT color="green">362</FONT> "a positive integer (size is in bits, not bytes)." +<a name="line.362"></a> |
| <FONT color="green">363</FONT> "\n\n" +<a name="line.363"></a> |
| <FONT color="green">364</FONT> "Because a salt must be specified if computing the\n" +<a name="line.364"></a> |
| <FONT color="green">365</FONT> "hash later, generated salts will be printed, defaulting to base64\n" +<a name="line.365"></a> |
| <FONT color="green">366</FONT> "encoding. If you prefer to use hex encoding, additionally use the\n" +<a name="line.366"></a> |
| <FONT color="green">367</FONT> "-sgh/--saltgeneratedhex option." +<a name="line.367"></a> |
| <FONT color="green">368</FONT> "\n\n" +<a name="line.368"></a> |
| <FONT color="green">369</FONT> "Files, URLs and classpath resources:\n" +<a name="line.369"></a> |
| <FONT color="green">370</FONT> "---------------------------------\n" +<a name="line.370"></a> |
| <FONT color="green">371</FONT> "If using the -r/--resource option, the <value> represents a resource path.\n" +<a name="line.371"></a> |
| <FONT color="green">372</FONT> "By default this is expected to be a file path, but you may specify\n" +<a name="line.372"></a> |
| <FONT color="green">373</FONT> "classpath or URL resources by using the classpath: or url: prefix\n" +<a name="line.373"></a> |
| <FONT color="green">374</FONT> "respectively." +<a name="line.374"></a> |
| <FONT color="green">375</FONT> "\n\n" +<a name="line.375"></a> |
| <FONT color="green">376</FONT> "Some examples:" +<a name="line.376"></a> |
| <FONT color="green">377</FONT> "\n\n" +<a name="line.377"></a> |
| <FONT color="green">378</FONT> "<command> -r fileInCurrentDirectory.txt\n" +<a name="line.378"></a> |
| <FONT color="green">379</FONT> "<command> -r ../../relativePathFile.xml\n" +<a name="line.379"></a> |
| <FONT color="green">380</FONT> "<command> -r ~/documents/myfile.pdf\n" +<a name="line.380"></a> |
| <FONT color="green">381</FONT> "<command> -r /usr/local/logs/absolutePathFile.log\n" +<a name="line.381"></a> |
| <FONT color="green">382</FONT> "<command> -r url:http://foo.com/page.html\n" +<a name="line.382"></a> |
| <FONT color="green">383</FONT> "<command> -r classpath:/WEB-INF/lib/something.jar" +<a name="line.383"></a> |
| <FONT color="green">384</FONT> "\n\n" +<a name="line.384"></a> |
| <FONT color="green">385</FONT> "Output Format:\n" +<a name="line.385"></a> |
| <FONT color="green">386</FONT> "---------------------------------\n" +<a name="line.386"></a> |
| <FONT color="green">387</FONT> "Specify the -f/--format option followed by either 1) the format ID (as defined\n" +<a name="line.387"></a> |
| <FONT color="green">388</FONT> "by the " + DefaultHashFormatFactory.class.getName() + "\n" +<a name="line.388"></a> |
| <FONT color="green">389</FONT> "JavaDoc) or 2) the fully qualified " + HashFormat.class.getName() + "\n" +<a name="line.389"></a> |
| <FONT color="green">390</FONT> "implementation class name to instantiate and use for formatting.\n\n" +<a name="line.390"></a> |
| <FONT color="green">391</FONT> "The default output format is 'shiro1' which is a Modular Crypt Format (MCF)\n" +<a name="line.391"></a> |
| <FONT color="green">392</FONT> "that shows all relevant information as a dollar-sign ($) delimited string.\n" +<a name="line.392"></a> |
| <FONT color="green">393</FONT> "This format is ideal for use in Shiro's text-based user configuration (e.g.\n" +<a name="line.393"></a> |
| <FONT color="green">394</FONT> "shiro.ini or a properties file).";<a name="line.394"></a> |
| <FONT color="green">395</FONT> <a name="line.395"></a> |
| <FONT color="green">396</FONT> printException(e, debug);<a name="line.396"></a> |
| <FONT color="green">397</FONT> <a name="line.397"></a> |
| <FONT color="green">398</FONT> System.out.println();<a name="line.398"></a> |
| <FONT color="green">399</FONT> help.printHelp(command, header, options, null);<a name="line.399"></a> |
| <FONT color="green">400</FONT> System.out.println(footer);<a name="line.400"></a> |
| <FONT color="green">401</FONT> }<a name="line.401"></a> |
| <FONT color="green">402</FONT> <a name="line.402"></a> |
| <FONT color="green">403</FONT> private static void printHelpAndExit(Options options, Exception e, boolean debug, int exitCode) {<a name="line.403"></a> |
| <FONT color="green">404</FONT> printHelp(options, e, debug);<a name="line.404"></a> |
| <FONT color="green">405</FONT> System.exit(exitCode);<a name="line.405"></a> |
| <FONT color="green">406</FONT> }<a name="line.406"></a> |
| <FONT color="green">407</FONT> <a name="line.407"></a> |
| <FONT color="green">408</FONT> private static char[] readPassword(boolean confirm) {<a name="line.408"></a> |
| <FONT color="green">409</FONT> if (!JavaEnvironment.isAtLeastVersion16()) {<a name="line.409"></a> |
| <FONT color="green">410</FONT> String msg = "Password hashing (prompt without echo) uses the java.io.Console to read passwords " +<a name="line.410"></a> |
| <FONT color="green">411</FONT> "safely. This is only available on Java 1.6 platforms and later.";<a name="line.411"></a> |
| <FONT color="green">412</FONT> throw new IllegalArgumentException(msg);<a name="line.412"></a> |
| <FONT color="green">413</FONT> }<a name="line.413"></a> |
| <FONT color="green">414</FONT> java.io.Console console = System.console();<a name="line.414"></a> |
| <FONT color="green">415</FONT> if (console == null) {<a name="line.415"></a> |
| <FONT color="green">416</FONT> throw new IllegalStateException("java.io.Console is not available on the current JVM. Cannot read passwords.");<a name="line.416"></a> |
| <FONT color="green">417</FONT> }<a name="line.417"></a> |
| <FONT color="green">418</FONT> char[] first = console.readPassword("%s", "Password to hash: ");<a name="line.418"></a> |
| <FONT color="green">419</FONT> if (first == null || first.length == 0) {<a name="line.419"></a> |
| <FONT color="green">420</FONT> throw new IllegalArgumentException("No password specified.");<a name="line.420"></a> |
| <FONT color="green">421</FONT> }<a name="line.421"></a> |
| <FONT color="green">422</FONT> if (confirm) {<a name="line.422"></a> |
| <FONT color="green">423</FONT> char[] second = console.readPassword("%s", "Password to hash (confirm): ");<a name="line.423"></a> |
| <FONT color="green">424</FONT> if (!Arrays.equals(first, second)) {<a name="line.424"></a> |
| <FONT color="green">425</FONT> String msg = "Password entries do not match.";<a name="line.425"></a> |
| <FONT color="green">426</FONT> throw new IllegalArgumentException(msg);<a name="line.426"></a> |
| <FONT color="green">427</FONT> }<a name="line.427"></a> |
| <FONT color="green">428</FONT> }<a name="line.428"></a> |
| <FONT color="green">429</FONT> return first;<a name="line.429"></a> |
| <FONT color="green">430</FONT> }<a name="line.430"></a> |
| <FONT color="green">431</FONT> <a name="line.431"></a> |
| <FONT color="green">432</FONT> private static File toFile(String path) {<a name="line.432"></a> |
| <FONT color="green">433</FONT> String resolved = path;<a name="line.433"></a> |
| <FONT color="green">434</FONT> if (path.startsWith("~/") || path.startsWith(("~\\"))) {<a name="line.434"></a> |
| <FONT color="green">435</FONT> resolved = path.replaceFirst("\\~", System.getProperty("user.home"));<a name="line.435"></a> |
| <FONT color="green">436</FONT> }<a name="line.436"></a> |
| <FONT color="green">437</FONT> return new File(resolved);<a name="line.437"></a> |
| <FONT color="green">438</FONT> }<a name="line.438"></a> |
| <FONT color="green">439</FONT> <a name="line.439"></a> |
| <FONT color="green">440</FONT> private static String toString(String[] strings) {<a name="line.440"></a> |
| <FONT color="green">441</FONT> int len = strings != null ? strings.length : 0;<a name="line.441"></a> |
| <FONT color="green">442</FONT> if (len == 0) {<a name="line.442"></a> |
| <FONT color="green">443</FONT> return null;<a name="line.443"></a> |
| <FONT color="green">444</FONT> }<a name="line.444"></a> |
| <FONT color="green">445</FONT> return StringUtils.toDelimitedString(strings, " ");<a name="line.445"></a> |
| <FONT color="green">446</FONT> }<a name="line.446"></a> |
| <FONT color="green">447</FONT> }<a name="line.447"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
