blob: 5929f408ca2d6b7b26794cab4ba7c8ec75a0dd17 [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.regionserver;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.math.BigInteger;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.security.PrivilegedAction;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.security.SecureRandom;<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.HashMap;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Map;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.function.Consumer;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.commons.lang3.mutable.MutableInt;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.conf.Configuration;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.fs.FileStatus;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.fs.FileSystem;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.fs.FileUtil;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.fs.Path;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.fs.permission.FsPermission;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.HConstants;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.TableName;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.AsyncConnection;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.ipc.RpcServer;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.regionserver.HRegion.BulkLoadListener;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.security.User;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.security.UserProvider;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.security.token.AuthenticationTokenIdentifier;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.security.token.ClientTokenUtil;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.security.token.FsDelegationToken;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.util.CommonFSUtils;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.util.FSUtils;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.util.Methods;<a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.apache.hadoop.io.Text;<a name="line.53"></a>
<span class="sourceLineNo">054</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.54"></a>
<span class="sourceLineNo">055</span>import org.apache.hadoop.security.token.Token;<a name="line.55"></a>
<span class="sourceLineNo">056</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.56"></a>
<span class="sourceLineNo">057</span>import org.slf4j.Logger;<a name="line.57"></a>
<span class="sourceLineNo">058</span>import org.slf4j.LoggerFactory;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos;<a name="line.62"></a>
<span class="sourceLineNo">063</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.BulkLoadHFileRequest;<a name="line.63"></a>
<span class="sourceLineNo">064</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.CleanupBulkLoadRequest;<a name="line.64"></a>
<span class="sourceLineNo">065</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.PrepareBulkLoadRequest;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>/**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Bulk loads in secure mode.<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * This service addresses two issues:<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;ol&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * &lt;li&gt;Moving files in a secure filesystem wherein the HBase Client<a name="line.72"></a>
<span class="sourceLineNo">073</span> * and HBase Server are different filesystem users.&lt;/li&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;li&gt;Does moving in a secure manner. Assuming that the filesystem<a name="line.74"></a>
<span class="sourceLineNo">075</span> * is POSIX compliant.&lt;/li&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> * &lt;/ol&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> *<a name="line.77"></a>
<span class="sourceLineNo">078</span> * The algorithm is as follows:<a name="line.78"></a>
<span class="sourceLineNo">079</span> * &lt;ol&gt;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;li&gt;Create an hbase owned staging directory which is<a name="line.80"></a>
<span class="sourceLineNo">081</span> * world traversable (711): {@code /hbase/staging}&lt;/li&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> * &lt;li&gt;A user writes out data to his secure output directory: {@code /user/foo/data}&lt;/li&gt;<a name="line.82"></a>
<span class="sourceLineNo">083</span> * &lt;li&gt;A call is made to hbase to create a secret staging directory<a name="line.83"></a>
<span class="sourceLineNo">084</span> * which globally rwx (777): {@code /user/staging/averylongandrandomdirectoryname}&lt;/li&gt;<a name="line.84"></a>
<span class="sourceLineNo">085</span> * &lt;li&gt;The user moves the data into the random staging directory,<a name="line.85"></a>
<span class="sourceLineNo">086</span> * then calls bulkLoadHFiles()&lt;/li&gt;<a name="line.86"></a>
<span class="sourceLineNo">087</span> * &lt;/ol&gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span> *<a name="line.88"></a>
<span class="sourceLineNo">089</span> * Like delegation tokens the strength of the security lies in the length<a name="line.89"></a>
<span class="sourceLineNo">090</span> * and randomness of the secret directory.<a name="line.90"></a>
<span class="sourceLineNo">091</span> *<a name="line.91"></a>
<span class="sourceLineNo">092</span> */<a name="line.92"></a>
<span class="sourceLineNo">093</span>@InterfaceAudience.Private<a name="line.93"></a>
<span class="sourceLineNo">094</span>public class SecureBulkLoadManager {<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> public static final long VERSION = 0L;<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> //320/5 = 64 characters<a name="line.98"></a>
<span class="sourceLineNo">099</span> private static final int RANDOM_WIDTH = 320;<a name="line.99"></a>
<span class="sourceLineNo">100</span> private static final int RANDOM_RADIX = 32;<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> private static final Logger LOG = LoggerFactory.getLogger(SecureBulkLoadManager.class);<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> private final static FsPermission PERM_ALL_ACCESS = FsPermission.valueOf("-rwxrwxrwx");<a name="line.104"></a>
<span class="sourceLineNo">105</span> private final static FsPermission PERM_HIDDEN = FsPermission.valueOf("-rwx--x--x");<a name="line.105"></a>
<span class="sourceLineNo">106</span> private SecureRandom random;<a name="line.106"></a>
<span class="sourceLineNo">107</span> private FileSystem fs;<a name="line.107"></a>
<span class="sourceLineNo">108</span> private Configuration conf;<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> //two levels so it doesn't get deleted accidentally<a name="line.110"></a>
<span class="sourceLineNo">111</span> //no sticky bit in Hadoop 1.0<a name="line.111"></a>
<span class="sourceLineNo">112</span> private Path baseStagingDir;<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> private UserProvider userProvider;<a name="line.114"></a>
<span class="sourceLineNo">115</span> private ConcurrentHashMap&lt;UserGroupInformation, MutableInt&gt; ugiReferenceCounter;<a name="line.115"></a>
<span class="sourceLineNo">116</span> private AsyncConnection conn;<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> SecureBulkLoadManager(Configuration conf, AsyncConnection conn) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> this.conf = conf;<a name="line.119"></a>
<span class="sourceLineNo">120</span> this.conn = conn;<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> public void start() throws IOException {<a name="line.123"></a>
<span class="sourceLineNo">124</span> random = new SecureRandom();<a name="line.124"></a>
<span class="sourceLineNo">125</span> userProvider = UserProvider.instantiate(conf);<a name="line.125"></a>
<span class="sourceLineNo">126</span> ugiReferenceCounter = new ConcurrentHashMap&lt;&gt;();<a name="line.126"></a>
<span class="sourceLineNo">127</span> fs = FileSystem.get(conf);<a name="line.127"></a>
<span class="sourceLineNo">128</span> baseStagingDir = new Path(CommonFSUtils.getRootDir(conf), HConstants.BULKLOAD_STAGING_DIR_NAME);<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> if (conf.get("hbase.bulkload.staging.dir") != null) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> LOG.warn("hbase.bulkload.staging.dir " + " is deprecated. Bulkload staging directory is "<a name="line.131"></a>
<span class="sourceLineNo">132</span> + baseStagingDir);<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (!fs.exists(baseStagingDir)) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> fs.mkdirs(baseStagingDir, PERM_HIDDEN);<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> public void stop() throws IOException {<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> public String prepareBulkLoad(final HRegion region, final PrepareBulkLoadRequest request)<a name="line.142"></a>
<span class="sourceLineNo">143</span> throws IOException {<a name="line.143"></a>
<span class="sourceLineNo">144</span> User user = getActiveUser();<a name="line.144"></a>
<span class="sourceLineNo">145</span> region.getCoprocessorHost().prePrepareBulkLoad(user);<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> String bulkToken =<a name="line.147"></a>
<span class="sourceLineNo">148</span> createStagingDir(baseStagingDir, user, region.getTableDescriptor().getTableName())<a name="line.148"></a>
<span class="sourceLineNo">149</span> .toString();<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> return bulkToken;<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> public void cleanupBulkLoad(final HRegion region, final CleanupBulkLoadRequest request)<a name="line.154"></a>
<span class="sourceLineNo">155</span> throws IOException {<a name="line.155"></a>
<span class="sourceLineNo">156</span> region.getCoprocessorHost().preCleanupBulkLoad(getActiveUser());<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> Path path = new Path(request.getBulkToken());<a name="line.158"></a>
<span class="sourceLineNo">159</span> if (!fs.delete(path, true)) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> if (fs.exists(path)) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> throw new IOException("Failed to clean up " + path);<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>
<span class="sourceLineNo">164</span> LOG.trace("Cleaned up {} successfully.", path);<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> private Consumer&lt;HRegion&gt; fsCreatedListener;<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> @VisibleForTesting<a name="line.169"></a>
<span class="sourceLineNo">170</span> void setFsCreatedListener(Consumer&lt;HRegion&gt; fsCreatedListener) {<a name="line.170"></a>
<span class="sourceLineNo">171</span> this.fsCreatedListener = fsCreatedListener;<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> private void incrementUgiReference(UserGroupInformation ugi) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> // if we haven't seen this ugi before, make a new counter<a name="line.176"></a>
<span class="sourceLineNo">177</span> ugiReferenceCounter.compute(ugi, (key, value) -&gt; {<a name="line.177"></a>
<span class="sourceLineNo">178</span> if (value == null) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> value = new MutableInt(1);<a name="line.179"></a>
<span class="sourceLineNo">180</span> } else {<a name="line.180"></a>
<span class="sourceLineNo">181</span> value.increment();<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span> return value;<a name="line.183"></a>
<span class="sourceLineNo">184</span> });<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> private void decrementUgiReference(UserGroupInformation ugi) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> // if the count drops below 1 we remove the entry by returning null<a name="line.188"></a>
<span class="sourceLineNo">189</span> ugiReferenceCounter.computeIfPresent(ugi, (key, value) -&gt; {<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (value.intValue() &gt; 1) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> value.decrement();<a name="line.191"></a>
<span class="sourceLineNo">192</span> } else {<a name="line.192"></a>
<span class="sourceLineNo">193</span> value = null;<a name="line.193"></a>
<span class="sourceLineNo">194</span> }<a name="line.194"></a>
<span class="sourceLineNo">195</span> return value;<a name="line.195"></a>
<span class="sourceLineNo">196</span> });<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> private boolean isUserReferenced(UserGroupInformation ugi) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> // if the ugi is in the map, based on invariants above<a name="line.200"></a>
<span class="sourceLineNo">201</span> // the count must be above zero<a name="line.201"></a>
<span class="sourceLineNo">202</span> return ugiReferenceCounter.containsKey(ugi);<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span> public Map&lt;byte[], List&lt;Path&gt;&gt; secureBulkLoadHFiles(final HRegion region,<a name="line.205"></a>
<span class="sourceLineNo">206</span> final BulkLoadHFileRequest request) throws IOException {<a name="line.206"></a>
<span class="sourceLineNo">207</span> return secureBulkLoadHFiles(region, request, null);<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span> public Map&lt;byte[], List&lt;Path&gt;&gt; secureBulkLoadHFiles(final HRegion region,<a name="line.210"></a>
<span class="sourceLineNo">211</span> final BulkLoadHFileRequest request, List&lt;String&gt; clusterIds) throws IOException {<a name="line.211"></a>
<span class="sourceLineNo">212</span> final List&lt;Pair&lt;byte[], String&gt;&gt; familyPaths = new ArrayList&lt;&gt;(request.getFamilyPathCount());<a name="line.212"></a>
<span class="sourceLineNo">213</span> for(ClientProtos.BulkLoadHFileRequest.FamilyPath el : request.getFamilyPathList()) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> familyPaths.add(new Pair&lt;&gt;(el.getFamily().toByteArray(), el.getPath()));<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span> Token&lt;AuthenticationTokenIdentifier&gt; userToken = null;<a name="line.217"></a>
<span class="sourceLineNo">218</span> if (userProvider.isHadoopSecurityEnabled()) {<a name="line.218"></a>
<span class="sourceLineNo">219</span> userToken = new Token&lt;&gt;(request.getFsToken().getIdentifier().toByteArray(),<a name="line.219"></a>
<span class="sourceLineNo">220</span> request.getFsToken().getPassword().toByteArray(), new Text(request.getFsToken().getKind()),<a name="line.220"></a>
<span class="sourceLineNo">221</span> new Text(request.getFsToken().getService()));<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span> final String bulkToken = request.getBulkToken();<a name="line.223"></a>
<span class="sourceLineNo">224</span> User user = getActiveUser();<a name="line.224"></a>
<span class="sourceLineNo">225</span> final UserGroupInformation ugi = user.getUGI();<a name="line.225"></a>
<span class="sourceLineNo">226</span> if (userProvider.isHadoopSecurityEnabled()) {<a name="line.226"></a>
<span class="sourceLineNo">227</span> try {<a name="line.227"></a>
<span class="sourceLineNo">228</span> Token&lt;AuthenticationTokenIdentifier&gt; tok = ClientTokenUtil.obtainToken(conn).get();<a name="line.228"></a>
<span class="sourceLineNo">229</span> if (tok != null) {<a name="line.229"></a>
<span class="sourceLineNo">230</span> boolean b = ugi.addToken(tok);<a name="line.230"></a>
<span class="sourceLineNo">231</span> LOG.debug("token added " + tok + " for user " + ugi + " return=" + b);<a name="line.231"></a>
<span class="sourceLineNo">232</span> }<a name="line.232"></a>
<span class="sourceLineNo">233</span> } catch (Exception ioe) {<a name="line.233"></a>
<span class="sourceLineNo">234</span> LOG.warn("unable to add token", ioe);<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span> if (userToken != null) {<a name="line.237"></a>
<span class="sourceLineNo">238</span> ugi.addToken(userToken);<a name="line.238"></a>
<span class="sourceLineNo">239</span> } else if (userProvider.isHadoopSecurityEnabled()) {<a name="line.239"></a>
<span class="sourceLineNo">240</span> //we allow this to pass through in "simple" security mode<a name="line.240"></a>
<span class="sourceLineNo">241</span> //for mini cluster testing<a name="line.241"></a>
<span class="sourceLineNo">242</span> throw new DoNotRetryIOException("User token cannot be null");<a name="line.242"></a>
<span class="sourceLineNo">243</span> }<a name="line.243"></a>
<span class="sourceLineNo">244</span><a name="line.244"></a>
<span class="sourceLineNo">245</span> if (region.getCoprocessorHost() != null) {<a name="line.245"></a>
<span class="sourceLineNo">246</span> region.getCoprocessorHost().preBulkLoadHFile(familyPaths);<a name="line.246"></a>
<span class="sourceLineNo">247</span> }<a name="line.247"></a>
<span class="sourceLineNo">248</span> Map&lt;byte[], List&lt;Path&gt;&gt; map = null;<a name="line.248"></a>
<span class="sourceLineNo">249</span><a name="line.249"></a>
<span class="sourceLineNo">250</span> try {<a name="line.250"></a>
<span class="sourceLineNo">251</span> incrementUgiReference(ugi);<a name="line.251"></a>
<span class="sourceLineNo">252</span> // Get the target fs (HBase region server fs) delegation token<a name="line.252"></a>
<span class="sourceLineNo">253</span> // Since we have checked the permission via 'preBulkLoadHFile', now let's give<a name="line.253"></a>
<span class="sourceLineNo">254</span> // the 'request user' necessary token to operate on the target fs.<a name="line.254"></a>
<span class="sourceLineNo">255</span> // After this point the 'doAs' user will hold two tokens, one for the source fs<a name="line.255"></a>
<span class="sourceLineNo">256</span> // ('request user'), another for the target fs (HBase region server principal).<a name="line.256"></a>
<span class="sourceLineNo">257</span> if (userProvider.isHadoopSecurityEnabled()) {<a name="line.257"></a>
<span class="sourceLineNo">258</span> FsDelegationToken targetfsDelegationToken = new FsDelegationToken(userProvider,"renewer");<a name="line.258"></a>
<span class="sourceLineNo">259</span> targetfsDelegationToken.acquireDelegationToken(fs);<a name="line.259"></a>
<span class="sourceLineNo">260</span><a name="line.260"></a>
<span class="sourceLineNo">261</span> Token&lt;?&gt; targetFsToken = targetfsDelegationToken.getUserToken();<a name="line.261"></a>
<span class="sourceLineNo">262</span> if (targetFsToken != null<a name="line.262"></a>
<span class="sourceLineNo">263</span> &amp;&amp; (userToken == null || !targetFsToken.getService().equals(userToken.getService()))){<a name="line.263"></a>
<span class="sourceLineNo">264</span> ugi.addToken(targetFsToken);<a name="line.264"></a>
<span class="sourceLineNo">265</span> }<a name="line.265"></a>
<span class="sourceLineNo">266</span> }<a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span> map = ugi.doAs(new PrivilegedAction&lt;Map&lt;byte[], List&lt;Path&gt;&gt;&gt;() {<a name="line.268"></a>
<span class="sourceLineNo">269</span> @Override<a name="line.269"></a>
<span class="sourceLineNo">270</span> public Map&lt;byte[], List&lt;Path&gt;&gt; run() {<a name="line.270"></a>
<span class="sourceLineNo">271</span> FileSystem fs = null;<a name="line.271"></a>
<span class="sourceLineNo">272</span> try {<a name="line.272"></a>
<span class="sourceLineNo">273</span> /*<a name="line.273"></a>
<span class="sourceLineNo">274</span> * This is creating and caching a new FileSystem instance. Other code called<a name="line.274"></a>
<span class="sourceLineNo">275</span> * "beneath" this method will rely on this FileSystem instance being in the<a name="line.275"></a>
<span class="sourceLineNo">276</span> * cache. This is important as those methods make _no_ attempt to close this<a name="line.276"></a>
<span class="sourceLineNo">277</span> * FileSystem instance. It is critical that here, in SecureBulkLoadManager,<a name="line.277"></a>
<span class="sourceLineNo">278</span> * we are tracking the lifecycle and closing the FS when safe to do so.<a name="line.278"></a>
<span class="sourceLineNo">279</span> */<a name="line.279"></a>
<span class="sourceLineNo">280</span> fs = FileSystem.get(conf);<a name="line.280"></a>
<span class="sourceLineNo">281</span> for(Pair&lt;byte[], String&gt; el: familyPaths) {<a name="line.281"></a>
<span class="sourceLineNo">282</span> Path stageFamily = new Path(bulkToken, Bytes.toString(el.getFirst()));<a name="line.282"></a>
<span class="sourceLineNo">283</span> if(!fs.exists(stageFamily)) {<a name="line.283"></a>
<span class="sourceLineNo">284</span> fs.mkdirs(stageFamily);<a name="line.284"></a>
<span class="sourceLineNo">285</span> fs.setPermission(stageFamily, PERM_ALL_ACCESS);<a name="line.285"></a>
<span class="sourceLineNo">286</span> }<a name="line.286"></a>
<span class="sourceLineNo">287</span> }<a name="line.287"></a>
<span class="sourceLineNo">288</span> if (fsCreatedListener != null) {<a name="line.288"></a>
<span class="sourceLineNo">289</span> fsCreatedListener.accept(region);<a name="line.289"></a>
<span class="sourceLineNo">290</span> }<a name="line.290"></a>
<span class="sourceLineNo">291</span> //We call bulkLoadHFiles as requesting user<a name="line.291"></a>
<span class="sourceLineNo">292</span> //To enable access prior to staging<a name="line.292"></a>
<span class="sourceLineNo">293</span> return region.bulkLoadHFiles(familyPaths, true,<a name="line.293"></a>
<span class="sourceLineNo">294</span> new SecureBulkLoadListener(fs, bulkToken, conf), request.getCopyFile(),<a name="line.294"></a>
<span class="sourceLineNo">295</span> clusterIds, request.getReplicate());<a name="line.295"></a>
<span class="sourceLineNo">296</span> } catch (Exception e) {<a name="line.296"></a>
<span class="sourceLineNo">297</span> LOG.error("Failed to complete bulk load", e);<a name="line.297"></a>
<span class="sourceLineNo">298</span> }<a name="line.298"></a>
<span class="sourceLineNo">299</span> return null;<a name="line.299"></a>
<span class="sourceLineNo">300</span> }<a name="line.300"></a>
<span class="sourceLineNo">301</span> });<a name="line.301"></a>
<span class="sourceLineNo">302</span> } finally {<a name="line.302"></a>
<span class="sourceLineNo">303</span> decrementUgiReference(ugi);<a name="line.303"></a>
<span class="sourceLineNo">304</span> try {<a name="line.304"></a>
<span class="sourceLineNo">305</span> if (!UserGroupInformation.getLoginUser().equals(ugi) &amp;&amp; !isUserReferenced(ugi)) {<a name="line.305"></a>
<span class="sourceLineNo">306</span> FileSystem.closeAllForUGI(ugi);<a name="line.306"></a>
<span class="sourceLineNo">307</span> }<a name="line.307"></a>
<span class="sourceLineNo">308</span> } catch (IOException e) {<a name="line.308"></a>
<span class="sourceLineNo">309</span> LOG.error("Failed to close FileSystem for: {}", ugi, e);<a name="line.309"></a>
<span class="sourceLineNo">310</span> }<a name="line.310"></a>
<span class="sourceLineNo">311</span> if (region.getCoprocessorHost() != null) {<a name="line.311"></a>
<span class="sourceLineNo">312</span> region.getCoprocessorHost().postBulkLoadHFile(familyPaths, map);<a name="line.312"></a>
<span class="sourceLineNo">313</span> }<a name="line.313"></a>
<span class="sourceLineNo">314</span> }<a name="line.314"></a>
<span class="sourceLineNo">315</span> return map;<a name="line.315"></a>
<span class="sourceLineNo">316</span> }<a name="line.316"></a>
<span class="sourceLineNo">317</span><a name="line.317"></a>
<span class="sourceLineNo">318</span> private Path createStagingDir(Path baseDir,<a name="line.318"></a>
<span class="sourceLineNo">319</span> User user,<a name="line.319"></a>
<span class="sourceLineNo">320</span> TableName tableName) throws IOException {<a name="line.320"></a>
<span class="sourceLineNo">321</span> String tblName = tableName.getNameAsString().replace(":", "_");<a name="line.321"></a>
<span class="sourceLineNo">322</span> String randomDir = user.getShortName()+"__"+ tblName +"__"+<a name="line.322"></a>
<span class="sourceLineNo">323</span> (new BigInteger(RANDOM_WIDTH, random).toString(RANDOM_RADIX));<a name="line.323"></a>
<span class="sourceLineNo">324</span> return createStagingDir(baseDir, user, randomDir);<a name="line.324"></a>
<span class="sourceLineNo">325</span> }<a name="line.325"></a>
<span class="sourceLineNo">326</span><a name="line.326"></a>
<span class="sourceLineNo">327</span> private Path createStagingDir(Path baseDir,<a name="line.327"></a>
<span class="sourceLineNo">328</span> User user,<a name="line.328"></a>
<span class="sourceLineNo">329</span> String randomDir) throws IOException {<a name="line.329"></a>
<span class="sourceLineNo">330</span> Path p = new Path(baseDir, randomDir);<a name="line.330"></a>
<span class="sourceLineNo">331</span> fs.mkdirs(p, PERM_ALL_ACCESS);<a name="line.331"></a>
<span class="sourceLineNo">332</span> fs.setPermission(p, PERM_ALL_ACCESS);<a name="line.332"></a>
<span class="sourceLineNo">333</span> return p;<a name="line.333"></a>
<span class="sourceLineNo">334</span> }<a name="line.334"></a>
<span class="sourceLineNo">335</span><a name="line.335"></a>
<span class="sourceLineNo">336</span> private User getActiveUser() throws IOException {<a name="line.336"></a>
<span class="sourceLineNo">337</span> // for non-rpc handling, fallback to system user<a name="line.337"></a>
<span class="sourceLineNo">338</span> User user = RpcServer.getRequestUser().orElse(userProvider.getCurrent());<a name="line.338"></a>
<span class="sourceLineNo">339</span> // this is for testing<a name="line.339"></a>
<span class="sourceLineNo">340</span> if (userProvider.isHadoopSecurityEnabled() &amp;&amp;<a name="line.340"></a>
<span class="sourceLineNo">341</span> "simple".equalsIgnoreCase(conf.get(User.HBASE_SECURITY_CONF_KEY))) {<a name="line.341"></a>
<span class="sourceLineNo">342</span> return User.createUserForTesting(conf, user.getShortName(), new String[] {});<a name="line.342"></a>
<span class="sourceLineNo">343</span> }<a name="line.343"></a>
<span class="sourceLineNo">344</span><a name="line.344"></a>
<span class="sourceLineNo">345</span> return user;<a name="line.345"></a>
<span class="sourceLineNo">346</span> }<a name="line.346"></a>
<span class="sourceLineNo">347</span><a name="line.347"></a>
<span class="sourceLineNo">348</span> private static class SecureBulkLoadListener implements BulkLoadListener {<a name="line.348"></a>
<span class="sourceLineNo">349</span> // Target filesystem<a name="line.349"></a>
<span class="sourceLineNo">350</span> private final FileSystem fs;<a name="line.350"></a>
<span class="sourceLineNo">351</span> private final String stagingDir;<a name="line.351"></a>
<span class="sourceLineNo">352</span> private final Configuration conf;<a name="line.352"></a>
<span class="sourceLineNo">353</span> // Source filesystem<a name="line.353"></a>
<span class="sourceLineNo">354</span> private FileSystem srcFs = null;<a name="line.354"></a>
<span class="sourceLineNo">355</span> private Map&lt;String, FsPermission&gt; origPermissions = null;<a name="line.355"></a>
<span class="sourceLineNo">356</span><a name="line.356"></a>
<span class="sourceLineNo">357</span> public SecureBulkLoadListener(FileSystem fs, String stagingDir, Configuration conf) {<a name="line.357"></a>
<span class="sourceLineNo">358</span> this.fs = fs;<a name="line.358"></a>
<span class="sourceLineNo">359</span> this.stagingDir = stagingDir;<a name="line.359"></a>
<span class="sourceLineNo">360</span> this.conf = conf;<a name="line.360"></a>
<span class="sourceLineNo">361</span> this.origPermissions = new HashMap&lt;&gt;();<a name="line.361"></a>
<span class="sourceLineNo">362</span> }<a name="line.362"></a>
<span class="sourceLineNo">363</span><a name="line.363"></a>
<span class="sourceLineNo">364</span> @Override<a name="line.364"></a>
<span class="sourceLineNo">365</span> public String prepareBulkLoad(final byte[] family, final String srcPath, boolean copyFile)<a name="line.365"></a>
<span class="sourceLineNo">366</span> throws IOException {<a name="line.366"></a>
<span class="sourceLineNo">367</span> Path p = new Path(srcPath);<a name="line.367"></a>
<span class="sourceLineNo">368</span> Path stageP = new Path(stagingDir, new Path(Bytes.toString(family), p.getName()));<a name="line.368"></a>
<span class="sourceLineNo">369</span><a name="line.369"></a>
<span class="sourceLineNo">370</span> // In case of Replication for bulk load files, hfiles are already copied in staging directory<a name="line.370"></a>
<span class="sourceLineNo">371</span> if (p.equals(stageP)) {<a name="line.371"></a>
<span class="sourceLineNo">372</span> LOG.debug(p.getName()<a name="line.372"></a>
<span class="sourceLineNo">373</span> + " is already available in staging directory. Skipping copy or rename.");<a name="line.373"></a>
<span class="sourceLineNo">374</span> return stageP.toString();<a name="line.374"></a>
<span class="sourceLineNo">375</span> }<a name="line.375"></a>
<span class="sourceLineNo">376</span><a name="line.376"></a>
<span class="sourceLineNo">377</span> if (srcFs == null) {<a name="line.377"></a>
<span class="sourceLineNo">378</span> srcFs = FileSystem.newInstance(p.toUri(), conf);<a name="line.378"></a>
<span class="sourceLineNo">379</span> }<a name="line.379"></a>
<span class="sourceLineNo">380</span><a name="line.380"></a>
<span class="sourceLineNo">381</span> if(!isFile(p)) {<a name="line.381"></a>
<span class="sourceLineNo">382</span> throw new IOException("Path does not reference a file: " + p);<a name="line.382"></a>
<span class="sourceLineNo">383</span> }<a name="line.383"></a>
<span class="sourceLineNo">384</span><a name="line.384"></a>
<span class="sourceLineNo">385</span> // Check to see if the source and target filesystems are the same<a name="line.385"></a>
<span class="sourceLineNo">386</span> if (!FSUtils.isSameHdfs(conf, srcFs, fs)) {<a name="line.386"></a>
<span class="sourceLineNo">387</span> LOG.debug("Bulk-load file " + srcPath + " is on different filesystem than " +<a name="line.387"></a>
<span class="sourceLineNo">388</span> "the destination filesystem. Copying file over to destination staging dir.");<a name="line.388"></a>
<span class="sourceLineNo">389</span> FileUtil.copy(srcFs, p, fs, stageP, false, conf);<a name="line.389"></a>
<span class="sourceLineNo">390</span> } else if (copyFile) {<a name="line.390"></a>
<span class="sourceLineNo">391</span> LOG.debug("Bulk-load file " + srcPath + " is copied to destination staging dir.");<a name="line.391"></a>
<span class="sourceLineNo">392</span> FileUtil.copy(srcFs, p, fs, stageP, false, conf);<a name="line.392"></a>
<span class="sourceLineNo">393</span> } else {<a name="line.393"></a>
<span class="sourceLineNo">394</span> LOG.debug("Moving " + p + " to " + stageP);<a name="line.394"></a>
<span class="sourceLineNo">395</span> FileStatus origFileStatus = fs.getFileStatus(p);<a name="line.395"></a>
<span class="sourceLineNo">396</span> origPermissions.put(srcPath, origFileStatus.getPermission());<a name="line.396"></a>
<span class="sourceLineNo">397</span> if(!fs.rename(p, stageP)) {<a name="line.397"></a>
<span class="sourceLineNo">398</span> throw new IOException("Failed to move HFile: " + p + " to " + stageP);<a name="line.398"></a>
<span class="sourceLineNo">399</span> }<a name="line.399"></a>
<span class="sourceLineNo">400</span> }<a name="line.400"></a>
<span class="sourceLineNo">401</span> fs.setPermission(stageP, PERM_ALL_ACCESS);<a name="line.401"></a>
<span class="sourceLineNo">402</span> return stageP.toString();<a name="line.402"></a>
<span class="sourceLineNo">403</span> }<a name="line.403"></a>
<span class="sourceLineNo">404</span><a name="line.404"></a>
<span class="sourceLineNo">405</span> @Override<a name="line.405"></a>
<span class="sourceLineNo">406</span> public void doneBulkLoad(byte[] family, String srcPath) throws IOException {<a name="line.406"></a>
<span class="sourceLineNo">407</span> LOG.debug("Bulk Load done for: " + srcPath);<a name="line.407"></a>
<span class="sourceLineNo">408</span> closeSrcFs();<a name="line.408"></a>
<span class="sourceLineNo">409</span> }<a name="line.409"></a>
<span class="sourceLineNo">410</span><a name="line.410"></a>
<span class="sourceLineNo">411</span> private void closeSrcFs() throws IOException {<a name="line.411"></a>
<span class="sourceLineNo">412</span> if (srcFs != null) {<a name="line.412"></a>
<span class="sourceLineNo">413</span> srcFs.close();<a name="line.413"></a>
<span class="sourceLineNo">414</span> srcFs = null;<a name="line.414"></a>
<span class="sourceLineNo">415</span> }<a name="line.415"></a>
<span class="sourceLineNo">416</span> }<a name="line.416"></a>
<span class="sourceLineNo">417</span><a name="line.417"></a>
<span class="sourceLineNo">418</span> @Override<a name="line.418"></a>
<span class="sourceLineNo">419</span> public void failedBulkLoad(final byte[] family, final String srcPath) throws IOException {<a name="line.419"></a>
<span class="sourceLineNo">420</span> try {<a name="line.420"></a>
<span class="sourceLineNo">421</span> Path p = new Path(srcPath);<a name="line.421"></a>
<span class="sourceLineNo">422</span> if (srcFs == null) {<a name="line.422"></a>
<span class="sourceLineNo">423</span> srcFs = FileSystem.newInstance(p.toUri(), conf);<a name="line.423"></a>
<span class="sourceLineNo">424</span> }<a name="line.424"></a>
<span class="sourceLineNo">425</span> if (!FSUtils.isSameHdfs(conf, srcFs, fs)) {<a name="line.425"></a>
<span class="sourceLineNo">426</span> // files are copied so no need to move them back<a name="line.426"></a>
<span class="sourceLineNo">427</span> return;<a name="line.427"></a>
<span class="sourceLineNo">428</span> }<a name="line.428"></a>
<span class="sourceLineNo">429</span> Path stageP = new Path(stagingDir, new Path(Bytes.toString(family), p.getName()));<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> // In case of Replication for bulk load files, hfiles are not renamed by end point during<a name="line.431"></a>
<span class="sourceLineNo">432</span> // prepare stage, so no need of rename here again<a name="line.432"></a>
<span class="sourceLineNo">433</span> if (p.equals(stageP)) {<a name="line.433"></a>
<span class="sourceLineNo">434</span> LOG.debug(p.getName() + " is already available in source directory. Skipping rename.");<a name="line.434"></a>
<span class="sourceLineNo">435</span> return;<a name="line.435"></a>
<span class="sourceLineNo">436</span> }<a name="line.436"></a>
<span class="sourceLineNo">437</span><a name="line.437"></a>
<span class="sourceLineNo">438</span> LOG.debug("Moving " + stageP + " back to " + p);<a name="line.438"></a>
<span class="sourceLineNo">439</span> if (!fs.rename(stageP, p)) {<a name="line.439"></a>
<span class="sourceLineNo">440</span> throw new IOException("Failed to move HFile: " + stageP + " to " + p);<a name="line.440"></a>
<span class="sourceLineNo">441</span> }<a name="line.441"></a>
<span class="sourceLineNo">442</span><a name="line.442"></a>
<span class="sourceLineNo">443</span> // restore original permission<a name="line.443"></a>
<span class="sourceLineNo">444</span> if (origPermissions.containsKey(srcPath)) {<a name="line.444"></a>
<span class="sourceLineNo">445</span> fs.setPermission(p, origPermissions.get(srcPath));<a name="line.445"></a>
<span class="sourceLineNo">446</span> } else {<a name="line.446"></a>
<span class="sourceLineNo">447</span> LOG.warn("Can't find previous permission for path=" + srcPath);<a name="line.447"></a>
<span class="sourceLineNo">448</span> }<a name="line.448"></a>
<span class="sourceLineNo">449</span> } finally {<a name="line.449"></a>
<span class="sourceLineNo">450</span> closeSrcFs();<a name="line.450"></a>
<span class="sourceLineNo">451</span> }<a name="line.451"></a>
<span class="sourceLineNo">452</span> }<a name="line.452"></a>
<span class="sourceLineNo">453</span><a name="line.453"></a>
<span class="sourceLineNo">454</span> /**<a name="line.454"></a>
<span class="sourceLineNo">455</span> * Check if the path is referencing a file.<a name="line.455"></a>
<span class="sourceLineNo">456</span> * This is mainly needed to avoid symlinks.<a name="line.456"></a>
<span class="sourceLineNo">457</span> * @param p<a name="line.457"></a>
<span class="sourceLineNo">458</span> * @return true if the p is a file<a name="line.458"></a>
<span class="sourceLineNo">459</span> * @throws IOException<a name="line.459"></a>
<span class="sourceLineNo">460</span> */<a name="line.460"></a>
<span class="sourceLineNo">461</span> private boolean isFile(Path p) throws IOException {<a name="line.461"></a>
<span class="sourceLineNo">462</span> FileStatus status = srcFs.getFileStatus(p);<a name="line.462"></a>
<span class="sourceLineNo">463</span> boolean isFile = !status.isDirectory();<a name="line.463"></a>
<span class="sourceLineNo">464</span> try {<a name="line.464"></a>
<span class="sourceLineNo">465</span> isFile = isFile &amp;&amp; !(Boolean)Methods.call(FileStatus.class, status, "isSymlink", null, null);<a name="line.465"></a>
<span class="sourceLineNo">466</span> } catch (Exception e) {<a name="line.466"></a>
<span class="sourceLineNo">467</span> }<a name="line.467"></a>
<span class="sourceLineNo">468</span> return isFile;<a name="line.468"></a>
<span class="sourceLineNo">469</span> }<a name="line.469"></a>
<span class="sourceLineNo">470</span> }<a name="line.470"></a>
<span class="sourceLineNo">471</span>}<a name="line.471"></a>
</pre>
</div>
</body>
</html>