rdhabalia commented on a change in pull request #1707: Fixed authentication flow via Pulsar Proxy URL: https://github.com/apache/incubator-pulsar/pull/1707#discussion_r185668018
########## File path: pulsar-proxy/src/test/java/org/apache/pulsar/proxy/server/ProxyAuthenticationTest.java ########## @@ -0,0 +1,269 @@ +/** + * 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.pulsar.proxy.server; + +import static org.mockito.Mockito.spy; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.TimeUnit; +import java.util.Set; + +import javax.naming.AuthenticationException; + +import org.apache.bookkeeper.test.PortManager; +import org.apache.pulsar.broker.ServiceConfiguration; +import org.apache.pulsar.broker.authentication.AuthenticationDataSource; +import org.apache.pulsar.broker.authentication.AuthenticationProvider; +import org.apache.pulsar.client.admin.PulsarAdmin; +import org.apache.pulsar.client.api.Authentication; +import org.apache.pulsar.client.api.AuthenticationDataProvider; +import org.apache.pulsar.client.api.Consumer; +import org.apache.pulsar.client.api.Message; +import org.apache.pulsar.client.api.MessageId; +import org.apache.pulsar.client.api.Producer; +import org.apache.pulsar.client.api.ProducerConsumerBase; +import org.apache.pulsar.client.api.PulsarClient; +import org.apache.pulsar.client.api.PulsarClientException; +import org.apache.pulsar.client.impl.ConsumerImpl; +import org.apache.pulsar.common.policies.data.AuthAction; +import org.apache.pulsar.common.util.FutureUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.testng.Assert; +import org.testng.annotations.AfterMethod; +import org.testng.annotations.BeforeMethod; +import org.testng.annotations.Test; + +import com.google.common.collect.Sets; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; + +public class ProxyAuthenticationTest extends ProducerConsumerBase { + private static final Logger log = LoggerFactory.getLogger(ProxyAuthenticationTest.class); + + public static class BasicAuthenticationData implements AuthenticationDataProvider { + private String authParam; + + public BasicAuthenticationData(String authParam) { + this.authParam = authParam; + } + + public boolean hasDataFromCommand() { + return true; + } + + public String getCommandData() { + return authParam; + } + + public boolean hasDataForHttp() { + return true; + } + + @Override + public Set<Entry<String, String>> getHttpHeaders() { + Map<String, String> headers = new HashMap<>(); + headers.put("BasicAuthentication", authParam); + return headers.entrySet(); + } + } + + public static class BasicAuthentication implements Authentication { + + private String authParam; + + @Override + public void close() throws IOException { + // noop + } + + @Override + public String getAuthMethodName() { + return "BasicAuthentication"; + } + + @Override + public AuthenticationDataProvider getAuthData() throws PulsarClientException { + try { + return new BasicAuthenticationData(authParam); + } catch (Exception e) { + throw new PulsarClientException(e); + } + } + + @Override + public void configure(Map<String, String> authParams) { + this.authParam = String.format("{\"entityType\": \"%s\", \"expiryTime\": \"%s\"}", + authParams.get("entityType"), authParams.get("expiryTime")); + } + + @Override + public void start() throws PulsarClientException { + // noop + } + } + + public static class BasicAuthenticationProvider implements AuthenticationProvider { + + @Override + public void close() throws IOException { + } + + @Override + public void initialize(ServiceConfiguration config) throws IOException { + } + + @Override + public String getAuthMethodName() { + return "BasicAuthentication"; + } + + @Override + public String authenticate(AuthenticationDataSource authData) throws AuthenticationException { + String commandData = null; + if (authData.hasDataFromCommand()) { + commandData = authData.getCommandData(); + } else if (authData.hasDataFromHttp()) { + commandData = authData.getHttpHeader("BasicAuthentication"); + } + + JsonParser parser = new JsonParser(); + JsonObject element = parser.parse(commandData).getAsJsonObject(); + long expiryTimeInMillis = Long.parseLong(element.get("expiryTime").getAsString()); + long currentTimeInMillis = System.currentTimeMillis(); + if (expiryTimeInMillis < currentTimeInMillis) { + throw new AuthenticationException("Authentication data has been expired"); + } + return element.get("entityType").getAsString(); + } + } + + private int webServicePort; + private int servicePort; + + @BeforeMethod + @Override + protected void setup() throws Exception { + webServicePort = PortManager.nextFreePort(); + servicePort = PortManager.nextFreePort(); + conf.setAuthenticationEnabled(true); + conf.setAuthorizationEnabled(true); + conf.setTlsEnabled(false); + conf.setBrokerClientAuthenticationPlugin(BasicAuthentication.class.getName()); + // Expires after an hour + conf.setBrokerClientAuthenticationParameters( + "entityType:broker,expiryTime:" + (System.currentTimeMillis() + 3600 * 1000)); + + Set<String> superUserRoles = new HashSet<String>(); + superUserRoles.add("admin"); + conf.setSuperUserRoles(superUserRoles); + + Set<String> providers = new HashSet<String>(); + providers.add(BasicAuthenticationProvider.class.getName()); + conf.setAuthenticationProviders(providers); + + conf.setClusterName("test"); + Set<String> proxyRoles = new HashSet<String>(); + proxyRoles.add("proxy"); + conf.setProxyRoles(proxyRoles); + conf.setAuthenticateOriginalAuthData(true); + super.init(); + + createAdminClient(); + producerBaseSetup(); + } + + @Override + @AfterMethod + protected void cleanup() throws Exception { + super.internalCleanup(); + } + + @Test + void testAuthentication() throws Exception { + log.info("-- Starting {} test --", methodName); + + // Step 1: Create Admin Client + createAdminClient(); + final String proxyServiceUrl = "pulsar://localhost:" + servicePort; + // create a client which connects to proxy and pass authData + String namespaceName = "my-property/my-ns"; + String topicName = "persistent://my-property/my-ns/my-topic1"; + String subscriptionName = "my-subscriber-name"; + // expires after 6 seconds + String clientAuthParams = "entityType:client,expiryTime:" + (System.currentTimeMillis() + 6 * 1000); + // expires after 3 seconds + String proxyAuthParams = "entityType:proxy,expiryTime:" + (System.currentTimeMillis() + 3 * 1000); + + admin.namespaces().grantPermissionOnNamespace(namespaceName, "proxy", + Sets.newHashSet(AuthAction.consume, AuthAction.produce)); + admin.namespaces().grantPermissionOnNamespace(namespaceName, "client", + Sets.newHashSet(AuthAction.consume, AuthAction.produce)); + + // Step 2: Try to use proxy Client as a normal Client - expect exception + ProxyConfiguration proxyConfig = new ProxyConfiguration(); + proxyConfig.setAuthenticationEnabled(true); + proxyConfig.setServicePort(servicePort); + proxyConfig.setWebServicePort(webServicePort); + proxyConfig.setBrokerServiceURL("pulsar://localhost:" + BROKER_PORT); + + proxyConfig.setBrokerClientAuthenticationPlugin(BasicAuthentication.class.getName()); + proxyConfig.setBrokerClientAuthenticationParameters(proxyAuthParams); + + Set<String> providers = new HashSet<>(); + providers.add(BasicAuthenticationProvider.class.getName()); + proxyConfig.setAuthenticationProviders(providers); + proxyConfig.setForwardAuthorizationCredentials(true); + ProxyService proxyService = new ProxyService(proxyConfig); + + proxyService.start(); + + // Step 3: Pass correct client params + PulsarClient proxyClient = createPulsarClient(proxyServiceUrl, clientAuthParams, 1); + proxyClient.newProducer().topic(topicName).create(); + // Sleep for 4 seconds - wait for proxy auth params to expire + Thread.sleep(4 * 1000); + proxyClient.newProducer().topic(topicName).create(); + // Sleep for 3 seconds - wait for client auth parans to expire + Thread.sleep(3 * 1000); + proxyClient.newProducer().topic(topicName).create(); + proxyClient.close(); + proxyService.close(); + } + + private void createAdminClient() throws PulsarClientException { Review comment: `createAdminClient()` name seems misleading as we are not closing admin and we may think it's leaking. so, probably we can rename it as `updateAdmin()`? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on 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
