blob: b6df69b3ec0fef00f985f963c6d752ef353c7c5a [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.http, class: TestLdapHttpServer">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.http;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import static org.junit.Assert.assertEquals;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.net.HttpURLConnection;</span>
<span class="source-line-no">024</span><span id="line-24">import java.net.URL;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.commons.codec.binary.Base64;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.directory.server.annotations.CreateLdapServer;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.directory.server.annotations.CreateTransport;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.directory.server.core.annotations.ApplyLdifs;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.directory.server.core.annotations.ContextEntry;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.directory.server.core.annotations.CreateDS;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.directory.server.core.annotations.CreatePartition;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.directory.server.core.integ.CreateLdapServerRule;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.http.resource.JerseyResource;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.testclassification.MiscTests;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.testclassification.SmallTests;</span>
<span class="source-line-no">038</span><span id="line-38">import org.junit.AfterClass;</span>
<span class="source-line-no">039</span><span id="line-39">import org.junit.BeforeClass;</span>
<span class="source-line-no">040</span><span id="line-40">import org.junit.ClassRule;</span>
<span class="source-line-no">041</span><span id="line-41">import org.junit.Test;</span>
<span class="source-line-no">042</span><span id="line-42">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">043</span><span id="line-43">import org.slf4j.Logger;</span>
<span class="source-line-no">044</span><span id="line-44">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46">/**</span>
<span class="source-line-no">047</span><span id="line-47"> * Test class for LDAP authentication on the HttpServer.</span>
<span class="source-line-no">048</span><span id="line-48"> */</span>
<span class="source-line-no">049</span><span id="line-49">@Category({ MiscTests.class, SmallTests.class })</span>
<span class="source-line-no">050</span><span id="line-50">@CreateLdapServer(</span>
<span class="source-line-no">051</span><span id="line-51"> transports = { @CreateTransport(protocol = "LDAP", address = LdapConstants.LDAP_SERVER_ADDR), })</span>
<span class="source-line-no">052</span><span id="line-52">@CreateDS(allowAnonAccess = true,</span>
<span class="source-line-no">053</span><span id="line-53"> partitions = { @CreatePartition(name = "Test_Partition", suffix = LdapConstants.LDAP_BASE_DN,</span>
<span class="source-line-no">054</span><span id="line-54"> contextEntry = @ContextEntry(entryLdif = "dn: " + LdapConstants.LDAP_BASE_DN + " \n"</span>
<span class="source-line-no">055</span><span id="line-55"> + "dc: example\n" + "objectClass: top\n" + "objectClass: domain\n\n")) })</span>
<span class="source-line-no">056</span><span id="line-56">@ApplyLdifs({ "dn: uid=bjones," + LdapConstants.LDAP_BASE_DN, "cn: Bob Jones", "sn: Jones",</span>
<span class="source-line-no">057</span><span id="line-57"> "objectClass: inetOrgPerson", "uid: bjones", "userPassword: p@ssw0rd" })</span>
<span class="source-line-no">058</span><span id="line-58">public class TestLdapHttpServer extends HttpServerFunctionalTest {</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> @ClassRule</span>
<span class="source-line-no">061</span><span id="line-61"> public static final HBaseClassTestRule CLASS_RULE =</span>
<span class="source-line-no">062</span><span id="line-62"> HBaseClassTestRule.forClass(TestLdapHttpServer.class);</span>
<span class="source-line-no">063</span><span id="line-63"> @ClassRule</span>
<span class="source-line-no">064</span><span id="line-64"> public static CreateLdapServerRule serverRule = new CreateLdapServerRule();</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> private static final Logger LOG = LoggerFactory.getLogger(TestLdapHttpServer.class);</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> private static HttpServer server;</span>
<span class="source-line-no">069</span><span id="line-69"> private static URL baseUrl;</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> @BeforeClass</span>
<span class="source-line-no">072</span><span id="line-72"> public static void setupServer() throws Exception {</span>
<span class="source-line-no">073</span><span id="line-73"> Configuration conf = new Configuration();</span>
<span class="source-line-no">074</span><span id="line-74"> buildLdapConfiguration(conf);</span>
<span class="source-line-no">075</span><span id="line-75"> server = createTestServer(conf);</span>
<span class="source-line-no">076</span><span id="line-76"> server.addUnprivilegedServlet("echo", "/echo", TestHttpServer.EchoServlet.class);</span>
<span class="source-line-no">077</span><span id="line-77"> server.addJerseyResourcePackage(JerseyResource.class.getPackage().getName(), "/jersey/*");</span>
<span class="source-line-no">078</span><span id="line-78"> server.start();</span>
<span class="source-line-no">079</span><span id="line-79"> baseUrl = getServerURL(server);</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> LOG.info("HTTP server started: " + baseUrl);</span>
<span class="source-line-no">082</span><span id="line-82"> }</span>
<span class="source-line-no">083</span><span id="line-83"></span>
<span class="source-line-no">084</span><span id="line-84"> @AfterClass</span>
<span class="source-line-no">085</span><span id="line-85"> public static void stopServer() throws Exception {</span>
<span class="source-line-no">086</span><span id="line-86"> try {</span>
<span class="source-line-no">087</span><span id="line-87"> if (null != server) {</span>
<span class="source-line-no">088</span><span id="line-88"> server.stop();</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"> } catch (Exception e) {</span>
<span class="source-line-no">091</span><span id="line-91"> LOG.info("Failed to stop info server", e);</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93"> }</span>
<span class="source-line-no">094</span><span id="line-94"></span>
<span class="source-line-no">095</span><span id="line-95"> private static Configuration buildLdapConfiguration(Configuration conf) {</span>
<span class="source-line-no">096</span><span id="line-96"></span>
<span class="source-line-no">097</span><span id="line-97"> conf.setInt(HttpServer.HTTP_MAX_THREADS, TestHttpServer.MAX_THREADS);</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> // Enable LDAP (pre-req)</span>
<span class="source-line-no">100</span><span id="line-100"> conf.set(HttpServer.HTTP_UI_AUTHENTICATION, "ldap");</span>
<span class="source-line-no">101</span><span id="line-101"> conf.set(HttpServer.FILTER_INITIALIZERS_PROPERTY,</span>
<span class="source-line-no">102</span><span id="line-102"> "org.apache.hadoop.hbase.http.lib.AuthenticationFilterInitializer");</span>
<span class="source-line-no">103</span><span id="line-103"> conf.set("hadoop.http.authentication.type", "ldap");</span>
<span class="source-line-no">104</span><span id="line-104"> conf.set("hadoop.http.authentication.ldap.providerurl", String.format("ldap://%s:%s",</span>
<span class="source-line-no">105</span><span id="line-105"> LdapConstants.LDAP_SERVER_ADDR, serverRule.getLdapServer().getPort()));</span>
<span class="source-line-no">106</span><span id="line-106"> conf.set("hadoop.http.authentication.ldap.enablestarttls", "false");</span>
<span class="source-line-no">107</span><span id="line-107"> conf.set("hadoop.http.authentication.ldap.basedn", LdapConstants.LDAP_BASE_DN);</span>
<span class="source-line-no">108</span><span id="line-108"> return conf;</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"></span>
<span class="source-line-no">111</span><span id="line-111"> @Test</span>
<span class="source-line-no">112</span><span id="line-112"> public void testUnauthorizedClientsDisallowed() throws IOException {</span>
<span class="source-line-no">113</span><span id="line-113"> URL url = new URL(getServerURL(server), "/echo?a=b");</span>
<span class="source-line-no">114</span><span id="line-114"> HttpURLConnection conn = (HttpURLConnection) url.openConnection();</span>
<span class="source-line-no">115</span><span id="line-115"> assertEquals(HttpURLConnection.HTTP_UNAUTHORIZED, conn.getResponseCode());</span>
<span class="source-line-no">116</span><span id="line-116"> }</span>
<span class="source-line-no">117</span><span id="line-117"></span>
<span class="source-line-no">118</span><span id="line-118"> @Test</span>
<span class="source-line-no">119</span><span id="line-119"> public void testAllowedClient() throws IOException {</span>
<span class="source-line-no">120</span><span id="line-120"> URL url = new URL(getServerURL(server), "/echo?a=b");</span>
<span class="source-line-no">121</span><span id="line-121"> HttpURLConnection conn = (HttpURLConnection) url.openConnection();</span>
<span class="source-line-no">122</span><span id="line-122"> final Base64 base64 = new Base64(0);</span>
<span class="source-line-no">123</span><span id="line-123"> String userCredentials = "bjones:p@ssw0rd";</span>
<span class="source-line-no">124</span><span id="line-124"> String basicAuth = "Basic " + base64.encodeToString(userCredentials.getBytes());</span>
<span class="source-line-no">125</span><span id="line-125"> conn.setRequestProperty("Authorization", basicAuth);</span>
<span class="source-line-no">126</span><span id="line-126"> assertEquals(HttpURLConnection.HTTP_OK, conn.getResponseCode());</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"></span>
<span class="source-line-no">129</span><span id="line-129"> @Test</span>
<span class="source-line-no">130</span><span id="line-130"> public void testWrongAuthClientsDisallowed() throws IOException {</span>
<span class="source-line-no">131</span><span id="line-131"> URL url = new URL(getServerURL(server), "/echo?a=b");</span>
<span class="source-line-no">132</span><span id="line-132"> HttpURLConnection conn = (HttpURLConnection) url.openConnection();</span>
<span class="source-line-no">133</span><span id="line-133"> final Base64 base64 = new Base64(0);</span>
<span class="source-line-no">134</span><span id="line-134"> String userCredentials = "bjones:password";</span>
<span class="source-line-no">135</span><span id="line-135"> String basicAuth = "Basic " + base64.encodeToString(userCredentials.getBytes());</span>
<span class="source-line-no">136</span><span id="line-136"> conn.setRequestProperty("Authorization", basicAuth);</span>
<span class="source-line-no">137</span><span id="line-137"> assertEquals(HttpURLConnection.HTTP_FORBIDDEN, conn.getResponseCode());</span>
<span class="source-line-no">138</span><span id="line-138"> }</span>
<span class="source-line-no">139</span><span id="line-139"></span>
<span class="source-line-no">140</span><span id="line-140">}</span>
</pre>
</div>
</main>
</body>
</html>