| <!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.security;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.ByteArrayInputStream;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.ByteArrayOutputStream;<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.security.Key;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.security.KeyException;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.security.SecureRandom;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Properties;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import javax.crypto.spec.SecretKeySpec;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.commons.crypto.cipher.CryptoCipherFactory;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.conf.Configuration;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.HConstants;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.slf4j.Logger;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.slf4j.LoggerFactory;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.io.crypto.Cipher;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.io.crypto.Encryption;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.EncryptionProtos;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.io.crypto.aes.CryptoAES;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span>/**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Some static utility methods for encryption uses in hbase-client.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>@InterfaceAudience.Private<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>@InterfaceStability.Evolving<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public final class EncryptionUtil {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> static private final Logger LOG = LoggerFactory.getLogger(EncryptionUtil.class);<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> static private final SecureRandom RNG = new SecureRandom();<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Private constructor to keep this class from being instantiated.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private EncryptionUtil() {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> }<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Protect a key by encrypting it with the secret key of the given subject.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * The configuration must be set up correctly for key alias resolution.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @param conf configuration<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param key the raw key bytes<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param algorithm the algorithm to use with this key material<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @return the encrypted key bytes<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @throws IOException<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public static byte[] wrapKey(Configuration conf, byte[] key, String algorithm)<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> throws IOException {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> return wrapKey(conf,<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> conf.get(HConstants.CRYPTO_MASTERKEY_NAME_CONF_KEY, User.getCurrent().getShortName()),<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> new SecretKeySpec(key, algorithm));<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Protect a key by encrypting it with the secret key of the given subject.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * The configuration must be set up correctly for key alias resolution.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @param conf configuration<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param subject subject key alias<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @param key the key<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @return the encrypted key bytes<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> public static byte[] wrapKey(Configuration conf, String subject, Key key)<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> throws IOException {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> // Wrap the key with the configured encryption algorithm.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> String algorithm =<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> conf.get(HConstants.CRYPTO_KEY_ALGORITHM_CONF_KEY, HConstants.CIPHER_AES);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> Cipher cipher = Encryption.getCipher(conf, algorithm);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> if (cipher == null) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> throw new RuntimeException("Cipher '" + algorithm + "' not available");<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> EncryptionProtos.WrappedKey.Builder builder = EncryptionProtos.WrappedKey.newBuilder();<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> builder.setAlgorithm(key.getAlgorithm());<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> byte[] iv = null;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> if (cipher.getIvLength() > 0) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> iv = new byte[cipher.getIvLength()];<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> RNG.nextBytes(iv);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> builder.setIv(UnsafeByteOperations.unsafeWrap(iv));<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> byte[] keyBytes = key.getEncoded();<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> builder.setLength(keyBytes.length);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> builder.setHash(UnsafeByteOperations.unsafeWrap(Encryption.hash128(keyBytes)));<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> ByteArrayOutputStream out = new ByteArrayOutputStream();<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> Encryption.encryptWithSubjectKey(out, new ByteArrayInputStream(keyBytes), subject,<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> conf, cipher, iv);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> builder.setData(UnsafeByteOperations.unsafeWrap(out.toByteArray()));<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> // Build and return the protobuf message<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> out.reset();<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> builder.build().writeDelimitedTo(out);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> return out.toByteArray();<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> /**<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * Unwrap a key by decrypting it with the secret key of the given subject.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * The configuration must be set up correctly for key alias resolution.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param conf configuration<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @param subject subject key alias<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @param value the encrypted key bytes<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @return the raw key bytes<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * @throws IOException<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @throws KeyException<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> public static Key unwrapKey(Configuration conf, String subject, byte[] value)<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> throws IOException, KeyException {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> EncryptionProtos.WrappedKey wrappedKey = EncryptionProtos.WrappedKey.PARSER<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> .parseDelimitedFrom(new ByteArrayInputStream(value));<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> String algorithm = conf.get(HConstants.CRYPTO_KEY_ALGORITHM_CONF_KEY,<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> HConstants.CIPHER_AES);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> Cipher cipher = Encryption.getCipher(conf, algorithm);<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if (cipher == null) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> throw new RuntimeException("Cipher '" + algorithm + "' not available");<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return getUnwrapKey(conf, subject, wrappedKey, cipher);<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> private static Key getUnwrapKey(Configuration conf, String subject,<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> EncryptionProtos.WrappedKey wrappedKey, Cipher cipher) throws IOException, KeyException {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> ByteArrayOutputStream out = new ByteArrayOutputStream();<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> byte[] iv = wrappedKey.hasIv() ? wrappedKey.getIv().toByteArray() : null;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> Encryption.decryptWithSubjectKey(out, wrappedKey.getData().newInput(),<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> wrappedKey.getLength(), subject, conf, cipher, iv);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> byte[] keyBytes = out.toByteArray();<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> if (wrappedKey.hasHash()) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> if (!Bytes.equals(wrappedKey.getHash().toByteArray(), Encryption.hash128(keyBytes))) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> throw new KeyException("Key was not successfully unwrapped");<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> return new SecretKeySpec(keyBytes, wrappedKey.getAlgorithm());<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> /**<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * Unwrap a wal key by decrypting it with the secret key of the given subject. The configuration<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * must be set up correctly for key alias resolution.<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @param conf configuration<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @param subject subject key alias<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @param value the encrypted key bytes<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @return the raw key bytes<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @throws IOException if key is not found for the subject, or if some I/O error occurs<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @throws KeyException if fail to unwrap the key<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> public static Key unwrapWALKey(Configuration conf, String subject, byte[] value)<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> throws IOException, KeyException {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> EncryptionProtos.WrappedKey wrappedKey =<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> EncryptionProtos.WrappedKey.PARSER.parseDelimitedFrom(new ByteArrayInputStream(value));<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> String algorithm = conf.get(HConstants.CRYPTO_WAL_ALGORITHM_CONF_KEY, HConstants.CIPHER_AES);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> Cipher cipher = Encryption.getCipher(conf, algorithm);<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> if (cipher == null) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> throw new RuntimeException("Cipher '" + algorithm + "' not available");<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return getUnwrapKey(conf, subject, wrappedKey, cipher);<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> * Helper to create an encyption context.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> *<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * @param conf The current configuration.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @param family The current column descriptor.<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @return The created encryption context.<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @throws IOException if an encryption key for the column cannot be unwrapped<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> */<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> public static Encryption.Context createEncryptionContext(Configuration conf,<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> ColumnFamilyDescriptor family) throws IOException {<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> Encryption.Context cryptoContext = Encryption.Context.NONE;<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> String cipherName = family.getEncryptionType();<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> if (cipherName != null) {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> Cipher cipher;<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> Key key;<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> byte[] keyBytes = family.getEncryptionKey();<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> if (keyBytes != null) {<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> // Family provides specific key material<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> key = unwrapKey(conf, keyBytes);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> // Use the algorithm the key wants<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> cipher = Encryption.getCipher(conf, key.getAlgorithm());<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> if (cipher == null) {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> throw new RuntimeException("Cipher '" + key.getAlgorithm() + "' is not available");<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> }<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> // Fail if misconfigured<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> // We use the encryption type specified in the column schema as a sanity check on<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> // what the wrapped key is telling us<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> if (!cipher.getName().equalsIgnoreCase(cipherName)) {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> throw new RuntimeException("Encryption for family '" + family.getNameAsString()<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> + "' configured with type '" + cipherName + "' but key specifies algorithm '"<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> + cipher.getName() + "'");<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> }<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> } else {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> // Family does not provide key material, create a random key<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> cipher = Encryption.getCipher(conf, cipherName);<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> if (cipher == null) {<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> throw new RuntimeException("Cipher '" + cipherName + "' is not available");<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> }<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> key = cipher.getRandomKey();<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> cryptoContext = Encryption.newContext(conf);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> cryptoContext.setCipher(cipher);<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> cryptoContext.setKey(key);<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> return cryptoContext;<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> * Helper for {@link #unwrapKey(Configuration, String, byte[])} which automatically uses the<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * configured master and alternative keys, rather than having to specify a key type to unwrap<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * with.<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> *<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * The configuration must be set up correctly for key alias resolution.<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> *<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * @param conf the current configuration<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * @param keyBytes the key encrypted by master (or alternative) to unwrap<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * @return the key bytes, decrypted<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * @throws IOException if the key cannot be unwrapped<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> */<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> public static Key unwrapKey(Configuration conf, byte[] keyBytes) throws IOException {<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> Key key;<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> String masterKeyName = conf.get(HConstants.CRYPTO_MASTERKEY_NAME_CONF_KEY,<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> User.getCurrent().getShortName());<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> try {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> // First try the master key<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> key = unwrapKey(conf, masterKeyName, keyBytes);<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> } catch (KeyException e) {<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> // If the current master key fails to unwrap, try the alternate, if<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> // one is configured<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> if (LOG.isDebugEnabled()) {<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> LOG.debug("Unable to unwrap key with current master key '" + masterKeyName + "'");<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> }<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> String alternateKeyName =<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> conf.get(HConstants.CRYPTO_MASTERKEY_ALTERNATE_NAME_CONF_KEY);<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> if (alternateKeyName != null) {<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> try {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> key = unwrapKey(conf, alternateKeyName, keyBytes);<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> } catch (KeyException ex) {<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> throw new IOException(ex);<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> }<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> } else {<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> throw new IOException(e);<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> }<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> }<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> return key;<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> /**<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * Helper to create an instance of CryptoAES.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> *<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * @param conf The current configuration.<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * @param cryptoCipherMeta The metadata for create CryptoAES.<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * @return The instance of CryptoAES.<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * @throws IOException if create CryptoAES failed<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> */<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> public static CryptoAES createCryptoAES(RPCProtos.CryptoCipherMeta cryptoCipherMeta,<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> Configuration conf) throws IOException {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> Properties properties = new Properties();<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> // the property for cipher class<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> properties.setProperty(CryptoCipherFactory.CLASSES_KEY,<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> conf.get("hbase.rpc.crypto.encryption.aes.cipher.class",<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> "org.apache.commons.crypto.cipher.JceCipher"));<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> // create SaslAES for client<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> return new CryptoAES(cryptoCipherMeta.getTransformation(), properties,<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> cryptoCipherMeta.getInKey().toByteArray(),<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> cryptoCipherMeta.getOutKey().toByteArray(),<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> cryptoCipherMeta.getInIv().toByteArray(),<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> cryptoCipherMeta.getOutIv().toByteArray());<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> }<a name="line.284"></a> |
| <span class="sourceLineNo">285</span>}<a name="line.285"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
