Skip to content

Fix BasicAuth token configuration naming consistency across Pinot com… #17687

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

Open
Akanksha-kedia wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix BasicAuth token configuration naming consistency across Pinot com… #17687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion pinot-controller/src/test/java/org/apache/pinot/controller/helix/ControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1268,7 +1268,7 @@ public final Map<String, Object> getSharedControllerConfiguration() {
properties.put(ControllerConf.TABLE_MIN_REPLICAS, DEFAULT_MIN_NUM_REPLICAS);

// Used in PinotControllerAppConfigsTest to test obfuscation
properties.put("controller.segment.fetcher.auth.token", "*personal*");
properties.put("pinot.controller.segment.fetcher.auth.token", "*personal*");
properties.put("controller.admin.access.control.principals.user.password", "*personal*");

return properties;
Expand Down
10 changes: 6 additions & 4 deletions ...ration-test-base/src/test/java/org/apache/pinot/integration/tests/BasicAuthTestUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,20 @@ public final class BasicAuthTestUtils {
private BasicAuthTestUtils() {
}

public static final String AUTH_TOKEN = "Basic YWRtaW46dmVyeXNlY3JldA=====";
public static final String AUTH_TOKEN = "Basic YWRtaW46dmVyeXNlY3JldA==";
public static final String AUTH_TOKEN_USER = "Basic dXNlcjpzZWNyZXQ==";
public static final Map<String, String> AUTH_HEADER = Map.of("Authorization", AUTH_TOKEN);
public static final BasicHeader AUTH_HEADER_BASIC = new BasicHeader("Authorization", AUTH_TOKEN);
public static final Map<String, String> AUTH_HEADER_USER = Map.of("Authorization", AUTH_TOKEN_USER);

public static void addControllerConfiguration(Map<String, Object> properties) {
properties.put("controller.segment.fetcher.auth.token", AUTH_TOKEN);
properties.put("pinot.controller.segment.fetcher.auth.token", AUTH_TOKEN);
properties.put("controller.admin.access.control.factory.class",
"org.apache.pinot.controller.api.access.BasicAuthAccessControlFactory");
properties.put("controller.admin.access.control.principals", "admin, user");
properties.put("controller.admin.access.control.principals.admin.password", "verysecret");
// Admin user has access to all tables (no tables restriction means all tables)
// Admin user has all permissions (no permissions restriction means all permissions)
properties.put("controller.admin.access.control.principals.user.password", "secret");
properties.put("controller.admin.access.control.principals.user.tables", "userTableOnly");
properties.put("controller.admin.access.control.principals.user.permissions", "read");
Expand All @@ -61,7 +63,7 @@ public static void addServerConfiguration(PinotConfiguration serverConf) {
}

public static void addMinionConfiguration(PinotConfiguration minionConf) {
minionConf.setProperty("segment.fetcher.auth.token", AUTH_TOKEN);
minionConf.setProperty("task.auth.token", AUTH_TOKEN);
minionConf.setProperty("pinot.minion.segment.fetcher.auth.token", AUTH_TOKEN);
minionConf.setProperty("pinot.minion.task.auth.token", AUTH_TOKEN);
}
}
6 changes: 3 additions & 3 deletions ...tests/src/test/java/org/apache/pinot/integration/tests/CursorWithAuthIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ protected Object[][] getPageSizesAndQueryEngine() {
@Override
protected void overrideControllerConf(Map<String, Object> properties) {
BasicAuthTestUtils.addControllerConfiguration(properties);
properties.put("controller.segment.fetcher.auth.provider.class", AUTH_PROVIDER_CLASS);
properties.put("controller.segment.fetcher.auth.url", AUTH_URL);
properties.put("controller.segment.fetcher.auth.prefix", AUTH_PREFIX);
properties.put("pinot.controller.segment.fetcher.auth.provider.class", AUTH_PROVIDER_CLASS);
properties.put("pinot.controller.segment.fetcher.auth.url", AUTH_URL);
properties.put("pinot.controller.segment.fetcher.auth.prefix", AUTH_PREFIX);
properties.put(ControllerConf.CONTROLLER_BROKER_AUTH_PREFIX + ".provider.class", AUTH_PROVIDER_CLASS);
properties.put(ControllerConf.CONTROLLER_BROKER_AUTH_PREFIX + ".url", AUTH_URL);
properties.put(ControllerConf.CONTROLLER_BROKER_AUTH_PREFIX + ".prefix", AUTH_PREFIX);
Expand Down
2 changes: 1 addition & 1 deletion ...sts/src/test/java/org/apache/pinot/integration/tests/RowLevelSecurityIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public class RowLevelSecurityIntegrationTest extends BaseClusterIntegrationTest

@Override
protected void overrideControllerConf(Map<String, Object> properties) {
properties.put("controller.segment.fetcher.auth.token", AUTH_TOKEN);
properties.put("pinot.controller.segment.fetcher.auth.token", AUTH_TOKEN);
properties.put("controller.admin.access.control.factory.class",
"org.apache.pinot.controller.api.access.BasicAuthAccessControlFactory");
properties.put("controller.admin.access.control.principals", "admin, user, user2");
Expand Down
3 changes: 2 additions & 1 deletion ...ntegration-tests/src/test/java/org/apache/pinot/integration/tests/TlsIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,7 @@ public void testRealtimeSegmentUploadDownload()
Assert.assertNotNull(_controllerStarter.getTaskManager().scheduleTasks(new TaskSchedulingContext()));

// wait for offline segments
// Increased timeout from 30s to 90s to account for CI resource contention when running parallel test sets
JsonNode offlineSegments = TestUtils.waitForResult(() -> {
JsonNode segmentSets = JsonUtils.stringToJsonNode(
sendGetRequest(_controllerRequestURLBuilder.forSegmentListAPI(getTableName()), AUTH_HEADER));
Expand All @@ -490,7 +491,7 @@ public void testRealtimeSegmentUploadDownload()
.map(s -> s.get("OFFLINE")).findFirst().get();
Assert.assertFalse(currentOfflineSegments.isEmpty());
return currentOfflineSegments;
}, 30000);
}, 90000);

// Verify constant row count
ResultSetGroup resultAfterOffline = getPinotConnection().execute(query);
Expand Down
25 changes: 15 additions & 10 deletions ...ests/src/test/java/org/apache/pinot/integration/tests/UrlAuthRealtimeIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@ public void tearDown()
@Override
protected void overrideControllerConf(Map<String, Object> properties) {
BasicAuthTestUtils.addControllerConfiguration(properties);
properties.put("controller.segment.fetcher.auth.provider.class", AUTH_PROVIDER_CLASS);
properties.put("controller.segment.fetcher.auth.url", AUTH_URL);
properties.put("controller.segment.fetcher.auth.prefix", AUTH_PREFIX);
properties.put("pinot.controller.segment.fetcher.auth.provider.class", AUTH_PROVIDER_CLASS);
properties.put("pinot.controller.segment.fetcher.auth.url", AUTH_URL);
properties.put("pinot.controller.segment.fetcher.auth.prefix", AUTH_PREFIX);
}

@Override
Expand All @@ -119,12 +119,16 @@ protected void overrideServerConf(PinotConfiguration serverConf) {
@Override
protected void overrideMinionConf(PinotConfiguration minionConf) {
BasicAuthTestUtils.addMinionConfiguration(minionConf);
minionConf.setProperty("segment.fetcher.auth.provider.class", AUTH_PROVIDER_CLASS);
minionConf.setProperty("segment.fetcher.auth.url", AUTH_URL_PREFIXED);
minionConf.setProperty("segment.fetcher.auth.prefix", AUTH_PREFIX);
minionConf.setProperty("task.auth.provider.class", AUTH_PROVIDER_CLASS);
minionConf.setProperty("task.auth.url", AUTH_URL_PREFIXED);
minionConf.setProperty("task.auth.prefix", AUTH_PREFIX);
minionConf.setProperty("pinot.minion.segment.fetcher.auth.provider.class", AUTH_PROVIDER_CLASS);
minionConf.setProperty("pinot.minion.segment.fetcher.auth.url", AUTH_URL_PREFIXED);
minionConf.setProperty("pinot.minion.segment.fetcher.auth.prefix", AUTH_PREFIX);
// Add explicit token as fallback
minionConf.setProperty("pinot.minion.segment.fetcher.auth.token", "Basic YWRtaW46dmVyeXNlY3JldA==");
minionConf.setProperty("pinot.minion.task.auth.provider.class", AUTH_PROVIDER_CLASS);
minionConf.setProperty("pinot.minion.task.auth.url", AUTH_URL_PREFIXED);
minionConf.setProperty("pinot.minion.task.auth.prefix", AUTH_PREFIX);
// Add explicit token as fallback
minionConf.setProperty("pinot.minion.task.auth.token", "Basic YWRtaW46dmVyeXNlY3JldA==");
}

@Override
Expand Down Expand Up @@ -165,12 +169,13 @@ public void testSegmentUploadDownload()
Assert.assertNotNull(_controllerStarter.getTaskManager().scheduleTasks(new TaskSchedulingContext()));

// wait for offline segments
// Increased timeout from 30s to 90s to account for CI resource contention when running parallel test sets
List<String> offlineSegments = TestUtils.waitForResult(() -> {
List<String> currentOfflineSegments =
getControllerRequestClient().listSegments(getTableName(), TableType.OFFLINE.name(), false);
Assert.assertFalse(currentOfflineSegments.isEmpty());
return currentOfflineSegments;
}, 30000);
}, 90000);

// Verify constant row count
ResultSetGroup resultAfterOffline = getPinotConnection().execute(query);
Expand Down
4 changes: 2 additions & 2 deletions pinot-tools/src/main/java/org/apache/pinot/tools/AuthZkBasicQuickstart.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ public Map<String, Object> getConfigOverrides() {
properties.put("pinot.server.segment.uploader.auth.token", "Basic YWRtaW46dmVyeXNlY3JldA==");

// minion
properties.put("segment.fetcher.auth.token", "Basic YWRtaW46dmVyeXNlY3JldA==");
properties.put("task.auth.token", "Basic YWRtaW46dmVyeXNlY3JldA==");
properties.put("pinot.minion.segment.fetcher.auth.token", "Basic YWRtaW46dmVyeXNlY3JldA==");
properties.put("pinot.minion.task.auth.token", "Basic YWRtaW46dmVyeXNlY3JldA==");

return properties;
}
Expand Down
4 changes: 2 additions & 2 deletions pinot-tools/src/main/java/org/apache/pinot/tools/utils/AuthUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ public static Map<String, Object> getAuthQuickStartDefaultConfigs() {
properties.put("pinot.server.instance.auth.token", DEFAULT_AUTH_TOKEN);

// minion
properties.put("segment.fetcher.auth.token", DEFAULT_AUTH_TOKEN);
properties.put("task.auth.token", DEFAULT_AUTH_TOKEN);
properties.put("pinot.minion.segment.fetcher.auth.token", DEFAULT_AUTH_TOKEN);
properties.put("pinot.minion.task.auth.token", DEFAULT_AUTH_TOKEN);

// loggers
properties.put("pinot.controller.logger.root.dir", "logs");
Expand Down
Loading