blob: 4c5c0deb186770cd7a7f38345b8c6776092938e0 [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.File;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.InetAddress;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configuration;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.fs.CommonConfigurationKeys;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.AuthUtil;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HBaseCommonTestingUtil;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.HBaseConfiguration;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.http.ssl.KeyStoreTestUtil;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hdfs.DFSConfigKeys;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.http.HttpConfig;<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.yarn.conf.YarnConfiguration;<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>import org.slf4j.Logger;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.slf4j.LoggerFactory;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hbase.thirdparty.com.google.common.base.Strings;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>@InterfaceAudience.Private<a name="line.39"></a>
<span class="sourceLineNo">040</span>public final class HBaseKerberosUtils {<a name="line.40"></a>
<span class="sourceLineNo">041</span> private static final Logger LOG = LoggerFactory.getLogger(HBaseKerberosUtils.class);<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> public static final String KRB_PRINCIPAL = SecurityConstants.REGIONSERVER_KRB_PRINCIPAL;<a name="line.43"></a>
<span class="sourceLineNo">044</span> public static final String MASTER_KRB_PRINCIPAL = SecurityConstants.MASTER_KRB_PRINCIPAL;<a name="line.44"></a>
<span class="sourceLineNo">045</span> public static final String KRB_KEYTAB_FILE = SecurityConstants.REGIONSERVER_KRB_KEYTAB_FILE;<a name="line.45"></a>
<span class="sourceLineNo">046</span> public static final String CLIENT_PRINCIPAL = AuthUtil.HBASE_CLIENT_KERBEROS_PRINCIPAL;<a name="line.46"></a>
<span class="sourceLineNo">047</span> public static final String CLIENT_KEYTAB = AuthUtil.HBASE_CLIENT_KEYTAB_FILE;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> private HBaseKerberosUtils() {<a name="line.49"></a>
<span class="sourceLineNo">050</span> }<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> public static boolean isKerberosPropertySetted() {<a name="line.52"></a>
<span class="sourceLineNo">053</span> String krbPrincipal = System.getProperty(KRB_PRINCIPAL);<a name="line.53"></a>
<span class="sourceLineNo">054</span> String krbKeytab = System.getProperty(KRB_KEYTAB_FILE);<a name="line.54"></a>
<span class="sourceLineNo">055</span> if (Strings.isNullOrEmpty(krbPrincipal) || Strings.isNullOrEmpty(krbKeytab)) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> return false;<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span> return true;<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> public static void setPrincipalForTesting(String principal) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> setSystemProperty(KRB_PRINCIPAL, principal);<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 setKeytabFileForTesting(String keytabFile) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> setSystemProperty(KRB_KEYTAB_FILE, keytabFile);<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> public static void setClientPrincipalForTesting(String clientPrincipal) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> setSystemProperty(CLIENT_PRINCIPAL, clientPrincipal);<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> public static void setClientKeytabForTesting(String clientKeytab) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> setSystemProperty(CLIENT_KEYTAB, clientKeytab);<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> public static void setSystemProperty(String propertyName, String propertyValue) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> System.setProperty(propertyName, propertyValue);<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> public static String getKeytabFileForTesting() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return System.getProperty(KRB_KEYTAB_FILE);<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> public static String getPrincipalForTesting() {<a name="line.85"></a>
<span class="sourceLineNo">086</span> return System.getProperty(KRB_PRINCIPAL);<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> public static String getClientPrincipalForTesting() {<a name="line.89"></a>
<span class="sourceLineNo">090</span> return System.getProperty(CLIENT_PRINCIPAL);<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> public static String getClientKeytabForTesting() {<a name="line.93"></a>
<span class="sourceLineNo">094</span> return System.getProperty(CLIENT_KEYTAB);<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> public static Configuration getConfigurationWoPrincipal() {<a name="line.97"></a>
<span class="sourceLineNo">098</span> Configuration conf = HBaseConfiguration.create();<a name="line.98"></a>
<span class="sourceLineNo">099</span> conf.set(CommonConfigurationKeys.HADOOP_SECURITY_AUTHENTICATION, "kerberos");<a name="line.99"></a>
<span class="sourceLineNo">100</span> conf.set(User.HBASE_SECURITY_CONF_KEY, "kerberos");<a name="line.100"></a>
<span class="sourceLineNo">101</span> conf.setBoolean(User.HBASE_SECURITY_AUTHORIZATION_CONF_KEY, true);<a name="line.101"></a>
<span class="sourceLineNo">102</span> return conf;<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> public static Configuration getSecuredConfiguration() {<a name="line.105"></a>
<span class="sourceLineNo">106</span> Configuration conf = HBaseConfiguration.create();<a name="line.106"></a>
<span class="sourceLineNo">107</span> setSecuredConfiguration(conf);<a name="line.107"></a>
<span class="sourceLineNo">108</span> return conf;<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> /**<a name="line.111"></a>
<span class="sourceLineNo">112</span> * Set up configuration for a secure HDFS+HBase cluster.<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @param conf configuration object.<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @param servicePrincipal service principal used by NN, HM and RS.<a name="line.114"></a>
<span class="sourceLineNo">115</span> * @param spnegoPrincipal SPNEGO principal used by NN web UI.<a name="line.115"></a>
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
<span class="sourceLineNo">117</span> public static void setSecuredConfiguration(Configuration conf, String servicePrincipal,<a name="line.117"></a>
<span class="sourceLineNo">118</span> String spnegoPrincipal) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> setPrincipalForTesting(servicePrincipal);<a name="line.119"></a>
<span class="sourceLineNo">120</span> setSecuredConfiguration(conf);<a name="line.120"></a>
<span class="sourceLineNo">121</span> setSecuredHadoopConfiguration(conf, spnegoPrincipal);<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> public static void setSecuredConfiguration(Configuration conf) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> conf.set(CommonConfigurationKeys.HADOOP_SECURITY_AUTHENTICATION, "kerberos");<a name="line.125"></a>
<span class="sourceLineNo">126</span> conf.set(User.HBASE_SECURITY_CONF_KEY, "kerberos");<a name="line.126"></a>
<span class="sourceLineNo">127</span> conf.setBoolean(User.HBASE_SECURITY_AUTHORIZATION_CONF_KEY, true);<a name="line.127"></a>
<span class="sourceLineNo">128</span> conf.set(KRB_KEYTAB_FILE, System.getProperty(KRB_KEYTAB_FILE));<a name="line.128"></a>
<span class="sourceLineNo">129</span> conf.set(KRB_PRINCIPAL, System.getProperty(KRB_PRINCIPAL));<a name="line.129"></a>
<span class="sourceLineNo">130</span> conf.set(MASTER_KRB_PRINCIPAL, System.getProperty(KRB_PRINCIPAL));<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> private static void setSecuredHadoopConfiguration(Configuration conf,<a name="line.133"></a>
<span class="sourceLineNo">134</span> String spnegoServerPrincipal) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> String serverPrincipal = System.getProperty(KRB_PRINCIPAL);<a name="line.135"></a>
<span class="sourceLineNo">136</span> String keytabFilePath = System.getProperty(KRB_KEYTAB_FILE);<a name="line.136"></a>
<span class="sourceLineNo">137</span> // HDFS<a name="line.137"></a>
<span class="sourceLineNo">138</span> conf.set(DFSConfigKeys.DFS_NAMENODE_KERBEROS_PRINCIPAL_KEY, serverPrincipal);<a name="line.138"></a>
<span class="sourceLineNo">139</span> conf.set(DFSConfigKeys.DFS_NAMENODE_KEYTAB_FILE_KEY, keytabFilePath);<a name="line.139"></a>
<span class="sourceLineNo">140</span> conf.set(DFSConfigKeys.DFS_DATANODE_KERBEROS_PRINCIPAL_KEY, serverPrincipal);<a name="line.140"></a>
<span class="sourceLineNo">141</span> conf.set(DFSConfigKeys.DFS_DATANODE_KEYTAB_FILE_KEY, keytabFilePath);<a name="line.141"></a>
<span class="sourceLineNo">142</span> conf.setBoolean(DFSConfigKeys.DFS_BLOCK_ACCESS_TOKEN_ENABLE_KEY, true);<a name="line.142"></a>
<span class="sourceLineNo">143</span> // YARN<a name="line.143"></a>
<span class="sourceLineNo">144</span> conf.set(YarnConfiguration.RM_PRINCIPAL, KRB_PRINCIPAL);<a name="line.144"></a>
<span class="sourceLineNo">145</span> conf.set(YarnConfiguration.NM_PRINCIPAL, KRB_PRINCIPAL);<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> if (spnegoServerPrincipal != null) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> conf.set(DFSConfigKeys.DFS_WEB_AUTHENTICATION_KERBEROS_PRINCIPAL_KEY, spnegoServerPrincipal);<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> conf.setBoolean("ignore.secure.ports.for.testing", true);<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> UserGroupInformation.setConfiguration(conf);<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<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> * Set up SSL configuration for HDFS NameNode and DataNode.<a name="line.157"></a>
<span class="sourceLineNo">158</span> * @param utility a HBaseTestingUtility object.<a name="line.158"></a>
<span class="sourceLineNo">159</span> * @param clazz the caller test class.<a name="line.159"></a>
<span class="sourceLineNo">160</span> * @throws Exception if unable to set up SSL configuration<a name="line.160"></a>
<span class="sourceLineNo">161</span> */<a name="line.161"></a>
<span class="sourceLineNo">162</span> public static void setSSLConfiguration(HBaseCommonTestingUtil utility, Class&lt;?&gt; clazz)<a name="line.162"></a>
<span class="sourceLineNo">163</span> throws Exception {<a name="line.163"></a>
<span class="sourceLineNo">164</span> Configuration conf = utility.getConfiguration();<a name="line.164"></a>
<span class="sourceLineNo">165</span> conf.set(DFSConfigKeys.DFS_HTTP_POLICY_KEY, HttpConfig.Policy.HTTPS_ONLY.name());<a name="line.165"></a>
<span class="sourceLineNo">166</span> conf.set(DFSConfigKeys.DFS_NAMENODE_HTTPS_ADDRESS_KEY, "localhost:0");<a name="line.166"></a>
<span class="sourceLineNo">167</span> conf.set(DFSConfigKeys.DFS_DATANODE_HTTPS_ADDRESS_KEY, "localhost:0");<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> File keystoresDir = new File(utility.getDataTestDir("keystore").toUri().getPath());<a name="line.169"></a>
<span class="sourceLineNo">170</span> keystoresDir.mkdirs();<a name="line.170"></a>
<span class="sourceLineNo">171</span> String sslConfDir = KeyStoreTestUtil.getClasspathDir(clazz);<a name="line.171"></a>
<span class="sourceLineNo">172</span> KeyStoreTestUtil.setupSSLConfig(keystoresDir.getAbsolutePath(), sslConfDir, conf, false);<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> public static UserGroupInformation loginAndReturnUGI(Configuration conf, String username)<a name="line.175"></a>
<span class="sourceLineNo">176</span> throws IOException {<a name="line.176"></a>
<span class="sourceLineNo">177</span> String hostname = InetAddress.getLocalHost().getHostName();<a name="line.177"></a>
<span class="sourceLineNo">178</span> String keyTabFileConfKey = "hbase." + username + ".keytab.file";<a name="line.178"></a>
<span class="sourceLineNo">179</span> String keyTabFileLocation = conf.get(keyTabFileConfKey);<a name="line.179"></a>
<span class="sourceLineNo">180</span> String principalConfKey = "hbase." + username + ".kerberos.principal";<a name="line.180"></a>
<span class="sourceLineNo">181</span> String principal = org.apache.hadoop.security.SecurityUtil<a name="line.181"></a>
<span class="sourceLineNo">182</span> .getServerPrincipal(conf.get(principalConfKey), hostname);<a name="line.182"></a>
<span class="sourceLineNo">183</span> if (keyTabFileLocation == null || principal == null) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> LOG.warn(<a name="line.184"></a>
<span class="sourceLineNo">185</span> "Principal or key tab file null for : " + principalConfKey + ", " + keyTabFileConfKey);<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span> UserGroupInformation ugi =<a name="line.187"></a>
<span class="sourceLineNo">188</span> UserGroupInformation.loginUserFromKeytabAndReturnUGI(principal, keyTabFileLocation);<a name="line.188"></a>
<span class="sourceLineNo">189</span> return ugi;<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> public static UserGroupInformation loginKerberosPrincipal(String krbKeytab, String krbPrincipal)<a name="line.192"></a>
<span class="sourceLineNo">193</span> throws Exception {<a name="line.193"></a>
<span class="sourceLineNo">194</span> Configuration conf = new Configuration();<a name="line.194"></a>
<span class="sourceLineNo">195</span> conf.set(CommonConfigurationKeys.HADOOP_SECURITY_AUTHENTICATION, "kerberos");<a name="line.195"></a>
<span class="sourceLineNo">196</span> UserGroupInformation.setConfiguration(conf);<a name="line.196"></a>
<span class="sourceLineNo">197</span> UserGroupInformation.loginUserFromKeytab(krbPrincipal, krbKeytab);<a name="line.197"></a>
<span class="sourceLineNo">198</span> return UserGroupInformation.getLoginUser();<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span>}<a name="line.200"></a>
</pre>
</div>
</body>
</html>