| <!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> *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.security;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.security.PrivilegedAction;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.security.PrivilegedExceptionAction;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Arrays;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Collection;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.HashMap;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.List;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.Map;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.Optional;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.concurrent.ExecutionException;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.conf.Configuration;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.AuthUtil;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.util.Methods;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.security.Groups;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.security.SecurityUtil;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.security.token.Token;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.security.token.TokenIdentifier;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.hbase.thirdparty.com.google.common.cache.LoadingCache;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span>/**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Wrapper to abstract out usage of user and group information in HBase.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <p><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * This class provides a common interface for interacting with user and group<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * information across changing APIs in different versions of Hadoop. It only<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * provides access to the common set of functionality in<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * {@link org.apache.hadoop.security.UserGroupInformation} currently needed by<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * HBase, but can be extended as needs change.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * </p><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>@InterfaceAudience.Public<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>public abstract class User {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> public static final String HBASE_SECURITY_CONF_KEY =<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> "hbase.security.authentication";<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public static final String HBASE_SECURITY_AUTHORIZATION_CONF_KEY =<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> "hbase.security.authorization";<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> protected UserGroupInformation ugi;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public UserGroupInformation getUGI() {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> return ugi;<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> * Returns the full user name. For Kerberos principals this will include<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * the host and realm portions of the principal name.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> *<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @return User full name.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> public String getName() {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> return ugi.getUserName();<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> }<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> * Returns the list of groups of which this user is a member. On secure<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * Hadoop this returns the group information for the user as resolved on the<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * server. For 0.20 based Hadoop, the group names are passed from the client.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public String[] getGroupNames() {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> return ugi.getGroupNames();<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> /**<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Returns the shortened version of the user name -- the portion that maps<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * to an operating system user name.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> *<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @return Short name<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public abstract String getShortName();<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> /**<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * Executes the given action within the context of this user.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public abstract <T> T runAs(PrivilegedAction<T> action);<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> * Executes the given action within the context of this user.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> public abstract <T> T runAs(PrivilegedExceptionAction<T> action)<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> throws IOException, InterruptedException;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Returns the Token of the specified kind associated with this user,<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * or null if the Token is not present.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> *<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param kind the kind of token<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param service service on which the token is supposed to be used<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @return the token of the specified kind.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> */<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> public Token<?> getToken(String kind, String service) throws IOException {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> for (Token<?> token : ugi.getTokens()) {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> if (token.getKind().toString().equals(kind) &&<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> (service != null && token.getService().toString().equals(service))) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> return token;<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> return null;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> /**<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * Returns all the tokens stored in the user's credentials.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> */<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> public Collection<Token<? extends TokenIdentifier>> getTokens() {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> return ugi.getTokens();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<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> * Adds the given Token to the user's credentials.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> *<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @param token the token to add<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> */<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> public void addToken(Token<? extends TokenIdentifier> token) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> ugi.addToken(token);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<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> * @return true if user credentials are obtained from keytab.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> public boolean isLoginFromKeytab() {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> return ugi.isFromKeytab();<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> }<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> @Override<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> public boolean equals(Object o) {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> if (this == o) {<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return true;<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> if (o == null || getClass() != o.getClass()) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> return false;<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> return ugi.equals(((User) o).ugi);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> @Override<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> public int hashCode() {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> return ugi.hashCode();<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> @Override<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> public String toString() {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> return ugi.toString();<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> /**<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * Returns the {@code User} instance within current execution context.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> public static User getCurrent() throws IOException {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> User user = new SecureHadoopUser();<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> if (user.getUGI() == null) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> return null;<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> return user;<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> /**<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * Executes the given action as the login user<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @param action<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @return the result of the action<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * @throws IOException<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> */<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> @SuppressWarnings({ "rawtypes", "unchecked" })<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> public static <T> T runAsLoginUser(PrivilegedExceptionAction<T> action) throws IOException {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> try {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> Class c = Class.forName("org.apache.hadoop.security.SecurityUtil");<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> Class [] types = new Class[]{PrivilegedExceptionAction.class};<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> Object[] args = new Object[]{action};<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> return (T) Methods.call(c, null, "doAsLoginUser", types, args);<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> } catch (Throwable e) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> throw new IOException(e);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<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> * Wraps an underlying {@code UserGroupInformation} instance.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * @param ugi The base Hadoop user<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * @return User<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> */<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> public static User create(UserGroupInformation ugi) {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> if (ugi == null) {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> return null;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> return new SecureHadoopUser(ugi);<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> /**<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * Generates a new {@code User} instance specifically for use in test code.<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * @param name the full username<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * @param groups the group names to which the test user will belong<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * @return a new <code>User</code> instance<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> */<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> public static User createUserForTesting(Configuration conf,<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> String name, String[] groups) {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> User userForTesting = SecureHadoopUser.createUserForTesting(conf, name, groups);<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> return userForTesting;<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span><a name="line.221"></a> |
| <span class="sourceLineNo">222</span> /**<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * Log in the current process using the given configuration keys for the<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * credential file and login principal.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> *<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * <p><strong>This is only applicable when<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * running on secure Hadoop</strong> -- see<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * org.apache.hadoop.security.SecurityUtil#login(Configuration,String,String,String).<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * On regular Hadoop (without security features), this will safely be ignored.<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * </p><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> *<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * @param conf The configuration data to use<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * @param fileConfKey Property key used to configure path to the credential file<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * @param principalConfKey Property key used to configure login principal<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * @param localhost Current hostname to use in any credentials<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @throws IOException underlying exception from SecurityUtil.login() call<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> */<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> public static void login(Configuration conf, String fileConfKey,<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> String principalConfKey, String localhost) throws IOException {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> SecureHadoopUser.login(conf, fileConfKey, principalConfKey, localhost);<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> }<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> /**<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * Login with the given keytab and principal.<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @param keytabLocation path of keytab<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * @param pricipalName login principal<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @throws IOException underlying exception from UserGroupInformation.loginUserFromKeytab<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> */<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> public static void login(String keytabLocation, String pricipalName) throws IOException {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> SecureHadoopUser.login(keytabLocation, pricipalName);<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> /**<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * Returns whether or not Kerberos authentication is configured for Hadoop.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * For non-secure Hadoop, this always returns <code>false</code>.<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * For secure Hadoop, it will return the value from<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * {@code UserGroupInformation.isSecurityEnabled()}.<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> */<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> public static boolean isSecurityEnabled() {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> return SecureHadoopUser.isSecurityEnabled();<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> /**<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * Returns whether or not secure authentication is enabled for HBase. Note that<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * HBase security requires HDFS security to provide any guarantees, so it is<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * recommended that secure HBase should run on secure HDFS.<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> */<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> public static boolean isHBaseSecurityEnabled(Configuration conf) {<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> return "kerberos".equalsIgnoreCase(conf.get(HBASE_SECURITY_CONF_KEY));<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> }<a name="line.270"></a> |
| <span class="sourceLineNo">271</span><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> /**<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * In secure environment, if a user specified his keytab and principal,<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * a hbase client will try to login with them. Otherwise, hbase client will try to obtain<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * ticket(through kinit) from system.<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * @param conf configuration file<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * @return true if keytab and principal are configured<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> */<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> public static boolean shouldLoginFromKeytab(Configuration conf) {<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> Optional<String> keytab =<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> Optional.ofNullable(conf.get(AuthUtil.HBASE_CLIENT_KEYTAB_FILE));<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> Optional<String> principal =<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> Optional.ofNullable(conf.get(AuthUtil.HBASE_CLIENT_KERBEROS_PRINCIPAL));<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> return keytab.isPresent() && principal.isPresent();<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> }<a name="line.285"></a> |
| <span class="sourceLineNo">286</span><a name="line.286"></a> |
| <span class="sourceLineNo">287</span> /* Concrete implementations */<a name="line.287"></a> |
| <span class="sourceLineNo">288</span><a name="line.288"></a> |
| <span class="sourceLineNo">289</span> /**<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * Bridges {@code User} invocations to underlying calls to<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * {@link org.apache.hadoop.security.UserGroupInformation} for secure Hadoop<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * 0.20 and versions 0.21 and above.<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> */<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> @InterfaceAudience.Private<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> public static final class SecureHadoopUser extends User {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> private String shortName;<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> private LoadingCache<String, String[]> cache;<a name="line.297"></a> |
| <span class="sourceLineNo">298</span><a name="line.298"></a> |
| <span class="sourceLineNo">299</span> public SecureHadoopUser() throws IOException {<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> ugi = UserGroupInformation.getCurrentUser();<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> this.cache = null;<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> }<a name="line.302"></a> |
| <span class="sourceLineNo">303</span><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> public SecureHadoopUser(UserGroupInformation ugi) {<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> this.ugi = ugi;<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> this.cache = null;<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> }<a name="line.307"></a> |
| <span class="sourceLineNo">308</span><a name="line.308"></a> |
| <span class="sourceLineNo">309</span> public SecureHadoopUser(UserGroupInformation ugi,<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> LoadingCache<String, String[]> cache) {<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> this.ugi = ugi;<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> this.cache = cache;<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> @Override<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> public String getShortName() {<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> if (shortName != null) return shortName;<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> try {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> shortName = ugi.getShortUserName();<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> return shortName;<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> } catch (Exception e) {<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> throw new RuntimeException("Unexpected error getting user short name",<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> e);<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> }<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> @Override<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> public String[] getGroupNames() {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> if (cache != null) {<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> try {<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> return this.cache.get(getShortName());<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> } catch (ExecutionException e) {<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> return new String[0];<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> return ugi.getGroupNames();<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> }<a name="line.337"></a> |
| <span class="sourceLineNo">338</span><a name="line.338"></a> |
| <span class="sourceLineNo">339</span> @Override<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> public <T> T runAs(PrivilegedAction<T> action) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> return ugi.doAs(action);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> @Override<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> public <T> T runAs(PrivilegedExceptionAction<T> action)<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> throws IOException, InterruptedException {<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> return ugi.doAs(action);<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> /** @see User#createUserForTesting(org.apache.hadoop.conf.Configuration, String, String[]) */<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> public static User createUserForTesting(Configuration conf,<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> String name, String[] groups) {<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> synchronized (UserProvider.class) {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> if (!(UserProvider.groups instanceof TestingGroups) ||<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> conf.getBoolean(TestingGroups.TEST_CONF, false)) {<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> UserProvider.groups = new TestingGroups(UserProvider.groups);<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> }<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> }<a name="line.358"></a> |
| <span class="sourceLineNo">359</span><a name="line.359"></a> |
| <span class="sourceLineNo">360</span> ((TestingGroups)UserProvider.groups).setUserGroups(name, groups);<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> return new SecureHadoopUser(UserGroupInformation.createUserForTesting(name, groups));<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> /**<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * Obtain credentials for the current process using the configured<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * Kerberos keytab file and principal.<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * @see User#login(org.apache.hadoop.conf.Configuration, String, String, String)<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> *<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * @param conf the Configuration to use<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * @param fileConfKey Configuration property key used to store the path<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * to the keytab file<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * @param principalConfKey Configuration property key used to store the<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * principal name to login as<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> * @param localhost the local hostname<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> */<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> public static void login(Configuration conf, String fileConfKey,<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> String principalConfKey, String localhost) throws IOException {<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> if (isSecurityEnabled()) {<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> SecurityUtil.login(conf, fileConfKey, principalConfKey, localhost);<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> }<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> }<a name="line.381"></a> |
| <span class="sourceLineNo">382</span><a name="line.382"></a> |
| <span class="sourceLineNo">383</span> /**<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * Login through configured keytab and pricipal.<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * @param keytabLocation location of keytab<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * @param principalName principal in keytab<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * @throws IOException exception from UserGroupInformation.loginUserFromKeytab<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> */<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> public static void login(String keytabLocation, String principalName)<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> throws IOException {<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> if (isSecurityEnabled()) {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> UserGroupInformation.loginUserFromKeytab(principalName, keytabLocation);<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> }<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span><a name="line.395"></a> |
| <span class="sourceLineNo">396</span> /**<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> * Returns the result of {@code UserGroupInformation.isSecurityEnabled()}.<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> */<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> public static boolean isSecurityEnabled() {<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> return UserGroupInformation.isSecurityEnabled();<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> }<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span><a name="line.403"></a> |
| <span class="sourceLineNo">404</span> public static class TestingGroups extends Groups {<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> public static final String TEST_CONF = "hbase.group.service.for.test.only";<a name="line.405"></a> |
| <span class="sourceLineNo">406</span><a name="line.406"></a> |
| <span class="sourceLineNo">407</span> private final Map<String, List<String>> userToGroupsMapping = new HashMap<>();<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> private Groups underlyingImplementation;<a name="line.408"></a> |
| <span class="sourceLineNo">409</span><a name="line.409"></a> |
| <span class="sourceLineNo">410</span> public TestingGroups(Groups underlyingImplementation) {<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> super(new Configuration());<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> this.underlyingImplementation = underlyingImplementation;<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> }<a name="line.413"></a> |
| <span class="sourceLineNo">414</span><a name="line.414"></a> |
| <span class="sourceLineNo">415</span> @Override<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> public List<String> getGroups(String user) throws IOException {<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> List<String> result = userToGroupsMapping.get(user);<a name="line.417"></a> |
| <span class="sourceLineNo">418</span><a name="line.418"></a> |
| <span class="sourceLineNo">419</span> if (result == null) {<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> result = underlyingImplementation.getGroups(user);<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> }<a name="line.421"></a> |
| <span class="sourceLineNo">422</span><a name="line.422"></a> |
| <span class="sourceLineNo">423</span> return result;<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> }<a name="line.424"></a> |
| <span class="sourceLineNo">425</span><a name="line.425"></a> |
| <span class="sourceLineNo">426</span> private void setUserGroups(String user, String[] groups) {<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> userToGroupsMapping.put(user, Arrays.asList(groups));<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> }<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> }<a name="line.429"></a> |
| <span class="sourceLineNo">430</span>}<a name="line.430"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
