Google Git
Sign in
apache / hbase-site / 8ac68d4b7a8449d1b079203ac526389e2358d31e / . / devapidocs / src-html / org / apache / hadoop / hbase / security / UserProvider.html
blob: 8d950d1aff129984c4e079b078c370fd124092e6 [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 java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.LinkedHashSet;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Set;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.Callable;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.Executors;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.TimeUnit;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.conf.Configuration;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.fs.CommonConfigurationKeys;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.BaseConfigurable;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.security.Groups;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.util.ReflectionUtils;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hbase.thirdparty.com.google.common.cache.CacheBuilder;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hbase.thirdparty.com.google.common.cache.CacheLoader;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hbase.thirdparty.com.google.common.cache.LoadingCache;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hbase.thirdparty.com.google.common.util.concurrent.ListenableFuture;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hbase.thirdparty.com.google.common.util.concurrent.ListeningExecutorService;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hbase.thirdparty.com.google.common.util.concurrent.MoreExecutors;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hbase.thirdparty.com.google.common.util.concurrent.ThreadFactoryBuilder;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>/**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Provide an instance of a user. Allows custom {@link User} creation.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span>@InterfaceAudience.Private<a name="line.47"></a>
<span class="sourceLineNo">048</span>public class UserProvider extends BaseConfigurable {<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final String USER_PROVIDER_CONF_KEY = "hbase.client.userprovider.class";<a name="line.50"></a>
<span class="sourceLineNo">051</span> private static final ListeningExecutorService executor = MoreExecutors.listeningDecorator(<a name="line.51"></a>
<span class="sourceLineNo">052</span> Executors.newScheduledThreadPool(<a name="line.52"></a>
<span class="sourceLineNo">053</span> 1,<a name="line.53"></a>
<span class="sourceLineNo">054</span> new ThreadFactoryBuilder().setDaemon(true).setNameFormat("group-cache-%d").build()));<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> private LoadingCache&lt;String, String[]&gt; groupCache = null;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> static Groups groups = Groups.getUserToGroupsMappingService();<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> @VisibleForTesting<a name="line.60"></a>
<span class="sourceLineNo">061</span> public static Groups getGroups() {<a name="line.61"></a>
<span class="sourceLineNo">062</span> return groups;<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> public static void setGroups(Groups groups) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> UserProvider.groups = groups;<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> @Override<a name="line.69"></a>
<span class="sourceLineNo">070</span> public void setConf(final Configuration conf) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> super.setConf(conf);<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> synchronized (UserProvider.class) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> if (!(groups instanceof User.TestingGroups)) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> groups = Groups.getUserToGroupsMappingService(conf);<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<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> long cacheTimeout =<a name="line.79"></a>
<span class="sourceLineNo">080</span> getConf().getLong(CommonConfigurationKeys.HADOOP_SECURITY_GROUPS_CACHE_SECS,<a name="line.80"></a>
<span class="sourceLineNo">081</span> CommonConfigurationKeys.HADOOP_SECURITY_GROUPS_CACHE_SECS_DEFAULT) * 1000;<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> this.groupCache = CacheBuilder.newBuilder()<a name="line.83"></a>
<span class="sourceLineNo">084</span> // This is the same timeout that hadoop uses. So we'll follow suit.<a name="line.84"></a>
<span class="sourceLineNo">085</span> .refreshAfterWrite(cacheTimeout, TimeUnit.MILLISECONDS)<a name="line.85"></a>
<span class="sourceLineNo">086</span> .expireAfterWrite(10 * cacheTimeout, TimeUnit.MILLISECONDS)<a name="line.86"></a>
<span class="sourceLineNo">087</span> // Set concurrency level equal to the default number of handlers that<a name="line.87"></a>
<span class="sourceLineNo">088</span> // the simple handler spins up.<a name="line.88"></a>
<span class="sourceLineNo">089</span> .concurrencyLevel(20)<a name="line.89"></a>
<span class="sourceLineNo">090</span> // create the loader<a name="line.90"></a>
<span class="sourceLineNo">091</span> // This just delegates to UGI.<a name="line.91"></a>
<span class="sourceLineNo">092</span> .build(new CacheLoader&lt;String, String[]&gt;() {<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> // Since UGI's don't hash based on the user id<a name="line.94"></a>
<span class="sourceLineNo">095</span> // The cache needs to be keyed on the same thing that Hadoop's Groups class<a name="line.95"></a>
<span class="sourceLineNo">096</span> // uses. So this cache uses shortname.<a name="line.96"></a>
<span class="sourceLineNo">097</span> @Override<a name="line.97"></a>
<span class="sourceLineNo">098</span> public String[] load(String ugi) throws Exception {<a name="line.98"></a>
<span class="sourceLineNo">099</span> return getGroupStrings(ugi);<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> private String[] getGroupStrings(String ugi) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> try {<a name="line.103"></a>
<span class="sourceLineNo">104</span> Set&lt;String&gt; result = new LinkedHashSet&lt;&gt;(groups.getGroups(ugi));<a name="line.104"></a>
<span class="sourceLineNo">105</span> return result.toArray(new String[result.size()]);<a name="line.105"></a>
<span class="sourceLineNo">106</span> } catch (Exception e) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> return new String[0];<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> // Provide the reload function that uses the executor thread.<a name="line.111"></a>
<span class="sourceLineNo">112</span> @Override<a name="line.112"></a>
<span class="sourceLineNo">113</span> public ListenableFuture&lt;String[]&gt; reload(final String k, String[] oldValue)<a name="line.113"></a>
<span class="sourceLineNo">114</span> throws Exception {<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> return executor.submit(new Callable&lt;String[]&gt;() {<a name="line.116"></a>
<span class="sourceLineNo">117</span> @Override<a name="line.117"></a>
<span class="sourceLineNo">118</span> public String[] call() throws Exception {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return getGroupStrings(k);<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> });<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> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * Instantiate the {@link UserProvider} specified in the configuration and set the passed<a name="line.127"></a>
<span class="sourceLineNo">128</span> * configuration via {@link UserProvider#setConf(Configuration)}<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @param conf to read and set on the created {@link UserProvider}<a name="line.129"></a>
<span class="sourceLineNo">130</span> * @return a {@link UserProvider} ready for use.<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> public static UserProvider instantiate(Configuration conf) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> Class&lt;? extends UserProvider&gt; clazz =<a name="line.133"></a>
<span class="sourceLineNo">134</span> conf.getClass(USER_PROVIDER_CONF_KEY, UserProvider.class, UserProvider.class);<a name="line.134"></a>
<span class="sourceLineNo">135</span> return ReflectionUtils.newInstance(clazz, conf);<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> * Set the {@link UserProvider} in the given configuration that should be instantiated<a name="line.139"></a>
<span class="sourceLineNo">140</span> * @param conf to update<a name="line.140"></a>
<span class="sourceLineNo">141</span> * @param provider class of the provider to set<a name="line.141"></a>
<span class="sourceLineNo">142</span> */<a name="line.142"></a>
<span class="sourceLineNo">143</span> public static void setUserProviderForTesting(Configuration conf,<a name="line.143"></a>
<span class="sourceLineNo">144</span> Class&lt;? extends UserProvider&gt; provider) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> conf.set(USER_PROVIDER_CONF_KEY, provider.getName());<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> /**<a name="line.148"></a>
<span class="sourceLineNo">149</span> * @return the userName for the current logged-in user.<a name="line.149"></a>
<span class="sourceLineNo">150</span> * @throws IOException if the underlying user cannot be obtained<a name="line.150"></a>
<span class="sourceLineNo">151</span> */<a name="line.151"></a>
<span class="sourceLineNo">152</span> public String getCurrentUserName() throws IOException {<a name="line.152"></a>
<span class="sourceLineNo">153</span> User user = getCurrent();<a name="line.153"></a>
<span class="sourceLineNo">154</span> return user == null ? null : user.getName();<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<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> * @return &lt;tt&gt;true&lt;/tt&gt; if security is enabled, &lt;tt&gt;false&lt;/tt&gt; otherwise<a name="line.158"></a>
<span class="sourceLineNo">159</span> */<a name="line.159"></a>
<span class="sourceLineNo">160</span> public boolean isHBaseSecurityEnabled() {<a name="line.160"></a>
<span class="sourceLineNo">161</span> return User.isHBaseSecurityEnabled(this.getConf());<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> /**<a name="line.164"></a>
<span class="sourceLineNo">165</span> * @return whether or not Kerberos authentication is configured for Hadoop. For non-secure Hadoop,<a name="line.165"></a>
<span class="sourceLineNo">166</span> * this always returns &lt;code&gt;false&lt;/code&gt;. For secure Hadoop, it will return the value<a name="line.166"></a>
<span class="sourceLineNo">167</span> * from {@code UserGroupInformation.isSecurityEnabled()}.<a name="line.167"></a>
<span class="sourceLineNo">168</span> */<a name="line.168"></a>
<span class="sourceLineNo">169</span> public boolean isHadoopSecurityEnabled() {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return User.isSecurityEnabled();<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<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> * In secure environment, if a user specified his keytab and principal,<a name="line.174"></a>
<span class="sourceLineNo">175</span> * a hbase client will try to login with them. Otherwise, hbase client will try to obtain<a name="line.175"></a>
<span class="sourceLineNo">176</span> * ticket(through kinit) from system.<a name="line.176"></a>
<span class="sourceLineNo">177</span> */<a name="line.177"></a>
<span class="sourceLineNo">178</span> public boolean shouldLoginFromKeytab() {<a name="line.178"></a>
<span class="sourceLineNo">179</span> return User.shouldLoginFromKeytab(this.getConf());<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> /**<a name="line.182"></a>
<span class="sourceLineNo">183</span> * @return the current user within the current execution context<a name="line.183"></a>
<span class="sourceLineNo">184</span> * @throws IOException if the user cannot be loaded<a name="line.184"></a>
<span class="sourceLineNo">185</span> */<a name="line.185"></a>
<span class="sourceLineNo">186</span> public User getCurrent() throws IOException {<a name="line.186"></a>
<span class="sourceLineNo">187</span> return User.getCurrent();<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> /**<a name="line.190"></a>
<span class="sourceLineNo">191</span> * Wraps an underlying {@code UserGroupInformation} instance.<a name="line.191"></a>
<span class="sourceLineNo">192</span> * @param ugi The base Hadoop user<a name="line.192"></a>
<span class="sourceLineNo">193</span> * @return User<a name="line.193"></a>
<span class="sourceLineNo">194</span> */<a name="line.194"></a>
<span class="sourceLineNo">195</span> public User create(UserGroupInformation ugi) {<a name="line.195"></a>
<span class="sourceLineNo">196</span> if (ugi == null) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> return null;<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span> return new User.SecureHadoopUser(ugi, groupCache);<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> /**<a name="line.202"></a>
<span class="sourceLineNo">203</span> * Log in the current process using the given configuration keys for the credential file and login<a name="line.203"></a>
<span class="sourceLineNo">204</span> * principal. It is for SPN(Service Principal Name) login. SPN should be this format,<a name="line.204"></a>
<span class="sourceLineNo">205</span> * servicename/fully.qualified.domain.name@REALM.<a name="line.205"></a>
<span class="sourceLineNo">206</span> * &lt;p&gt;<a name="line.206"></a>
<span class="sourceLineNo">207</span> * &lt;strong&gt;This is only applicable when running on secure Hadoop&lt;/strong&gt; -- see<a name="line.207"></a>
<span class="sourceLineNo">208</span> * org.apache.hadoop.security.SecurityUtil#login(Configuration,String,String,String). On regular<a name="line.208"></a>
<span class="sourceLineNo">209</span> * Hadoop (without security features), this will safely be ignored.<a name="line.209"></a>
<span class="sourceLineNo">210</span> * &lt;/p&gt;<a name="line.210"></a>
<span class="sourceLineNo">211</span> * @param fileConfKey Property key used to configure path to the credential file<a name="line.211"></a>
<span class="sourceLineNo">212</span> * @param principalConfKey Property key used to configure login principal<a name="line.212"></a>
<span class="sourceLineNo">213</span> * @param localhost Current hostname to use in any credentials<a name="line.213"></a>
<span class="sourceLineNo">214</span> * @throws IOException underlying exception from SecurityUtil.login() call<a name="line.214"></a>
<span class="sourceLineNo">215</span> */<a name="line.215"></a>
<span class="sourceLineNo">216</span> public void login(String fileConfKey, String principalConfKey, String localhost)<a name="line.216"></a>
<span class="sourceLineNo">217</span> throws IOException {<a name="line.217"></a>
<span class="sourceLineNo">218</span> User.login(getConf(), fileConfKey, principalConfKey, localhost);<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<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> * Login with given keytab and principal. This can be used for both SPN(Service Principal Name)<a name="line.222"></a>
<span class="sourceLineNo">223</span> * and UPN(User Principal Name) which format should be clientname@REALM.<a name="line.223"></a>
<span class="sourceLineNo">224</span> * @param fileConfKey config name for client keytab<a name="line.224"></a>
<span class="sourceLineNo">225</span> * @param principalConfKey config name for client principal<a name="line.225"></a>
<span class="sourceLineNo">226</span> * @throws IOException underlying exception from UserGroupInformation.loginUserFromKeytab<a name="line.226"></a>
<span class="sourceLineNo">227</span> */<a name="line.227"></a>
<span class="sourceLineNo">228</span> public void login(String fileConfKey, String principalConfKey) throws IOException {<a name="line.228"></a>
<span class="sourceLineNo">229</span> User.login(getConf().get(fileConfKey), getConf().get(principalConfKey));<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span>}<a name="line.231"></a>
</pre>
</div>
</body>
</html>