| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver, class: TestEncryptionRandomKeying"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import static org.junit.Assert.assertNotNull;</span> |
| <span class="source-line-no">021</span><span id="line-21">import static org.junit.Assert.assertTrue;</span> |
| <span class="source-line-no">022</span><span id="line-22"></span> |
| <span class="source-line-no">023</span><span id="line-23">import java.security.Key;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.ArrayList;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.List;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.HBaseClassTestRule;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.HBaseTestingUtil;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.client.Put;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.client.Table;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.client.TableDescriptorBuilder;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.io.crypto.Encryption;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.io.crypto.KeyProviderForTesting;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.io.hfile.CacheConfig;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.io.hfile.HFile;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.testclassification.MediumTests;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.testclassification.RegionServerTests;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.junit.AfterClass;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.junit.BeforeClass;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.junit.ClassRule;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.junit.Test;</span> |
| <span class="source-line-no">047</span><span id="line-47">import org.junit.experimental.categories.Category;</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49">@Category({ RegionServerTests.class, MediumTests.class })</span> |
| <span class="source-line-no">050</span><span id="line-50">public class TestEncryptionRandomKeying {</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> @ClassRule</span> |
| <span class="source-line-no">053</span><span id="line-53"> public static final HBaseClassTestRule CLASS_RULE =</span> |
| <span class="source-line-no">054</span><span id="line-54"> HBaseClassTestRule.forClass(TestEncryptionRandomKeying.class);</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> private static final HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();</span> |
| <span class="source-line-no">057</span><span id="line-57"> private static Configuration conf = TEST_UTIL.getConfiguration();</span> |
| <span class="source-line-no">058</span><span id="line-58"> private static TableDescriptorBuilder tdb;</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> private static List<Path> findStorefilePaths(TableName tableName) throws Exception {</span> |
| <span class="source-line-no">061</span><span id="line-61"> List<Path> paths = new ArrayList<>();</span> |
| <span class="source-line-no">062</span><span id="line-62"> for (Region region : TEST_UTIL.getRSForFirstRegionInTable(tableName)</span> |
| <span class="source-line-no">063</span><span id="line-63"> .getRegions(tdb.build().getTableName())) {</span> |
| <span class="source-line-no">064</span><span id="line-64"> for (HStore store : ((HRegion) region).getStores()) {</span> |
| <span class="source-line-no">065</span><span id="line-65"> for (HStoreFile storefile : store.getStorefiles()) {</span> |
| <span class="source-line-no">066</span><span id="line-66"> paths.add(storefile.getPath());</span> |
| <span class="source-line-no">067</span><span id="line-67"> }</span> |
| <span class="source-line-no">068</span><span id="line-68"> }</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"> return paths;</span> |
| <span class="source-line-no">071</span><span id="line-71"> }</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> private static byte[] extractHFileKey(Path path) throws Exception {</span> |
| <span class="source-line-no">074</span><span id="line-74"> HFile.Reader reader =</span> |
| <span class="source-line-no">075</span><span id="line-75"> HFile.createReader(TEST_UTIL.getTestFileSystem(), path, new CacheConfig(conf), true, conf);</span> |
| <span class="source-line-no">076</span><span id="line-76"> try {</span> |
| <span class="source-line-no">077</span><span id="line-77"> Encryption.Context cryptoContext = reader.getFileContext().getEncryptionContext();</span> |
| <span class="source-line-no">078</span><span id="line-78"> assertNotNull("Reader has a null crypto context", cryptoContext);</span> |
| <span class="source-line-no">079</span><span id="line-79"> Key key = cryptoContext.getKey();</span> |
| <span class="source-line-no">080</span><span id="line-80"> if (key == null) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> return null;</span> |
| <span class="source-line-no">082</span><span id="line-82"> }</span> |
| <span class="source-line-no">083</span><span id="line-83"> return key.getEncoded();</span> |
| <span class="source-line-no">084</span><span id="line-84"> } finally {</span> |
| <span class="source-line-no">085</span><span id="line-85"> reader.close();</span> |
| <span class="source-line-no">086</span><span id="line-86"> }</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> @BeforeClass</span> |
| <span class="source-line-no">090</span><span id="line-90"> public static void setUp() throws Exception {</span> |
| <span class="source-line-no">091</span><span id="line-91"> conf.setInt("hfile.format.version", 3);</span> |
| <span class="source-line-no">092</span><span id="line-92"> conf.set(HConstants.CRYPTO_KEYPROVIDER_CONF_KEY, KeyProviderForTesting.class.getName());</span> |
| <span class="source-line-no">093</span><span id="line-93"> conf.set(HConstants.CRYPTO_MASTERKEY_NAME_CONF_KEY, "hbase");</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> // Create the table schema</span> |
| <span class="source-line-no">096</span><span id="line-96"> // Specify an encryption algorithm without a key</span> |
| <span class="source-line-no">097</span><span id="line-97"> tdb =</span> |
| <span class="source-line-no">098</span><span id="line-98"> TableDescriptorBuilder.newBuilder(TableName.valueOf("default", "TestEncryptionRandomKeying"));</span> |
| <span class="source-line-no">099</span><span id="line-99"> ColumnFamilyDescriptorBuilder columnFamilyDescriptorBuilder =</span> |
| <span class="source-line-no">100</span><span id="line-100"> ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("cf"));</span> |
| <span class="source-line-no">101</span><span id="line-101"> String algorithm = conf.get(HConstants.CRYPTO_KEY_ALGORITHM_CONF_KEY, HConstants.CIPHER_AES);</span> |
| <span class="source-line-no">102</span><span id="line-102"> columnFamilyDescriptorBuilder.setEncryptionType(algorithm);</span> |
| <span class="source-line-no">103</span><span id="line-103"> tdb.setColumnFamily(columnFamilyDescriptorBuilder.build());</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105"> // Start the minicluster</span> |
| <span class="source-line-no">106</span><span id="line-106"> TEST_UTIL.startMiniCluster(1);</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> // Create the test table</span> |
| <span class="source-line-no">109</span><span id="line-109"> TEST_UTIL.getAdmin().createTable(tdb.build());</span> |
| <span class="source-line-no">110</span><span id="line-110"> TEST_UTIL.waitTableAvailable(tdb.build().getTableName(), 5000);</span> |
| <span class="source-line-no">111</span><span id="line-111"></span> |
| <span class="source-line-no">112</span><span id="line-112"> // Create a store file</span> |
| <span class="source-line-no">113</span><span id="line-113"> Table table = TEST_UTIL.getConnection().getTable(tdb.build().getTableName());</span> |
| <span class="source-line-no">114</span><span id="line-114"> try {</span> |
| <span class="source-line-no">115</span><span id="line-115"> table.put(</span> |
| <span class="source-line-no">116</span><span id="line-116"> new Put(Bytes.toBytes("testrow")).addColumn(columnFamilyDescriptorBuilder.build().getName(),</span> |
| <span class="source-line-no">117</span><span id="line-117"> Bytes.toBytes("q"), Bytes.toBytes("value")));</span> |
| <span class="source-line-no">118</span><span id="line-118"> } finally {</span> |
| <span class="source-line-no">119</span><span id="line-119"> table.close();</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"> TEST_UTIL.getAdmin().flush(tdb.build().getTableName());</span> |
| <span class="source-line-no">122</span><span id="line-122"> }</span> |
| <span class="source-line-no">123</span><span id="line-123"></span> |
| <span class="source-line-no">124</span><span id="line-124"> @AfterClass</span> |
| <span class="source-line-no">125</span><span id="line-125"> public static void tearDown() throws Exception {</span> |
| <span class="source-line-no">126</span><span id="line-126"> TEST_UTIL.shutdownMiniCluster();</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> @Test</span> |
| <span class="source-line-no">130</span><span id="line-130"> public void testRandomKeying() throws Exception {</span> |
| <span class="source-line-no">131</span><span id="line-131"> // Verify we have store file(s) with a random key</span> |
| <span class="source-line-no">132</span><span id="line-132"> final List<Path> initialPaths = findStorefilePaths(tdb.build().getTableName());</span> |
| <span class="source-line-no">133</span><span id="line-133"> assertTrue(initialPaths.size() > 0);</span> |
| <span class="source-line-no">134</span><span id="line-134"> for (Path path : initialPaths) {</span> |
| <span class="source-line-no">135</span><span id="line-135"> assertNotNull("Store file " + path + " is not encrypted", extractHFileKey(path));</span> |
| <span class="source-line-no">136</span><span id="line-136"> }</span> |
| <span class="source-line-no">137</span><span id="line-137"> }</span> |
| <span class="source-line-no">138</span><span id="line-138"></span> |
| <span class="source-line-no">139</span><span id="line-139">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
