http://git-wip-us.apache.org/repos/asf/hbase-site/blob/5fd895c6/apidocs/src-html/org/apache/hadoop/hbase/AuthUtil.html
----------------------------------------------------------------------
diff --git a/apidocs/src-html/org/apache/hadoop/hbase/AuthUtil.html
b/apidocs/src-html/org/apache/hadoop/hbase/AuthUtil.html
index f16f8df..30bba22 100644
--- a/apidocs/src-html/org/apache/hadoop/hbase/AuthUtil.html
+++ b/apidocs/src-html/org/apache/hadoop/hbase/AuthUtil.html
@@ -30,152 +30,254 @@
<span class="sourceLineNo">022</span>import java.net.UnknownHostException;<a
name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import
org.apache.hadoop.conf.Configuration;<a name="line.24"></a>
-<span class="sourceLineNo">025</span>import
org.apache.hadoop.hbase.security.UserProvider;<a name="line.25"></a>
-<span class="sourceLineNo">026</span>import
org.apache.hadoop.hbase.util.DNS;<a name="line.26"></a>
-<span class="sourceLineNo">027</span>import
org.apache.hadoop.hbase.util.Strings;<a name="line.27"></a>
-<span class="sourceLineNo">028</span>import
org.apache.hadoop.security.UserGroupInformation;<a name="line.28"></a>
-<span class="sourceLineNo">029</span>import
org.apache.yetus.audience.InterfaceAudience;<a name="line.29"></a>
-<span class="sourceLineNo">030</span>import org.slf4j.Logger;<a
name="line.30"></a>
-<span class="sourceLineNo">031</span>import org.slf4j.LoggerFactory;<a
name="line.31"></a>
-<span class="sourceLineNo">032</span><a name="line.32"></a>
-<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
-<span class="sourceLineNo">034</span> * Utility methods for helping with
security tasks. Downstream users<a name="line.34"></a>
-<span class="sourceLineNo">035</span> * may rely on this class to handle
authenticating via keytab where<a name="line.35"></a>
-<span class="sourceLineNo">036</span> * long running services need access to a
secure HBase cluster.<a name="line.36"></a>
-<span class="sourceLineNo">037</span> *<a name="line.37"></a>
-<span class="sourceLineNo">038</span> * Callers must ensure:<a
name="line.38"></a>
-<span class="sourceLineNo">039</span> *<a name="line.39"></a>
-<span class="sourceLineNo">040</span> * <ul><a name="line.40"></a>
-<span class="sourceLineNo">041</span> * <li>HBase configuration files
are in the Classpath<a name="line.41"></a>
-<span class="sourceLineNo">042</span> * <li>hbase.client.keytab.file
points to a valid keytab on the local filesystem<a name="line.42"></a>
-<span class="sourceLineNo">043</span> *
<li>hbase.client.kerberos.principal gives the Kerberos principal to use<a
name="line.43"></a>
-<span class="sourceLineNo">044</span> * </ul><a name="line.44"></a>
-<span class="sourceLineNo">045</span> *<a name="line.45"></a>
-<span class="sourceLineNo">046</span> * <pre><a name="line.46"></a>
-<span class="sourceLineNo">047</span> * {@code<a name="line.47"></a>
-<span class="sourceLineNo">048</span> * ChoreService choreService = null;<a
name="line.48"></a>
-<span class="sourceLineNo">049</span> * // Presumes HBase configuration
files are on the classpath<a name="line.49"></a>
-<span class="sourceLineNo">050</span> * final Configuration conf =
HBaseConfiguration.create();<a name="line.50"></a>
-<span class="sourceLineNo">051</span> * final ScheduledChore authChore =
AuthUtil.getAuthChore(conf);<a name="line.51"></a>
-<span class="sourceLineNo">052</span> * if (authChore != null) {<a
name="line.52"></a>
-<span class="sourceLineNo">053</span> * choreService = new
ChoreService("MY_APPLICATION");<a name="line.53"></a>
-<span class="sourceLineNo">054</span> *
choreService.scheduleChore(authChore);<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * }<a name="line.55"></a>
-<span class="sourceLineNo">056</span> * try {<a name="line.56"></a>
-<span class="sourceLineNo">057</span> * // do application work<a
name="line.57"></a>
-<span class="sourceLineNo">058</span> * } finally {<a name="line.58"></a>
-<span class="sourceLineNo">059</span> * if (choreService != null) {<a
name="line.59"></a>
-<span class="sourceLineNo">060</span> * choreService.shutdown();<a
name="line.60"></a>
-<span class="sourceLineNo">061</span> * }<a name="line.61"></a>
-<span class="sourceLineNo">062</span> * }<a name="line.62"></a>
-<span class="sourceLineNo">063</span> * }<a name="line.63"></a>
-<span class="sourceLineNo">064</span> * </pre><a name="line.64"></a>
-<span class="sourceLineNo">065</span> *<a name="line.65"></a>
-<span class="sourceLineNo">066</span> * See the "Running Canary in a
Kerberos-enabled Cluster" section of the HBase Reference Guide for<a
name="line.66"></a>
-<span class="sourceLineNo">067</span> * an example of configuring a user of
this Auth Chore to run on a secure cluster.<a name="line.67"></a>
-<span class="sourceLineNo">068</span> */<a name="line.68"></a>
-<span class="sourceLineNo">069</span>@InterfaceAudience.Public<a
name="line.69"></a>
-<span class="sourceLineNo">070</span>public class AuthUtil {<a
name="line.70"></a>
-<span class="sourceLineNo">071</span> private static final Logger LOG =
LoggerFactory.getLogger(AuthUtil.class);<a name="line.71"></a>
-<span class="sourceLineNo">072</span><a name="line.72"></a>
-<span class="sourceLineNo">073</span> /** Prefix character to denote group
names */<a name="line.73"></a>
-<span class="sourceLineNo">074</span> private static final String
GROUP_PREFIX = "@";<a name="line.74"></a>
-<span class="sourceLineNo">075</span><a name="line.75"></a>
-<span class="sourceLineNo">076</span> private AuthUtil() {<a
name="line.76"></a>
-<span class="sourceLineNo">077</span> super();<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> /**<a name="line.80"></a>
-<span class="sourceLineNo">081</span> * Checks if security is enabled and if
so, launches chore for refreshing kerberos ticket.<a name="line.81"></a>
-<span class="sourceLineNo">082</span> * @param conf the hbase service
configuration<a name="line.82"></a>
-<span class="sourceLineNo">083</span> * @return a ScheduledChore for
renewals, if needed, and null otherwise.<a name="line.83"></a>
-<span class="sourceLineNo">084</span> */<a name="line.84"></a>
-<span class="sourceLineNo">085</span> public static ScheduledChore
getAuthChore(Configuration conf) throws IOException {<a name="line.85"></a>
-<span class="sourceLineNo">086</span> UserProvider userProvider =
UserProvider.instantiate(conf);<a name="line.86"></a>
-<span class="sourceLineNo">087</span> // login the principal (if using
secure Hadoop)<a name="line.87"></a>
-<span class="sourceLineNo">088</span> boolean securityEnabled =<a
name="line.88"></a>
-<span class="sourceLineNo">089</span>
userProvider.isHadoopSecurityEnabled() &&
userProvider.isHBaseSecurityEnabled();<a name="line.89"></a>
-<span class="sourceLineNo">090</span> if (!securityEnabled) return null;<a
name="line.90"></a>
-<span class="sourceLineNo">091</span> String host = null;<a
name="line.91"></a>
-<span class="sourceLineNo">092</span> try {<a name="line.92"></a>
-<span class="sourceLineNo">093</span> host =
Strings.domainNamePointerToHostName(DNS.getDefaultHost(<a name="line.93"></a>
-<span class="sourceLineNo">094</span>
conf.get("hbase.client.dns.interface", "default"),<a name="line.94"></a>
-<span class="sourceLineNo">095</span>
conf.get("hbase.client.dns.nameserver", "default")));<a name="line.95"></a>
-<span class="sourceLineNo">096</span>
userProvider.login("hbase.client.keytab.file",
"hbase.client.kerberos.principal", host);<a name="line.96"></a>
-<span class="sourceLineNo">097</span> } catch (UnknownHostException e) {<a
name="line.97"></a>
-<span class="sourceLineNo">098</span> LOG.error("Error resolving host
name: " + e.getMessage(), e);<a name="line.98"></a>
-<span class="sourceLineNo">099</span> throw e;<a name="line.99"></a>
-<span class="sourceLineNo">100</span> } catch (IOException e) {<a
name="line.100"></a>
-<span class="sourceLineNo">101</span> LOG.error("Error while trying to
perform the initial login: " + e.getMessage(), e);<a name="line.101"></a>
-<span class="sourceLineNo">102</span> throw e;<a name="line.102"></a>
-<span class="sourceLineNo">103</span> }<a name="line.103"></a>
-<span class="sourceLineNo">104</span><a name="line.104"></a>
-<span class="sourceLineNo">105</span> final UserGroupInformation ugi =
userProvider.getCurrent().getUGI();<a name="line.105"></a>
-<span class="sourceLineNo">106</span> Stoppable stoppable = new Stoppable()
{<a name="line.106"></a>
-<span class="sourceLineNo">107</span> private volatile boolean isStopped
= false;<a name="line.107"></a>
+<span class="sourceLineNo">025</span>import
org.apache.hadoop.hbase.security.User;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import
org.apache.hadoop.hbase.security.UserProvider;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import
org.apache.hadoop.hbase.util.DNS;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import
org.apache.hadoop.hbase.util.Strings;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import
org.apache.hadoop.security.UserGroupInformation;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import
org.apache.yetus.audience.InterfaceAudience;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import org.slf4j.Logger;<a
name="line.31"></a>
+<span class="sourceLineNo">032</span>import org.slf4j.LoggerFactory;<a
name="line.32"></a>
+<span class="sourceLineNo">033</span><a name="line.33"></a>
+<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * Utility methods for helping with
security tasks. Downstream users<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * may rely on this class to handle
authenticating via keytab where<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * long running services need access to a
secure HBase cluster.<a name="line.37"></a>
+<span class="sourceLineNo">038</span> *<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * Callers must ensure:<a
name="line.39"></a>
+<span class="sourceLineNo">040</span> *<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * <ul><a name="line.41"></a>
+<span class="sourceLineNo">042</span> * <li>HBase configuration files
are in the Classpath<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * <li>hbase.client.keytab.file
points to a valid keytab on the local filesystem<a name="line.43"></a>
+<span class="sourceLineNo">044</span> *
<li>hbase.client.kerberos.principal gives the Kerberos principal to use<a
name="line.44"></a>
+<span class="sourceLineNo">045</span> * </ul><a name="line.45"></a>
+<span class="sourceLineNo">046</span> *<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * <pre><a name="line.47"></a>
+<span class="sourceLineNo">048</span> * {@code<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * ChoreService choreService = null;<a
name="line.49"></a>
+<span class="sourceLineNo">050</span> * // Presumes HBase configuration
files are on the classpath<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * final Configuration conf =
HBaseConfiguration.create();<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * final ScheduledChore authChore =
AuthUtil.getAuthChore(conf);<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * if (authChore != null) {<a
name="line.53"></a>
+<span class="sourceLineNo">054</span> * choreService = new
ChoreService("MY_APPLICATION");<a name="line.54"></a>
+<span class="sourceLineNo">055</span> *
choreService.scheduleChore(authChore);<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * }<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * try {<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * // do application work<a
name="line.58"></a>
+<span class="sourceLineNo">059</span> * } finally {<a name="line.59"></a>
+<span class="sourceLineNo">060</span> * if (choreService != null) {<a
name="line.60"></a>
+<span class="sourceLineNo">061</span> * choreService.shutdown();<a
name="line.61"></a>
+<span class="sourceLineNo">062</span> * }<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> * </pre><a name="line.65"></a>
+<span class="sourceLineNo">066</span> *<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * See the "Running Canary in a
Kerberos-enabled Cluster" section of the HBase Reference Guide for<a
name="line.67"></a>
+<span class="sourceLineNo">068</span> * an example of configuring a user of
this Auth Chore to run on a secure cluster.<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * <pre><a name="line.69"></a>
+<span class="sourceLineNo">070</span> * </pre><a name="line.70"></a>
+<span class="sourceLineNo">071</span> * This class will be internal use only
from 2.2.0 version, and will transparently work<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * for kerberized applications. For more,
please refer<a name="line.72"></a>
+<span class="sourceLineNo">073</span> * <a
href="http://hbase.apache.org/book.html#hbase.secure.configuration">Client-side
Configuration for Secure Operation</a><a name="line.73"></a>
+<span class="sourceLineNo">074</span> *<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * @deprecated since 2.2.0, to be removed
in hbase-3.0.0.<a name="line.75"></a>
+<span class="sourceLineNo">076</span> */<a name="line.76"></a>
+<span class="sourceLineNo">077</span>@Deprecated<a name="line.77"></a>
+<span class="sourceLineNo">078</span>@InterfaceAudience.Public<a
name="line.78"></a>
+<span class="sourceLineNo">079</span>public final class AuthUtil {<a
name="line.79"></a>
+<span class="sourceLineNo">080</span> // TODO: Mark this class
InterfaceAudience.Private from 3.0.0<a name="line.80"></a>
+<span class="sourceLineNo">081</span> private static final Logger LOG =
LoggerFactory.getLogger(AuthUtil.class);<a name="line.81"></a>
+<span class="sourceLineNo">082</span><a name="line.82"></a>
+<span class="sourceLineNo">083</span> /** Prefix character to denote group
names */<a name="line.83"></a>
+<span class="sourceLineNo">084</span> private static final String
GROUP_PREFIX = "@";<a name="line.84"></a>
+<span class="sourceLineNo">085</span><a name="line.85"></a>
+<span class="sourceLineNo">086</span> /** Client keytab file */<a
name="line.86"></a>
+<span class="sourceLineNo">087</span> public static final String
HBASE_CLIENT_KEYTAB_FILE = "hbase.client.keytab.file";<a name="line.87"></a>
+<span class="sourceLineNo">088</span><a name="line.88"></a>
+<span class="sourceLineNo">089</span> /** Client principal */<a
name="line.89"></a>
+<span class="sourceLineNo">090</span> public static final String
HBASE_CLIENT_KERBEROS_PRINCIPAL = "hbase.client.keytab.principal";<a
name="line.90"></a>
+<span class="sourceLineNo">091</span><a name="line.91"></a>
+<span class="sourceLineNo">092</span> private AuthUtil() {<a
name="line.92"></a>
+<span class="sourceLineNo">093</span> super();<a name="line.93"></a>
+<span class="sourceLineNo">094</span> }<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> * For kerberized cluster, return login
user (from kinit or from keytab if specified).<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * For non-kerberized cluster, return
system user.<a name="line.98"></a>
+<span class="sourceLineNo">099</span> * @param conf configuartion file<a
name="line.99"></a>
+<span class="sourceLineNo">100</span> * @return user<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * @throws IOException login
exception<a name="line.101"></a>
+<span class="sourceLineNo">102</span> */<a name="line.102"></a>
+<span class="sourceLineNo">103</span> @InterfaceAudience.Private<a
name="line.103"></a>
+<span class="sourceLineNo">104</span> public static User
loginClient(Configuration conf) throws IOException {<a name="line.104"></a>
+<span class="sourceLineNo">105</span> UserProvider provider =
UserProvider.instantiate(conf);<a name="line.105"></a>
+<span class="sourceLineNo">106</span> User user = provider.getCurrent();<a
name="line.106"></a>
+<span class="sourceLineNo">107</span> boolean securityOn =
provider.isHBaseSecurityEnabled() &&
provider.isHadoopSecurityEnabled();<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
-<span class="sourceLineNo">109</span> @Override<a name="line.109"></a>
-<span class="sourceLineNo">110</span> public void stop(String why) {<a
name="line.110"></a>
-<span class="sourceLineNo">111</span> isStopped = true;<a
name="line.111"></a>
-<span class="sourceLineNo">112</span> }<a name="line.112"></a>
-<span class="sourceLineNo">113</span><a name="line.113"></a>
-<span class="sourceLineNo">114</span> @Override<a name="line.114"></a>
-<span class="sourceLineNo">115</span> public boolean isStopped() {<a
name="line.115"></a>
-<span class="sourceLineNo">116</span> return isStopped;<a
name="line.116"></a>
-<span class="sourceLineNo">117</span> }<a name="line.117"></a>
-<span class="sourceLineNo">118</span> };<a name="line.118"></a>
-<span class="sourceLineNo">119</span><a name="line.119"></a>
-<span class="sourceLineNo">120</span> // if you're in debug mode this is
useful to avoid getting spammed by the getTGT()<a name="line.120"></a>
-<span class="sourceLineNo">121</span> // you can increase this, keeping in
mind that the default refresh window is 0.8<a name="line.121"></a>
-<span class="sourceLineNo">122</span> // e.g. 5min tgt * 0.8 = 4min refresh
so interval is better be way less than 1min<a name="line.122"></a>
-<span class="sourceLineNo">123</span> final int CHECK_TGT_INTERVAL = 30 *
1000; // 30sec<a name="line.123"></a>
-<span class="sourceLineNo">124</span><a name="line.124"></a>
-<span class="sourceLineNo">125</span> ScheduledChore refreshCredentials =<a
name="line.125"></a>
-<span class="sourceLineNo">126</span> new
ScheduledChore("RefreshCredentials", stoppable, CHECK_TGT_INTERVAL) {<a
name="line.126"></a>
-<span class="sourceLineNo">127</span> @Override<a name="line.127"></a>
-<span class="sourceLineNo">128</span> protected void chore() {<a
name="line.128"></a>
-<span class="sourceLineNo">129</span> try {<a name="line.129"></a>
-<span class="sourceLineNo">130</span>
ugi.checkTGTAndReloginFromKeytab();<a name="line.130"></a>
-<span class="sourceLineNo">131</span> } catch (IOException e) {<a
name="line.131"></a>
-<span class="sourceLineNo">132</span> LOG.error("Got exception while
trying to refresh credentials: " + e.getMessage(), e);<a name="line.132"></a>
-<span class="sourceLineNo">133</span> }<a name="line.133"></a>
-<span class="sourceLineNo">134</span> }<a name="line.134"></a>
-<span class="sourceLineNo">135</span> };<a name="line.135"></a>
-<span class="sourceLineNo">136</span><a name="line.136"></a>
-<span class="sourceLineNo">137</span> return refreshCredentials;<a
name="line.137"></a>
-<span class="sourceLineNo">138</span> }<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> * Returns whether or not the given
name should be interpreted as a group<a name="line.141"></a>
-<span class="sourceLineNo">142</span> * principal. Currently this simply
checks if the name starts with the<a name="line.142"></a>
-<span class="sourceLineNo">143</span> * special group prefix character
("@").<a name="line.143"></a>
-<span class="sourceLineNo">144</span> */<a name="line.144"></a>
-<span class="sourceLineNo">145</span> @InterfaceAudience.Private<a
name="line.145"></a>
-<span class="sourceLineNo">146</span> public static boolean
isGroupPrincipal(String name) {<a name="line.146"></a>
-<span class="sourceLineNo">147</span> return name != null &&
name.startsWith(GROUP_PREFIX);<a name="line.147"></a>
-<span class="sourceLineNo">148</span> }<a name="line.148"></a>
-<span class="sourceLineNo">149</span><a name="line.149"></a>
-<span class="sourceLineNo">150</span> /**<a name="line.150"></a>
-<span class="sourceLineNo">151</span> * Returns the actual name for a group
principal (stripped of the<a name="line.151"></a>
-<span class="sourceLineNo">152</span> * group prefix).<a name="line.152"></a>
-<span class="sourceLineNo">153</span> */<a name="line.153"></a>
-<span class="sourceLineNo">154</span> @InterfaceAudience.Private<a
name="line.154"></a>
-<span class="sourceLineNo">155</span> public static String
getGroupName(String aclKey) {<a name="line.155"></a>
-<span class="sourceLineNo">156</span> if (!isGroupPrincipal(aclKey)) {<a
name="line.156"></a>
-<span class="sourceLineNo">157</span> return aclKey;<a
name="line.157"></a>
-<span class="sourceLineNo">158</span> }<a name="line.158"></a>
-<span class="sourceLineNo">159</span><a name="line.159"></a>
-<span class="sourceLineNo">160</span> return
aclKey.substring(GROUP_PREFIX.length());<a name="line.160"></a>
-<span class="sourceLineNo">161</span> }<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> * Returns the group entry with the
group prefix for a group principal.<a name="line.164"></a>
-<span class="sourceLineNo">165</span> */<a name="line.165"></a>
-<span class="sourceLineNo">166</span> @InterfaceAudience.Private<a
name="line.166"></a>
-<span class="sourceLineNo">167</span> public static String
toGroupEntry(String name) {<a name="line.167"></a>
-<span class="sourceLineNo">168</span> return GROUP_PREFIX + name;<a
name="line.168"></a>
-<span class="sourceLineNo">169</span> }<a name="line.169"></a>
-<span class="sourceLineNo">170</span>}<a name="line.170"></a>
+<span class="sourceLineNo">109</span> if (securityOn) {<a
name="line.109"></a>
+<span class="sourceLineNo">110</span> boolean fromKeytab =
provider.shouldLoginFromKeytab();<a name="line.110"></a>
+<span class="sourceLineNo">111</span> if
(user.getUGI().hasKerberosCredentials()) {<a name="line.111"></a>
+<span class="sourceLineNo">112</span> // There's already a login
user.<a name="line.112"></a>
+<span class="sourceLineNo">113</span> // But we should avoid misuse
credentials which is a dangerous security issue,<a name="line.113"></a>
+<span class="sourceLineNo">114</span> // so here check whether user
specified a keytab and a principal:<a name="line.114"></a>
+<span class="sourceLineNo">115</span> // 1. Yes, check if user
principal match.<a name="line.115"></a>
+<span class="sourceLineNo">116</span> // a. match, just return.<a
name="line.116"></a>
+<span class="sourceLineNo">117</span> // b. mismatch, login using
keytab.<a name="line.117"></a>
+<span class="sourceLineNo">118</span> // 2. No, user may login through
kinit, this is the old way, also just return.<a name="line.118"></a>
+<span class="sourceLineNo">119</span> if (fromKeytab) {<a
name="line.119"></a>
+<span class="sourceLineNo">120</span> return
checkPrincipalMatch(conf, user.getUGI().getUserName()) ? user :<a
name="line.120"></a>
+<span class="sourceLineNo">121</span>
loginFromKeytabAndReturnUser(provider);<a name="line.121"></a>
+<span class="sourceLineNo">122</span> }<a name="line.122"></a>
+<span class="sourceLineNo">123</span> return user;<a
name="line.123"></a>
+<span class="sourceLineNo">124</span> } else if (fromKeytab) {<a
name="line.124"></a>
+<span class="sourceLineNo">125</span> // Kerberos is on and client
specify a keytab and principal, but client doesn't login yet.<a
name="line.125"></a>
+<span class="sourceLineNo">126</span> return
loginFromKeytabAndReturnUser(provider);<a name="line.126"></a>
+<span class="sourceLineNo">127</span> }<a name="line.127"></a>
+<span class="sourceLineNo">128</span> }<a name="line.128"></a>
+<span class="sourceLineNo">129</span> return user;<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> private static boolean
checkPrincipalMatch(Configuration conf, String loginUserName) {<a
name="line.132"></a>
+<span class="sourceLineNo">133</span> String configuredUserName =
conf.get(HBASE_CLIENT_KERBEROS_PRINCIPAL);<a name="line.133"></a>
+<span class="sourceLineNo">134</span> boolean match =
configuredUserName.equals(loginUserName);<a name="line.134"></a>
+<span class="sourceLineNo">135</span> if (!match) {<a name="line.135"></a>
+<span class="sourceLineNo">136</span> LOG.warn("Trying to login with a
different user: {}, existed user is {}.",<a name="line.136"></a>
+<span class="sourceLineNo">137</span> configuredUserName,
loginUserName);<a name="line.137"></a>
+<span class="sourceLineNo">138</span> }<a name="line.138"></a>
+<span class="sourceLineNo">139</span> return match;<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> private static User
loginFromKeytabAndReturnUser(UserProvider provider) throws IOException {<a
name="line.142"></a>
+<span class="sourceLineNo">143</span> try {<a name="line.143"></a>
+<span class="sourceLineNo">144</span>
provider.login(HBASE_CLIENT_KEYTAB_FILE, HBASE_CLIENT_KERBEROS_PRINCIPAL);<a
name="line.144"></a>
+<span class="sourceLineNo">145</span> } catch (IOException ioe) {<a
name="line.145"></a>
+<span class="sourceLineNo">146</span> LOG.error("Error while trying to
login as user {} through {}, with message: {}.",<a name="line.146"></a>
+<span class="sourceLineNo">147</span> HBASE_CLIENT_KERBEROS_PRINCIPAL,
HBASE_CLIENT_KEYTAB_FILE,<a name="line.147"></a>
+<span class="sourceLineNo">148</span> ioe.getMessage());<a
name="line.148"></a>
+<span class="sourceLineNo">149</span> throw ioe;<a name="line.149"></a>
+<span class="sourceLineNo">150</span> }<a name="line.150"></a>
+<span class="sourceLineNo">151</span> return provider.getCurrent();<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> /**<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * For kerberized cluster, return login
user (from kinit or from keytab).<a name="line.155"></a>
+<span class="sourceLineNo">156</span> * Principal should be the following
format: name/fully.qualified.domain.name@REALM.<a name="line.156"></a>
+<span class="sourceLineNo">157</span> * For non-kerberized cluster, return
system user.<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * <p><a name="line.158"></a>
+<span class="sourceLineNo">159</span> * NOT recommend to use to method
unless you're sure what you're doing, it is for canary only.<a
name="line.159"></a>
+<span class="sourceLineNo">160</span> * Please use User#loginClient.<a
name="line.160"></a>
+<span class="sourceLineNo">161</span> * @param conf configuration file<a
name="line.161"></a>
+<span class="sourceLineNo">162</span> * @return user<a name="line.162"></a>
+<span class="sourceLineNo">163</span> * @throws IOException login
exception<a name="line.163"></a>
+<span class="sourceLineNo">164</span> */<a name="line.164"></a>
+<span class="sourceLineNo">165</span> private static User
loginClientAsService(Configuration conf) throws IOException {<a
name="line.165"></a>
+<span class="sourceLineNo">166</span> UserProvider provider =
UserProvider.instantiate(conf);<a name="line.166"></a>
+<span class="sourceLineNo">167</span> if (provider.isHBaseSecurityEnabled()
&& provider.isHadoopSecurityEnabled()) {<a name="line.167"></a>
+<span class="sourceLineNo">168</span> try {<a name="line.168"></a>
+<span class="sourceLineNo">169</span> if
(provider.shouldLoginFromKeytab()) {<a name="line.169"></a>
+<span class="sourceLineNo">170</span> String host =
Strings.domainNamePointerToHostName(DNS.getDefaultHost(<a name="line.170"></a>
+<span class="sourceLineNo">171</span>
conf.get("hbase.client.dns.interface", "default"),<a name="line.171"></a>
+<span class="sourceLineNo">172</span>
conf.get("hbase.client.dns.nameserver", "default")));<a name="line.172"></a>
+<span class="sourceLineNo">173</span>
provider.login(HBASE_CLIENT_KEYTAB_FILE, HBASE_CLIENT_KERBEROS_PRINCIPAL,
host);<a name="line.173"></a>
+<span class="sourceLineNo">174</span> }<a name="line.174"></a>
+<span class="sourceLineNo">175</span> } catch (UnknownHostException e)
{<a name="line.175"></a>
+<span class="sourceLineNo">176</span> LOG.error("Error resolving host
name: " + e.getMessage(), e);<a name="line.176"></a>
+<span class="sourceLineNo">177</span> throw e;<a name="line.177"></a>
+<span class="sourceLineNo">178</span> } catch (IOException e) {<a
name="line.178"></a>
+<span class="sourceLineNo">179</span> LOG.error("Error while trying to
perform the initial login: " + e.getMessage(), e);<a name="line.179"></a>
+<span class="sourceLineNo">180</span> throw e;<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 provider.getCurrent();<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> * Checks if security is enabled and if
so, launches chore for refreshing kerberos ticket.<a name="line.187"></a>
+<span class="sourceLineNo">188</span> * @return a ScheduledChore for
renewals.<a name="line.188"></a>
+<span class="sourceLineNo">189</span> */<a name="line.189"></a>
+<span class="sourceLineNo">190</span> @InterfaceAudience.Private<a
name="line.190"></a>
+<span class="sourceLineNo">191</span> public static ScheduledChore
getAuthRenewalChore(final UserGroupInformation user) {<a name="line.191"></a>
+<span class="sourceLineNo">192</span> if (!user.hasKerberosCredentials())
{<a name="line.192"></a>
+<span class="sourceLineNo">193</span> return null;<a name="line.193"></a>
+<span class="sourceLineNo">194</span> }<a name="line.194"></a>
+<span class="sourceLineNo">195</span><a name="line.195"></a>
+<span class="sourceLineNo">196</span> Stoppable stoppable =
createDummyStoppable();<a name="line.196"></a>
+<span class="sourceLineNo">197</span> // if you're in debug mode this is
useful to avoid getting spammed by the getTGT()<a name="line.197"></a>
+<span class="sourceLineNo">198</span> // you can increase this, keeping in
mind that the default refresh window is 0.8<a name="line.198"></a>
+<span class="sourceLineNo">199</span> // e.g. 5min tgt * 0.8 = 4min refresh
so interval is better be way less than 1min<a name="line.199"></a>
+<span class="sourceLineNo">200</span> final int CHECK_TGT_INTERVAL = 30 *
1000; // 30sec<a name="line.200"></a>
+<span class="sourceLineNo">201</span> return new
ScheduledChore("RefreshCredentials", stoppable, CHECK_TGT_INTERVAL) {<a
name="line.201"></a>
+<span class="sourceLineNo">202</span> @Override<a name="line.202"></a>
+<span class="sourceLineNo">203</span> protected void chore() {<a
name="line.203"></a>
+<span class="sourceLineNo">204</span> try {<a name="line.204"></a>
+<span class="sourceLineNo">205</span>
user.checkTGTAndReloginFromKeytab();<a name="line.205"></a>
+<span class="sourceLineNo">206</span> } catch (IOException e) {<a
name="line.206"></a>
+<span class="sourceLineNo">207</span> LOG.error("Got exception while
trying to refresh credentials: " + e.getMessage(), e);<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> }<a name="line.211"></a>
+<span class="sourceLineNo">212</span><a name="line.212"></a>
+<span class="sourceLineNo">213</span> /**<a name="line.213"></a>
+<span class="sourceLineNo">214</span> * Checks if security is enabled and if
so, launches chore for refreshing kerberos ticket.<a name="line.214"></a>
+<span class="sourceLineNo">215</span> * @param conf the hbase service
configuration<a name="line.215"></a>
+<span class="sourceLineNo">216</span> * @return a ScheduledChore for
renewals, if needed, and null otherwise.<a name="line.216"></a>
+<span class="sourceLineNo">217</span> * @deprecated Deprecated since 2.2.0,
this method will be internal use only after 3.0.0.<a name="line.217"></a>
+<span class="sourceLineNo">218</span> */<a name="line.218"></a>
+<span class="sourceLineNo">219</span> @Deprecated<a name="line.219"></a>
+<span class="sourceLineNo">220</span> public static ScheduledChore
getAuthChore(Configuration conf) throws IOException {<a name="line.220"></a>
+<span class="sourceLineNo">221</span> // TODO: Mark this method
InterfaceAudience.Private from 3.0.0<a name="line.221"></a>
+<span class="sourceLineNo">222</span> User user =
loginClientAsService(conf);<a name="line.222"></a>
+<span class="sourceLineNo">223</span> return
getAuthRenewalChore(user.getUGI());<a name="line.223"></a>
+<span class="sourceLineNo">224</span> }<a name="line.224"></a>
+<span class="sourceLineNo">225</span><a name="line.225"></a>
+<span class="sourceLineNo">226</span> private static Stoppable
createDummyStoppable() {<a name="line.226"></a>
+<span class="sourceLineNo">227</span> return new Stoppable() {<a
name="line.227"></a>
+<span class="sourceLineNo">228</span> private volatile boolean isStopped
= false;<a name="line.228"></a>
+<span class="sourceLineNo">229</span><a name="line.229"></a>
+<span class="sourceLineNo">230</span> @Override<a name="line.230"></a>
+<span class="sourceLineNo">231</span> public void stop(String why) {<a
name="line.231"></a>
+<span class="sourceLineNo">232</span> isStopped = true;<a
name="line.232"></a>
+<span class="sourceLineNo">233</span> }<a name="line.233"></a>
+<span class="sourceLineNo">234</span><a name="line.234"></a>
+<span class="sourceLineNo">235</span> @Override<a name="line.235"></a>
+<span class="sourceLineNo">236</span> public boolean isStopped() {<a
name="line.236"></a>
+<span class="sourceLineNo">237</span> return isStopped;<a
name="line.237"></a>
+<span class="sourceLineNo">238</span> }<a name="line.238"></a>
+<span class="sourceLineNo">239</span> };<a name="line.239"></a>
+<span class="sourceLineNo">240</span> }<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> * Returns whether or not the given
name should be interpreted as a group<a name="line.243"></a>
+<span class="sourceLineNo">244</span> * principal. Currently this simply
checks if the name starts with the<a name="line.244"></a>
+<span class="sourceLineNo">245</span> * special group prefix character
("@").<a name="line.245"></a>
+<span class="sourceLineNo">246</span> */<a name="line.246"></a>
+<span class="sourceLineNo">247</span> @InterfaceAudience.Private<a
name="line.247"></a>
+<span class="sourceLineNo">248</span> public static boolean
isGroupPrincipal(String name) {<a name="line.248"></a>
+<span class="sourceLineNo">249</span> return name != null &&
name.startsWith(GROUP_PREFIX);<a name="line.249"></a>
+<span class="sourceLineNo">250</span> }<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> * Returns the actual name for a group
principal (stripped of the<a name="line.253"></a>
+<span class="sourceLineNo">254</span> * group prefix).<a name="line.254"></a>
+<span class="sourceLineNo">255</span> */<a name="line.255"></a>
+<span class="sourceLineNo">256</span> @InterfaceAudience.Private<a
name="line.256"></a>
+<span class="sourceLineNo">257</span> public static String
getGroupName(String aclKey) {<a name="line.257"></a>
+<span class="sourceLineNo">258</span> if (!isGroupPrincipal(aclKey)) {<a
name="line.258"></a>
+<span class="sourceLineNo">259</span> return aclKey;<a
name="line.259"></a>
+<span class="sourceLineNo">260</span> }<a name="line.260"></a>
+<span class="sourceLineNo">261</span><a name="line.261"></a>
+<span class="sourceLineNo">262</span> return
aclKey.substring(GROUP_PREFIX.length());<a name="line.262"></a>
+<span class="sourceLineNo">263</span> }<a name="line.263"></a>
+<span class="sourceLineNo">264</span><a name="line.264"></a>
+<span class="sourceLineNo">265</span> /**<a name="line.265"></a>
+<span class="sourceLineNo">266</span> * Returns the group entry with the
group prefix for a group principal.<a name="line.266"></a>
+<span class="sourceLineNo">267</span> */<a name="line.267"></a>
+<span class="sourceLineNo">268</span> @InterfaceAudience.Private<a
name="line.268"></a>
+<span class="sourceLineNo">269</span> public static String
toGroupEntry(String name) {<a name="line.269"></a>
+<span class="sourceLineNo">270</span> return GROUP_PREFIX + name;<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>
