HBASE-27693 Support for Hadoop's LDAP Authentication mechanism

Author: ydodeja365

hbase-http/src/main/java/org/apache/hadoop/hbase/http/AuthenticationFilterInitializer.java

@@ -0,0 +1,87 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.hadoop.hbase.http;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.hbase.HBaseInterfaceAudience;
+import org.apache.hadoop.security.SecurityUtil;
+import org.apache.hadoop.security.authentication.server.AuthenticationFilter;
+import org.apache.hadoop.security.authentication.server.KerberosAuthenticationHandler;
+import org.apache.yetus.audience.InterfaceAudience;
+
+/**
+ * Initializes hadoop-auth AuthenticationFilter which provides support for Kerberos HTTP SPNEGO
+ * authentication.
+ * <p>
+ * It enables anonymous access, simple/pseudo and Kerberos HTTP SPNEGO authentication for Hadoop
+ * JobTracker, NameNode, DataNodes and TaskTrackers.
+ * <p>
+ * Refer to the <code>core-default.xml</code> file, after the comment 'HTTP Authentication' for
+ * details on the configuration options. All related configuration properties have
+ * 'hadoop.http.authentication.' as prefix.
+ */
+@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
+public class AuthenticationFilterInitializer extends FilterInitializer {
+
+  static final String PREFIX = "hadoop.http.authentication.";
+
+  /**
+   * Initializes hadoop-auth AuthenticationFilter.
+   * <p>
+   * Propagates to hadoop-auth AuthenticationFilter configuration all Hadoop configuration
+   * properties prefixed with "hadoop.http.authentication."
+   * @param container The filter container
+   * @param conf      Configuration for run-time parameters
+   */
+  @Override
+  public void initFilter(FilterContainer container, Configuration conf) {
+    Map<String, String> filterConfig = getFilterConfigMap(conf, PREFIX);
+
+    container.addFilter("authentication", AuthenticationFilter.class.getName(), filterConfig);
+  }
+
+  public static Map<String, String> getFilterConfigMap(Configuration conf, String prefix) {
+    Map<String, String> filterConfig = new HashMap<String, String>();
+
+    // setting the cookie path to root '/' so it is used for all resources.
+    filterConfig.put(AuthenticationFilter.COOKIE_PATH, "/");
+    Map<String, String> propsWithPrefix = conf.getPropsWithPrefix(prefix);
+
+    for (Map.Entry<String, String> entry : propsWithPrefix.entrySet()) {
+      filterConfig.put(entry.getKey(), entry.getValue());
+    }
+
+    // Resolve _HOST into bind address
+    String bindAddress = conf.get(HttpServer.BIND_ADDRESS);
+    String principal = filterConfig.get(KerberosAuthenticationHandler.PRINCIPAL);
+    if (principal != null) {
+      try {
+        principal = SecurityUtil.getServerPrincipal(principal, bindAddress);
+      } catch (IOException ex) {
+        throw new RuntimeException("Could not resolve Kerberos principal name: " + ex.toString(),
+          ex);
+      }
+      filterConfig.put(KerberosAuthenticationHandler.PRINCIPAL, principal);
+    }
+    return filterConfig;
+  }
+
+}

hbase-http/src/test/java/org/apache/hadoop/hbase/http/TestAuthenticationFilterInitializer.java

@@ -0,0 +1,78 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.hadoop.hbase.http;
+
+import static org.junit.Assert.*;
+import static org.mockito.ArgumentMatchers.any;
+
+import java.util.Map;
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.hbase.HBaseClassTestRule;
+import org.apache.hadoop.hbase.testclassification.MiscTests;
+import org.apache.hadoop.hbase.testclassification.SmallTests;
+import org.apache.hadoop.security.authentication.server.AuthenticationFilter;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+import org.mockito.Mockito;
+import org.mockito.invocation.InvocationOnMock;
+import org.mockito.stubbing.Answer;
+
+@Category({ MiscTests.class, SmallTests.class })
+public class TestAuthenticationFilterInitializer {
+  @ClassRule
+  public static final HBaseClassTestRule CLASS_RULE =
+    HBaseClassTestRule.forClass(TestAuthenticationFilterInitializer.class);
+
+  @Test
+  public void testConfiguration() throws Exception {
+    Configuration conf = new Configuration();
+    conf.set("hadoop.http.authentication.foo", "bar");
+
+    conf.set(HttpServer.BIND_ADDRESS, "barhost");
+
+    FilterContainer container = Mockito.mock(FilterContainer.class);
+    Mockito.doAnswer(new Answer() {
+      @Override
+      public Object answer(InvocationOnMock invocationOnMock) throws Throwable {
+        Object[] args = invocationOnMock.getArguments();
+
+        assertEquals("authentication", args[0]);
+
+        assertEquals(AuthenticationFilter.class.getName(), args[1]);
+
+        Map<String, String> conf = (Map<String, String>) args[2];
+        assertEquals("/", conf.get("cookie.path"));
+
+        assertEquals("simple", conf.get("type"));
+        assertEquals("36000", conf.get("token.validity"));
+        assertNull(conf.get("cookie.domain"));
+        assertEquals("true", conf.get("simple.anonymous.allowed"));
+        assertEquals("HTTP/barhost@LOCALHOST", conf.get("kerberos.principal"));
+        assertEquals(System.getProperty("user.home") + "/hadoop.keytab",
+          conf.get("kerberos.keytab"));
+        assertEquals("bar", conf.get("foo"));
+
+        return null;
+      }
+    }).when(container).addFilter(any(), any(), any());
+
+    new AuthenticationFilterInitializer().initFilter(container, conf);
+  }
+
+}

src/main/asciidoc/_chapters/security.adoc

@@ -185,6 +185,64 @@ non-sensitive endpoints in the Web UI.
 
 If it doesn't go without saying: non-authenticated users cannot access any part of the Web UI.
 
+[[hbase.secure.ldap.ui]]
+=== Using LDAP authentication with Web UIs
+
+LDAP authentication to HBase Web UIs can be enabled via configuring LDAP with the `hbase.security.authentication.ui`
+property in _hbase-site.xml_. The `hbase.http.filter.initializers` property also needs to have the `AuthenticationFilterInitializer` class.
+
+*IMPORTANT:* A LDAP server must be configured and running. When TLS is enabled for communication with LDAP server (either via ldaps scheme or ‘start TLS’ extension), configure the public certificate of the LDAP server in the local truststore.
+The LDAP authentication mechanism uses HTTP Basic authentication scheme to verify user specified credentials against a configured LDAP (or Active Directory) server. The authentication filter must be configured with the following init parameters:
+
+[source,xml]
+----
+<property>
+  <name>hbase.security.authentication.ui</name>
+  <value>ldap</value>
+  <description>Controls what kind of authentication should be used for the HBase web UIs.</description>
+</property>
+<property>
+  <name>hbase.http.filter.initializers</name>
+  <value>org.apache.hadoop.hbase.http.AuthenticationFilterInitializer</value>
+  <description>Comma separated class names corresponding to the Filters that will be initialized.
+  Then, the Filters will be applied to all user facing jsp and servlet web pages.</description>
+</property>
+<property>
+  <name>hadoop.http.authentication.type</name>
+  <value>ldap</value>
+  <description>Defines authentication used for the HTTP web-consoles in Hadoop ecosystem.</description>
+</property>
+----
+
+A number of properties exist to configure LDAP authentication for the web server:
+
+[source,xml]
+----
+<property>
+  <name>hadoop.http.authentication.ldap.binddomain</name>
+  <value>EXAMPLE.COM</value>
+  <description>The LDAP bind domain value to be used with the LDAP server. This property is optional
+   and useful only in case of Active Directory server (e.g. example.com).</description>
+</property>
+<property>
+  <name>hadoop.http.authentication.ldap.providerurl</name>
+  <value>ldap://ldap-server-host:8920</value>
+  <description>The url of the LDAP server.</description>
+</property>
+<property>
+  <name>hadoop.http.authentication.ldap.enablestarttls</name>
+  <value>false</value>
+  <description>A boolean value used to define if the LDAP server supports ‘StartTLS’ extension.</description>
+</property>
+<property>
+  <name>hadoop.http.authentication.ldap.basedn</name>
+  <value>ou=users,dc=example,dc=com</value>
+  <description>The base distinguished name (DN) to be used with the LDAP server. This value is
+  appended to the provided user id for authentication purpose. This property is not useful in case
+  of Active Directory server.</description>
+</property>
+----
+
 === Other UI security-related configuration
 
 While it is a clear anti-pattern for HBase developers, the developers acknowledge that the HBase