forked from apache/pulsar
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PLSR-1470: Only auth _errors_ should log at error level (apache#9325)
An authentication failure should not log at error level, as it depends on the credentials that the client provides, which may well be wrong. An authentication/authorization error, where it cannot be decided if credentials are valid or not, is an error that needs operator attention and therefore should be logged at error level. Co-authored-by: Ivan Kelly <[email protected]> Co-authored-by: Matteo Merli <[email protected]> Co-authored-by: Sijie Guo <[email protected]>
- Loading branch information
4 people
authored
Feb 15, 2021
1 parent
6ebc795
commit fd9875c
Showing
7 changed files
with
693 additions
and
18 deletions.
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
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
222 changes: 222 additions & 0 deletions
222
pulsar-broker/src/test/java/org/apache/pulsar/broker/auth/AuthLogsTest.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,222 @@ | ||
| /** | ||
| * 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.broker.auth; | ||
|
|
||
| import static org.testng.Assert.fail; | ||
|
|
||
| import org.apache.pulsar.common.policies.data.ClusterData; | ||
| import org.apache.pulsar.common.policies.data.TenantInfo; | ||
| import org.testng.annotations.AfterClass; | ||
|
|
||
| import org.testng.annotations.BeforeClass; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import org.apache.pulsar.client.admin.PulsarAdmin; | ||
| import org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException; | ||
| import org.apache.pulsar.client.admin.PulsarAdminException.ServerSideErrorException; | ||
| import org.apache.pulsar.client.api.Consumer; | ||
| import org.apache.pulsar.client.api.PulsarClient; | ||
| import org.apache.pulsar.client.api.PulsarClientException.AuthenticationException; | ||
| import org.apache.pulsar.client.api.PulsarClientException.AuthorizationException; | ||
| import org.apache.pulsar.client.api.Producer; | ||
| import com.google.common.collect.Sets; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This test doesn't test much in and off itself. | ||
| * However it is useful to see which logs are produced when there's an | ||
| * failure or error in authentication. | ||
| */ | ||
| public class AuthLogsTest extends MockedPulsarServiceBaseTest { | ||
| private static final Logger log = LoggerFactory.getLogger(AuthLogsTest.class); | ||
|
|
||
| public AuthLogsTest() { | ||
| super(); | ||
| } | ||
|
|
||
| @BeforeClass | ||
| @Override | ||
| public void setup() throws Exception { | ||
| conf.setClusterName("test"); | ||
| conf.setAuthenticationEnabled(true); | ||
| conf.setAuthenticationProviders( | ||
| Sets.newHashSet("org.apache.pulsar.broker.auth.MockAuthenticationProvider")); | ||
| conf.setAuthorizationProvider("org.apache.pulsar.broker.auth.MockAuthorizationProvider"); | ||
| conf.setAuthorizationEnabled(true); | ||
| conf.setAuthorizationAllowWildcardsMatching(true); | ||
| conf.setSuperUserRoles(Sets.newHashSet("super")); | ||
| internalSetup(); | ||
|
|
||
| try (PulsarAdmin admin = PulsarAdmin.builder() | ||
| .authentication(new MockAuthentication("pass.pass")) | ||
| .serviceHttpUrl(brokerUrl.toString()).build()) { | ||
| admin.clusters().createCluster("test", new ClusterData(pulsar.getWebServiceAddress())); | ||
| admin.tenants().createTenant("public", | ||
| new TenantInfo(Sets.newHashSet("appid1", "appid2"), Sets.newHashSet("test"))); | ||
| admin.namespaces().createNamespace("public/default"); | ||
| admin.namespaces().setNamespaceReplicationClusters("public/default", Sets.newHashSet("test")); | ||
| } | ||
| } | ||
|
|
||
| @AfterClass(alwaysRun = true) | ||
| @Override | ||
| public void cleanup() throws Exception { | ||
| internalCleanup(); | ||
| } | ||
|
|
||
| @Test | ||
| public void binaryEndpoint() throws Exception { | ||
| log.info("LOG_TEST_SUCCESS_CLIENT should succeeed both client"); | ||
| try (PulsarClient client = PulsarClient.builder() | ||
| .serviceUrl(pulsar.getBrokerServiceUrl()) | ||
| .authentication(new MockAuthentication("pass.pass")) | ||
| .build(); | ||
| Producer<byte[]> producer = client.newProducer().topic("foobar").create(); | ||
| Consumer<byte[]> consumer = client.newConsumer().topic("foobar") | ||
| .subscriptionName("foobar").subscribe()) { | ||
| } | ||
|
|
||
| log.info("LOG_TEST_PRODUCER_AUTHN_FAIL"); | ||
| try (PulsarClient client = PulsarClient.builder() | ||
| .serviceUrl(pulsar.getBrokerServiceUrl()) | ||
| .authentication(new MockAuthentication("fail.ignored")) | ||
| .build(); | ||
| Producer<byte[]> producer = client.newProducer().topic("foobar").create()) { | ||
| fail("Should fail auth"); | ||
| } catch (AuthenticationException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_PRODUCER_AUTHN_ERROR"); | ||
| try (PulsarClient client = PulsarClient.builder() | ||
| .serviceUrl(pulsar.getBrokerServiceUrl()) | ||
| .authentication(new MockAuthentication("error.ignored")) | ||
| .build(); | ||
| Producer<byte[]> producer = client.newProducer().topic("foobar").create()) { | ||
| fail("Should fail auth"); | ||
| } catch (AuthenticationException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_CONSUMER_AUTHN_FAIL"); | ||
| try (PulsarClient client = PulsarClient.builder() | ||
| .serviceUrl(pulsar.getBrokerServiceUrl()) | ||
| .authentication(new MockAuthentication("fail.ignored")) | ||
| .build(); | ||
| Consumer<byte[]> consumer = client.newConsumer().topic("foobar") | ||
| .subscriptionName("foobar").subscribe()) { | ||
| fail("Should fail auth"); | ||
| } catch (AuthenticationException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_CONSUMER_AUTHN_ERROR"); | ||
| try (PulsarClient client = PulsarClient.builder() | ||
| .serviceUrl(pulsar.getBrokerServiceUrl()) | ||
| .authentication(new MockAuthentication("error.ignored")) | ||
| .build(); | ||
| Consumer<byte[]> consumer = client.newConsumer().topic("foobar") | ||
| .subscriptionName("foobar").subscribe()) { | ||
| fail("Should fail auth"); | ||
| } catch (AuthenticationException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_PRODUCER_AUTHZ_FAIL"); | ||
| try (PulsarClient client = PulsarClient.builder() | ||
| .serviceUrl(pulsar.getBrokerServiceUrl()) | ||
| .authentication(new MockAuthentication("pass.fail")) | ||
| .build(); | ||
| Producer<byte[]> producer = client.newProducer().topic("foobar").create()) { | ||
| fail("Should fail auth"); | ||
| } catch (AuthorizationException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_PRODUCER_AUTHZ_ERROR"); | ||
| try (PulsarClient client = PulsarClient.builder() | ||
| .serviceUrl(pulsar.getBrokerServiceUrl()) | ||
| .authentication(new MockAuthentication("pass.error")) | ||
| .build(); | ||
| Producer<byte[]> producer = client.newProducer().topic("foobar").create()) { | ||
| fail("Should fail auth"); | ||
| } catch (AuthorizationException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_CONSUMER_AUTHZ_FAIL"); | ||
| try (PulsarClient client = PulsarClient.builder() | ||
| .serviceUrl(pulsar.getBrokerServiceUrl()) | ||
| .authentication(new MockAuthentication("pass.fail")) | ||
| .build(); | ||
| Consumer<byte[]> consumer = client.newConsumer().topic("foobar") | ||
| .subscriptionName("foobar").subscribe()) { | ||
| fail("Should fail auth"); | ||
| } catch (AuthorizationException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_CONSUMER_AUTHZ_ERROR"); | ||
| try (PulsarClient client = PulsarClient.builder() | ||
| .serviceUrl(pulsar.getBrokerServiceUrl()) | ||
| .authentication(new MockAuthentication("pass.error")) | ||
| .build(); | ||
| Consumer<byte[]> consumer = client.newConsumer().topic("foobar") | ||
| .subscriptionName("foobar").subscribe()) { | ||
| fail("Should fail auth"); | ||
| } catch (AuthorizationException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_CLIENT_DONE"); | ||
| } | ||
|
|
||
| @Test | ||
| public void httpEndpoint() throws Exception { | ||
| log.info("LOG_TEST_SUCCESS_CLIENT should succeeed both client"); | ||
| try (PulsarAdmin admin = PulsarAdmin.builder() | ||
| .authentication(new MockAuthentication("pass.pass")) | ||
| .serviceHttpUrl(brokerUrl.toString()).build()) { | ||
| admin.namespaces().getNamespaces("public"); | ||
| } | ||
|
|
||
| log.info("LOG_TEST_HTTP_AUTHN_FAIL"); | ||
| try (PulsarAdmin admin = PulsarAdmin.builder() | ||
| .authentication(new MockAuthentication("fail.ignore")) | ||
| .serviceHttpUrl(brokerUrl.toString()).build()) { | ||
| admin.namespaces().getNamespaces("public"); | ||
| fail("Should fail auth"); | ||
| } catch (NotAuthorizedException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_HTTP_AUTHN_ERROR"); | ||
| try (PulsarAdmin admin = PulsarAdmin.builder() | ||
| .authentication(new MockAuthentication("error.ignore")) | ||
| .serviceHttpUrl(brokerUrl.toString()).build()) { | ||
| admin.namespaces().getNamespaces("public"); | ||
| fail("Should fail auth"); | ||
| } catch (NotAuthorizedException ae) { /* expected */ } | ||
|
|
||
|
|
||
| log.info("LOG_TEST_HTTP_AUTHZ_FAIL"); | ||
| try (PulsarAdmin admin = PulsarAdmin.builder() | ||
| .authentication(new MockAuthentication("pass.fail")) | ||
| .serviceHttpUrl(brokerUrl.toString()).build()) { | ||
| admin.namespaces().getNamespaces("public"); | ||
| fail("Should fail auth"); | ||
| } catch (NotAuthorizedException ae) { /* expected */ } | ||
|
|
||
| log.info("LOG_TEST_HTTP_AUTHZ_ERROR"); | ||
| try (PulsarAdmin admin = PulsarAdmin.builder() | ||
| .authentication(new MockAuthentication("pass.error")) | ||
| .serviceHttpUrl(brokerUrl.toString()).build()) { | ||
| admin.namespaces().getNamespaces("public"); | ||
| fail("Should fail auth"); | ||
| } catch (ServerSideErrorException ae) { /* expected */ } | ||
|
|
||
|
|
||
| log.info("LOG_TEST_CLIENT_DONE"); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.