blob: dd2dc5c2f01956786f199a09cf3a9054af75acdc [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>Hasher xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/tools/hasher/Hasher.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.tools.hasher;
<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.commons.cli.CommandLine;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.commons.cli.CommandLineParser;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.commons.cli.HelpFormatter;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.commons.cli.Option;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.commons.cli.Options;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.commons.cli.DefaultParser;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.authc.credential.DefaultPasswordService;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Base64;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.codec.Hex;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.SecureRandomNumberGenerator;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.UnknownAlgorithmException;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.DefaultHashService;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.Hash;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.HashRequest;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.SimpleHashRequest;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.format.DefaultHashFormatFactory;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.format.HashFormat;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.format.HashFormatFactory;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.format.HexFormat;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.crypto.hash.format.Shiro1CryptFormat;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.io.ResourceUtils;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.ByteSource;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.JavaEnvironment;
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils;
<a class="jxr_linenumber" name="L45" href="#L45">45</a>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Commandline line utility to hash data such as strings, passwords, resources (files, urls, etc).</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * Usage:</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * java -jar shiro-tools-hasher&lt;em&gt;-version&lt;/em&gt;-cli.jar</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * This will print out all supported options with documentation.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/tools/hasher/Hasher.html">Hasher</a> {
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String HEX_PREFIX = <span class="jxr_string">"0x"</span>;
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ALGORITHM_NAME = <span class="jxr_string">"MD5"</span>;
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_PASSWORD_ALGORITHM_NAME = DefaultPasswordService.DEFAULT_HASH_ALGORITHM;
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_GENERATED_SALT_SIZE = 128;
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_NUM_ITERATIONS = 1;
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_PASSWORD_NUM_ITERATIONS = DefaultPasswordService.DEFAULT_HASH_ITERATIONS;
<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option ALGORITHM = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"a"</span>, <span class="jxr_string">"algorithm"</span>, <strong class="jxr_keyword">true</strong>, <span class="jxr_string">"hash algorithm name. Defaults to SHA-256 when password hashing, MD5 otherwise."</span>);
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option DEBUG = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"d"</span>, <span class="jxr_string">"debug"</span>, false, <span class="jxr_string">"show additional error (stack trace) information."</span>);
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option FORMAT = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"f"</span>, <span class="jxr_string">"format"</span>, <strong class="jxr_keyword">true</strong>, <span class="jxr_string">"hash output format. Defaults to 'shiro1' when password hashing, 'hex' otherwise. See below for more information."</span>);
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option HELP = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"help"</span>, <span class="jxr_string">"help"</span>, false, <span class="jxr_string">"show this help message."</span>);
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option ITERATIONS = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"i"</span>, <span class="jxr_string">"iterations"</span>, <strong class="jxr_keyword">true</strong>, <span class="jxr_string">"number of hash iterations. Defaults to "</span> + DEFAULT_PASSWORD_NUM_ITERATIONS + <span class="jxr_string">" when password hashing, 1 otherwise."</span>);
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option PASSWORD = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"p"</span>, <span class="jxr_string">"password"</span>, false, <span class="jxr_string">"hash a password (disable typing echo)"</span>);
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option PASSWORD_NC = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"pnc"</span>, <span class="jxr_string">"pnoconfirm"</span>, false, <span class="jxr_string">"hash a password (disable typing echo) but disable password confirmation prompt."</span>);
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option RESOURCE = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"r"</span>, <span class="jxr_string">"resource"</span>, false, <span class="jxr_string">"read and hash the resource located at &lt;value&gt;. See below for more information."</span>);
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option SALT = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"s"</span>, <span class="jxr_string">"salt"</span>, <strong class="jxr_keyword">true</strong>, <span class="jxr_string">"use the specified salt. &lt;arg&gt; is plaintext."</span>);
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option SALT_BYTES = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"sb"</span>, <span class="jxr_string">"saltbytes"</span>, <strong class="jxr_keyword">true</strong>, <span class="jxr_string">"use the specified salt bytes. &lt;arg&gt; is hex or base64 encoded text."</span>);
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option SALT_GEN = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"gs"</span>, <span class="jxr_string">"gensalt"</span>, false, <span class="jxr_string">"generate and use a random salt. Defaults to true when password hashing, false otherwise."</span>);
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option NO_SALT_GEN = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"ngs"</span>, <span class="jxr_string">"nogensalt"</span>, false, <span class="jxr_string">"do NOT generate and use a random salt (valid during password hashing)."</span>);
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option SALT_GEN_SIZE = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"gss"</span>, <span class="jxr_string">"gensaltsize"</span>, <strong class="jxr_keyword">true</strong>, <span class="jxr_string">"the number of salt bits (not bytes!) to generate. Defaults to 128."</span>);
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option PRIVATE_SALT = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"ps"</span>, <span class="jxr_string">"privatesalt"</span>, <strong class="jxr_keyword">true</strong>, <span class="jxr_string">"use the specified private salt. &lt;arg&gt; is plaintext."</span>);
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Option PRIVATE_SALT_BYTES = <strong class="jxr_keyword">new</strong> Option(<span class="jxr_string">"psb"</span>, <span class="jxr_string">"privatesaltbytes"</span>, <strong class="jxr_keyword">true</strong>, <span class="jxr_string">"use the specified private salt bytes. &lt;arg&gt; is hex or base64 encoded text."</span>);
<a class="jxr_linenumber" name="L85" href="#L85">85</a>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SALT_MUTEX_MSG = createMutexMessage(SALT, SALT_BYTES);
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> HashFormatFactory HASH_FORMAT_FACTORY = <strong class="jxr_keyword">new</strong> DefaultHashFormatFactory();
<a class="jxr_linenumber" name="L89" href="#L89">89</a>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">static</strong> {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> ALGORITHM.setArgName(<span class="jxr_string">"name"</span>);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> SALT_GEN_SIZE.setArgName(<span class="jxr_string">"numBits"</span>);
<a class="jxr_linenumber" name="L93" href="#L93">93</a> ITERATIONS.setArgName(<span class="jxr_string">"num"</span>);
<a class="jxr_linenumber" name="L94" href="#L94">94</a> SALT.setArgName(<span class="jxr_string">"sval"</span>);
<a class="jxr_linenumber" name="L95" href="#L95">95</a> SALT_BYTES.setArgName(<span class="jxr_string">"encTxt"</span>);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> main(String[] args) {
<a class="jxr_linenumber" name="L99" href="#L99">99</a>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> CommandLineParser parser = <strong class="jxr_keyword">new</strong> DefaultParser();
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> Options options = <strong class="jxr_keyword">new</strong> Options();
<a class="jxr_linenumber" name="L103" href="#L103">103</a> options.addOption(HELP).addOption(DEBUG).addOption(ALGORITHM).addOption(ITERATIONS);
<a class="jxr_linenumber" name="L104" href="#L104">104</a> options.addOption(RESOURCE).addOption(PASSWORD).addOption(PASSWORD_NC);
<a class="jxr_linenumber" name="L105" href="#L105">105</a> options.addOption(SALT).addOption(SALT_BYTES).addOption(SALT_GEN).addOption(SALT_GEN_SIZE).addOption(NO_SALT_GEN);
<a class="jxr_linenumber" name="L106" href="#L106">106</a> options.addOption(PRIVATE_SALT).addOption(PRIVATE_SALT_BYTES);
<a class="jxr_linenumber" name="L107" href="#L107">107</a> options.addOption(FORMAT);
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">boolean</strong> debug = false;
<a class="jxr_linenumber" name="L110" href="#L110">110</a> String algorithm = <strong class="jxr_keyword">null</strong>; <em class="jxr_comment">//user unspecified</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">int</strong> iterations = 0; <em class="jxr_comment">//0 means unspecified by the end-user</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">boolean</strong> resource = false;
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">boolean</strong> password = false;
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">boolean</strong> passwordConfirm = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L115" href="#L115">115</a> String saltString = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L116" href="#L116">116</a> String saltBytesString = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">boolean</strong> generateSalt = false;
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">int</strong> generatedSaltSize = DEFAULT_GENERATED_SALT_SIZE;
<a class="jxr_linenumber" name="L119" href="#L119">119</a> String privateSaltString = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L120" href="#L120">120</a> String privateSaltBytesString = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L121" href="#L121">121</a>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> String formatString = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L123" href="#L123">123</a>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">char</strong>[] passwordChars = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L125" href="#L125">125</a>
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L127" href="#L127">127</a> CommandLine line = parser.parse(options, args);
<a class="jxr_linenumber" name="L128" href="#L128">128</a>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">if</strong> (line.hasOption(HELP.getOpt())) {
<a class="jxr_linenumber" name="L130" href="#L130">130</a> printHelpAndExit(options, <strong class="jxr_keyword">null</strong>, debug, 0);
<a class="jxr_linenumber" name="L131" href="#L131">131</a> }
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">if</strong> (line.hasOption(DEBUG.getOpt())) {
<a class="jxr_linenumber" name="L133" href="#L133">133</a> debug = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L134" href="#L134">134</a> }
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">if</strong> (line.hasOption(ALGORITHM.getOpt())) {
<a class="jxr_linenumber" name="L136" href="#L136">136</a> algorithm = line.getOptionValue(ALGORITHM.getOpt());
<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">if</strong> (line.hasOption(ITERATIONS.getOpt())) {
<a class="jxr_linenumber" name="L139" href="#L139">139</a> iterations = getRequiredPositiveInt(line, ITERATIONS);
<a class="jxr_linenumber" name="L140" href="#L140">140</a> }
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">if</strong> (line.hasOption(PASSWORD.getOpt())) {
<a class="jxr_linenumber" name="L142" href="#L142">142</a> password = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L143" href="#L143">143</a> generateSalt = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">if</strong> (line.hasOption(RESOURCE.getOpt())) {
<a class="jxr_linenumber" name="L146" href="#L146">146</a> resource = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">if</strong> (line.hasOption(PASSWORD_NC.getOpt())) {
<a class="jxr_linenumber" name="L149" href="#L149">149</a> password = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L150" href="#L150">150</a> generateSalt = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L151" href="#L151">151</a> passwordConfirm = false;
<a class="jxr_linenumber" name="L152" href="#L152">152</a> }
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">if</strong> (line.hasOption(SALT.getOpt())) {
<a class="jxr_linenumber" name="L154" href="#L154">154</a> saltString = line.getOptionValue(SALT.getOpt());
<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">if</strong> (line.hasOption(SALT_BYTES.getOpt())) {
<a class="jxr_linenumber" name="L157" href="#L157">157</a> saltBytesString = line.getOptionValue(SALT_BYTES.getOpt());
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">if</strong> (line.hasOption(NO_SALT_GEN.getOpt())) {
<a class="jxr_linenumber" name="L160" href="#L160">160</a> generateSalt = false;
<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">if</strong> (line.hasOption(SALT_GEN.getOpt())) {
<a class="jxr_linenumber" name="L163" href="#L163">163</a> generateSalt = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L164" href="#L164">164</a> }
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> (line.hasOption(SALT_GEN_SIZE.getOpt())) {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> generateSalt = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L167" href="#L167">167</a> generatedSaltSize = getRequiredPositiveInt(line, SALT_GEN_SIZE);
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">if</strong> (generatedSaltSize % 8 != 0) {
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Generated salt size must be a multiple of 8 (e.g. 128, 192, 256, 512, etc)."</span>);
<a class="jxr_linenumber" name="L170" href="#L170">170</a> }
<a class="jxr_linenumber" name="L171" href="#L171">171</a> }
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">if</strong> (line.hasOption(PRIVATE_SALT.getOpt())) {
<a class="jxr_linenumber" name="L173" href="#L173">173</a> privateSaltString = line.getOptionValue(PRIVATE_SALT.getOpt());
<a class="jxr_linenumber" name="L174" href="#L174">174</a> }
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">if</strong> (line.hasOption(PRIVATE_SALT_BYTES.getOpt())) {
<a class="jxr_linenumber" name="L176" href="#L176">176</a> privateSaltBytesString = line.getOptionValue(PRIVATE_SALT_BYTES.getOpt());
<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">if</strong> (line.hasOption(FORMAT.getOpt())) {
<a class="jxr_linenumber" name="L179" href="#L179">179</a> formatString = line.getOptionValue(FORMAT.getOpt());
<a class="jxr_linenumber" name="L180" href="#L180">180</a> }
<a class="jxr_linenumber" name="L181" href="#L181">181</a>
<a class="jxr_linenumber" name="L182" href="#L182">182</a> String sourceValue;
<a class="jxr_linenumber" name="L183" href="#L183">183</a>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> Object source;
<a class="jxr_linenumber" name="L185" href="#L185">185</a>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">if</strong> (password) {
<a class="jxr_linenumber" name="L187" href="#L187">187</a> passwordChars = readPassword(passwordConfirm);
<a class="jxr_linenumber" name="L188" href="#L188">188</a> source = passwordChars;
<a class="jxr_linenumber" name="L189" href="#L189">189</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L190" href="#L190">190</a> String[] remainingArgs = line.getArgs();
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">if</strong> (remainingArgs == <strong class="jxr_keyword">null</strong> || remainingArgs.length != 1) {
<a class="jxr_linenumber" name="L192" href="#L192">192</a> printHelpAndExit(options, <strong class="jxr_keyword">null</strong>, debug, -1);
<a class="jxr_linenumber" name="L193" href="#L193">193</a> }
<a class="jxr_linenumber" name="L194" href="#L194">194</a>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> assert remainingArgs != <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L196" href="#L196">196</a> sourceValue = toString(remainingArgs);
<a class="jxr_linenumber" name="L197" href="#L197">197</a>
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">if</strong> (resource) {
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">if</strong> (!ResourceUtils.hasResourcePrefix(sourceValue)) {
<a class="jxr_linenumber" name="L200" href="#L200">200</a> source = toFile(sourceValue);
<a class="jxr_linenumber" name="L201" href="#L201">201</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L202" href="#L202">202</a> source = ResourceUtils.getInputStreamForPath(sourceValue);
<a class="jxr_linenumber" name="L203" href="#L203">203</a> }
<a class="jxr_linenumber" name="L204" href="#L204">204</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L205" href="#L205">205</a> source = sourceValue;
<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
<a class="jxr_linenumber" name="L208" href="#L208">208</a>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">if</strong> (algorithm == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">if</strong> (password) {
<a class="jxr_linenumber" name="L211" href="#L211">211</a> algorithm = DEFAULT_PASSWORD_ALGORITHM_NAME;
<a class="jxr_linenumber" name="L212" href="#L212">212</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L213" href="#L213">213</a> algorithm = DEFAULT_ALGORITHM_NAME;
<a class="jxr_linenumber" name="L214" href="#L214">214</a> }
<a class="jxr_linenumber" name="L215" href="#L215">215</a> }
<a class="jxr_linenumber" name="L216" href="#L216">216</a>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">if</strong> (iterations &lt; DEFAULT_NUM_ITERATIONS) {
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_comment">//Iterations were not specified. Default to 350,000 when password hashing, and 1 for everything else:</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">if</strong> (password) {
<a class="jxr_linenumber" name="L220" href="#L220">220</a> iterations = DEFAULT_PASSWORD_NUM_ITERATIONS;
<a class="jxr_linenumber" name="L221" href="#L221">221</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> iterations = DEFAULT_NUM_ITERATIONS;
<a class="jxr_linenumber" name="L223" href="#L223">223</a> }
<a class="jxr_linenumber" name="L224" href="#L224">224</a> }
<a class="jxr_linenumber" name="L225" href="#L225">225</a>
<a class="jxr_linenumber" name="L226" href="#L226">226</a> ByteSource publicSalt = getSalt(saltString, saltBytesString, generateSalt, generatedSaltSize);
<a class="jxr_linenumber" name="L227" href="#L227">227</a> ByteSource privateSalt = getSalt(privateSaltString, privateSaltBytesString, false, generatedSaltSize);
<a class="jxr_linenumber" name="L228" href="#L228">228</a> HashRequest hashRequest = <strong class="jxr_keyword">new</strong> SimpleHashRequest(algorithm, ByteSource.Util.bytes(source), publicSalt, iterations);
<a class="jxr_linenumber" name="L229" href="#L229">229</a>
<a class="jxr_linenumber" name="L230" href="#L230">230</a> DefaultHashService hashService = <strong class="jxr_keyword">new</strong> DefaultHashService();
<a class="jxr_linenumber" name="L231" href="#L231">231</a> hashService.setPrivateSalt(privateSalt);
<a class="jxr_linenumber" name="L232" href="#L232">232</a> Hash hash = hashService.computeHash(hashRequest);
<a class="jxr_linenumber" name="L233" href="#L233">233</a>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">if</strong> (formatString == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_comment">//Output format was not specified. Default to 'shiro1' when password hashing, and 'hex' for</em>
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_comment">//everything else:</em>
<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">if</strong> (password) {
<a class="jxr_linenumber" name="L238" href="#L238">238</a> formatString = Shiro1CryptFormat.<strong class="jxr_keyword">class</strong>.getName();
<a class="jxr_linenumber" name="L239" href="#L239">239</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L240" href="#L240">240</a> formatString = HexFormat.<strong class="jxr_keyword">class</strong>.getName();
<a class="jxr_linenumber" name="L241" href="#L241">241</a> }
<a class="jxr_linenumber" name="L242" href="#L242">242</a> }
<a class="jxr_linenumber" name="L243" href="#L243">243</a>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> HashFormat format = HASH_FORMAT_FACTORY.getInstance(formatString);
<a class="jxr_linenumber" name="L245" href="#L245">245</a>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">if</strong> (format == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Unrecognized hash format '"</span> + formatString + <span class="jxr_string">"'."</span>);
<a class="jxr_linenumber" name="L248" href="#L248">248</a> }
<a class="jxr_linenumber" name="L249" href="#L249">249</a>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> String output = format.format(hash);
<a class="jxr_linenumber" name="L251" href="#L251">251</a>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> System.out.println(output);
<a class="jxr_linenumber" name="L253" href="#L253">253</a>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> } <strong class="jxr_keyword">catch</strong> (IllegalArgumentException iae) {
<a class="jxr_linenumber" name="L255" href="#L255">255</a> exit(iae, debug);
<a class="jxr_linenumber" name="L256" href="#L256">256</a> } <strong class="jxr_keyword">catch</strong> (UnknownAlgorithmException uae) {
<a class="jxr_linenumber" name="L257" href="#L257">257</a> exit(uae, debug);
<a class="jxr_linenumber" name="L258" href="#L258">258</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a class="jxr_linenumber" name="L259" href="#L259">259</a> exit(ioe, debug);
<a class="jxr_linenumber" name="L260" href="#L260">260</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="L261" href="#L261">261</a> printHelpAndExit(options, e, debug, -1);
<a class="jxr_linenumber" name="L262" href="#L262">262</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">if</strong> (passwordChars != <strong class="jxr_keyword">null</strong> &amp;&amp; passwordChars.length &gt; 0) {
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; passwordChars.length; i++) {
<a class="jxr_linenumber" name="L265" href="#L265">265</a> passwordChars[i] = ' ';
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a> }
<a class="jxr_linenumber" name="L268" href="#L268">268</a> }
<a class="jxr_linenumber" name="L269" href="#L269">269</a> }
<a class="jxr_linenumber" name="L270" href="#L270">270</a>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String createMutexMessage(Option... options) {
<a class="jxr_linenumber" name="L272" href="#L272">272</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L273" href="#L273">273</a> sb.append(<span class="jxr_string">"The "</span>);
<a class="jxr_linenumber" name="L274" href="#L274">274</a>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; options.length; i++) {
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">if</strong> (i &gt; 0) {
<a class="jxr_linenumber" name="L277" href="#L277">277</a> sb.append(<span class="jxr_string">", "</span>);
<a class="jxr_linenumber" name="L278" href="#L278">278</a> }
<a class="jxr_linenumber" name="L279" href="#L279">279</a> Option o = options[0];
<a class="jxr_linenumber" name="L280" href="#L280">280</a> sb.append(<span class="jxr_string">"-"</span>).append(o.getOpt()).append(<span class="jxr_string">"/--"</span>).append(o.getLongOpt());
<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
<a class="jxr_linenumber" name="L282" href="#L282">282</a> sb.append(<span class="jxr_string">" and generated salt options are mutually exclusive. Only one of them may be used at a time"</span>);
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">return</strong> sb.toString();
<a class="jxr_linenumber" name="L284" href="#L284">284</a> }
<a class="jxr_linenumber" name="L285" href="#L285">285</a>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> exit(Exception e, <strong class="jxr_keyword">boolean</strong> debug) {
<a class="jxr_linenumber" name="L287" href="#L287">287</a> printException(e, debug);
<a class="jxr_linenumber" name="L288" href="#L288">288</a> System.exit(-1);
<a class="jxr_linenumber" name="L289" href="#L289">289</a> }
<a class="jxr_linenumber" name="L290" href="#L290">290</a>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> getRequiredPositiveInt(CommandLine line, Option option) {
<a class="jxr_linenumber" name="L292" href="#L292">292</a> String iterVal = line.getOptionValue(option.getOpt());
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">return</strong> Integer.parseInt(iterVal);
<a class="jxr_linenumber" name="L295" href="#L295">295</a> } <strong class="jxr_keyword">catch</strong> (NumberFormatException e) {
<a class="jxr_linenumber" name="L296" href="#L296">296</a> String msg = <span class="jxr_string">"'"</span> + option.getLongOpt() + <span class="jxr_string">"' value must be a positive integer."</span>;
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(msg, e);
<a class="jxr_linenumber" name="L298" href="#L298">298</a> }
<a class="jxr_linenumber" name="L299" href="#L299">299</a> }
<a class="jxr_linenumber" name="L300" href="#L300">300</a>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> ByteSource getSalt(String saltString, String saltBytesString, <strong class="jxr_keyword">boolean</strong> generateSalt, <strong class="jxr_keyword">int</strong> generatedSaltSize) {
<a class="jxr_linenumber" name="L302" href="#L302">302</a>
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">if</strong> (saltString != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">if</strong> (generateSalt || (saltBytesString != <strong class="jxr_keyword">null</strong>)) {
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(SALT_MUTEX_MSG);
<a class="jxr_linenumber" name="L306" href="#L306">306</a> }
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">return</strong> ByteSource.Util.bytes(saltString);
<a class="jxr_linenumber" name="L308" href="#L308">308</a> }
<a class="jxr_linenumber" name="L309" href="#L309">309</a>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">if</strong> (saltBytesString != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">if</strong> (generateSalt) {
<a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(SALT_MUTEX_MSG);
<a class="jxr_linenumber" name="L313" href="#L313">313</a> }
<a class="jxr_linenumber" name="L314" href="#L314">314</a>
<a class="jxr_linenumber" name="L315" href="#L315">315</a> String value = saltBytesString;
<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">boolean</strong> base64 = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">if</strong> (saltBytesString.startsWith(HEX_PREFIX)) {
<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_comment">//hex:</em>
<a class="jxr_linenumber" name="L319" href="#L319">319</a> base64 = false;
<a class="jxr_linenumber" name="L320" href="#L320">320</a> value = value.substring(HEX_PREFIX.length());
<a class="jxr_linenumber" name="L321" href="#L321">321</a> }
<a class="jxr_linenumber" name="L322" href="#L322">322</a> byte[] bytes;
<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">if</strong> (base64) {
<a class="jxr_linenumber" name="L324" href="#L324">324</a> bytes = Base64.decode(value);
<a class="jxr_linenumber" name="L325" href="#L325">325</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L326" href="#L326">326</a> bytes = Hex.decode(value);
<a class="jxr_linenumber" name="L327" href="#L327">327</a> }
<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">return</strong> ByteSource.Util.bytes(bytes);
<a class="jxr_linenumber" name="L329" href="#L329">329</a> }
<a class="jxr_linenumber" name="L330" href="#L330">330</a>
<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">if</strong> (generateSalt) {
<a class="jxr_linenumber" name="L332" href="#L332">332</a> SecureRandomNumberGenerator generator = <strong class="jxr_keyword">new</strong> SecureRandomNumberGenerator();
<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">int</strong> byteSize = generatedSaltSize / 8; <em class="jxr_comment">//generatedSaltSize is in *bits* - convert to byte size:</em>
<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">return</strong> generator.nextBytes(byteSize);
<a class="jxr_linenumber" name="L335" href="#L335">335</a> }
<a class="jxr_linenumber" name="L336" href="#L336">336</a>
<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_comment">//no salt used:</em>
<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L339" href="#L339">339</a> }
<a class="jxr_linenumber" name="L340" href="#L340">340</a>
<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> printException(Exception e, <strong class="jxr_keyword">boolean</strong> debug) {
<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">if</strong> (e != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L343" href="#L343">343</a> System.out.println();
<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">if</strong> (debug) {
<a class="jxr_linenumber" name="L345" href="#L345">345</a> System.out.println(<span class="jxr_string">"Error: "</span>);
<a class="jxr_linenumber" name="L346" href="#L346">346</a> e.printStackTrace(System.out);
<a class="jxr_linenumber" name="L347" href="#L347">347</a> System.out.println(e.getMessage());
<a class="jxr_linenumber" name="L348" href="#L348">348</a>
<a class="jxr_linenumber" name="L349" href="#L349">349</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L350" href="#L350">350</a> System.out.println(<span class="jxr_string">"Error: "</span> + e.getMessage());
<a class="jxr_linenumber" name="L351" href="#L351">351</a> System.out.println();
<a class="jxr_linenumber" name="L352" href="#L352">352</a> System.out.println(<span class="jxr_string">"Specify -d or --debug for more information."</span>);
<a class="jxr_linenumber" name="L353" href="#L353">353</a> }
<a class="jxr_linenumber" name="L354" href="#L354">354</a> }
<a class="jxr_linenumber" name="L355" href="#L355">355</a> }
<a class="jxr_linenumber" name="L356" href="#L356">356</a>
<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> printHelp(Options options, Exception e, <strong class="jxr_keyword">boolean</strong> debug) {
<a class="jxr_linenumber" name="L358" href="#L358">358</a> HelpFormatter help = <strong class="jxr_keyword">new</strong> HelpFormatter();
<a class="jxr_linenumber" name="L359" href="#L359">359</a> String command = <span class="jxr_string">"java -jar shiro-tools-hasher-&lt;version&gt;.jar [options] [&lt;value&gt;]"</span>;
<a class="jxr_linenumber" name="L360" href="#L360">360</a> String header = <span class="jxr_string">"\nPrint a cryptographic hash (aka message digest) of the specified &lt;value&gt;.\n--\nOptions:"</span>;
<a class="jxr_linenumber" name="L361" href="#L361">361</a> String footer = <span class="jxr_string">"\n"</span> +
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <span class="jxr_string">"&lt;value&gt; is optional only when hashing passwords (see below). It is\n"</span> +
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <span class="jxr_string">"required all other times."</span> +
<a class="jxr_linenumber" name="L364" href="#L364">364</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L365" href="#L365">365</a> <span class="jxr_string">"Password Hashing:\n"</span> +
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <span class="jxr_string">"---------------------------------\n"</span> +
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <span class="jxr_string">"Specify the -p/--password option and DO NOT enter a &lt;value&gt;. You will\n"</span> +
<a class="jxr_linenumber" name="L368" href="#L368">368</a> <span class="jxr_string">"be prompted for a password and characters will not echo as you type."</span> +
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <span class="jxr_string">"Salting:\n"</span> +
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <span class="jxr_string">"---------------------------------\n"</span> +
<a class="jxr_linenumber" name="L372" href="#L372">372</a> <span class="jxr_string">"Specifying a salt:"</span> +
<a class="jxr_linenumber" name="L373" href="#L373">373</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <span class="jxr_string">"You may specify a salt using the -s/--salt option followed by the salt\n"</span> +
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <span class="jxr_string">"value. If the salt value is a base64 or hex string representing a\n"</span> +
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <span class="jxr_string">"byte array, you must specify the -sb/--saltbytes option to indicate this,\n"</span> +
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <span class="jxr_string">"otherwise the text value bytes will be used directly."</span> +
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <span class="jxr_string">"When using -sb/--saltbytes, the -s/--salt value is expected to be a\n"</span> +
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <span class="jxr_string">"base64-encoded string by default. If the value is a hex-encoded string,\n"</span> +
<a class="jxr_linenumber" name="L381" href="#L381">381</a> <span class="jxr_string">"you must prefix the string with 0x (zero x) to indicate a hex value."</span> +
<a class="jxr_linenumber" name="L382" href="#L382">382</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <span class="jxr_string">"Generating a salt:"</span> +
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <span class="jxr_string">"Use the -gs/--gensalt option if you don't want to specify a salt,\n"</span> +
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <span class="jxr_string">"but want a strong random salt to be generated and used during hashing.\n"</span> +
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <span class="jxr_string">"The generated salt size defaults to 128 bits. You may specify\n"</span> +
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <span class="jxr_string">"a different size by using the -gss/--gensaltsize option followed by\n"</span> +
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <span class="jxr_string">"a positive integer (size is in bits, not bytes)."</span> +
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L391" href="#L391">391</a> <span class="jxr_string">"Because a salt must be specified if computing the hash later,\n"</span> +
<a class="jxr_linenumber" name="L392" href="#L392">392</a> <span class="jxr_string">"generated salts are only useful with the shiro1 output format;\n"</span> +
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <span class="jxr_string">"the other formats do not include the generated salt."</span> +
<a class="jxr_linenumber" name="L394" href="#L394">394</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L395" href="#L395">395</a> <span class="jxr_string">"Specifying a private salt:"</span> +
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <span class="jxr_string">"You may specify a private salt using the -ps/--privatesalt option followed\n"</span> +
<a class="jxr_linenumber" name="L398" href="#L398">398</a> <span class="jxr_string">"by the private salt value. If the private salt value is a base64 or hex \n"</span> +
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <span class="jxr_string">"string representing a byte array, you must specify the -psb/--privatesaltbytes\n"</span> +
<a class="jxr_linenumber" name="L400" href="#L400">400</a> <span class="jxr_string">"option to indicate this, otherwise the text value bytes will be used directly."</span> +
<a class="jxr_linenumber" name="L401" href="#L401">401</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L402" href="#L402">402</a> <span class="jxr_string">"When using -psb/--privatesaltbytes, the -ps/--privatesalt value is expected to\n"</span> +
<a class="jxr_linenumber" name="L403" href="#L403">403</a> <span class="jxr_string">"be a base64-encoded string by default. If the value is a hex-encoded string,\n"</span> +
<a class="jxr_linenumber" name="L404" href="#L404">404</a> <span class="jxr_string">"you must prefix the string with 0x (zero x) to indicate a hex value."</span> +
<a class="jxr_linenumber" name="L405" href="#L405">405</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <span class="jxr_string">"Files, URLs and classpath resources:\n"</span> +
<a class="jxr_linenumber" name="L407" href="#L407">407</a> <span class="jxr_string">"---------------------------------\n"</span> +
<a class="jxr_linenumber" name="L408" href="#L408">408</a> <span class="jxr_string">"If using the -r/--resource option, the &lt;value&gt; represents a resource path.\n"</span> +
<a class="jxr_linenumber" name="L409" href="#L409">409</a> <span class="jxr_string">"By default this is expected to be a file path, but you may specify\n"</span> +
<a class="jxr_linenumber" name="L410" href="#L410">410</a> <span class="jxr_string">"classpath or URL resources by using the classpath: or url: prefix\n"</span> +
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <span class="jxr_string">"respectively."</span> +
<a class="jxr_linenumber" name="L412" href="#L412">412</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L413" href="#L413">413</a> <span class="jxr_string">"Some examples:"</span> +
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L415" href="#L415">415</a> <span class="jxr_string">"&lt;command&gt; -r fileInCurrentDirectory.txt\n"</span> +
<a class="jxr_linenumber" name="L416" href="#L416">416</a> <span class="jxr_string">"&lt;command&gt; -r ../../relativePathFile.xml\n"</span> +
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <span class="jxr_string">"&lt;command&gt; -r ~/documents/myfile.pdf\n"</span> +
<a class="jxr_linenumber" name="L418" href="#L418">418</a> <span class="jxr_string">"&lt;command&gt; -r /usr/local/logs/absolutePathFile.log\n"</span> +
<a class="jxr_linenumber" name="L419" href="#L419">419</a> <span class="jxr_string">"&lt;command&gt; -r url:http://foo.com/page.html\n"</span> +
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <span class="jxr_string">"&lt;command&gt; -r classpath:/WEB-INF/lib/something.jar"</span> +
<a class="jxr_linenumber" name="L421" href="#L421">421</a> <span class="jxr_string">"\n\n"</span> +
<a class="jxr_linenumber" name="L422" href="#L422">422</a> <span class="jxr_string">"Output Format:\n"</span> +
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <span class="jxr_string">"---------------------------------\n"</span> +
<a class="jxr_linenumber" name="L424" href="#L424">424</a> <span class="jxr_string">"Specify the -f/--format option followed by either 1) the format ID (as defined\n"</span> +
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <span class="jxr_string">"by the "</span> + DefaultHashFormatFactory.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"\n"</span> +
<a class="jxr_linenumber" name="L426" href="#L426">426</a> <span class="jxr_string">"JavaDoc) or 2) the fully qualified "</span> + HashFormat.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">"\n"</span> +
<a class="jxr_linenumber" name="L427" href="#L427">427</a> <span class="jxr_string">"implementation class name to instantiate and use for formatting.\n\n"</span> +
<a class="jxr_linenumber" name="L428" href="#L428">428</a> <span class="jxr_string">"The default output format is 'shiro1' which is a Modular Crypt Format (MCF)\n"</span> +
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <span class="jxr_string">"that shows all relevant information as a dollar-sign ($) delimited string.\n"</span> +
<a class="jxr_linenumber" name="L430" href="#L430">430</a> <span class="jxr_string">"This format is ideal for use in Shiro's text-based user configuration (e.g.\n"</span> +
<a class="jxr_linenumber" name="L431" href="#L431">431</a> <span class="jxr_string">"shiro.ini or a properties file)."</span>;
<a class="jxr_linenumber" name="L432" href="#L432">432</a>
<a class="jxr_linenumber" name="L433" href="#L433">433</a> printException(e, debug);
<a class="jxr_linenumber" name="L434" href="#L434">434</a>
<a class="jxr_linenumber" name="L435" href="#L435">435</a> System.out.println();
<a class="jxr_linenumber" name="L436" href="#L436">436</a> help.printHelp(command, header, options, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L437" href="#L437">437</a> System.out.println(footer);
<a class="jxr_linenumber" name="L438" href="#L438">438</a> }
<a class="jxr_linenumber" name="L439" href="#L439">439</a>
<a class="jxr_linenumber" name="L440" href="#L440">440</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> printHelpAndExit(Options options, Exception e, <strong class="jxr_keyword">boolean</strong> debug, <strong class="jxr_keyword">int</strong> exitCode) {
<a class="jxr_linenumber" name="L441" href="#L441">441</a> printHelp(options, e, debug);
<a class="jxr_linenumber" name="L442" href="#L442">442</a> System.exit(exitCode);
<a class="jxr_linenumber" name="L443" href="#L443">443</a> }
<a class="jxr_linenumber" name="L444" href="#L444">444</a>
<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">char</strong>[] readPassword(<strong class="jxr_keyword">boolean</strong> confirm) {
<a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">if</strong> (!JavaEnvironment.isAtLeastVersion16()) {
<a class="jxr_linenumber" name="L447" href="#L447">447</a> String msg = <span class="jxr_string">"Password hashing (prompt without echo) uses the java.io.Console to read passwords "</span> +
<a class="jxr_linenumber" name="L448" href="#L448">448</a> <span class="jxr_string">"safely. This is only available on Java 1.6 platforms and later."</span>;
<a class="jxr_linenumber" name="L449" href="#L449">449</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(msg);
<a class="jxr_linenumber" name="L450" href="#L450">450</a> }
<a class="jxr_linenumber" name="L451" href="#L451">451</a> java.io.Console console = System.console();
<a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">if</strong> (console == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"java.io.Console is not available on the current JVM. Cannot read passwords."</span>);
<a class="jxr_linenumber" name="L454" href="#L454">454</a> }
<a class="jxr_linenumber" name="L455" href="#L455">455</a> <strong class="jxr_keyword">char</strong>[] first = console.readPassword(<span class="jxr_string">"%s"</span>, <span class="jxr_string">"Password to hash: "</span>);
<a class="jxr_linenumber" name="L456" href="#L456">456</a> <strong class="jxr_keyword">if</strong> (first == <strong class="jxr_keyword">null</strong> || first.length == 0) {
<a class="jxr_linenumber" name="L457" href="#L457">457</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"No password specified."</span>);
<a class="jxr_linenumber" name="L458" href="#L458">458</a> }
<a class="jxr_linenumber" name="L459" href="#L459">459</a> <strong class="jxr_keyword">if</strong> (confirm) {
<a class="jxr_linenumber" name="L460" href="#L460">460</a> <strong class="jxr_keyword">char</strong>[] second = console.readPassword(<span class="jxr_string">"%s"</span>, <span class="jxr_string">"Password to hash (confirm): "</span>);
<a class="jxr_linenumber" name="L461" href="#L461">461</a> <strong class="jxr_keyword">if</strong> (!Arrays.equals(first, second)) {
<a class="jxr_linenumber" name="L462" href="#L462">462</a> String msg = <span class="jxr_string">"Password entries do not match."</span>;
<a class="jxr_linenumber" name="L463" href="#L463">463</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(msg);
<a class="jxr_linenumber" name="L464" href="#L464">464</a> }
<a class="jxr_linenumber" name="L465" href="#L465">465</a> }
<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">return</strong> first;
<a class="jxr_linenumber" name="L467" href="#L467">467</a> }
<a class="jxr_linenumber" name="L468" href="#L468">468</a>
<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> File toFile(String path) {
<a class="jxr_linenumber" name="L470" href="#L470">470</a> String resolved = path;
<a class="jxr_linenumber" name="L471" href="#L471">471</a> <strong class="jxr_keyword">if</strong> (path.startsWith(<span class="jxr_string">"~/"</span>) || path.startsWith((<span class="jxr_string">"~&#92;&#92;"</span>))) {
<a class="jxr_linenumber" name="L472" href="#L472">472</a> resolved = path.replaceFirst(<span class="jxr_string">"&#92;&#92;~"</span>, System.getProperty(<span class="jxr_string">"user.home"</span>));
<a class="jxr_linenumber" name="L473" href="#L473">473</a> }
<a class="jxr_linenumber" name="L474" href="#L474">474</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File(resolved);
<a class="jxr_linenumber" name="L475" href="#L475">475</a> }
<a class="jxr_linenumber" name="L476" href="#L476">476</a>
<a class="jxr_linenumber" name="L477" href="#L477">477</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String toString(String[] strings) {
<a class="jxr_linenumber" name="L478" href="#L478">478</a> <strong class="jxr_keyword">int</strong> len = strings != <strong class="jxr_keyword">null</strong> ? strings.length : 0;
<a class="jxr_linenumber" name="L479" href="#L479">479</a> <strong class="jxr_keyword">if</strong> (len == 0) {
<a class="jxr_linenumber" name="L480" href="#L480">480</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L481" href="#L481">481</a> }
<a class="jxr_linenumber" name="L482" href="#L482">482</a> <strong class="jxr_keyword">return</strong> StringUtils.toDelimitedString(strings, <span class="jxr_string">" "</span>);
<a class="jxr_linenumber" name="L483" href="#L483">483</a> }
<a class="jxr_linenumber" name="L484" href="#L484">484</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>