Skip to content
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

[fix][broker] support missing tenant level fine-granted permissions #23660

Merged
merged 8 commits into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
import org.apache.pulsar.common.naming.NamedEntity;
import org.apache.pulsar.common.policies.data.TenantInfo;
import org.apache.pulsar.common.policies.data.TenantInfoImpl;
import org.apache.pulsar.common.policies.data.TenantOperation;
import org.apache.pulsar.common.util.FutureUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand All @@ -62,7 +63,7 @@ public class TenantsBase extends PulsarWebResource {
@ApiResponse(code = 404, message = "Tenant doesn't exist")})
public void getTenants(@Suspended final AsyncResponse asyncResponse) {
final String clientAppId = clientAppId();
validateSuperUserAccessAsync()
validateBothSuperUserAndTenantOperation(null, TenantOperation.LIST_TENANTS)
.thenCompose(__ -> tenantResources().listTenantsAsync())
.thenAccept(tenants -> {
// deep copy the tenants to avoid concurrent sort exception
Expand All @@ -84,7 +85,7 @@ public void getTenants(@Suspended final AsyncResponse asyncResponse) {
public void getTenantAdmin(@Suspended final AsyncResponse asyncResponse,
@ApiParam(value = "The tenant name") @PathParam("tenant") String tenant) {
final String clientAppId = clientAppId();
validateSuperUserAccessAsync()
validateBothSuperUserAndTenantOperation(tenant, TenantOperation.GET_TENANT)
.thenCompose(__ -> tenantResources().getTenantAsync(tenant))
.thenApply(tenantInfo -> {
if (!tenantInfo.isPresent()) {
Expand Down Expand Up @@ -121,7 +122,7 @@ public void createTenant(@Suspended final AsyncResponse asyncResponse,
asyncResponse.resume(new RestException(Status.PRECONDITION_FAILED, "Tenant name is not valid"));
return;
}
validateSuperUserAccessAsync()
validateBothSuperUserAndTenantOperation(tenant, TenantOperation.CREATE_TENANT)
.thenCompose(__ -> validatePoliciesReadOnlyAccessAsync())
.thenCompose(__ -> validateClustersAsync(tenantInfo))
.thenCompose(__ -> validateAdminRoleAsync(tenantInfo))
Expand Down Expand Up @@ -169,7 +170,7 @@ public void updateTenant(@Suspended final AsyncResponse asyncResponse,
@ApiParam(value = "The tenant name") @PathParam("tenant") String tenant,
@ApiParam(value = "TenantInfo") TenantInfoImpl newTenantAdmin) {
final String clientAppId = clientAppId();
validateSuperUserAccessAsync()
validateBothSuperUserAndTenantOperation(tenant, TenantOperation.UPDATE_TENANT)
.thenCompose(__ -> validatePoliciesReadOnlyAccessAsync())
.thenCompose(__ -> validateClustersAsync(newTenantAdmin))
.thenCompose(__ -> validateAdminRoleAsync(newTenantAdmin))
Expand Down Expand Up @@ -206,7 +207,7 @@ public void deleteTenant(@Suspended final AsyncResponse asyncResponse,
@PathParam("tenant") @ApiParam(value = "The tenant name") String tenant,
@QueryParam("force") @DefaultValue("false") boolean force) {
final String clientAppId = clientAppId();
validateSuperUserAccessAsync()
validateBothSuperUserAndTenantOperation(tenant, TenantOperation.DELETE_TENANT)
.thenCompose(__ -> validatePoliciesReadOnlyAccessAsync())
.thenCompose(__ -> internalDeleteTenant(tenant, force))
.thenAccept(__ -> {
Expand Down Expand Up @@ -304,4 +305,41 @@ private CompletableFuture<Void> validateAdminRoleAsync(TenantInfoImpl info) {
}
return CompletableFuture.completedFuture(null);
}

private CompletableFuture<Boolean> validateBothSuperUserAndTenantOperation(String tenant,
TenantOperation operation) {
final var superUserValidationFuture = validateSuperUserAccessAsync();
final var tenantOperationValidationFuture = validateTenantOperationAsync(tenant, operation);
return CompletableFuture.allOf(superUserValidationFuture, tenantOperationValidationFuture)
.handle((__, err) -> {
if (!superUserValidationFuture.isCompletedExceptionally()
|| !tenantOperationValidationFuture.isCompletedExceptionally()) {
return true;
}
if (log.isDebugEnabled()) {
Throwable superUserValidationException = null;
try {
superUserValidationFuture.join();
} catch (Throwable ex) {
superUserValidationException = FutureUtil.unwrapCompletionException(ex);
}
Throwable brokerOperationValidationException = null;
try {
tenantOperationValidationFuture.join();
} catch (Throwable ex) {
brokerOperationValidationException = FutureUtil.unwrapCompletionException(ex);
}
log.debug("validateBothTenantOperationAndSuperUser failed."
+ " originalPrincipal={} clientAppId={} operation={} "
+ "superuserValidationError={} tenantOperationValidationError={}",
originalPrincipal(), clientAppId(), operation.toString(),
superUserValidationException, brokerOperationValidationException);
}
throw new RestException(Status.UNAUTHORIZED,
String.format("Unauthorized to validateBothTenantOperationAndSuperUser for"
+ " originalPrincipal [%s] and clientAppId [%s] "
+ "about operation [%s] ",
originalPrincipal(), clientAppId(), operation.toString()));
});
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
/*
* 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.admin;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isNull;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import lombok.SneakyThrows;
import org.apache.commons.lang3.reflect.FieldUtils;
import org.apache.pulsar.broker.authorization.AuthorizationService;
import org.apache.pulsar.client.admin.PulsarAdmin;
import org.apache.pulsar.client.admin.PulsarAdminException;
import org.apache.pulsar.client.impl.auth.AuthenticationToken;
import org.apache.pulsar.common.policies.data.TenantInfo;
import org.apache.pulsar.common.policies.data.TenantOperation;
import org.apache.pulsar.security.MockedPulsarStandalone;
import org.mockito.Mockito;
import org.testng.Assert;
import org.testng.annotations.AfterClass;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import java.util.Set;
import java.util.UUID;

@Test(groups = "broker-admin")
public class TenantEndpointsAuthorizationTest extends MockedPulsarStandalone {

private AuthorizationService orignalAuthorizationService;
private AuthorizationService spyAuthorizationService;

private PulsarAdmin superUserAdmin;
private PulsarAdmin nobodyAdmin;

@SneakyThrows
@BeforeClass(alwaysRun = true)
public void setup() {
configureTokenAuthentication();
configureDefaultAuthorization();
start();
this.superUserAdmin = PulsarAdmin.builder()
.serviceHttpUrl(getPulsarService().getWebServiceAddress())
.authentication(new AuthenticationToken(SUPER_USER_TOKEN))
.build();
this.nobodyAdmin = PulsarAdmin.builder()
.serviceHttpUrl(getPulsarService().getWebServiceAddress())
.authentication(new AuthenticationToken(NOBODY_TOKEN))
.build();
}

@BeforeMethod(alwaysRun = true)
public void before() throws IllegalAccessException {
orignalAuthorizationService = getPulsarService().getBrokerService().getAuthorizationService();
spyAuthorizationService = spy(orignalAuthorizationService);
FieldUtils.writeField(getPulsarService().getBrokerService(), "authorizationService",
spyAuthorizationService, true);
}

@AfterMethod(alwaysRun = true)
public void after() throws IllegalAccessException {
if (orignalAuthorizationService != null) {
FieldUtils.writeField(getPulsarService().getBrokerService(), "authorizationService", orignalAuthorizationService, true);
}
}

@SneakyThrows
@AfterClass(alwaysRun = true)
public void cleanup() {
if (superUserAdmin != null) {
superUserAdmin.close();
superUserAdmin = null;
}
spyAuthorizationService = null;
orignalAuthorizationService = null;
super.close();
}

@Test
public void testListTenants() throws PulsarAdminException {
superUserAdmin.tenants().getTenants();
// test allow broker operation
verify(spyAuthorizationService)
.allowTenantOperationAsync(isNull(), Mockito.eq(TenantOperation.LIST_TENANTS), any(), any());
// fallback to superuser
verify(spyAuthorizationService).isSuperUser(any(), any());

// ---- test nobody
Assert.assertThrows(PulsarAdminException.NotAuthorizedException.class, () -> nobodyAdmin.tenants().getTenants());
}


@Test
public void testGetTenant() throws PulsarAdminException {
String tenantName = "public";
superUserAdmin.tenants().getTenantInfo(tenantName);
// test allow broker operation
verify(spyAuthorizationService)
.allowTenantOperationAsync(eq(tenantName), Mockito.eq(TenantOperation.GET_TENANT), any(), any());
// fallback to superuser
verify(spyAuthorizationService).isSuperUser(any(), any());

// ---- test nobody
Assert.assertThrows(PulsarAdminException.NotAuthorizedException.class, () -> nobodyAdmin.tenants().getTenantInfo(tenantName));
}

@Test
public void testUpdateTenant() throws PulsarAdminException {
String tenantName = "public";
superUserAdmin.tenants().updateTenant(tenantName, TenantInfo.builder()
.allowedClusters(Set.of(getPulsarService().getConfiguration().getClusterName()))
.adminRoles(Set.of("example")).build());
// test allow broker operation
verify(spyAuthorizationService)
.allowTenantOperationAsync(eq(tenantName), Mockito.eq(TenantOperation.UPDATE_TENANT), any(), any());
// fallback to superuser
verify(spyAuthorizationService).isSuperUser(any(), any());

// ---- test nobody
Assert.assertThrows(PulsarAdminException.NotAuthorizedException.class, () -> nobodyAdmin.tenants()
.updateTenant(tenantName, TenantInfo.builder().adminRoles(Set.of("example")).build()));
}

@Test
public void testDeleteTenant() throws PulsarAdminException {
String tenantName = UUID.randomUUID().toString();
superUserAdmin.tenants().createTenant(tenantName, TenantInfo.builder()
.allowedClusters(Set.of(getPulsarService().getConfiguration().getClusterName()))
.adminRoles(Set.of("example")).build());

Mockito.clearInvocations(spyAuthorizationService);
superUserAdmin.tenants().deleteTenant(tenantName);
// test allow broker operation
verify(spyAuthorizationService)
.allowTenantOperationAsync(eq(tenantName), Mockito.eq(TenantOperation.DELETE_TENANT), any(), any());
// fallback to superuser
verify(spyAuthorizationService).isSuperUser(any(), any());

// ---- test nobody
Assert.assertThrows(PulsarAdminException.NotAuthorizedException.class, () -> nobodyAdmin.tenants().deleteTenant(tenantName));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,10 @@ public enum TenantOperation {
CREATE_NAMESPACE,
DELETE_NAMESPACE,
LIST_NAMESPACES,

LIST_TENANTS,
GET_TENANT,
CREATE_TENANT,
UPDATE_TENANT,
DELETE_TENANT,
}
Loading