Google Git
Sign in
apache / hbase-site / 8ac68d4b7a8449d1b079203ac526389e2358d31e / . / devapidocs / src-html / org / apache / hadoop / hbase / security / NettyHBaseSaslRpcClientHandler.html
blob: 9acde9be71470ca93fe6ed777b963141795d54b3 [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.security;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.exceptions.ConnectionClosedException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hbase.thirdparty.io.netty.buffer.ByteBuf;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hbase.thirdparty.io.netty.channel.ChannelHandlerContext;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hbase.thirdparty.io.netty.channel.SimpleChannelInboundHandler;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hbase.thirdparty.io.netty.util.concurrent.Promise;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.io.IOException;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.security.PrivilegedExceptionAction;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.conf.Configuration;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.slf4j.Logger;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.slf4j.LoggerFactory;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.ipc.FallbackDisallowedException;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.security.token.Token;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.security.token.TokenIdentifier;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Implement SASL logic for netty rpc client.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @since 2.0.0<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>@InterfaceAudience.Private<a name="line.42"></a>
<span class="sourceLineNo">043</span>public class NettyHBaseSaslRpcClientHandler extends SimpleChannelInboundHandler&lt;ByteBuf&gt; {<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> private static final Logger LOG = LoggerFactory.getLogger(NettyHBaseSaslRpcClientHandler.class);<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> private final Promise&lt;Boolean&gt; saslPromise;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> private final UserGroupInformation ugi;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> private final NettyHBaseSaslRpcClient saslRpcClient;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private final Configuration conf;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> // flag to mark if Crypto AES encryption is enable<a name="line.55"></a>
<span class="sourceLineNo">056</span> private boolean needProcessConnectionHeader = false;<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> * @param saslPromise {@code true} if success, {@code false} if server tells us to fallback to<a name="line.59"></a>
<span class="sourceLineNo">060</span> * simple.<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> public NettyHBaseSaslRpcClientHandler(Promise&lt;Boolean&gt; saslPromise, UserGroupInformation ugi,<a name="line.62"></a>
<span class="sourceLineNo">063</span> AuthMethod method, Token&lt;? extends TokenIdentifier&gt; token, String serverPrincipal,<a name="line.63"></a>
<span class="sourceLineNo">064</span> boolean fallbackAllowed, Configuration conf)<a name="line.64"></a>
<span class="sourceLineNo">065</span> throws IOException {<a name="line.65"></a>
<span class="sourceLineNo">066</span> this.saslPromise = saslPromise;<a name="line.66"></a>
<span class="sourceLineNo">067</span> this.ugi = ugi;<a name="line.67"></a>
<span class="sourceLineNo">068</span> this.conf = conf;<a name="line.68"></a>
<span class="sourceLineNo">069</span> this.saslRpcClient = new NettyHBaseSaslRpcClient(method, token, serverPrincipal,<a name="line.69"></a>
<span class="sourceLineNo">070</span> fallbackAllowed, conf.get(<a name="line.70"></a>
<span class="sourceLineNo">071</span> "hbase.rpc.protection", SaslUtil.QualityOfProtection.AUTHENTICATION.name().toLowerCase()));<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> private void writeResponse(ChannelHandlerContext ctx, byte[] response) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> LOG.trace("Sending token size={} from initSASLContext.", response.length);<a name="line.75"></a>
<span class="sourceLineNo">076</span> ctx.writeAndFlush(<a name="line.76"></a>
<span class="sourceLineNo">077</span> ctx.alloc().buffer(4 + response.length).writeInt(response.length).writeBytes(response));<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> private void tryComplete(ChannelHandlerContext ctx) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> if (!saslRpcClient.isComplete()) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return;<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> saslRpcClient.setupSaslHandler(ctx.pipeline());<a name="line.85"></a>
<span class="sourceLineNo">086</span> setCryptoAESOption();<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> saslPromise.setSuccess(true);<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> private void setCryptoAESOption() {<a name="line.91"></a>
<span class="sourceLineNo">092</span> boolean saslEncryptionEnabled = SaslUtil.QualityOfProtection.PRIVACY.<a name="line.92"></a>
<span class="sourceLineNo">093</span> getSaslQop().equalsIgnoreCase(saslRpcClient.getSaslQOP());<a name="line.93"></a>
<span class="sourceLineNo">094</span> needProcessConnectionHeader = saslEncryptionEnabled &amp;&amp; conf.getBoolean(<a name="line.94"></a>
<span class="sourceLineNo">095</span> "hbase.rpc.crypto.encryption.aes.enabled", false);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> public boolean isNeedProcessConnectionHeader() {<a name="line.98"></a>
<span class="sourceLineNo">099</span> return needProcessConnectionHeader;<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> @Override<a name="line.102"></a>
<span class="sourceLineNo">103</span> public void handlerAdded(ChannelHandlerContext ctx) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> try {<a name="line.104"></a>
<span class="sourceLineNo">105</span> byte[] initialResponse = ugi.doAs(new PrivilegedExceptionAction&lt;byte[]&gt;() {<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> @Override<a name="line.107"></a>
<span class="sourceLineNo">108</span> public byte[] run() throws Exception {<a name="line.108"></a>
<span class="sourceLineNo">109</span> return saslRpcClient.getInitialResponse();<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> if (initialResponse != null) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> writeResponse(ctx, initialResponse);<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span> tryComplete(ctx);<a name="line.115"></a>
<span class="sourceLineNo">116</span> } catch (Exception e) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> // the exception thrown by handlerAdded will not be passed to the exceptionCaught below<a name="line.117"></a>
<span class="sourceLineNo">118</span> // because netty will remove a handler if handlerAdded throws an exception.<a name="line.118"></a>
<span class="sourceLineNo">119</span> exceptionCaught(ctx, e);<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> @Override<a name="line.123"></a>
<span class="sourceLineNo">124</span> protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {<a name="line.124"></a>
<span class="sourceLineNo">125</span> int len = msg.readInt();<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (len == SaslUtil.SWITCH_TO_SIMPLE_AUTH) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> saslRpcClient.dispose();<a name="line.127"></a>
<span class="sourceLineNo">128</span> if (saslRpcClient.fallbackAllowed) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> saslPromise.trySuccess(false);<a name="line.129"></a>
<span class="sourceLineNo">130</span> } else {<a name="line.130"></a>
<span class="sourceLineNo">131</span> saslPromise.tryFailure(new FallbackDisallowedException());<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span> return;<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span> LOG.trace("Reading input token size={} for processing by initSASLContext", len);<a name="line.135"></a>
<span class="sourceLineNo">136</span> final byte[] challenge = new byte[len];<a name="line.136"></a>
<span class="sourceLineNo">137</span> msg.readBytes(challenge);<a name="line.137"></a>
<span class="sourceLineNo">138</span> byte[] response = ugi.doAs(new PrivilegedExceptionAction&lt;byte[]&gt;() {<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> @Override<a name="line.140"></a>
<span class="sourceLineNo">141</span> public byte[] run() throws Exception {<a name="line.141"></a>
<span class="sourceLineNo">142</span> return saslRpcClient.evaluateChallenge(challenge);<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span> });<a name="line.144"></a>
<span class="sourceLineNo">145</span> if (response != null) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> writeResponse(ctx, response);<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span> tryComplete(ctx);<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> @Override<a name="line.151"></a>
<span class="sourceLineNo">152</span> public void channelInactive(ChannelHandlerContext ctx) throws Exception {<a name="line.152"></a>
<span class="sourceLineNo">153</span> saslRpcClient.dispose();<a name="line.153"></a>
<span class="sourceLineNo">154</span> saslPromise.tryFailure(new ConnectionClosedException("Connection closed"));<a name="line.154"></a>
<span class="sourceLineNo">155</span> ctx.fireChannelInactive();<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> @Override<a name="line.158"></a>
<span class="sourceLineNo">159</span> public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> saslRpcClient.dispose();<a name="line.160"></a>
<span class="sourceLineNo">161</span> saslPromise.tryFailure(cause);<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span>}<a name="line.163"></a>
</pre>
</div>
</body>
</html>