Skip to content

Propagate correct HTTP status for security exceptions on SQL analytic… #5473

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
dai-chen merged 3 commits into from
May 27, 2026
Merged

Propagate correct HTTP status for security exceptions on SQL analytic… #5473

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
815d3c5
Propagate correct HTTP status for security exceptions on SQL analytic…
finnegancarroll May 27, 2026
efa65e1
Spotless apply
finnegancarroll May 27, 2026
43d3bcb
Re-use helper.
finnegancarroll May 27, 2026
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
24 changes: 3 additions & 21 deletions integ-test/src/test/java/org/opensearch/sql/security/AnalyticsEngineSecurityIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,24 +263,14 @@ public void testSQLQueryAllowedForAuthorizedUser() throws IOException {
}
}

// TODO: The SQL endpoint (/_plugins/_sql) returns 500 instead of 403 for security exceptions.
// The legacy RestSqlAction error handling wraps OpenSearchSecurityException as a generic 500
// Internal Server Error rather than propagating the 403 Forbidden status. The authorization
// IS denied (query does not execute), but the HTTP status is incorrect. These tests accept
// either 403 or 500 until the SQL plugin's error propagation is fixed.

@Test
public void testSQLQueryDeniedForUnauthorizedUser() throws IOException {
ResponseException e =
assertThrows(
ResponseException.class,
() ->
executeSQLAsUser("SELECT name, age FROM " + TEST_INDEX + " LIMIT 3", DENIED_USER));
assertTrue(
"Expected 403 or 500 with security exception, got "
+ e.getResponse().getStatusLine().getStatusCode(),
e.getResponse().getStatusLine().getStatusCode() == 403
|| e.getResponse().getStatusLine().getStatusCode() == 500);
assertEquals(403, e.getResponse().getStatusLine().getStatusCode());
}

@Test
Expand All @@ -291,11 +281,7 @@ public void testSQLQueryDeniedForForbiddenIndex() throws IOException {
() ->
executeSQLAsUser(
"SELECT name, age FROM " + FORBIDDEN_INDEX + " LIMIT 3", ALLOWED_USER));
assertTrue(
"Expected 403 or 500 with security exception, got "
+ e.getResponse().getStatusLine().getStatusCode(),
e.getResponse().getStatusLine().getStatusCode() == 403
|| e.getResponse().getStatusLine().getStatusCode() == 500);
assertEquals(403, e.getResponse().getStatusLine().getStatusCode());
}

@Test
Expand All @@ -306,11 +292,7 @@ public void testSQLQueryDeniedWithSearchPermissionOnly() throws IOException {
() ->
executeSQLAsUser(
"SELECT name, age FROM " + TEST_INDEX + " LIMIT 3", SEARCH_ONLY_USER));
assertTrue(
"Expected 403 or 500 with security exception, got "
+ e.getResponse().getStatusLine().getStatusCode(),
e.getResponse().getStatusLine().getStatusCode() == 403
|| e.getResponse().getStatusLine().getStatusCode() == 500);
assertEquals(403, e.getResponse().getStatusLine().getStatusCode());
}

/** Executes a PPL query via the production SQL plugin endpoint (/_plugins/_ppl). */
Expand Down
2 changes: 1 addition & 1 deletion legacy/src/main/java/org/opensearch/sql/legacy/plugin/RestSqlAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ private void handleException(RestChannel restChannel, Exception exception) {
reportError(restChannel, exception, status);
}

private static RestStatus getRestStatus(Exception ex) {
public static RestStatus getRestStatus(Exception ex) {
int code = getRawErrorCode(ex);
return RestStatus.fromCode(code);
}
Expand Down
4 changes: 2 additions & 2 deletions plugin/src/main/java/org/opensearch/sql/plugin/SQLPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ protected Object buildJsonObject(ExplainResponse resp) {
@Override
public void onFailure(Exception e) {
channel.sendResponse(
new BytesRestResponse(RestStatus.INTERNAL_SERVER_ERROR, e.getMessage()));
new BytesRestResponse(RestSqlAction.getRestStatus(e), e.getMessage()));
}
});
} else {
Expand All @@ -283,7 +283,7 @@ public void onResponse(TransportPPLQueryResponse response) {
@Override
public void onFailure(Exception e) {
channel.sendResponse(
new BytesRestResponse(RestStatus.INTERNAL_SERVER_ERROR, e.getMessage()));
new BytesRestResponse(RestSqlAction.getRestStatus(e), e.getMessage()));
}
});
}
Expand Down
Loading