blob: cfc77b458b8e2038cc8c2a723576e8f19ff4a280 [file] [log] [blame]
<!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.regionserver;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.junit.Assert.assertNotNull;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.junit.Assert.assertTrue;<a name="line.21"></a>
<span class="sourceLineNo">022</span><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.util.ArrayList;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.conf.Configuration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.fs.Path;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.HBaseTestingUtil;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HConstants;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.TableName;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.Put;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.Table;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.client.TableDescriptorBuilder;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.io.crypto.Encryption;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.io.crypto.KeyProviderForTesting;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.io.hfile.CacheConfig;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.io.hfile.HFile;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.testclassification.MediumTests;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.testclassification.RegionServerTests;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.junit.AfterClass;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.junit.BeforeClass;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.junit.ClassRule;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.junit.Test;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.junit.experimental.categories.Category;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>@Category({RegionServerTests.class, MediumTests.class})<a name="line.49"></a>
<span class="sourceLineNo">050</span>public class TestEncryptionRandomKeying {<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> @ClassRule<a name="line.52"></a>
<span class="sourceLineNo">053</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.53"></a>
<span class="sourceLineNo">054</span> HBaseClassTestRule.forClass(TestEncryptionRandomKeying.class);<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> private static final HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();<a name="line.56"></a>
<span class="sourceLineNo">057</span> private static Configuration conf = TEST_UTIL.getConfiguration();<a name="line.57"></a>
<span class="sourceLineNo">058</span> private static TableDescriptorBuilder tdb;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> private static List&lt;Path&gt; findStorefilePaths(TableName tableName) throws Exception {<a name="line.60"></a>
<span class="sourceLineNo">061</span> List&lt;Path&gt; paths = new ArrayList&lt;&gt;();<a name="line.61"></a>
<span class="sourceLineNo">062</span> for (Region region:<a name="line.62"></a>
<span class="sourceLineNo">063</span> TEST_UTIL.getRSForFirstRegionInTable(tableName).getRegions(tdb.build().getTableName())) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> for (HStore store : ((HRegion) region).getStores()) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> for (HStoreFile storefile : store.getStorefiles()) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> paths.add(storefile.getPath());<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span> return paths;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> private static byte[] extractHFileKey(Path path) throws Exception {<a name="line.73"></a>
<span class="sourceLineNo">074</span> HFile.Reader reader = HFile.createReader(TEST_UTIL.getTestFileSystem(), path,<a name="line.74"></a>
<span class="sourceLineNo">075</span> new CacheConfig(conf), true, conf);<a name="line.75"></a>
<span class="sourceLineNo">076</span> try {<a name="line.76"></a>
<span class="sourceLineNo">077</span> Encryption.Context cryptoContext = reader.getFileContext().getEncryptionContext();<a name="line.77"></a>
<span class="sourceLineNo">078</span> assertNotNull("Reader has a null crypto context", cryptoContext);<a name="line.78"></a>
<span class="sourceLineNo">079</span> Key key = cryptoContext.getKey();<a name="line.79"></a>
<span class="sourceLineNo">080</span> if (key == null) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> return null;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> return key.getEncoded();<a name="line.83"></a>
<span class="sourceLineNo">084</span> } finally {<a name="line.84"></a>
<span class="sourceLineNo">085</span> reader.close();<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> @BeforeClass<a name="line.89"></a>
<span class="sourceLineNo">090</span> public static void setUp() throws Exception {<a name="line.90"></a>
<span class="sourceLineNo">091</span> conf.setInt("hfile.format.version", 3);<a name="line.91"></a>
<span class="sourceLineNo">092</span> conf.set(HConstants.CRYPTO_KEYPROVIDER_CONF_KEY, KeyProviderForTesting.class.getName());<a name="line.92"></a>
<span class="sourceLineNo">093</span> conf.set(HConstants.CRYPTO_MASTERKEY_NAME_CONF_KEY, "hbase");<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> // Create the table schema<a name="line.95"></a>
<span class="sourceLineNo">096</span> // Specify an encryption algorithm without a key<a name="line.96"></a>
<span class="sourceLineNo">097</span> tdb = TableDescriptorBuilder.newBuilder(TableName.valueOf("default",<a name="line.97"></a>
<span class="sourceLineNo">098</span> "TestEncryptionRandomKeying"));<a name="line.98"></a>
<span class="sourceLineNo">099</span> ColumnFamilyDescriptorBuilder columnFamilyDescriptorBuilder =<a name="line.99"></a>
<span class="sourceLineNo">100</span> ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("cf"));<a name="line.100"></a>
<span class="sourceLineNo">101</span> String algorithm = conf.get(HConstants.CRYPTO_KEY_ALGORITHM_CONF_KEY, HConstants.CIPHER_AES);<a name="line.101"></a>
<span class="sourceLineNo">102</span> columnFamilyDescriptorBuilder.setEncryptionType(algorithm);<a name="line.102"></a>
<span class="sourceLineNo">103</span> tdb.setColumnFamily(columnFamilyDescriptorBuilder.build());<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> // Start the minicluster<a name="line.105"></a>
<span class="sourceLineNo">106</span> TEST_UTIL.startMiniCluster(1);<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> // Create the test table<a name="line.108"></a>
<span class="sourceLineNo">109</span> TEST_UTIL.getAdmin().createTable(tdb.build());<a name="line.109"></a>
<span class="sourceLineNo">110</span> TEST_UTIL.waitTableAvailable(tdb.build().getTableName(), 5000);<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> // Create a store file<a name="line.112"></a>
<span class="sourceLineNo">113</span> Table table = TEST_UTIL.getConnection().getTable(tdb.build().getTableName());<a name="line.113"></a>
<span class="sourceLineNo">114</span> try {<a name="line.114"></a>
<span class="sourceLineNo">115</span> table.put(new Put(Bytes.toBytes("testrow"))<a name="line.115"></a>
<span class="sourceLineNo">116</span> .addColumn(columnFamilyDescriptorBuilder.build().getName(),<a name="line.116"></a>
<span class="sourceLineNo">117</span> Bytes.toBytes("q"), Bytes.toBytes("value")));<a name="line.117"></a>
<span class="sourceLineNo">118</span> } finally {<a name="line.118"></a>
<span class="sourceLineNo">119</span> table.close();<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span> TEST_UTIL.getAdmin().flush(tdb.build().getTableName());<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> @AfterClass<a name="line.124"></a>
<span class="sourceLineNo">125</span> public static void tearDown() throws Exception {<a name="line.125"></a>
<span class="sourceLineNo">126</span> TEST_UTIL.shutdownMiniCluster();<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> @Test<a name="line.129"></a>
<span class="sourceLineNo">130</span> public void testRandomKeying() throws Exception {<a name="line.130"></a>
<span class="sourceLineNo">131</span> // Verify we have store file(s) with a random key<a name="line.131"></a>
<span class="sourceLineNo">132</span> final List&lt;Path&gt; initialPaths = findStorefilePaths(tdb.build().getTableName());<a name="line.132"></a>
<span class="sourceLineNo">133</span> assertTrue(initialPaths.size() &gt; 0);<a name="line.133"></a>
<span class="sourceLineNo">134</span> for (Path path: initialPaths) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> assertNotNull("Store file " + path + " is not encrypted", extractHFileKey(path));<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<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>}<a name="line.139"></a>
</pre>
</div>
</body>
</html>