-
Notifications
You must be signed in to change notification settings - Fork 3.7k
[improve][broker] Authorize originalPrincipal when provided #19830
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
Merged
mattisonchao
merged 1 commit into
apache:branch-2.11
from
michaeljmarshall:improve-proxy-authz
Mar 17, 2023
Merged
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 hidden or 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
135 changes: 135 additions & 0 deletions
135
...common/src/test/java/org/apache/pulsar/broker/authorization/AuthorizationServiceTest.java
This file contains hidden or 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,135 @@ | ||
| /** | ||
| * 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.authorization; | ||
|
|
||
| import static org.testng.AssertJUnit.assertFalse; | ||
| import static org.testng.AssertJUnit.assertTrue; | ||
| import java.util.HashSet; | ||
| import org.apache.pulsar.broker.PulsarServerException; | ||
| import org.apache.pulsar.broker.ServiceConfiguration; | ||
| import org.apache.pulsar.common.naming.NamespaceName; | ||
| import org.apache.pulsar.common.naming.TopicName; | ||
| import org.apache.pulsar.common.policies.data.NamespaceOperation; | ||
| import org.apache.pulsar.common.policies.data.PolicyName; | ||
| import org.apache.pulsar.common.policies.data.PolicyOperation; | ||
| import org.apache.pulsar.common.policies.data.TenantOperation; | ||
| import org.apache.pulsar.common.policies.data.TopicOperation; | ||
| import org.testng.annotations.BeforeClass; | ||
| import org.testng.annotations.DataProvider; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| public class AuthorizationServiceTest { | ||
|
|
||
| AuthorizationService authorizationService; | ||
|
|
||
| @BeforeClass | ||
| void beforeClass() throws PulsarServerException { | ||
| ServiceConfiguration conf = new ServiceConfiguration(); | ||
| conf.setAuthorizationEnabled(true); | ||
| // Consider both of these proxy roles to make testing more comprehensive | ||
| HashSet<String> proxyRoles = new HashSet<>(); | ||
| proxyRoles.add("pass.proxy"); | ||
| proxyRoles.add("fail.proxy"); | ||
| conf.setProxyRoles(proxyRoles); | ||
| conf.setAuthorizationProvider(MockAuthorizationProvider.class.getName()); | ||
| authorizationService = new AuthorizationService(conf, null); | ||
| } | ||
|
|
||
| /** | ||
| * See {@link MockAuthorizationProvider} for the implementation of the mock authorization provider. | ||
| */ | ||
| @DataProvider(name = "roles") | ||
| public Object[][] encryptionProvider() { | ||
| return new Object[][]{ | ||
| // Schema: role, originalRole, whether authorization should pass | ||
|
|
||
| // Client conditions where original role isn't passed or is blank | ||
| {"pass.client", null, Boolean.TRUE}, | ||
| {"pass.client", " ", Boolean.TRUE}, | ||
| {"fail.client", null, Boolean.FALSE}, | ||
| {"fail.client", " ", Boolean.FALSE}, | ||
|
|
||
| // Proxy conditions where original role isn't passed or is blank | ||
nodece marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| {"pass.proxy", null, Boolean.FALSE}, | ||
| {"pass.proxy", " ", Boolean.FALSE}, | ||
| {"fail.proxy", null, Boolean.FALSE}, | ||
| {"fail.proxy", " ", Boolean.FALSE}, | ||
|
|
||
| // Normal proxy and client conditions | ||
| {"pass.proxy", "pass.client", Boolean.TRUE}, | ||
| {"pass.proxy", "fail.client", Boolean.FALSE}, | ||
| {"fail.proxy", "pass.client", Boolean.FALSE}, | ||
| {"fail.proxy", "fail.client", Boolean.FALSE}, | ||
|
|
||
| // Not proxy with original principal | ||
| {"pass.not-proxy", "pass.client", Boolean.TRUE}, | ||
| {"pass.not-proxy", "fail.client", Boolean.FALSE}, | ||
| {"fail.not-proxy", "pass.client", Boolean.FALSE}, | ||
| {"fail.not-proxy", "fail.client", Boolean.FALSE}, | ||
|
|
||
| // Covers an unlikely scenario, but valid in the context of this test | ||
| {null, "pass.proxy", Boolean.FALSE}, | ||
| }; | ||
| } | ||
|
|
||
| private void checkResult(boolean expected, boolean actual) { | ||
| if (expected) { | ||
| assertTrue(actual); | ||
| } else { | ||
| assertFalse(actual); | ||
| } | ||
| } | ||
|
|
||
| @Test(dataProvider = "roles") | ||
| public void testAllowTenantOperationAsync(String role, String originalRole, boolean shouldPass) throws Exception { | ||
| boolean isAuthorized = authorizationService.allowTenantOperationAsync("tenant", | ||
| TenantOperation.DELETE_NAMESPACE, originalRole, role, null).get(); | ||
| checkResult(shouldPass, isAuthorized); | ||
| } | ||
|
|
||
| @Test(dataProvider = "roles") | ||
| public void testNamespaceOperationAsync(String role, String originalRole, boolean shouldPass) throws Exception { | ||
| boolean isAuthorized = authorizationService.allowNamespaceOperationAsync(NamespaceName.get("public/default"), | ||
| NamespaceOperation.PACKAGES, originalRole, role, null).get(); | ||
| checkResult(shouldPass, isAuthorized); | ||
| } | ||
|
|
||
| @Test(dataProvider = "roles") | ||
| public void testTopicOperationAsync(String role, String originalRole, boolean shouldPass) throws Exception { | ||
| boolean isAuthorized = authorizationService.allowTopicOperationAsync(TopicName.get("topic"), | ||
| TopicOperation.PRODUCE, originalRole, role, null).get(); | ||
| checkResult(shouldPass, isAuthorized); | ||
| } | ||
|
|
||
| @Test(dataProvider = "roles") | ||
| public void testNamespacePolicyOperationAsync(String role, String originalRole, boolean shouldPass) | ||
| throws Exception { | ||
| boolean isAuthorized = authorizationService.allowNamespacePolicyOperationAsync( | ||
| NamespaceName.get("public/default"), PolicyName.ALL, PolicyOperation.READ, originalRole, role, null) | ||
| .get(); | ||
| checkResult(shouldPass, isAuthorized); | ||
| } | ||
|
|
||
| @Test(dataProvider = "roles") | ||
| public void testTopicPolicyOperationAsync(String role, String originalRole, boolean shouldPass) throws Exception { | ||
| boolean isAuthorized = authorizationService.allowTopicPolicyOperationAsync(TopicName.get("topic"), | ||
| PolicyName.ALL, PolicyOperation.READ, originalRole, role, null).get(); | ||
| checkResult(shouldPass, isAuthorized); | ||
| } | ||
| } | ||
135 changes: 135 additions & 0 deletions
135
...ommon/src/test/java/org/apache/pulsar/broker/authorization/MockAuthorizationProvider.java
This file contains hidden or 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,135 @@ | ||
| /** | ||
| * 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.authorization; | ||
|
|
||
| import org.apache.pulsar.broker.authentication.AuthenticationDataSource; | ||
| import org.apache.pulsar.common.naming.NamespaceName; | ||
| import org.apache.pulsar.common.naming.TopicName; | ||
| import org.apache.pulsar.common.policies.data.AuthAction; | ||
| import org.apache.pulsar.common.policies.data.NamespaceOperation; | ||
| import org.apache.pulsar.common.policies.data.PolicyName; | ||
| import org.apache.pulsar.common.policies.data.PolicyOperation; | ||
| import org.apache.pulsar.common.policies.data.TenantOperation; | ||
| import org.apache.pulsar.common.policies.data.TopicOperation; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Set; | ||
| import java.util.concurrent.CompletableFuture; | ||
|
|
||
| /** | ||
| * Mock implementation of the authorization provider interface used for testing. | ||
| * A role is authorized if it starts with "pass". | ||
| */ | ||
| public class MockAuthorizationProvider implements AuthorizationProvider { | ||
|
|
||
| private CompletableFuture<Boolean> shouldPass(String role) { | ||
| return CompletableFuture.completedFuture(role != null && role.startsWith("pass")); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> canProduceAsync(TopicName topicName, String role, | ||
| AuthenticationDataSource authenticationData) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> canConsumeAsync(TopicName topicName, String role, | ||
| AuthenticationDataSource authenticationData, String subscription) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> canLookupAsync(TopicName topicName, String role, | ||
| AuthenticationDataSource authenticationData) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> allowFunctionOpsAsync(NamespaceName namespaceName, String role, | ||
| AuthenticationDataSource authenticationData) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> allowSourceOpsAsync(NamespaceName namespaceName, String role, | ||
| AuthenticationDataSource authenticationData) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> allowTenantOperationAsync(String tenantName, String role, TenantOperation operation, AuthenticationDataSource authData) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> allowNamespaceOperationAsync(NamespaceName namespaceName, String role, NamespaceOperation operation, AuthenticationDataSource authData) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> allowNamespacePolicyOperationAsync(NamespaceName namespaceName, PolicyName policy, PolicyOperation operation, String role, AuthenticationDataSource authData) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> allowTopicOperationAsync(TopicName topic, String role, TopicOperation operation, AuthenticationDataSource authData) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> allowTopicPolicyOperationAsync(TopicName topic, String role, PolicyName policy, PolicyOperation operation, AuthenticationDataSource authData) { | ||
| return shouldPass(role); | ||
| } | ||
|
|
||
|
|
||
| @Override | ||
| public CompletableFuture<Boolean> allowSinkOpsAsync(NamespaceName namespaceName, String role, AuthenticationDataSource authenticationData) { | ||
| return null; | ||
| } | ||
|
|
||
|
|
||
| @Override | ||
| public CompletableFuture<Void> grantPermissionAsync(NamespaceName namespace, Set<AuthAction> actions, String role, | ||
| String authDataJson) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Void> grantSubscriptionPermissionAsync(NamespaceName namespace, String subscriptionName, | ||
| Set<String> roles, String authDataJson) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Void> revokeSubscriptionPermissionAsync(NamespaceName namespace, String subscriptionName, | ||
| String role, String authDataJson) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Void> grantPermissionAsync(TopicName topicName, Set<AuthAction> actions, String role, | ||
| String authDataJson) { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public void close() throws IOException { | ||
|
|
||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.