| <!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.http;<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.net.URI;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import javax.servlet.ServletContext;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import javax.servlet.http.HttpServlet;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import javax.servlet.http.HttpServletRequest;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.conf.Configuration;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.fs.CommonConfigurationKeys;<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.security.authorize.AccessControlList;<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><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hbase.thirdparty.com.google.common.net.HostAndPort;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hbase.thirdparty.org.eclipse.jetty.servlet.ServletHolder;<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> * Create a Jetty embedded server to answer http requests. The primary goal is to serve up status<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * information for the server. There are three contexts: "/stacks/" -&gt; points to stack trace<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * "/static/" -&gt; points to common static files (src/hbase-webapps/static) "/" -&gt; the jsp<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * server code from (src/hbase-webapps/&lt;name&gt;)<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>@InterfaceAudience.Private<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>public class InfoServer {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private static final String HBASE_APP_DIR = "hbase-webapps";<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> private final org.apache.hadoop.hbase.http.HttpServer httpServer;<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> * Create a status server on the given port. The jsp scripts are taken from<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * src/hbase-webapps/<code>name</code>.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param name The name of the server<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param bindAddress address to bind to<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @param port The port to use on the server<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @param findPort whether the server should start at the given port and increment by 1 until<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * it finds a free port.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * @param c the {@link Configuration} to build the server<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @throws IOException if getting one of the password fails or the server cannot be created<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public InfoServer(String name, String bindAddress, int port, boolean findPort,<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> final Configuration c) throws IOException {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> HttpConfig httpConfig = new HttpConfig(c);<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> HttpServer.Builder builder = new org.apache.hadoop.hbase.http.HttpServer.Builder();<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> builder.setName(name)<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> .addEndpoint(URI<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> .create(httpConfig.getSchemePrefix() + HostAndPort.fromParts(bindAddress, port).toString()))<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> .setAppDir(HBASE_APP_DIR).setFindPort(findPort).setConf(c);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> String logDir = System.getProperty("hbase.log.dir");<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> if (logDir != null) {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> builder.setLogDir(logDir);<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> if (httpConfig.isSecure()) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> builder<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> .keyPassword(HBaseConfiguration.getPassword(c, "ssl.server.keystore.keypassword", null))<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> .keyStore(c.get("ssl.server.keystore.location"),<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> HBaseConfiguration.getPassword(c, "ssl.server.keystore.password", null),<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> c.get("ssl.server.keystore.type", "jks"))<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> .trustStore(c.get("ssl.server.truststore.location"),<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> HBaseConfiguration.getPassword(c, "ssl.server.truststore.password", null),<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> c.get("ssl.server.truststore.type", "jks"));<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> builder.excludeCiphers(c.get("ssl.server.exclude.cipher.list"));<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> }<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> // Enable SPNEGO authentication<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> if ("kerberos".equalsIgnoreCase(c.get(HttpServer.HTTP_UI_AUTHENTICATION, null))) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> builder.setUsernameConfKey(HttpServer.HTTP_SPNEGO_AUTHENTICATION_PRINCIPAL_KEY)<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> .setKeytabConfKey(HttpServer.HTTP_SPNEGO_AUTHENTICATION_KEYTAB_KEY)<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> .setKerberosNameRulesKey(HttpServer.HTTP_SPNEGO_AUTHENTICATION_KRB_NAME_KEY)<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> .setSignatureSecretFileKey(HttpServer.HTTP_AUTHENTICATION_SIGNATURE_SECRET_FILE_KEY)<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> .setSecurityEnabled(true);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> // Set an admin ACL on sensitive webUI endpoints<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> AccessControlList acl = buildAdminAcl(c);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> builder.setACL(acl);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> this.httpServer = builder.build();<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<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> * Builds an ACL that will restrict the users who can issue commands to endpoints on the UI which<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * are meant only for administrators.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> AccessControlList buildAdminAcl(Configuration conf) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> final String userGroups = conf.get(HttpServer.HTTP_SPNEGO_AUTHENTICATION_ADMIN_USERS_KEY, null);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> final String adminGroups =<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> conf.get(HttpServer.HTTP_SPNEGO_AUTHENTICATION_ADMIN_GROUPS_KEY, null);<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> if (userGroups == null && adminGroups == null) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> // Backwards compatibility - if the user doesn't have anything set, allow all users in.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> return new AccessControlList("*", null);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return new AccessControlList(userGroups, adminGroups);<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> * Explicitly invoke {@link #addPrivilegedServlet(String, String, Class)} or<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * {@link #addUnprivilegedServlet(String, String, Class)} instead of this method. This method will<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * add a servlet which any authenticated user can access.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @deprecated Use {@link #addUnprivilegedServlet(String, String, Class)} or<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * {@link #addPrivilegedServlet(String, String, Class)} instead of this method which<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * does not state outwardly what kind of authz rules will be applied to this servlet.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> @Deprecated<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> public void addServlet(String name, String pathSpec, Class<? extends HttpServlet> clazz) {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> addUnprivilegedServlet(name, pathSpec, clazz);<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> * Adds a servlet in the server that any user can access.<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @see HttpServer#addUnprivilegedServlet(String, String, Class)<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> */<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> public void addUnprivilegedServlet(String name, String pathSpec,<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> Class<? extends HttpServlet> clazz) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> this.httpServer.addUnprivilegedServlet(name, pathSpec, clazz);<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 a servlet in the server that any user can access.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @see HttpServer#addUnprivilegedServlet(String, ServletHolder)<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> public void addUnprivilegedServlet(String name, String pathSpec, ServletHolder holder) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> if (name != null) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> holder.setName(name);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> this.httpServer.addUnprivilegedServlet(pathSpec, holder);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * Adds a servlet in the server that any user can access.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @see HttpServer#addPrivilegedServlet(String, String, Class)<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> public void addPrivilegedServlet(String name, String pathSpec,<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> Class<? extends HttpServlet> clazz) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> this.httpServer.addPrivilegedServlet(name, pathSpec, clazz);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> public void setAttribute(String name, Object value) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> this.httpServer.setAttribute(name, value);<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> public void start() throws IOException {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> this.httpServer.start();<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> /**<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @return the port of the info server<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @deprecated Since 0.99.0<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> @Deprecated<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> public int getPort() {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> return this.httpServer.getPort();<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> public void stop() throws Exception {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> this.httpServer.stop();<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> * Returns true if and only if UI authentication (spnego) is enabled, UI authorization is enabled,<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * and the requesting user is defined as an administrator. If the UI is set to readonly, this<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * method always returns false.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> */<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> public static boolean canUserModifyUI(HttpServletRequest req, ServletContext ctx,<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> Configuration conf) {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> if (conf.getBoolean("hbase.master.ui.readonly", false)) {<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> return false;<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> }<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> String remoteUser = req.getRemoteUser();<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> if (<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> "kerberos".equalsIgnoreCase(conf.get(HttpServer.HTTP_UI_AUTHENTICATION))<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> && conf.getBoolean(CommonConfigurationKeys.HADOOP_SECURITY_AUTHORIZATION, false)<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> && remoteUser != null<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> ) {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> return HttpServer.userHasAdministratorAccess(ctx, remoteUser);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> return false;<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span>}<a name="line.193"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
