| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.io.crypto;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import static java.lang.String.format;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.InputStream;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.io.OutputStream;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.security.Key;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.security.MessageDigest;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.security.NoSuchAlgorithmException;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.security.spec.InvalidKeySpecException;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.Arrays;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.Map;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import javax.crypto.SecretKeyFactory;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import javax.crypto.spec.PBEKeySpec;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import javax.crypto.spec.SecretKeySpec;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.commons.io.IOUtils;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.conf.Configuration;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.HBaseConfiguration;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.HConstants;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.io.crypto.aes.AES;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.hadoop.util.ReflectionUtils;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.slf4j.Logger;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.slf4j.LoggerFactory;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span>/**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * A facade for encryption algorithms and related support.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>@InterfaceAudience.Public<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public final class Encryption {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> private static final Logger LOG = LoggerFactory.getLogger(Encryption.class);<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Configuration key for globally enable / disable column family encryption<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> public static final String CRYPTO_ENABLED_CONF_KEY = "hbase.crypto.enabled";<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Default value for globally enable / disable column family encryption (set to "true" for<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * backward compatibility)<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> public static final boolean CRYPTO_ENABLED_CONF_DEFAULT = true;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Configuration key for the hash algorithm used for generating key hash in encrypted HFiles. This<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * is a MessageDigest algorithm identifier string, like "MD5", "SHA-256" or "SHA-384". (default:<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * "MD5" for backward compatibility reasons)<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public static final String CRYPTO_KEY_HASH_ALGORITHM_CONF_KEY = "hbase.crypto.key.hash.algorithm";<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /**<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * Default hash algorithm used for generating key hash in encrypted HFiles. (we use "MD5" for<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * backward compatibility reasons)<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> public static final String CRYPTO_KEY_HASH_ALGORITHM_CONF_DEFAULT = "MD5";<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> /**<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * Configuration key for specifying the behaviour if the configured hash algorithm differs from<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * the one used for generating key hash in encrypted HFiles currently being read. - "false"<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * (default): we won't fail but use the hash algorithm stored in the HFile - "true": we throw an<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * exception (this can be useful if regulations are enforcing the usage of certain algorithms,<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * e.g. on FIPS compliant clusters)<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> public static final String CRYPTO_KEY_FAIL_ON_ALGORITHM_MISMATCH_CONF_KEY =<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> "hbase.crypto.key.hash.algorithm.failOnMismatch";<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> /**<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Default behaviour is not to fail if the hash algorithm configured differs from the one used in<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * the HFile. (this is the more fail-safe approach, allowing us to read encrypted HFiles written<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * using a different encryption key hash algorithm)<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public static final boolean CRYPTO_KEY_FAIL_ON_ALGORITHM_MISMATCH_CONF_DEFAULT = false;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Crypto context<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> @InterfaceAudience.Public<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> public static class Context extends org.apache.hadoop.hbase.io.crypto.Context {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> /** The null crypto context */<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> public static final Context NONE = new Context();<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> private Context() {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> super();<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> private Context(Configuration conf) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> super(conf);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> @Override<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> public Context setCipher(Cipher cipher) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> super.setCipher(cipher);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return this;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> @Override<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> public Context setKey(Key key) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> super.setKey(key);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> return this;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> public Context setKey(byte[] key) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> super.setKey(new SecretKeySpec(key, getCipher().getName()));<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> return this;<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> }<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public static Context newContext() {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> return new Context();<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> public static Context newContext(Configuration conf) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return new Context(conf);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> // Prevent instantiation<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> private Encryption() {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> super();<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> /**<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * Returns true if the column family encryption feature is enabled globally.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> public static boolean isEncryptionEnabled(Configuration conf) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> return conf.getBoolean(CRYPTO_ENABLED_CONF_KEY, CRYPTO_ENABLED_CONF_DEFAULT);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> /**<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * Get an cipher given a name<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * @param name the cipher name<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @return the cipher, or null if a suitable one could not be found<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> */<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> public static Cipher getCipher(Configuration conf, String name) {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> return getCipherProvider(conf).getCipher(name);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> }<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> /**<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * Get names of supported encryption algorithms<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @return Array of strings, each represents a supported encryption algorithm<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> public static String[] getSupportedCiphers() {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> return getSupportedCiphers(HBaseConfiguration.create());<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> /**<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * Get names of supported encryption algorithms<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @return Array of strings, each represents a supported encryption algorithm<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> public static String[] getSupportedCiphers(Configuration conf) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return getCipherProvider(conf).getSupportedCiphers();<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> /**<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * Returns the Hash Algorithm defined in the crypto configuration.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> */<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> public static String getConfiguredHashAlgorithm(Configuration conf) {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> return conf.getTrimmed(CRYPTO_KEY_HASH_ALGORITHM_CONF_KEY,<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> CRYPTO_KEY_HASH_ALGORITHM_CONF_DEFAULT);<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> }<a name="line.182"></a> |
| <span class="sourceLineNo">183</span><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> /**<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * Returns the Hash Algorithm mismatch behaviour defined in the crypto configuration.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> */<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> public static boolean failOnHashAlgorithmMismatch(Configuration conf) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> return conf.getBoolean(CRYPTO_KEY_FAIL_ON_ALGORITHM_MISMATCH_CONF_KEY,<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> CRYPTO_KEY_FAIL_ON_ALGORITHM_MISMATCH_CONF_DEFAULT);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> /**<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * Returns the hash of the supplied argument, using the hash algorithm specified in the given<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * config.<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> */<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> public static byte[] computeCryptoKeyHash(Configuration conf, byte[] arg) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> String algorithm = getConfiguredHashAlgorithm(conf);<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> try {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> return hashWithAlg(algorithm, arg);<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> } catch (RuntimeException e) {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> String message = format(<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> "Error in computeCryptoKeyHash (please check your configuration "<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> + "parameter %s and the security provider configuration of the JVM)",<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> CRYPTO_KEY_HASH_ALGORITHM_CONF_KEY);<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> throw new RuntimeException(message, e);<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> }<a name="line.207"></a> |
| <span class="sourceLineNo">208</span><a name="line.208"></a> |
| <span class="sourceLineNo">209</span> /**<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * Return the MD5 digest of the concatenation of the supplied arguments.<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> */<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> public static byte[] hash128(String... args) {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> return hashWithAlg("MD5", Bytes.toByteArrays(args));<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> }<a name="line.214"></a> |
| <span class="sourceLineNo">215</span><a name="line.215"></a> |
| <span class="sourceLineNo">216</span> /**<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * Return the MD5 digest of the concatenation of the supplied arguments.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> */<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> public static byte[] hash128(byte[]... args) {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> return hashWithAlg("MD5", args);<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> }<a name="line.221"></a> |
| <span class="sourceLineNo">222</span><a name="line.222"></a> |
| <span class="sourceLineNo">223</span> /**<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * Return the SHA-256 digest of the concatenation of the supplied arguments.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> */<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> public static byte[] hash256(String... args) {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> return hashWithAlg("SHA-256", Bytes.toByteArrays(args));<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<a name="line.228"></a> |
| <span class="sourceLineNo">229</span><a name="line.229"></a> |
| <span class="sourceLineNo">230</span> /**<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * Return the SHA-256 digest of the concatenation of the supplied arguments.<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> */<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> public static byte[] hash256(byte[]... args) {<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> return hashWithAlg("SHA-256", args);<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> }<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> /**<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * Return a 128 bit key derived from the concatenation of the supplied arguments using<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * PBKDF2WithHmacSHA1 at 10,000 iterations.<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> */<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> public static byte[] pbkdf128(String... args) {<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> StringBuilder sb = new StringBuilder();<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> for (String s : args) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> sb.append(s);<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> }<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> return generateSecretKey("PBKDF2WithHmacSHA1", AES.KEY_LENGTH, sb.toString().toCharArray());<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> }<a name="line.247"></a> |
| <span class="sourceLineNo">248</span><a name="line.248"></a> |
| <span class="sourceLineNo">249</span> /**<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * Return a 128 bit key derived from the concatenation of the supplied arguments using<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * PBKDF2WithHmacSHA1 at 10,000 iterations.<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> */<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> public static byte[] pbkdf128(byte[]... args) {<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> StringBuilder sb = new StringBuilder();<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> for (byte[] b : args) {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> sb.append(Arrays.toString(b));<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> return generateSecretKey("PBKDF2WithHmacSHA1", AES.KEY_LENGTH, sb.toString().toCharArray());<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> }<a name="line.259"></a> |
| <span class="sourceLineNo">260</span><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> /**<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * Return a key derived from the concatenation of the supplied arguments using<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * PBKDF2WithHmacSHA384 key derivation algorithm at 10,000 iterations. The length of the returned<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * key is determined based on the need of the cypher algorithm. E.g. for the default "AES" we will<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * need a 128 bit long key, while if the user is using a custom cipher, we might generate keys<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * with other length. This key generation method is used currently e.g. in the HBase Shell<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * (admin.rb) to generate a column family data encryption key, if the user provided an<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * ENCRYPTION_KEY parameter.<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> */<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> public static byte[] generateSecretKey(Configuration conf, String cypherAlg, String... args) {<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> StringBuilder sb = new StringBuilder();<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> for (String s : args) {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> sb.append(s);<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> int keyLengthBytes = Encryption.getCipher(conf, cypherAlg).getKeyLength();<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> return generateSecretKey("PBKDF2WithHmacSHA384", keyLengthBytes, sb.toString().toCharArray());<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> }<a name="line.277"></a> |
| <span class="sourceLineNo">278</span><a name="line.278"></a> |
| <span class="sourceLineNo">279</span> /**<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * Return a key derived from the concatenation of the supplied arguments using<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * PBKDF2WithHmacSHA384 key derivation algorithm at 10,000 iterations. The length of the returned<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * key is determined based on the need of the cypher algorithm. E.g. for the default "AES" we will<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * need a 128 bit long key, while if the user is using a custom cipher, we might generate keys<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * with other length. This key generation method is used currently e.g. in the HBase Shell<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * (admin.rb) to generate a column family data encryption key, if the user provided an<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * ENCRYPTION_KEY parameter.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> */<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> public static byte[] generateSecretKey(Configuration conf, String cypherAlg, byte[]... args) {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> StringBuilder sb = new StringBuilder();<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> for (byte[] b : args) {<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> sb.append(Arrays.toString(b));<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> }<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> int keyLength = Encryption.getCipher(conf, cypherAlg).getKeyLength();<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> return generateSecretKey("PBKDF2WithHmacSHA384", keyLength, sb.toString().toCharArray());<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> }<a name="line.295"></a> |
| <span class="sourceLineNo">296</span><a name="line.296"></a> |
| <span class="sourceLineNo">297</span> /**<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * Return a key (byte array) derived from the supplied password argument using the given algorithm<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * with a random salt at 10,000 iterations.<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * @param algorithm the secret key generation algorithm to use<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * @param keyLengthBytes the length of the key to be derived (in bytes, not in bits)<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * @param password char array to use as password for the key generation algorithm<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * @return secret key encoded as a byte array<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> */<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> private static byte[] generateSecretKey(String algorithm, int keyLengthBytes, char[] password) {<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> byte[] salt = new byte[keyLengthBytes];<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> Bytes.secureRandom(salt);<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> PBEKeySpec spec = new PBEKeySpec(password, salt, 10000, keyLengthBytes * 8);<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> try {<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> return SecretKeyFactory.getInstance(algorithm).generateSecret(spec).getEncoded();<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> throw new RuntimeException(e);<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> }<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> }<a name="line.314"></a> |
| <span class="sourceLineNo">315</span><a name="line.315"></a> |
| <span class="sourceLineNo">316</span> /**<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * Encrypt a block of plaintext<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * <p><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * The encryptor's state will be finalized. It should be reinitialized or returned to the pool.<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * @param out ciphertext<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * @param src plaintext<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> */<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> public static void encrypt(OutputStream out, byte[] src, int offset, int length, Encryptor e)<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> throws IOException {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> OutputStream cout = e.createEncryptionStream(out);<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> try {<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> cout.write(src, offset, length);<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> } finally {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> cout.close();<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> }<a name="line.331"></a> |
| <span class="sourceLineNo">332</span><a name="line.332"></a> |
| <span class="sourceLineNo">333</span> /**<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * Encrypt a block of plaintext<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * @param out ciphertext<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * @param src plaintext<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> */<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> public static void encrypt(OutputStream out, byte[] src, int offset, int length, Context context,<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> byte[] iv) throws IOException {<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> Encryptor e = context.getCipher().getEncryptor();<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> e.setKey(context.getKey());<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> e.setIv(iv); // can be null<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> e.reset();<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> encrypt(out, src, offset, length, e);<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> }<a name="line.345"></a> |
| <span class="sourceLineNo">346</span><a name="line.346"></a> |
| <span class="sourceLineNo">347</span> /**<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * Encrypt a stream of plaintext given an encryptor<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * <p><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * The encryptor's state will be finalized. It should be reinitialized or returned to the pool.<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * @param out ciphertext<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * @param in plaintext<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> */<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> public static void encrypt(OutputStream out, InputStream in, Encryptor e) throws IOException {<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> OutputStream cout = e.createEncryptionStream(out);<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> try {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> IOUtils.copy(in, cout);<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> } finally {<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> cout.close();<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> }<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> }<a name="line.361"></a> |
| <span class="sourceLineNo">362</span><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> /**<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * Encrypt a stream of plaintext given a context and IV<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * @param out ciphertext<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * @param in plaintet<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> */<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> public static void encrypt(OutputStream out, InputStream in, Context context, byte[] iv)<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> throws IOException {<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> Encryptor e = context.getCipher().getEncryptor();<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> e.setKey(context.getKey());<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> e.setIv(iv); // can be null<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> e.reset();<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> encrypt(out, in, e);<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> }<a name="line.375"></a> |
| <span class="sourceLineNo">376</span><a name="line.376"></a> |
| <span class="sourceLineNo">377</span> /**<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * Decrypt a block of ciphertext read in from a stream with the given cipher and context<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * <p><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * The decryptor's state will be finalized. It should be reinitialized or returned to the pool.<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> */<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> public static void decrypt(byte[] dest, int destOffset, InputStream in, int destSize, Decryptor d)<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> throws IOException {<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> InputStream cin = d.createDecryptionStream(in);<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> try {<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> IOUtils.readFully(cin, dest, destOffset, destSize);<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> } finally {<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> cin.close();<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> }<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> }<a name="line.390"></a> |
| <span class="sourceLineNo">391</span><a name="line.391"></a> |
| <span class="sourceLineNo">392</span> /**<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * Decrypt a block of ciphertext from a stream given a context and IV<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> */<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> public static void decrypt(byte[] dest, int destOffset, InputStream in, int destSize,<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> Context context, byte[] iv) throws IOException {<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> Decryptor d = context.getCipher().getDecryptor();<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> d.setKey(context.getKey());<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> d.setIv(iv); // can be null<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> decrypt(dest, destOffset, in, destSize, d);<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> }<a name="line.401"></a> |
| <span class="sourceLineNo">402</span><a name="line.402"></a> |
| <span class="sourceLineNo">403</span> /**<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> * Decrypt a stream of ciphertext given a decryptor<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> */<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> public static void decrypt(OutputStream out, InputStream in, int outLen, Decryptor d)<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> throws IOException {<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> InputStream cin = d.createDecryptionStream(in);<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> byte buf[] = new byte[8 * 1024];<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> long remaining = outLen;<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> try {<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> while (remaining > 0) {<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> int toRead = (int) (remaining < buf.length ? remaining : buf.length);<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> int read = cin.read(buf, 0, toRead);<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> if (read < 0) {<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> break;<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> }<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> out.write(buf, 0, read);<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> remaining -= read;<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> }<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> } finally {<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> cin.close();<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> }<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> }<a name="line.424"></a> |
| <span class="sourceLineNo">425</span><a name="line.425"></a> |
| <span class="sourceLineNo">426</span> /**<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * Decrypt a stream of ciphertext given a context and IV<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> */<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> public static void decrypt(OutputStream out, InputStream in, int outLen, Context context,<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> byte[] iv) throws IOException {<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> Decryptor d = context.getCipher().getDecryptor();<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> d.setKey(context.getKey());<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> d.setIv(iv); // can be null<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> decrypt(out, in, outLen, d);<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> }<a name="line.435"></a> |
| <span class="sourceLineNo">436</span><a name="line.436"></a> |
| <span class="sourceLineNo">437</span> /**<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> * Resolves a key for the given subject<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> * @return a key for the given subject<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> * @throws IOException if the key is not found<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> */<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> public static Key getSecretKeyForSubject(String subject, Configuration conf) throws IOException {<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> KeyProvider provider = getKeyProvider(conf);<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> if (provider != null) {<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> try {<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> Key[] keys = provider.getKeys(new String[] { subject });<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> if (keys != null && keys.length > 0) {<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> return keys[0];<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> }<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> } catch (Exception e) {<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> throw new IOException(e);<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> }<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> }<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> throw new IOException("No key found for subject '" + subject + "'");<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> }<a name="line.455"></a> |
| <span class="sourceLineNo">456</span><a name="line.456"></a> |
| <span class="sourceLineNo">457</span> /**<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> * Encrypts a block of plaintext with the symmetric key resolved for the given subject<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> * @param out ciphertext<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> * @param in plaintext<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> * @param conf configuration<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> * @param cipher the encryption algorithm<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * @param iv the initialization vector, can be null<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> */<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> public static void encryptWithSubjectKey(OutputStream out, InputStream in, String subject,<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> Configuration conf, Cipher cipher, byte[] iv) throws IOException {<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> Key key = getSecretKeyForSubject(subject, conf);<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> if (key == null) {<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> throw new IOException("No key found for subject '" + subject + "'");<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> }<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> Encryptor e = cipher.getEncryptor();<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> e.setKey(key);<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> e.setIv(iv); // can be null<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> encrypt(out, in, e);<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> }<a name="line.475"></a> |
| <span class="sourceLineNo">476</span><a name="line.476"></a> |
| <span class="sourceLineNo">477</span> /**<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> * Decrypts a block of ciphertext with the symmetric key resolved for the given subject<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> * @param out plaintext<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> * @param in ciphertext<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * @param outLen the expected plaintext length<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> * @param subject the subject's key alias<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> * @param conf configuration<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> * @param cipher the encryption algorithm<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> * @param iv the initialization vector, can be null<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> */<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> public static void decryptWithSubjectKey(OutputStream out, InputStream in, int outLen,<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> String subject, Configuration conf, Cipher cipher, byte[] iv) throws IOException {<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> Key key = getSecretKeyForSubject(subject, conf);<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> if (key == null) {<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> throw new IOException("No key found for subject '" + subject + "'");<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> }<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> Decryptor d = cipher.getDecryptor();<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> d.setKey(key);<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> d.setIv(iv); // can be null<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> try {<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> decrypt(out, in, outLen, d);<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> } catch (IOException e) {<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> // If the current cipher algorithm fails to unwrap, try the alternate cipher algorithm, if one<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> // is configured<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> String alternateAlgorithm = conf.get(HConstants.CRYPTO_ALTERNATE_KEY_ALGORITHM_CONF_KEY);<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> if (alternateAlgorithm != null) {<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> if (LOG.isDebugEnabled()) {<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> LOG.debug("Unable to decrypt data with current cipher algorithm '"<a name="line.504"></a> |
| <span class="sourceLineNo">505</span> + conf.get(HConstants.CRYPTO_KEY_ALGORITHM_CONF_KEY, HConstants.CIPHER_AES)<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> + "'. Trying with the alternate cipher algorithm '" + alternateAlgorithm<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> + "' configured.");<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> }<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> Cipher alterCipher = Encryption.getCipher(conf, alternateAlgorithm);<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> if (alterCipher == null) {<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> throw new RuntimeException("Cipher '" + alternateAlgorithm + "' not available");<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> }<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> d = alterCipher.getDecryptor();<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> d.setKey(key);<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> d.setIv(iv); // can be null<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> decrypt(out, in, outLen, d);<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> } else {<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> throw new IOException(e);<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> }<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> }<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> }<a name="line.521"></a> |
| <span class="sourceLineNo">522</span><a name="line.522"></a> |
| <span class="sourceLineNo">523</span> private static ClassLoader getClassLoaderForClass(Class<?> c) {<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> ClassLoader cl = Thread.currentThread().getContextClassLoader();<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> if (cl == null) {<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> cl = c.getClassLoader();<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> }<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> if (cl == null) {<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> cl = ClassLoader.getSystemClassLoader();<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> }<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> if (cl == null) {<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> throw new RuntimeException("A ClassLoader to load the Cipher could not be determined");<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> }<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> return cl;<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> }<a name="line.535"></a> |
| <span class="sourceLineNo">536</span><a name="line.536"></a> |
| <span class="sourceLineNo">537</span> public static CipherProvider getCipherProvider(Configuration conf) {<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> String providerClassName =<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> conf.get(HConstants.CRYPTO_CIPHERPROVIDER_CONF_KEY, DefaultCipherProvider.class.getName());<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> try {<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> CipherProvider provider = (CipherProvider) ReflectionUtils.newInstance(<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> getClassLoaderForClass(CipherProvider.class).loadClass(providerClassName), conf);<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> return provider;<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> } catch (Exception e) {<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> throw new RuntimeException(e);<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> }<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> }<a name="line.547"></a> |
| <span class="sourceLineNo">548</span><a name="line.548"></a> |
| <span class="sourceLineNo">549</span> static final Map<Pair<String, String>, KeyProvider> keyProviderCache = new ConcurrentHashMap<>();<a name="line.549"></a> |
| <span class="sourceLineNo">550</span><a name="line.550"></a> |
| <span class="sourceLineNo">551</span> public static KeyProvider getKeyProvider(Configuration conf) {<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> String providerClassName =<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> conf.get(HConstants.CRYPTO_KEYPROVIDER_CONF_KEY, KeyStoreKeyProvider.class.getName());<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> String providerParameters = conf.get(HConstants.CRYPTO_KEYPROVIDER_PARAMETERS_KEY, "");<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> try {<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> Pair<String, String> providerCacheKey = new Pair<>(providerClassName, providerParameters);<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> KeyProvider provider = keyProviderCache.get(providerCacheKey);<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> if (provider != null) {<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> return provider;<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> }<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> provider = (KeyProvider) ReflectionUtils<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> .newInstance(getClassLoaderForClass(KeyProvider.class).loadClass(providerClassName), conf);<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> provider.init(providerParameters);<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> if (LOG.isDebugEnabled()) {<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> LOG.debug("Installed " + providerClassName + " into key provider cache");<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> }<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> keyProviderCache.put(providerCacheKey, provider);<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> return provider;<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> } catch (Exception e) {<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> throw new RuntimeException(e);<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> }<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> }<a name="line.572"></a> |
| <span class="sourceLineNo">573</span><a name="line.573"></a> |
| <span class="sourceLineNo">574</span> public static void incrementIv(byte[] iv) {<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> incrementIv(iv, 1);<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> }<a name="line.576"></a> |
| <span class="sourceLineNo">577</span><a name="line.577"></a> |
| <span class="sourceLineNo">578</span> public static void incrementIv(byte[] iv, int v) {<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> // v should be > 0<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> int length = iv.length;<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> int sum = 0;<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> for (int i = 0; i < length; i++) {<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> if (v <= 0) {<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> break;<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> }<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> sum = v + (iv[i] & 0xFF);<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> v = sum / 256;<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> iv[i] = (byte) (sum % 256);<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> }<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> }<a name="line.590"></a> |
| <span class="sourceLineNo">591</span><a name="line.591"></a> |
| <span class="sourceLineNo">592</span> /**<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> * Return the hash of the concatenation of the supplied arguments, using the hash algorithm<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> * provided.<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> */<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> public static byte[] hashWithAlg(String algorithm, byte[]... args) {<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> try {<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> MessageDigest md = MessageDigest.getInstance(algorithm);<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> for (byte[] arg : args) {<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> md.update(arg);<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> }<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> return md.digest();<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> } catch (NoSuchAlgorithmException e) {<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> throw new RuntimeException("unable to use hash algorithm: " + algorithm, e);<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> }<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> }<a name="line.606"></a> |
| <span class="sourceLineNo">607</span><a name="line.607"></a> |
| <span class="sourceLineNo">608</span>}<a name="line.608"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
