Google Git
Sign in
apache / hbase-site / 2e3aaee18b357604e6f6797bafb8e59d3025ccb0 / . / devapidocs / src-html / org / apache / hadoop / hbase / regionserver / wal / SecureProtobufLogReader.html
blob: 1caf2a558901abe68e3a8cb67192525c0e896893 [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><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.regionserver.wal;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.security.Key;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.security.KeyException;<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><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.slf4j.Logger;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.slf4j.LoggerFactory;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.fs.FSDataInputStream;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<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.hadoop.hbase.io.crypto.Cipher;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.io.crypto.Decryptor;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.io.crypto.Encryption;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.security.EncryptionUtil;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.security.User;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.util.EncryptionTest;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)<a name="line.41"></a>
<span class="sourceLineNo">042</span>public class SecureProtobufLogReader extends ProtobufLogReader {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> private static final Logger LOG = LoggerFactory.getLogger(SecureProtobufLogReader.class);<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private Decryptor decryptor = null;<a name="line.46"></a>
<span class="sourceLineNo">047</span> private static List&lt;String&gt; writerClsNames = new ArrayList&lt;&gt;();<a name="line.47"></a>
<span class="sourceLineNo">048</span> static {<a name="line.48"></a>
<span class="sourceLineNo">049</span> writerClsNames.add(ProtobufLogWriter.class.getSimpleName());<a name="line.49"></a>
<span class="sourceLineNo">050</span> writerClsNames.add(SecureProtobufLogWriter.class.getSimpleName());<a name="line.50"></a>
<span class="sourceLineNo">051</span> writerClsNames.add(AsyncProtobufLogWriter.class.getSimpleName());<a name="line.51"></a>
<span class="sourceLineNo">052</span> writerClsNames.add(SecureAsyncProtobufLogWriter.class.getSimpleName());<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> @Override<a name="line.55"></a>
<span class="sourceLineNo">056</span> public List&lt;String&gt; getWriterClsNames() {<a name="line.56"></a>
<span class="sourceLineNo">057</span> return writerClsNames;<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> @Override<a name="line.60"></a>
<span class="sourceLineNo">061</span> protected WALHdrContext readHeader(WALHeader.Builder builder, FSDataInputStream stream)<a name="line.61"></a>
<span class="sourceLineNo">062</span> throws IOException {<a name="line.62"></a>
<span class="sourceLineNo">063</span> WALHdrContext hdrCtxt = super.readHeader(builder, stream);<a name="line.63"></a>
<span class="sourceLineNo">064</span> WALHdrResult result = hdrCtxt.getResult();<a name="line.64"></a>
<span class="sourceLineNo">065</span> // We need to unconditionally handle the case where the WAL has a key in<a name="line.65"></a>
<span class="sourceLineNo">066</span> // the header, meaning it is encrypted, even if ENABLE_WAL_ENCRYPTION is<a name="line.66"></a>
<span class="sourceLineNo">067</span> // no longer set in the site configuration.<a name="line.67"></a>
<span class="sourceLineNo">068</span> if (result == WALHdrResult.SUCCESS &amp;&amp; builder.hasEncryptionKey()) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> // Serialized header data has been merged into the builder from the<a name="line.69"></a>
<span class="sourceLineNo">070</span> // stream.<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> EncryptionTest.testKeyProvider(conf);<a name="line.72"></a>
<span class="sourceLineNo">073</span> EncryptionTest.testCipherProvider(conf);<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> // Retrieve a usable key<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> byte[] keyBytes = builder.getEncryptionKey().toByteArray();<a name="line.77"></a>
<span class="sourceLineNo">078</span> Key key = null;<a name="line.78"></a>
<span class="sourceLineNo">079</span> String walKeyName = conf.get(HConstants.CRYPTO_WAL_KEY_NAME_CONF_KEY);<a name="line.79"></a>
<span class="sourceLineNo">080</span> // First try the WAL key, if one is configured<a name="line.80"></a>
<span class="sourceLineNo">081</span> if (walKeyName != null) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> try {<a name="line.82"></a>
<span class="sourceLineNo">083</span> key = EncryptionUtil.unwrapWALKey(conf, walKeyName, keyBytes);<a name="line.83"></a>
<span class="sourceLineNo">084</span> } catch (KeyException e) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> if (LOG.isDebugEnabled()) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> LOG.debug("Unable to unwrap key with WAL key '" + walKeyName + "'");<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span> key = null;<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> if (key == null) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> String masterKeyName = conf.get(HConstants.CRYPTO_MASTERKEY_NAME_CONF_KEY,<a name="line.92"></a>
<span class="sourceLineNo">093</span> User.getCurrent().getShortName());<a name="line.93"></a>
<span class="sourceLineNo">094</span> try {<a name="line.94"></a>
<span class="sourceLineNo">095</span> // Then, try the cluster master key<a name="line.95"></a>
<span class="sourceLineNo">096</span> key = EncryptionUtil.unwrapWALKey(conf, masterKeyName, keyBytes);<a name="line.96"></a>
<span class="sourceLineNo">097</span> } catch (KeyException e) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> // If the current master key fails to unwrap, try the alternate, if<a name="line.98"></a>
<span class="sourceLineNo">099</span> // one is configured<a name="line.99"></a>
<span class="sourceLineNo">100</span> if (LOG.isDebugEnabled()) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> LOG.debug("Unable to unwrap key with current master key '" + masterKeyName + "'");<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> String alternateKeyName =<a name="line.103"></a>
<span class="sourceLineNo">104</span> conf.get(HConstants.CRYPTO_MASTERKEY_ALTERNATE_NAME_CONF_KEY);<a name="line.104"></a>
<span class="sourceLineNo">105</span> if (alternateKeyName != null) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> try {<a name="line.106"></a>
<span class="sourceLineNo">107</span> key = EncryptionUtil.unwrapWALKey(conf, alternateKeyName, keyBytes);<a name="line.107"></a>
<span class="sourceLineNo">108</span> } catch (KeyException ex) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> throw new IOException(ex);<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> } else {<a name="line.111"></a>
<span class="sourceLineNo">112</span> throw new IOException(e);<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<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> // Use the algorithm the key wants<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> Cipher cipher = Encryption.getCipher(conf, key.getAlgorithm());<a name="line.119"></a>
<span class="sourceLineNo">120</span> if (cipher == null) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> throw new IOException("Cipher '" + key.getAlgorithm() + "' is not available");<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> // Set up the decryptor for this WAL<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> decryptor = cipher.getDecryptor();<a name="line.126"></a>
<span class="sourceLineNo">127</span> decryptor.setKey(key);<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> if (LOG.isTraceEnabled()) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> LOG.trace("Initialized secure protobuf WAL: cipher=" + cipher.getName());<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> return hdrCtxt;<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> @Override<a name="line.137"></a>
<span class="sourceLineNo">138</span> protected void initAfterCompression(String cellCodecClsName) throws IOException {<a name="line.138"></a>
<span class="sourceLineNo">139</span> if (decryptor != null &amp;&amp; cellCodecClsName.equals(SecureWALCellCodec.class.getName())) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> WALCellCodec codec = SecureWALCellCodec.getCodec(this.conf, decryptor);<a name="line.140"></a>
<span class="sourceLineNo">141</span> this.cellDecoder = codec.getDecoder(this.inputStream);<a name="line.141"></a>
<span class="sourceLineNo">142</span> // We do not support compression with WAL encryption<a name="line.142"></a>
<span class="sourceLineNo">143</span> this.compressionContext = null;<a name="line.143"></a>
<span class="sourceLineNo">144</span> this.byteStringUncompressor = WALCellCodec.getNoneUncompressor();<a name="line.144"></a>
<span class="sourceLineNo">145</span> this.hasCompression = false;<a name="line.145"></a>
<span class="sourceLineNo">146</span> } else {<a name="line.146"></a>
<span class="sourceLineNo">147</span> super.initAfterCompression(cellCodecClsName);<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<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>
</pre>
</div>
</body>
</html>