blob: 5a6d18f64a6c74f1e621ae33615153dd02c4577e [file] [log] [blame]
<!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.security, class: NettyHBaseRpcConnectionHeaderHandler">
<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.security;</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 org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.io.crypto.aes.CryptoAES;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23"></span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hbase.thirdparty.io.netty.buffer.ByteBuf;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hbase.thirdparty.io.netty.channel.ChannelHandlerContext;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hbase.thirdparty.io.netty.channel.ChannelPipeline;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hbase.thirdparty.io.netty.channel.SimpleChannelInboundHandler;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.io.netty.util.concurrent.Promise;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos;</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32">/**</span>
<span class="source-line-no">033</span><span id="line-33"> * Implement logic to deal with the rpc connection header.</span>
<span class="source-line-no">034</span><span id="line-34"> * @since 2.0.0</span>
<span class="source-line-no">035</span><span id="line-35"> */</span>
<span class="source-line-no">036</span><span id="line-36">@InterfaceAudience.Private</span>
<span class="source-line-no">037</span><span id="line-37">public class NettyHBaseRpcConnectionHeaderHandler extends SimpleChannelInboundHandler&lt;ByteBuf&gt; {</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> private final Promise&lt;Boolean&gt; saslPromise;</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> private final Configuration conf;</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> private final ByteBuf connectionHeaderWithLength;</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> public NettyHBaseRpcConnectionHeaderHandler(Promise&lt;Boolean&gt; saslPromise, Configuration conf,</span>
<span class="source-line-no">046</span><span id="line-46"> ByteBuf connectionHeaderWithLength) {</span>
<span class="source-line-no">047</span><span id="line-47"> this.saslPromise = saslPromise;</span>
<span class="source-line-no">048</span><span id="line-48"> this.conf = conf;</span>
<span class="source-line-no">049</span><span id="line-49"> this.connectionHeaderWithLength = connectionHeaderWithLength;</span>
<span class="source-line-no">050</span><span id="line-50"> }</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> @Override</span>
<span class="source-line-no">053</span><span id="line-53"> protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {</span>
<span class="source-line-no">054</span><span id="line-54"> // read the ConnectionHeaderResponse from server</span>
<span class="source-line-no">055</span><span id="line-55"> int len = msg.readInt();</span>
<span class="source-line-no">056</span><span id="line-56"> byte[] buff = new byte[len];</span>
<span class="source-line-no">057</span><span id="line-57"> msg.readBytes(buff);</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> RPCProtos.ConnectionHeaderResponse connectionHeaderResponse =</span>
<span class="source-line-no">060</span><span id="line-60"> RPCProtos.ConnectionHeaderResponse.parseFrom(buff);</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> // Get the CryptoCipherMeta, update the HBaseSaslRpcClient for Crypto Cipher</span>
<span class="source-line-no">063</span><span id="line-63"> if (connectionHeaderResponse.hasCryptoCipherMeta()) {</span>
<span class="source-line-no">064</span><span id="line-64"> CryptoAES cryptoAES =</span>
<span class="source-line-no">065</span><span id="line-65"> EncryptionUtil.createCryptoAES(connectionHeaderResponse.getCryptoCipherMeta(), conf);</span>
<span class="source-line-no">066</span><span id="line-66"> // replace the Sasl handler with Crypto AES handler</span>
<span class="source-line-no">067</span><span id="line-67"> setupCryptoAESHandler(ctx.pipeline(), cryptoAES);</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"> saslPromise.setSuccess(true);</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"> @Override</span>
<span class="source-line-no">074</span><span id="line-74"> public void handlerAdded(ChannelHandlerContext ctx) {</span>
<span class="source-line-no">075</span><span id="line-75"> try {</span>
<span class="source-line-no">076</span><span id="line-76"> // send the connection header to server first</span>
<span class="source-line-no">077</span><span id="line-77"> ctx.writeAndFlush(connectionHeaderWithLength.retainedDuplicate());</span>
<span class="source-line-no">078</span><span id="line-78"> } catch (Exception e) {</span>
<span class="source-line-no">079</span><span id="line-79"> // the exception thrown by handlerAdded will not be passed to the exceptionCaught below</span>
<span class="source-line-no">080</span><span id="line-80"> // because netty will remove a handler if handlerAdded throws an exception.</span>
<span class="source-line-no">081</span><span id="line-81"> exceptionCaught(ctx, e);</span>
<span class="source-line-no">082</span><span id="line-82"> }</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> @Override</span>
<span class="source-line-no">086</span><span id="line-86"> public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {</span>
<span class="source-line-no">087</span><span id="line-87"> saslPromise.tryFailure(cause);</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> /**</span>
<span class="source-line-no">091</span><span id="line-91"> * Remove handlers for sasl encryption and add handlers for Crypto AES encryption</span>
<span class="source-line-no">092</span><span id="line-92"> */</span>
<span class="source-line-no">093</span><span id="line-93"> private void setupCryptoAESHandler(ChannelPipeline p, CryptoAES cryptoAES) {</span>
<span class="source-line-no">094</span><span id="line-94"> p.replace(SaslWrapHandler.class, null, new SaslWrapHandler(cryptoAES::wrap));</span>
<span class="source-line-no">095</span><span id="line-95"> p.replace(SaslUnwrapHandler.class, null, new SaslUnwrapHandler(cryptoAES::unwrap));</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97">}</span>
</pre>
</div>
</main>
</body>
</html>