Skip to content

Fixes function api can not use authdata to check superuser #10364

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.

Sign up for GitHub

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
sijie merged 3 commits into from
May 4, 2021
Merged

Fixes function api can not use authdata to check superuser #10364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be8bb31
Fixes function api can not use authdata to check superuser
zymap Apr 25, 2021
798b0c4
Fix CI issue
zymap Apr 26, 2021
3f825b7
Fix failed tests
zymap Apr 28, 2021
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
4 changes: 2 additions & 2 deletions pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/FunctionsBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,7 +667,7 @@ public void startFunction(
@Consumes(MediaType.MULTIPART_FORM_DATA)
public void uploadFunction(final @FormDataParam("data") InputStream uploadedInputStream,
final @FormDataParam("path") String path) {
functions().uploadFunction(uploadedInputStream, path, clientAppId());
functions().uploadFunction(uploadedInputStream, path, clientAppId(), clientAuthData());
}

@GET
Expand Down Expand Up @@ -735,6 +735,6 @@ public void updateFunctionOnWorkerLeader(final @PathParam("tenant") String tenan
final @FormDataParam("delete") boolean delete) {

functions().updateFunctionOnWorkerLeader(tenant, namespace, functionName, uploadedInputStream,
delete, uri.getRequestUri(), clientAppId());
delete, uri.getRequestUri(), clientAppId(), clientAuthData());
}
}
2 changes: 1 addition & 1 deletion pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/SinksBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,6 +554,6 @@ public List<ConfigFieldDefinition> getSinkConfigDefinition(
})
@Path("/reloadBuiltInSinks")
public void reloadSinks() {
sinks().reloadConnectors(clientAppId());
sinks().reloadConnectors(clientAppId(), clientAuthData());
}
}
2 changes: 1 addition & 1 deletion pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/SourcesBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,6 +506,6 @@ public List<ConfigFieldDefinition> getSourceConfigDefinition(
})
@Path("/reloadBuiltInSources")
public void reloadSources() {
sources().reloadConnectors(clientAppId());
sources().reloadConnectors(clientAppId(), clientAuthData());
}
}
17 changes: 9 additions & 8 deletions ...tions/worker/src/main/java/org/apache/pulsar/functions/worker/rest/api/ComponentImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -901,13 +901,13 @@ public List<ConnectorDefinition> getListOfConnectors() {
}

@Override
public void reloadConnectors(String clientRole) {
public void reloadConnectors(String clientRole, AuthenticationDataSource authenticationData) {
if (!isWorkerServiceAvailable()) {
throwUnavailableException();
}
if (worker().getWorkerConfig().isAuthorizationEnabled()) {
// Only superuser has permission to do this operation.
if (!isSuperUser(clientRole)) {
if (!isSuperUser(clientRole, authenticationData)) {
throw new RestException(Status.UNAUTHORIZED, "This operation requires super-user access");
}
}
Expand Down Expand Up @@ -1205,13 +1205,14 @@ public void putFunctionState(final String tenant,
}

@Override
public void uploadFunction(final InputStream uploadedInputStream, final String path, String clientRole) {
public void uploadFunction(final InputStream uploadedInputStream, final String path, String clientRole,
AuthenticationDataSource authenticationData) {

if (!isWorkerServiceAvailable()) {
throwUnavailableException();
}

if (worker().getWorkerConfig().isAuthorizationEnabled() && !isSuperUser(clientRole)) {
if (worker().getWorkerConfig().isAuthorizationEnabled() && !isSuperUser(clientRole, authenticationData)) {
throw new RestException(Status.UNAUTHORIZED, "client is not authorize to perform operation");
}

Expand Down Expand Up @@ -1309,7 +1310,7 @@ public StreamingOutput downloadFunction(final String path, String clientRole, Au
throw new RestException(Status.INTERNAL_SERVER_ERROR, e.getMessage());
}
} else {
if (!isSuperUser(clientRole)) {
if (!isSuperUser(clientRole, clientAuthenticationDataHttps)) {
throw new RestException(Status.UNAUTHORIZED, "client is not authorize to perform operation");
}
}
Expand Down Expand Up @@ -1441,7 +1442,7 @@ public boolean isAuthorizedRole(String tenant, String namespace, String clientRo
AuthenticationDataSource authenticationData) throws PulsarAdminException {
if (worker().getWorkerConfig().isAuthorizationEnabled()) {
// skip authorization if client role is super-user
if (isSuperUser(clientRole)) {
if (isSuperUser(clientRole, authenticationData)) {
return true;
}

Expand Down Expand Up @@ -1524,14 +1525,14 @@ protected void componentInstanceStatusRequestValidate (final String tenant,
}
}

public boolean isSuperUser(String clientRole) {
public boolean isSuperUser(String clientRole, AuthenticationDataSource authenticationData) {
if (clientRole != null) {
try {
if ((worker().getWorkerConfig().getSuperUserRoles() != null
&& worker().getWorkerConfig().getSuperUserRoles().contains(clientRole))) {
return true;
}
return worker().getAuthorizationService().isSuperUser(clientRole, null)
return worker().getAuthorizationService().isSuperUser(clientRole, authenticationData)
.get(worker().getWorkerConfig().getZooKeeperOperationTimeoutSeconds(), SECONDS);
} catch (InterruptedException e) {
log.warn("Time-out {} sec while checking the role {} is a super user role ",
Expand Down
5 changes: 3 additions & 2 deletions ...tions/worker/src/main/java/org/apache/pulsar/functions/worker/rest/api/FunctionsImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,14 +670,15 @@ public void updateFunctionOnWorkerLeader(final String tenant,
final InputStream uploadedInputStream,
final boolean delete,
URI uri,
final String clientRole) {
final String clientRole,
AuthenticationDataSource authenticationData) {

if (!isWorkerServiceAvailable()) {
throwUnavailableException();
}

if (worker().getWorkerConfig().isAuthorizationEnabled()) {
if (!isSuperUser(clientRole)) {
if (!isSuperUser(clientRole, authenticationData)) {
log.error("{}/{}/{} Client [{}] is not superuser to update on worker leader {}", tenant, namespace,
functionName, clientRole, ComponentTypeUtils.toString(componentType));
throw new RestException(Response.Status.UNAUTHORIZED, "client is not authorize to perform operation");
Expand Down
4 changes: 2 additions & 2 deletions ...ons/worker/src/main/java/org/apache/pulsar/functions/worker/rest/api/FunctionsImplV2.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ public Response stopFunctionInstances(String tenant, String namespace, String fu

@Override
public Response uploadFunction(InputStream uploadedInputStream, String path, String clientRole) {
delegate.uploadFunction(uploadedInputStream, path, clientRole);
delegate.uploadFunction(uploadedInputStream, path, clientRole, null);
return Response.ok().build();
}

Expand Down Expand Up @@ -248,4 +248,4 @@ private InstanceCommunication.FunctionStatus toProto(

return functionStatus;
}
}
}
4 changes: 2 additions & 2 deletions .../src/main/java/org/apache/pulsar/functions/worker/rest/api/v3/FunctionsApiV3Resource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ public void startFunction(final @PathParam("tenant") String tenant,
@Consumes(MediaType.MULTIPART_FORM_DATA)
public void uploadFunction(final @FormDataParam("data") InputStream uploadedInputStream,
final @FormDataParam("path") String path) {
functions().uploadFunction(uploadedInputStream, path, clientAppId());
functions().uploadFunction(uploadedInputStream, path, clientAppId(), clientAuthData());
}

@GET
Expand Down Expand Up @@ -386,6 +386,6 @@ public void updateFunctionOnWorkerLeader(final @PathParam("tenant") String tenan
final @FormDataParam("delete") boolean delete) {

functions().updateFunctionOnWorkerLeader(tenant, namespace, functionName, uploadedInputStream,
delete, uri.getRequestUri(), clientAppId());
delete, uri.getRequestUri(), clientAppId(), clientAuthData());
}
}
2 changes: 1 addition & 1 deletion ...rker/src/main/java/org/apache/pulsar/functions/worker/rest/api/v3/SinksApiV3Resource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,6 @@ public List<ConfigFieldDefinition> getSinkConfigDefinition(
})
@Path("/reloadBuiltInSinks")
public void reloadSinks() {
sinks().reloadConnectors(clientAppId());
sinks().reloadConnectors(clientAppId(), clientAuthData());
}
}
2 changes: 1 addition & 1 deletion ...er/src/main/java/org/apache/pulsar/functions/worker/rest/api/v3/SourcesApiV3Resource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,6 @@ public List<ConfigFieldDefinition> getSourceConfigDefinition(
})
@Path("/reloadBuiltInSources")
public void reloadSources() {
sources().reloadConnectors(clientAppId());
sources().reloadConnectors(clientAppId(), clientAuthData());
}
}
5 changes: 3 additions & 2 deletions ...ctions/worker/src/main/java/org/apache/pulsar/functions/worker/service/api/Component.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ void putFunctionState(final String tenant,

void uploadFunction(final InputStream uploadedInputStream,
final String path,
String clientRole);
String clientRole,
final AuthenticationDataSource clientAuthenticationDataHttps);

StreamingOutput downloadFunction(String path,
String clientRole,
Expand All @@ -154,5 +155,5 @@ StreamingOutput downloadFunction(String tenant,
List<ConnectorDefinition> getListOfConnectors();


void reloadConnectors(String clientRole);
void reloadConnectors(String clientRole, AuthenticationDataSource clientAuthenticationDataHttps);
}
3 changes: 2 additions & 1 deletion ...ctions/worker/src/main/java/org/apache/pulsar/functions/worker/service/api/Functions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ void updateFunctionOnWorkerLeader(final String tenant,
final InputStream uploadedInputStream,
final boolean delete,
URI uri,
final String clientRole);
final String clientRole,
final AuthenticationDataSource clientAuthenticationDataHttps);

FunctionStatus getFunctionStatus(final String tenant,
final String namespace,
Expand Down
32 changes: 25 additions & 7 deletions ...s/worker/src/test/java/org/apache/pulsar/functions/worker/rest/api/FunctionsImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
package org.apache.pulsar.functions.worker.rest.api;

import org.apache.distributedlog.api.namespace.Namespace;
import org.apache.pulsar.broker.authentication.AuthenticationDataHttp;
import org.apache.pulsar.broker.authentication.AuthenticationDataSource;
import org.apache.pulsar.broker.authorization.AuthorizationService;
import org.apache.pulsar.client.admin.Namespaces;
Expand Down Expand Up @@ -55,6 +56,7 @@
import org.testng.annotations.ObjectFactory;
import org.testng.annotations.Test;

import javax.servlet.http.HttpServletRequest;
import java.io.InputStream;
import java.util.Collections;
import java.util.HashMap;
Expand Down Expand Up @@ -261,9 +263,10 @@ public void testIsAuthorizedRole() throws PulsarAdminException, InterruptedExcep

// test pulsar super user
final String pulsarSuperUser = "pulsarSuperUser";
when(authorizationService.isSuperUser(pulsarSuperUser, null)).thenReturn(CompletableFuture.completedFuture(true));
when(authorizationService.isSuperUser(eq(pulsarSuperUser), any()))
.thenReturn(CompletableFuture.completedFuture(true));
assertTrue(functionImpl.isAuthorizedRole("test-tenant", "test-ns", pulsarSuperUser, authenticationDataSource));
assertTrue(functionImpl.isSuperUser(pulsarSuperUser));
assertTrue(functionImpl.isSuperUser(pulsarSuperUser, null));

// test normal user
functionImpl = spy(new FunctionsImpl(() -> mockedWorkerService));
Expand All @@ -274,7 +277,7 @@ public void testIsAuthorizedRole() throws PulsarAdminException, InterruptedExcep
when(admin.tenants()).thenReturn(tenants);
when(this.mockedWorkerService.getBrokerAdmin()).thenReturn(admin);
when(authorizationService.isTenantAdmin("test-tenant", "test-user", tenantInfo, authenticationDataSource)).thenReturn(CompletableFuture.completedFuture(false));
when(authorizationService.isSuperUser("test-user", null)).thenReturn(CompletableFuture.completedFuture(false));
when(authorizationService.isSuperUser(eq("test-user"), any())).thenReturn(CompletableFuture.completedFuture(false));
assertFalse(functionImpl.isAuthorizedRole("test-tenant", "test-ns", "test-user", authenticationDataSource));

// if user is tenant admin
Expand Down Expand Up @@ -333,10 +336,10 @@ public void testIsSuperUser() throws PulsarAdminException {
});

AuthenticationDataSource authenticationDataSource = mock(AuthenticationDataSource.class);
assertTrue(functionImpl.isSuperUser(superUser));
assertTrue(functionImpl.isSuperUser(superUser, null));

assertFalse(functionImpl.isSuperUser("normal-user"));
assertFalse(functionImpl.isSuperUser( null));
assertFalse(functionImpl.isSuperUser("normal-user", null));
assertFalse(functionImpl.isSuperUser( null, null));

// test super roles is null and it's not a pulsar super user
when(authorizationService.isSuperUser(superUser, null))
Expand All @@ -345,7 +348,22 @@ public void testIsSuperUser() throws PulsarAdminException {
workerConfig = new WorkerConfig();
workerConfig.setAuthorizationEnabled(true);
doReturn(workerConfig).when(mockedWorkerService).getWorkerConfig();
assertFalse(functionImpl.isSuperUser(superUser));
assertFalse(functionImpl.isSuperUser(superUser, null));

// test super role is null but the auth datasource contains superuser
when(authorizationService.isSuperUser(anyString(), any(AuthenticationDataSource.class)))
.thenAnswer((invocationOnMock -> {
AuthenticationDataSource authData = invocationOnMock.getArgument(1, AuthenticationDataSource.class);
String user = authData.getHttpHeader("mockedUser");
return CompletableFuture.completedFuture(superUser.equals(user));
}));
AuthenticationDataSource authData = mock(AuthenticationDataSource.class);
when(authData.getHttpHeader("mockedUser")).thenReturn(superUser);
assertTrue(functionImpl.isSuperUser("non-superuser", authData));

AuthenticationDataSource nonSuperuserAuthData = mock(AuthenticationDataSource.class);
when(nonSuperuserAuthData.getHttpHeader("mockedUser")).thenReturn("non-superuser");
assertFalse(functionImpl.isSuperUser("non-superuser", nonSuperuserAuthData));
}

public static FunctionConfig createDefaultFunctionConfig() {
Expand Down