Skip to content

[FIX] Preserve response headers across context restore in SecurityInterceptor #6123

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
KishoreKicha14 wants to merge 2 commits into
base: main
Choose a base branch
from
+616 −6
Open

[FIX] Preserve response headers across context restore in SecurityInterceptor #6123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b2b652
fix: Preserve response headers across context restore in SecurityInte…
KishoreKicha14 Apr 28, 2026
520b2bc
Merge branch 'main' into fix/preserve-response-headers-on-context-res…
KishoreKicha14 May 7, 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
20 changes: 14 additions & 6 deletions src/main/java/org/opensearch/security/transport/SecurityInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,12 @@ public <T extends TransportResponse> void sendRequestDecorate(
requestHeadersToCopy.removeAll(Task.REQUEST_HEADERS); // Special case where this header is preserved during stashContext.
}

final Supplier<ThreadContext.StoredContext> restorableContextSupplier = getThreadContext().newRestorableContext(true);
try (ThreadContext.StoredContext stashedContext = getThreadContext().stashContext()) {
final TransportResponseHandler<T> restoringHandler = new RestoringTransportResponseHandler<T>(handler, stashedContext);
final TransportResponseHandler<T> restoringHandler = new RestoringTransportResponseHandler<T>(
handler,
restorableContextSupplier
);
getThreadContext().putHeader("_opendistro_security_remotecn", cs.getClusterName().value());

final Map<String, String> headerMap = new HashMap<>(
Expand Down Expand Up @@ -377,10 +381,13 @@ private ThreadContext getThreadContext() {
// which is private scoped
private class RestoringTransportResponseHandler<T extends TransportResponse> implements TransportResponseHandler<T> {

private final ThreadContext.StoredContext contextToRestore;
private final Supplier<ThreadContext.StoredContext> contextToRestore;
private final TransportResponseHandler<T> innerHandler;

private RestoringTransportResponseHandler(TransportResponseHandler<T> innerHandler, ThreadContext.StoredContext contextToRestore) {
private RestoringTransportResponseHandler(
TransportResponseHandler<T> innerHandler,
Supplier<ThreadContext.StoredContext> contextToRestore
) {
this.contextToRestore = contextToRestore;
this.innerHandler = innerHandler;
}
Expand All @@ -407,7 +414,7 @@ public void handleResponse(T response) {
List<String> dlsResponseHeader = responseHeaders.get(ConfigConstants.OPENDISTRO_SECURITY_DLS_QUERY_HEADER);
List<String> maskedFieldsResponseHeader = responseHeaders.get(ConfigConstants.OPENDISTRO_SECURITY_MASKED_FIELD_HEADER);

contextToRestore.restore();
contextToRestore.get();

final boolean isDebugEnabled = log.isDebugEnabled();
if (response instanceof ClusterSearchShardsResponse) {
Expand Down Expand Up @@ -438,8 +445,9 @@ public void handleResponse(T response) {

@Override
public void handleException(TransportException e) {
contextToRestore.restore();
innerHandler.handleException(e);
try (ThreadContext.StoredContext ignore = contextToRestore.get()) {
innerHandler.handleException(e);
}
}
Comment on lines 446 to 451
Copy link
Copy Markdown
Member

@dzane17 dzane17 May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: contextToRestore.get() returns a Closeable. You could close it by wrapping the call in a try-with-resources, like:

@Override
public void handleException(TransportException e) {
    try (ThreadContext.StoredContext ignore = contextToRestore.get()) {
        innerHandler.handleException(e);
    }
}

Reference: TransportService.java#L1606-L1608


@Override
Expand Down
Loading
Loading