Google Git
Sign in
apache / hbase-site / 2fb4a609121b6c045f6e3b7e801b5602fc328b1f / . / testdevapidocs / src-html / org / apache / hadoop / hbase / io / crypto / TestEncryption.html
blob: de0b8a6d1ae6f89715db9b9e283f82ab2375455f [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.io.crypto;<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.assertEquals;<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.io.ByteArrayInputStream;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.ByteArrayOutputStream;<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 javax.crypto.spec.SecretKeySpec;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.conf.Configuration;<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.HBaseConfiguration;<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.testclassification.MiscTests;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.testclassification.SmallTests;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.junit.ClassRule;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.junit.Test;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.junit.experimental.categories.Category;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.slf4j.Logger;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.slf4j.LoggerFactory;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>@Category({ MiscTests.class, SmallTests.class })<a name="line.40"></a>
<span class="sourceLineNo">041</span>public class TestEncryption {<a name="line.41"></a>
<span class="sourceLineNo">042</span> @ClassRule<a name="line.42"></a>
<span class="sourceLineNo">043</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.43"></a>
<span class="sourceLineNo">044</span> HBaseClassTestRule.forClass(TestEncryption.class);<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private static final Logger LOG = LoggerFactory.getLogger(TestEncryption.class);<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> @Test<a name="line.48"></a>
<span class="sourceLineNo">049</span> public void testSmallBlocks() throws Exception {<a name="line.49"></a>
<span class="sourceLineNo">050</span> byte[] key = new byte[16];<a name="line.50"></a>
<span class="sourceLineNo">051</span> Bytes.secureRandom(key);<a name="line.51"></a>
<span class="sourceLineNo">052</span> byte[] iv = new byte[16];<a name="line.52"></a>
<span class="sourceLineNo">053</span> Bytes.secureRandom(iv);<a name="line.53"></a>
<span class="sourceLineNo">054</span> for (int size : new int[] { 4, 8, 16, 32, 64, 128, 256, 512 }) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> checkTransformSymmetry(key, iv, getRandomBlock(size));<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> @Test<a name="line.59"></a>
<span class="sourceLineNo">060</span> public void testLargeBlocks() throws Exception {<a name="line.60"></a>
<span class="sourceLineNo">061</span> byte[] key = new byte[16];<a name="line.61"></a>
<span class="sourceLineNo">062</span> Bytes.secureRandom(key);<a name="line.62"></a>
<span class="sourceLineNo">063</span> byte[] iv = new byte[16];<a name="line.63"></a>
<span class="sourceLineNo">064</span> Bytes.secureRandom(iv);<a name="line.64"></a>
<span class="sourceLineNo">065</span> for (int size : new int[] { 256 * 1024, 512 * 1024, 1024 * 1024 }) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> checkTransformSymmetry(key, iv, getRandomBlock(size));<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> @Test<a name="line.70"></a>
<span class="sourceLineNo">071</span> public void testOddSizedBlocks() throws Exception {<a name="line.71"></a>
<span class="sourceLineNo">072</span> byte[] key = new byte[16];<a name="line.72"></a>
<span class="sourceLineNo">073</span> Bytes.secureRandom(key);<a name="line.73"></a>
<span class="sourceLineNo">074</span> byte[] iv = new byte[16];<a name="line.74"></a>
<span class="sourceLineNo">075</span> Bytes.secureRandom(iv);<a name="line.75"></a>
<span class="sourceLineNo">076</span> for (int size : new int[] { 3, 7, 11, 23, 47, 79, 119, 175 }) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> checkTransformSymmetry(key, iv, getRandomBlock(size));<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><a name="line.80"></a>
<span class="sourceLineNo">081</span> @Test<a name="line.81"></a>
<span class="sourceLineNo">082</span> public void testTypicalHFileBlocks() throws Exception {<a name="line.82"></a>
<span class="sourceLineNo">083</span> byte[] key = new byte[16];<a name="line.83"></a>
<span class="sourceLineNo">084</span> Bytes.secureRandom(key);<a name="line.84"></a>
<span class="sourceLineNo">085</span> byte[] iv = new byte[16];<a name="line.85"></a>
<span class="sourceLineNo">086</span> Bytes.secureRandom(iv);<a name="line.86"></a>
<span class="sourceLineNo">087</span> for (int size : new int[] { 4 * 1024, 8 * 1024, 64 * 1024, 128 * 1024 }) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> checkTransformSymmetry(key, iv, getRandomBlock(size));<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> @Test<a name="line.92"></a>
<span class="sourceLineNo">093</span> public void testIncrementIV() {<a name="line.93"></a>
<span class="sourceLineNo">094</span> byte[] iv = new byte[] { 1, 2, 3 };<a name="line.94"></a>
<span class="sourceLineNo">095</span> byte[] iv_neg = new byte[] { -3, -13, 25 };<a name="line.95"></a>
<span class="sourceLineNo">096</span> Encryption.incrementIv(iv);<a name="line.96"></a>
<span class="sourceLineNo">097</span> assertTrue(Bytes.equals(iv, new byte[] { 2, 2, 3 }));<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> Encryption.incrementIv(iv, 255);<a name="line.99"></a>
<span class="sourceLineNo">100</span> assertTrue(Bytes.equals(iv, new byte[] { 1, 3, 3 }));<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> Encryption.incrementIv(iv, 1024);<a name="line.102"></a>
<span class="sourceLineNo">103</span> assertTrue(Bytes.equals(iv, new byte[] { 1, 7, 3 }));<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> Encryption.incrementIv(iv_neg);<a name="line.105"></a>
<span class="sourceLineNo">106</span> assertTrue(Bytes.equals(iv_neg, new byte[] { -2, -13, 25 }));<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> Encryption.incrementIv(iv_neg, 5);<a name="line.108"></a>
<span class="sourceLineNo">109</span> assertTrue(Bytes.equals(iv_neg, new byte[] { 3, -12, 25 }));<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> private void checkTransformSymmetry(byte[] keyBytes, byte[] iv, byte[] plaintext)<a name="line.112"></a>
<span class="sourceLineNo">113</span> throws Exception {<a name="line.113"></a>
<span class="sourceLineNo">114</span> LOG.info("checkTransformSymmetry: AES, plaintext length = " + plaintext.length);<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> Configuration conf = HBaseConfiguration.create();<a name="line.116"></a>
<span class="sourceLineNo">117</span> String algorithm = conf.get(HConstants.CRYPTO_KEY_ALGORITHM_CONF_KEY, HConstants.CIPHER_AES);<a name="line.117"></a>
<span class="sourceLineNo">118</span> Cipher aes = Encryption.getCipher(conf, algorithm);<a name="line.118"></a>
<span class="sourceLineNo">119</span> Key key = new SecretKeySpec(keyBytes, algorithm);<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> Encryptor e = aes.getEncryptor();<a name="line.121"></a>
<span class="sourceLineNo">122</span> e.setKey(key);<a name="line.122"></a>
<span class="sourceLineNo">123</span> e.setIv(iv);<a name="line.123"></a>
<span class="sourceLineNo">124</span> e.reset();<a name="line.124"></a>
<span class="sourceLineNo">125</span> ByteArrayOutputStream encOut = new ByteArrayOutputStream();<a name="line.125"></a>
<span class="sourceLineNo">126</span> Encryption.encrypt(encOut, plaintext, 0, plaintext.length, e);<a name="line.126"></a>
<span class="sourceLineNo">127</span> byte[] encrypted = encOut.toByteArray();<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> Decryptor d = aes.getDecryptor();<a name="line.129"></a>
<span class="sourceLineNo">130</span> d.setKey(key);<a name="line.130"></a>
<span class="sourceLineNo">131</span> d.setIv(iv);<a name="line.131"></a>
<span class="sourceLineNo">132</span> d.reset();<a name="line.132"></a>
<span class="sourceLineNo">133</span> ByteArrayInputStream encIn = new ByteArrayInputStream(encrypted);<a name="line.133"></a>
<span class="sourceLineNo">134</span> ByteArrayOutputStream decOut = new ByteArrayOutputStream();<a name="line.134"></a>
<span class="sourceLineNo">135</span> Encryption.decrypt(decOut, encIn, plaintext.length, d);<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> byte[] result = decOut.toByteArray();<a name="line.137"></a>
<span class="sourceLineNo">138</span> assertEquals("Decrypted result has different length than plaintext", result.length,<a name="line.138"></a>
<span class="sourceLineNo">139</span> plaintext.length);<a name="line.139"></a>
<span class="sourceLineNo">140</span> assertTrue("Transformation was not symmetric", Bytes.equals(result, plaintext));<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> private byte[] getRandomBlock(int size) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> byte[] b = new byte[size];<a name="line.144"></a>
<span class="sourceLineNo">145</span> Bytes.random(b);<a name="line.145"></a>
<span class="sourceLineNo">146</span> return b;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span>}<a name="line.148"></a>
</pre>
</div>
</body>
</html>