joshelser commented on a change in pull request #884: HBASE-23347 Allowable custom authentication methods for RPCs URL: https://github.com/apache/hbase/pull/884#discussion_r359010084
########## File path: hbase-server/src/test/java/org/apache/hadoop/hbase/security/provider/TestCustomSaslAuthenticationProvider.java ########## @@ -0,0 +1,539 @@ +/* + * 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.security.provider; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; +import static org.junit.Assert.fail; + +import java.io.ByteArrayInputStream; +import java.io.DataInput; +import java.io.DataInputStream; +import java.io.DataOutput; +import java.io.File; +import java.io.IOException; +import java.net.InetAddress; +import java.security.PrivilegedExceptionAction; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.ConcurrentHashMap; +import java.util.stream.Collectors; + +import javax.security.auth.callback.Callback; +import javax.security.auth.callback.CallbackHandler; +import javax.security.auth.callback.NameCallback; +import javax.security.auth.callback.PasswordCallback; +import javax.security.auth.callback.UnsupportedCallbackException; +import javax.security.sasl.AuthorizeCallback; +import javax.security.sasl.RealmCallback; +import javax.security.sasl.RealmChoiceCallback; +import javax.security.sasl.Sasl; +import javax.security.sasl.SaslClient; +import javax.security.sasl.SaslServer; + +import org.apache.hadoop.conf.Configuration; +import org.apache.hadoop.fs.Path; +import org.apache.hadoop.hbase.Cell; +import org.apache.hadoop.hbase.CellUtil; +import org.apache.hadoop.hbase.HBaseClassTestRule; +import org.apache.hadoop.hbase.HBaseTestingUtility; +import org.apache.hadoop.hbase.HConstants; +import org.apache.hadoop.hbase.LocalHBaseCluster; +import org.apache.hadoop.hbase.TableName; +import org.apache.hadoop.hbase.client.Admin; +import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder; +import org.apache.hadoop.hbase.client.Connection; +import org.apache.hadoop.hbase.client.ConnectionFactory; +import org.apache.hadoop.hbase.client.Get; +import org.apache.hadoop.hbase.client.Put; +import org.apache.hadoop.hbase.client.Result; +import org.apache.hadoop.hbase.client.RetriesExhaustedException; +import org.apache.hadoop.hbase.client.Table; +import org.apache.hadoop.hbase.client.TableDescriptorBuilder; +import org.apache.hadoop.hbase.coprocessor.CoprocessorHost; +import org.apache.hadoop.hbase.ipc.BlockingRpcClient; +import org.apache.hadoop.hbase.ipc.RpcClientFactory; +import org.apache.hadoop.hbase.ipc.RpcServerFactory; +import org.apache.hadoop.hbase.ipc.SimpleRpcServer; +import org.apache.hadoop.hbase.security.AccessDeniedException; +import org.apache.hadoop.hbase.security.HBaseKerberosUtils; +import org.apache.hadoop.hbase.security.SaslUtil; +import org.apache.hadoop.hbase.security.SecurityInfo; +import org.apache.hadoop.hbase.security.token.SecureTestCluster; +import org.apache.hadoop.hbase.security.token.TokenProvider; +import org.apache.hadoop.hbase.testclassification.MediumTests; +import org.apache.hadoop.hbase.testclassification.SecurityTests; +import org.apache.hadoop.hbase.util.Bytes; +import org.apache.hadoop.hbase.util.FSUtils; +import org.apache.hadoop.hbase.util.Pair; +import org.apache.hadoop.io.Text; +import org.apache.hadoop.io.WritableUtils; +import org.apache.hadoop.minikdc.MiniKdc; +import org.apache.hadoop.security.UserGroupInformation; +import org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod; +import org.apache.hadoop.security.token.SecretManager; +import org.apache.hadoop.security.token.SecretManager.InvalidToken; +import org.apache.hadoop.security.token.Token; +import org.apache.hadoop.security.token.TokenIdentifier; +import org.junit.AfterClass; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.ClassRule; +import org.junit.Rule; +import org.junit.Test; +import org.junit.experimental.categories.Category; +import org.junit.rules.TestName; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.UserInformation; + +/** + * Tests the pluggable authentication framework with SASL using a contrived authentication system. + * + * This tests holds a "user database" in memory as a hashmap. Clients provide their password + * in the client Hadoop configuration. The servers validate this password via the "user database". + */ +@Category({MediumTests.class, SecurityTests.class}) +public class TestCustomSaslAuthenticationProvider { + private static final Logger LOG = LoggerFactory.getLogger( + TestCustomSaslAuthenticationProvider.class); + + @ClassRule + public static final HBaseClassTestRule CLASS_RULE = + HBaseClassTestRule.forClass(TestCustomSaslAuthenticationProvider.class); + + private static final Map<String,String> USER_DATABASE = createUserDatabase(); + + private static final String USER1_PASSWORD = "foobarbaz"; + private static final String USER2_PASSWORD = "bazbarfoo"; + + private static Map<String,String> createUserDatabase() { + Map<String,String> db = new ConcurrentHashMap<>(); + db.put("user1", USER1_PASSWORD); + db.put("user2", USER2_PASSWORD); + return db; + } + + public static String getPassword(String user) { + String password = USER_DATABASE.get(user); + if (password == null) { + throw new IllegalStateException("Cannot request password for a user that doesn't exist"); + } + return password; + } + + /** + * A custom tokenidentifier for our custom auth'n method. Unique from the TokenIdentifier + * used for delegation tokens. + */ + public static class PasswordAuthTokenIdentifier extends TokenIdentifier { + public static final Text PASSWORD_AUTH_TOKEN = new Text("HBASE_PASSWORD_TEST_TOKEN"); + private String username; + + public PasswordAuthTokenIdentifier() {} + + public PasswordAuthTokenIdentifier(String username) { + this.username = username; + } + + @Override + public void readFields(DataInput in) throws IOException { + this.username = WritableUtils.readString(in); + } + + @Override + public void write(DataOutput out) throws IOException { + WritableUtils.writeString(out, username); + } + + @Override + public Text getKind() { + return PASSWORD_AUTH_TOKEN; + } + + @Override + public UserGroupInformation getUser() { + if (username == null || "".equals(username)) { + return null; + } + return UserGroupInformation.createRemoteUser(username); + } + } + + public static Token<? extends TokenIdentifier> createPasswordToken( + String username, String password, String clusterId) { + PasswordAuthTokenIdentifier id = new PasswordAuthTokenIdentifier(username); + Token<? extends TokenIdentifier> token = new Token<>(id.getBytes(), Bytes.toBytes(password), + id.getKind(), new Text(clusterId)); + return token; + } + + /** + * Client provider that finds custom Token in the user's UGI and authenticates with the server + * via DIGEST-MD5 using that password. + */ + public static class InMemoryClientProvider extends AbstractSaslClientAuthenticationProvider { + public static final String MECHANISM = "DIGEST-MD5"; + public static final SaslAuthMethod SASL_AUTH_METHOD = new SaslAuthMethod( + "IN_MEMORY", (byte)42, MECHANISM, AuthenticationMethod.TOKEN); + + @Override + public SaslClient createClient(Configuration conf, InetAddress serverAddr, + SecurityInfo securityInfo, Token<? extends TokenIdentifier> token, boolean fallbackAllowed, + Map<String, String> saslProps) throws IOException { + return Sasl.createSaslClient(new String[] { MECHANISM }, null, null, + SaslUtil.SASL_DEFAULT_REALM, saslProps, new InMemoryClientProviderCallbackHandler(token)); + } + + public Optional<Token<? extends TokenIdentifier>> findToken(UserGroupInformation ugi) { + List<Token<? extends TokenIdentifier>> tokens = ugi.getTokens().stream() + .filter((token) -> token.getKind().equals(PasswordAuthTokenIdentifier.PASSWORD_AUTH_TOKEN)) + .collect(Collectors.toList()); + if (tokens.isEmpty()) { + return Optional.empty(); + } + if (tokens.size() > 1) { + throw new IllegalStateException("Cannot handle more than one PasswordAuthToken"); + } + return Optional.of(tokens.get(0)); + } + + @Override + public SaslAuthMethod getSaslAuthMethod() { + return SASL_AUTH_METHOD; + } + + /** + * Sasl CallbackHandler which extracts information from our custom token and places + * it into the Sasl objects. + */ + public class InMemoryClientProviderCallbackHandler implements CallbackHandler { + private final Token<? extends TokenIdentifier> token; + public InMemoryClientProviderCallbackHandler(Token<? extends TokenIdentifier> token) { + this.token = token; + } + + @Override + public void handle(Callback[] callbacks) throws UnsupportedCallbackException { + NameCallback nc = null; + PasswordCallback pc = null; + RealmCallback rc = null; + for (Callback callback : callbacks) { + if (callback instanceof RealmChoiceCallback) { + continue; + } else if (callback instanceof NameCallback) { + nc = (NameCallback) callback; + } else if (callback instanceof PasswordCallback) { + pc = (PasswordCallback) callback; + } else if (callback instanceof RealmCallback) { + rc = (RealmCallback) callback; + } else { + throw new UnsupportedCallbackException(callback, "Unrecognized SASL client callback"); + } + } + if (nc != null) { + nc.setName(SaslUtil.encodeIdentifier(token.getIdentifier())); + } + if (pc != null) { + pc.setPassword(SaslUtil.encodePassword(token.getPassword())); + } + if (rc != null) { + rc.setText(rc.getDefaultText()); + } + } + } + + @Override + public UserInformation getUserInfo(UserGroupInformation user) { + return null; + } + } + + /** + * Server provider which validates credentials from an in-memory database. + */ + public static class InMemoryServerProvider extends InMemoryClientProvider + implements SaslServerAuthenticationProvider { + + @Override + public AttemptingUserProvidingSaslServer createServer( + SecretManager<TokenIdentifier> secretManager, + Map<String, String> saslProps) throws IOException { + return new AttemptingUserProvidingSaslServer( + Sasl.createSaslServer(getSaslAuthMethod().getSaslMechanism(), null, + SaslUtil.SASL_DEFAULT_REALM, saslProps, new InMemoryServerProviderCallbackHandler()), + () -> null); + } + + /** + * Pulls the correct password for the user who started the SASL handshake so that SASL + * can validate that the user provided the right password. + */ + private class InMemoryServerProviderCallbackHandler implements CallbackHandler { + + @Override + public void handle(Callback[] callbacks) throws InvalidToken, UnsupportedCallbackException { + NameCallback nc = null; + PasswordCallback pc = null; + AuthorizeCallback ac = null; + for (Callback callback : callbacks) { + if (callback instanceof AuthorizeCallback) { + ac = (AuthorizeCallback) callback; + } else if (callback instanceof NameCallback) { + nc = (NameCallback) callback; + } else if (callback instanceof PasswordCallback) { + pc = (PasswordCallback) callback; + } else if (callback instanceof RealmCallback) { + continue; // realm is ignored + } else { + throw new UnsupportedCallbackException(callback, "Unrecognized SASL Callback"); + } + } + if (nc != null && pc != null) { + byte[] encodedId = SaslUtil.decodeIdentifier(nc.getDefaultName()); + PasswordAuthTokenIdentifier id = new PasswordAuthTokenIdentifier(); + try { + id.readFields(new DataInputStream(new ByteArrayInputStream(encodedId))); + } catch (IOException e) { + throw (InvalidToken) new InvalidToken( + "Can't de-serialize tokenIdentifier").initCause(e); + } + char[] actualPassword = SaslUtil.encodePassword( + Bytes.toBytes(getPassword(id.getUser().getUserName()))); + pc.setPassword(actualPassword); + } + if (ac != null) { + String authid = ac.getAuthenticationID(); + String authzid = ac.getAuthorizationID(); + if (authid.equals(authzid)) { + ac.setAuthorized(true); + } else { + ac.setAuthorized(false); + } + if (ac.isAuthorized()) { + ac.setAuthorizedID(authzid); + } + } + } + } + + @Override + public boolean supportsProtocolAuthentication() { + return false; + } + + @Override + public UserGroupInformation getAuthorizedUgi(String authzId, + SecretManager<TokenIdentifier> secretManager) throws IOException { + UserGroupInformation authorizedUgi; + byte[] encodedId = SaslUtil.decodeIdentifier(authzId); + PasswordAuthTokenIdentifier tokenId = new PasswordAuthTokenIdentifier(); + try { + tokenId.readFields(new DataInputStream(new ByteArrayInputStream(encodedId))); + } catch (IOException e) { + throw new IOException("Can't de-serialize PasswordAuthTokenIdentifier", e); + } + authorizedUgi = tokenId.getUser(); + if (authorizedUgi == null) { + throw new AccessDeniedException( + "Can't retrieve username from tokenIdentifier."); + } + authorizedUgi.addTokenIdentifier(tokenId); + authorizedUgi.setAuthenticationMethod(getSaslAuthMethod().getAuthMethod()); + return authorizedUgi; + } + } + + /** + * Custom provider which can select our custom provider, amongst other tokens which + * may be available. + */ + public static class InMemoryProviderSelector extends DefaultProviderSelector { + private InMemoryClientProvider inMemoryProvider; + + @Override + public void configure(Configuration conf, + Map<Byte,SaslClientAuthenticationProvider> providers) { + super.configure(conf, providers); + Optional<SaslClientAuthenticationProvider> o = providers.values().stream() + .filter((p) -> p instanceof InMemoryClientProvider) + .findAny(); + if (!o.isPresent()) { Review comment: Thanks! That's a nice cleanup. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
