-
Notifications
You must be signed in to change notification settings - Fork 3.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
HBASE-23312 HBase Thrift SPNEGO configs (HBASE-19852) should be backwards compatible #850
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
237 changes: 237 additions & 0 deletions
237
...rift/src/test/java/org/apache/hadoop/hbase/thrift/TestThriftSpnegoHttpFallbackServer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,237 @@ | ||
| /* | ||
| * 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.thrift; | ||
|
|
||
| import static org.apache.hadoop.hbase.thrift.Constants.THRIFT_SUPPORT_PROXYUSER_KEY; | ||
| import static org.junit.Assert.assertFalse; | ||
| import static org.junit.Assert.assertNotNull; | ||
|
|
||
| import java.io.File; | ||
| import java.nio.file.Paths; | ||
| import java.security.Principal; | ||
| import java.security.PrivilegedExceptionAction; | ||
| import java.util.Set; | ||
|
|
||
| import javax.security.auth.Subject; | ||
| import javax.security.auth.kerberos.KerberosTicket; | ||
|
|
||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.hadoop.hbase.HBaseClassTestRule; | ||
| import org.apache.hadoop.hbase.HBaseTestingUtility; | ||
| import org.apache.hadoop.hbase.HConstants; | ||
| import org.apache.hadoop.hbase.security.HBaseKerberosUtils; | ||
| import org.apache.hadoop.hbase.testclassification.ClientTests; | ||
| import org.apache.hadoop.hbase.testclassification.LargeTests; | ||
| import org.apache.hadoop.hbase.thrift.generated.Hbase; | ||
| import org.apache.hadoop.hbase.util.TableDescriptorChecker; | ||
| import org.apache.hadoop.security.authentication.util.KerberosName; | ||
| import org.apache.http.HttpHeaders; | ||
| import org.apache.http.auth.AuthSchemeProvider; | ||
| import org.apache.http.auth.AuthScope; | ||
| import org.apache.http.auth.KerberosCredentials; | ||
| import org.apache.http.client.config.AuthSchemes; | ||
| import org.apache.http.config.Lookup; | ||
| import org.apache.http.config.RegistryBuilder; | ||
| import org.apache.http.impl.auth.SPNegoSchemeFactory; | ||
| import org.apache.http.impl.client.BasicCredentialsProvider; | ||
| import org.apache.http.impl.client.CloseableHttpClient; | ||
| import org.apache.http.impl.client.HttpClients; | ||
| import org.apache.kerby.kerberos.kerb.client.JaasKrbUtil; | ||
| import org.apache.kerby.kerberos.kerb.server.SimpleKdcServer; | ||
| import org.apache.thrift.protocol.TBinaryProtocol; | ||
| import org.apache.thrift.protocol.TProtocol; | ||
| import org.apache.thrift.transport.THttpClient; | ||
| import org.ietf.jgss.GSSCredential; | ||
| import org.ietf.jgss.GSSManager; | ||
| import org.ietf.jgss.GSSName; | ||
| import org.ietf.jgss.Oid; | ||
| import org.junit.AfterClass; | ||
| import org.junit.BeforeClass; | ||
| import org.junit.ClassRule; | ||
| import org.junit.experimental.categories.Category; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * Start the HBase Thrift HTTP server on a random port through the command-line | ||
| * interface and talk to it from client side with SPNEGO security enabled. | ||
| */ | ||
| @Category({ClientTests.class, LargeTests.class}) | ||
| public class TestThriftSpnegoHttpFallbackServer extends TestThriftHttpServer { | ||
joshelser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| @ClassRule | ||
| public static final HBaseClassTestRule CLASS_RULE = | ||
| HBaseClassTestRule.forClass(TestThriftSpnegoHttpFallbackServer.class); | ||
|
|
||
| private static final Logger LOG = | ||
| LoggerFactory.getLogger(TestThriftSpnegoHttpFallbackServer.class); | ||
|
|
||
| private static SimpleKdcServer kdc; | ||
| private static File serverKeytab; | ||
| private static File clientKeytab; | ||
|
|
||
| private static String clientPrincipal; | ||
| private static String serverPrincipal; | ||
| private static String spnegoServerPrincipal; | ||
|
|
||
| private static SimpleKdcServer buildMiniKdc() throws Exception { | ||
| SimpleKdcServer kdc = new SimpleKdcServer(); | ||
|
|
||
| File kdcDir = Paths.get(TEST_UTIL.getRandomDir().toString()).toAbsolutePath().toFile(); | ||
| kdcDir.mkdirs(); | ||
| kdc.setWorkDir(kdcDir); | ||
|
|
||
| kdc.setKdcHost(HConstants.LOCALHOST); | ||
| int kdcPort = HBaseTestingUtility.randomFreePort(); | ||
| kdc.setAllowTcp(true); | ||
| kdc.setAllowUdp(false); | ||
| kdc.setKdcTcpPort(kdcPort); | ||
|
|
||
| LOG.info("Starting KDC server at " + HConstants.LOCALHOST + ":" + kdcPort); | ||
|
|
||
| kdc.init(); | ||
|
|
||
| return kdc; | ||
| } | ||
|
|
||
| private static void addSecurityConfigurations(Configuration conf) { | ||
| KerberosName.setRules("DEFAULT"); | ||
|
|
||
| HBaseKerberosUtils.setKeytabFileForTesting(serverKeytab.getAbsolutePath()); | ||
|
|
||
| conf.setBoolean(THRIFT_SUPPORT_PROXYUSER_KEY, true); | ||
| conf.setBoolean(Constants.USE_HTTP_CONF_KEY, true); | ||
|
|
||
| conf.set(Constants.THRIFT_KERBEROS_PRINCIPAL_KEY, serverPrincipal); | ||
| conf.set(Constants.THRIFT_KEYTAB_FILE_KEY, serverKeytab.getAbsolutePath()); | ||
|
|
||
| HBaseKerberosUtils.setSecuredConfiguration(conf, spnegoServerPrincipal, | ||
| spnegoServerPrincipal); | ||
| conf.set("hadoop.proxyuser.HTTP.hosts", "*"); | ||
| conf.set("hadoop.proxyuser.HTTP.groups", "*"); | ||
| conf.set(Constants.THRIFT_KERBEROS_PRINCIPAL_KEY, spnegoServerPrincipal); | ||
| } | ||
|
|
||
| @BeforeClass | ||
| public static void setUpBeforeClass() throws Exception { | ||
| kdc = buildMiniKdc(); | ||
| kdc.start(); | ||
|
|
||
| File keytabDir = Paths.get(TEST_UTIL.getRandomDir().toString()).toAbsolutePath().toFile(); | ||
| keytabDir.mkdirs(); | ||
|
|
||
| clientPrincipal = "client@" + kdc.getKdcConfig().getKdcRealm(); | ||
| clientKeytab = new File(keytabDir, clientPrincipal + ".keytab"); | ||
| kdc.createAndExportPrincipals(clientKeytab, clientPrincipal); | ||
|
|
||
| serverPrincipal = "hbase/" + HConstants.LOCALHOST + "@" + kdc.getKdcConfig().getKdcRealm(); | ||
| serverKeytab = new File(keytabDir, serverPrincipal.replace('/', '_') + ".keytab"); | ||
|
|
||
| spnegoServerPrincipal = "HTTP/" + HConstants.LOCALHOST + "@" + kdc.getKdcConfig().getKdcRealm(); | ||
| // Add SPNEGO principal to server keytab | ||
| kdc.createAndExportPrincipals(serverKeytab, serverPrincipal, spnegoServerPrincipal); | ||
|
|
||
| TEST_UTIL.getConfiguration().setBoolean(Constants.USE_HTTP_CONF_KEY, true); | ||
| TEST_UTIL.getConfiguration().setBoolean(TableDescriptorChecker.TABLE_SANITY_CHECKS, false); | ||
joshelser marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| addSecurityConfigurations(TEST_UTIL.getConfiguration()); | ||
|
|
||
| TestThriftHttpServer.setUpBeforeClass(); | ||
| } | ||
|
|
||
| @AfterClass | ||
| public static void tearDownAfterClass() throws Exception { | ||
| TestThriftHttpServer.tearDownAfterClass(); | ||
|
|
||
| try { | ||
| if (null != kdc) { | ||
| kdc.stop(); | ||
risdenk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| kdc = null; | ||
| } | ||
| } catch (Exception e) { | ||
| LOG.info("Failed to stop mini KDC", e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void talkToThriftServer(String url, int customHeaderSize) throws Exception { | ||
| // Close httpClient and THttpClient automatically on any failures | ||
| try ( | ||
| CloseableHttpClient httpClient = createHttpClient(); | ||
| THttpClient tHttpClient = new THttpClient(url, httpClient) | ||
| ) { | ||
| tHttpClient.open(); | ||
| if (customHeaderSize > 0) { | ||
| StringBuilder sb = new StringBuilder(); | ||
| for (int i = 0; i < customHeaderSize; i++) { | ||
| sb.append("a"); | ||
| } | ||
| tHttpClient.setCustomHeader(HttpHeaders.USER_AGENT, sb.toString()); | ||
| } | ||
|
|
||
| TProtocol prot = new TBinaryProtocol(tHttpClient); | ||
| Hbase.Client client = new Hbase.Client(prot); | ||
| TestThriftServer.createTestTables(client); | ||
| TestThriftServer.checkTableList(client); | ||
| TestThriftServer.dropTestTables(client); | ||
| } | ||
| } | ||
|
|
||
| private CloseableHttpClient createHttpClient() throws Exception { | ||
| final Subject clientSubject = JaasKrbUtil.loginUsingKeytab(clientPrincipal, clientKeytab); | ||
| final Set<Principal> clientPrincipals = clientSubject.getPrincipals(); | ||
| // Make sure the subject has a principal | ||
| assertFalse("Found no client principals in the clientSubject.", | ||
| clientPrincipals.isEmpty()); | ||
|
|
||
| // Get a TGT for the subject (might have many, different encryption types). The first should | ||
| // be the default encryption type. | ||
| Set<KerberosTicket> privateCredentials = | ||
| clientSubject.getPrivateCredentials(KerberosTicket.class); | ||
| assertFalse("Found no private credentials in the clientSubject.", | ||
| privateCredentials.isEmpty()); | ||
| KerberosTicket tgt = privateCredentials.iterator().next(); | ||
| assertNotNull("No kerberos ticket found.", tgt); | ||
|
|
||
| // The name of the principal | ||
| final String clientPrincipalName = clientPrincipals.iterator().next().getName(); | ||
|
|
||
| return Subject.doAs(clientSubject, new PrivilegedExceptionAction<CloseableHttpClient>() { | ||
| @Override | ||
| public CloseableHttpClient run() throws Exception { | ||
| // Logs in with Kerberos via GSS | ||
| GSSManager gssManager = GSSManager.getInstance(); | ||
| // jGSS Kerberos login constant | ||
| Oid oid = new Oid("1.2.840.113554.1.2.2"); | ||
| GSSName gssClient = gssManager.createName(clientPrincipalName, GSSName.NT_USER_NAME); | ||
| GSSCredential credential = gssManager.createCredential(gssClient, | ||
| GSSCredential.DEFAULT_LIFETIME, oid, GSSCredential.INITIATE_ONLY); | ||
|
|
||
| Lookup<AuthSchemeProvider> authRegistry = RegistryBuilder.<AuthSchemeProvider>create() | ||
| .register(AuthSchemes.SPNEGO, new SPNegoSchemeFactory(true, true)) | ||
| .build(); | ||
|
|
||
| BasicCredentialsProvider credentialsProvider = new BasicCredentialsProvider(); | ||
| credentialsProvider.setCredentials(AuthScope.ANY, new KerberosCredentials(credential)); | ||
|
|
||
| return HttpClients.custom() | ||
| .setDefaultAuthSchemeRegistry(authRegistry) | ||
| .setDefaultCredentialsProvider(credentialsProvider) | ||
| .build(); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're doing this ourselves instead of using Hadoop Configuration's deprecation mechanisms because we want a different fall back order? Or we can't set deprecation soon enough for some reason?
We should have comments proactively letting future folks know the reasoning.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm let me take a look at what Hadoop Configuration's deprecation options are - I didn't know that was a fine. The old config is still technically valid just not for SPNEGO. I'll see if that is an option here to fallback with a message.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So I don't think using the Hadoop
Configurationdeprecations will work here. The existing config keyhbase.thrift.kerberos.principalis still valid and needs to be used for Kerberos communication between HBase Thrift Server to backend HBase master/rs. The new config keyhbase.thrift.spnego.principalshould be used for SPNEGO (handling SPNEGO HTTP only not for backend communication).So its not really a deprecation per say, but more configuration to split out the principal/keytab used for SPNEGO versus backend communication. In an ideal world, the config
hbase.thrift.kerberos.principalwould never have done double duty.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a comment specifically for this case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given I missed this the first time, the comment clearly explains things to me. Resolving.