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.

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

Jump to bottom

Strip Matrix parameter from BasePath check #14383

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Strip Matrix parameter from BasePath check #14383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d0d2e43
Sanity check
praveenc7 Oct 13, 2024
747ba54
comments
praveenc7 Oct 24, 2024
001f837
Add test
praveenc7 Nov 5, 2024
7a606f6
fix build
praveenc7 Nov 5, 2024
d051365
fix build
praveenc7 Nov 5, 2024
973d64c
empty commit
praveenc7 Nov 5, 2024
68d4375
rerun
praveenc7 Nov 5, 2024
e493941
rerun
praveenc7 Nov 6, 2024
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
5 changes: 4 additions & 1 deletion pinot-broker/src/main/java/org/apache/pinot/broker/broker/AuthenticationFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,13 @@
import org.apache.commons.lang3.StringUtils;
import org.apache.pinot.broker.api.AccessControl;
import org.apache.pinot.broker.api.HttpRequesterIdentity;
import org.apache.pinot.common.auth.AuthProviderUtils;
import org.apache.pinot.core.auth.FineGrainedAuthUtils;
import org.apache.pinot.core.auth.ManualAuthorization;
import org.apache.pinot.spi.auth.AuthorizationResult;
import org.glassfish.grizzly.http.server.Request;


/**
* A container filter class responsible for automatic authentication of REST endpoints. Any rest endpoints not annotated
* with {@link org.apache.pinot.core.auth.ManualAuthorization} annotation, will go through authentication.
Expand Down Expand Up @@ -73,7 +75,8 @@ public void filter(ContainerRequestContext requestContext)
UriInfo uriInfo = requestContext.getUriInfo();

// exclude public/unprotected paths
if (isBaseFile(uriInfo.getPath()) || UNPROTECTED_PATHS.contains(uriInfo.getPath())) {
if (isBaseFile(AuthProviderUtils.stripMatrixParams(uriInfo.getPath()))
|| UNPROTECTED_PATHS.contains(AuthProviderUtils.stripMatrixParams(uriInfo.getPath()))) {
return;
}

Expand Down
13 changes: 13 additions & 0 deletions pinot-common/src/main/java/org/apache/pinot/common/auth/AuthProviderUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,4 +226,17 @@ public static AuthProvider makeAuthProvider(@Nullable AuthProvider provider, Str

return new NullAuthProvider();
}

/**
* Strips everything after the first matrix/semicolon character in a path.
* @param path the path to strip
* @return the stripped path
*/
public static String stripMatrixParams(String path) {
int matrixIndex = path.indexOf(';');
if (matrixIndex != -1) {
return path.substring(0, matrixIndex);
}
return path;
}
}
4 changes: 3 additions & 1 deletion ...controller/src/main/java/org/apache/pinot/controller/api/access/AuthenticationFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.UriInfo;
import org.apache.pinot.common.auth.AuthProviderUtils;
import org.apache.pinot.common.utils.DatabaseUtils;
import org.apache.pinot.core.auth.FineGrainedAuthUtils;
import org.apache.pinot.core.auth.ManualAuthorization;
Expand Down Expand Up @@ -77,7 +78,8 @@ public void filter(ContainerRequestContext requestContext)
UriInfo uriInfo = requestContext.getUriInfo();

// exclude public/unprotected paths
if (isBaseFile(uriInfo.getPath()) || UNPROTECTED_PATHS.contains(uriInfo.getPath())) {
if (isBaseFile(AuthProviderUtils.stripMatrixParams(uriInfo.getPath()))
|| UNPROTECTED_PATHS.contains(AuthProviderUtils.stripMatrixParams(uriInfo.getPath()))) {
return;
}

Expand Down
22 changes: 20 additions & 2 deletions ...roller/src/test/java/org/apache/pinot/controller/api/access/AuthenticationFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@
import javax.ws.rs.PUT;
import javax.ws.rs.core.MultivaluedHashMap;
import javax.ws.rs.core.MultivaluedMap;
import org.apache.pinot.common.auth.AuthProviderUtils;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNull;
import static org.testng.Assert.*;


public class AuthenticationFilterTest {
Expand Down Expand Up @@ -123,6 +124,23 @@ public void testExtractAccessTypeWithMissingAuthAnnotation() throws Exception {
assertEquals(AccessType.DELETE, _authFilter.extractAccessType(method));
}

// DataProvider supplying test cases
@DataProvider(name = "pathProvider")
public Object[][] pathProvider() {
return new Object[][] {
{"/path/to/resource;param1=value1;param2=value2", "/path/to/resource"}, // with matrix params
{"/path/to/resource", "/path/to/resource"}, // no matrix params
{"", ""}, // empty path
{";param1=value1/path/to/resource", ""}, // matrix at beginning
{"/path;param1=value1;param2=value2/to/resource", "/path"} // multiple semicolons
};
}

@Test(dataProvider = "pathProvider")
public void testStripMatrixParams(String input, String expected) {
assertEquals(AuthProviderUtils.stripMatrixParams(input), expected);
}

@Authenticate(AccessType.UPDATE)
public void methodWithAuthAnnotation() {
}
Expand Down
Loading