Skip to content

Commit e7ee950

Browse files
cwperkscwperks
authored
Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin (#15039)
* Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin Signed-off-by: Craig Perkins <[email protected]> * Add to CHANGELOG Signed-off-by: Craig Perkins <[email protected]> * Use ThreadContextAccess Signed-off-by: Craig Perkins <[email protected]> --------- Signed-off-by: Craig Perkins <[email protected]>
1 parent 4707885 commit e7ee950

File tree

7 files changed

+40
-6
lines changed

7 files changed

+40
-6
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
1111
- [Streaming Indexing] Enhance RestClient with a new streaming API support ([#14437](https://github.com/opensearch-project/OpenSearch/pull/14437))
1212
- Add basic aggregation support for derived fields ([#14618](https://github.com/opensearch-project/OpenSearch/pull/14618))
1313
- Add ThreadContextPermission for markAsSystemContext and allow core to perform the method ([#15016](https://github.com/opensearch-project/OpenSearch/pull/15016))
14+
- Add ThreadContextPermission for stashAndMergeHeaders and stashWithOrigin ([#15039](https://github.com/opensearch-project/OpenSearch/pull/15039))
1415

1516
### Dependencies
1617
- Bump `org.apache.commons:commons-lang3` from 3.14.0 to 3.15.0 ([#14861](https://github.com/opensearch-project/OpenSearch/pull/14861))

‎server/src/main/java/org/opensearch/client/OriginSettingClient.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
import org.opensearch.action.ActionType;
3737
import org.opensearch.action.support.ContextPreservingActionListener;
3838
import org.opensearch.common.util.concurrent.ThreadContext;
39+
import org.opensearch.common.util.concurrent.ThreadContextAccess;
3940
import org.opensearch.core.action.ActionListener;
4041
import org.opensearch.core.action.ActionResponse;
4142

@@ -65,7 +66,11 @@ protected <Request extends ActionRequest, Response extends ActionResponse> void
6566
ActionListener<Response> listener
6667
) {
6768
final Supplier<ThreadContext.StoredContext> supplier = in().threadPool().getThreadContext().newRestorableContext(false);
68-
try (ThreadContext.StoredContext ignore = in().threadPool().getThreadContext().stashWithOrigin(origin)) {
69+
try (
70+
ThreadContext.StoredContext ignore = ThreadContextAccess.doPrivileged(
71+
() -> in().threadPool().getThreadContext().stashWithOrigin(origin)
72+
)
73+
) {
6974
super.doExecute(action, request, new ContextPreservingActionListener<>(supplier, listener));
7075
}
7176
}

‎server/src/main/java/org/opensearch/client/support/AbstractClient.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,7 @@
416416
import org.opensearch.common.action.ActionFuture;
417417
import org.opensearch.common.settings.Settings;
418418
import org.opensearch.common.util.concurrent.ThreadContext;
419+
import org.opensearch.common.util.concurrent.ThreadContextAccess;
419420
import org.opensearch.core.action.ActionListener;
420421
import org.opensearch.core.action.ActionResponse;
421422
import org.opensearch.core.common.bytes.BytesReference;
@@ -2148,7 +2149,9 @@ protected <Request extends ActionRequest, Response extends ActionResponse> void
21482149
ActionListener<Response> listener
21492150
) {
21502151
ThreadContext threadContext = threadPool().getThreadContext();
2151-
try (ThreadContext.StoredContext ctx = threadContext.stashAndMergeHeaders(headers)) {
2152+
try (
2153+
ThreadContext.StoredContext ctx = ThreadContextAccess.doPrivileged(() -> threadContext.stashAndMergeHeaders(headers))
2154+
) {
21522155
super.doExecute(action, request, listener);
21532156
}
21542157
}

‎server/src/main/java/org/opensearch/common/util/concurrent/ThreadContext.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,8 @@ public final class ThreadContext implements Writeable {
116116
// thread context permissions
117117

118118
private static final Permission ACCESS_SYSTEM_THREAD_CONTEXT_PERMISSION = new ThreadContextPermission("markAsSystemContext");
119+
private static final Permission STASH_AND_MERGE_THREAD_CONTEXT_PERMISSION = new ThreadContextPermission("stashAndMergeHeaders");
120+
private static final Permission STASH_WITH_ORIGIN_THREAD_CONTEXT_PERMISSION = new ThreadContextPermission("stashWithOrigin");
119121

120122
private static final Logger logger = LogManager.getLogger(ThreadContext.class);
121123
private static final ThreadContextStruct DEFAULT_CONTEXT = new ThreadContextStruct();
@@ -213,6 +215,10 @@ public Writeable captureAsWriteable() {
213215
* if it can't find the task in memory.
214216
*/
215217
public StoredContext stashWithOrigin(String origin) {
218+
SecurityManager sm = System.getSecurityManager();
219+
if (sm != null) {
220+
sm.checkPermission(STASH_WITH_ORIGIN_THREAD_CONTEXT_PERMISSION);
221+
}
216222
final ThreadContext.StoredContext storedContext = stashContext();
217223
putTransient(ACTION_ORIGIN_TRANSIENT_NAME, origin);
218224
return storedContext;
@@ -224,6 +230,10 @@ public StoredContext stashWithOrigin(String origin) {
224230
* that are already existing are preserved unless they are defaults.
225231
*/
226232
public StoredContext stashAndMergeHeaders(Map<String, String> headers) {
233+
SecurityManager sm = System.getSecurityManager();
234+
if (sm != null) {
235+
sm.checkPermission(STASH_AND_MERGE_THREAD_CONTEXT_PERMISSION);
236+
}
227237
final ThreadContextStruct context = threadLocal.get();
228238
Map<String, String> newHeader = new HashMap<>(headers);
229239
newHeader.putAll(context.requestHeaders);

‎server/src/main/resources/org/opensearch/bootstrap/security.policy

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ grant codeBase "${codebase.opensearch}" {
4949
// needed for SPI class loading
5050
permission java.lang.RuntimePermission "accessDeclaredMembers";
5151
permission org.opensearch.secure_sm.ThreadContextPermission "markAsSystemContext";
52+
permission org.opensearch.secure_sm.ThreadContextPermission "stashWithOrigin";
5253
};
5354

5455
//// Very special jar permissions:

‎server/src/main/resources/org/opensearch/bootstrap/test-framework.policy

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,4 +158,6 @@ grant {
158158
permission java.lang.RuntimePermission "accessClassInPackage.sun.reflect";
159159
permission java.lang.reflect.ReflectPermission "suppressAccessChecks";
160160
permission org.opensearch.secure_sm.ThreadContextPermission "markAsSystemContext";
161+
permission org.opensearch.secure_sm.ThreadContextPermission "stashAndMergeHeaders";
162+
permission org.opensearch.secure_sm.ThreadContextPermission "stashWithOrigin";
161163
};

‎server/src/test/java/org/opensearch/common/util/concurrent/ThreadContextTests.java

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ public void testStashWithOrigin() {
206206
}
207207

208208
assertNull(threadContext.getTransient(ThreadContext.ACTION_ORIGIN_TRANSIENT_NAME));
209-
try (ThreadContext.StoredContext storedContext = threadContext.stashWithOrigin(origin)) {
209+
try (ThreadContext.StoredContext storedContext = ThreadContextAccess.doPrivileged(() -> threadContext.stashWithOrigin(origin))) {
210210
assertEquals(origin, threadContext.getTransient(ThreadContext.ACTION_ORIGIN_TRANSIENT_NAME));
211211
assertNull(threadContext.getTransient("foo"));
212212
assertNull(threadContext.getTransient("bar"));
@@ -231,7 +231,7 @@ public void testStashAndMerge() {
231231
HashMap<String, String> toMerge = new HashMap<>();
232232
toMerge.put("foo", "baz");
233233
toMerge.put("simon", "says");
234-
try (ThreadContext.StoredContext ctx = threadContext.stashAndMergeHeaders(toMerge)) {
234+
try (ThreadContext.StoredContext ctx = ThreadContextAccess.doPrivileged(() -> threadContext.stashAndMergeHeaders(toMerge))) {
235235
assertEquals("bar", threadContext.getHeader("foo"));
236236
assertEquals("says", threadContext.getHeader("simon"));
237237
assertNull(threadContext.getTransient("ctx.foo"));
@@ -493,7 +493,13 @@ public void testStashAndMergeWithModifiedDefaults() {
493493
ThreadContext threadContext = new ThreadContext(build);
494494
HashMap<String, String> toMerge = new HashMap<>();
495495
toMerge.put("default", "2");
496-
try (ThreadContext.StoredContext ctx = threadContext.stashAndMergeHeaders(toMerge)) {
496+
ThreadContext finalThreadContext1 = threadContext;
497+
HashMap<String, String> finalToMerge1 = toMerge;
498+
try (
499+
ThreadContext.StoredContext ctx = ThreadContextAccess.doPrivileged(
500+
() -> finalThreadContext1.stashAndMergeHeaders(finalToMerge1)
501+
)
502+
) {
497503
assertEquals("2", threadContext.getHeader("default"));
498504
}
499505

@@ -502,7 +508,13 @@ public void testStashAndMergeWithModifiedDefaults() {
502508
threadContext.putHeader("default", "4");
503509
toMerge = new HashMap<>();
504510
toMerge.put("default", "2");
505-
try (ThreadContext.StoredContext ctx = threadContext.stashAndMergeHeaders(toMerge)) {
511+
ThreadContext finalThreadContext2 = threadContext;
512+
HashMap<String, String> finalToMerge2 = toMerge;
513+
try (
514+
ThreadContext.StoredContext ctx = ThreadContextAccess.doPrivileged(
515+
() -> finalThreadContext2.stashAndMergeHeaders(finalToMerge2)
516+
)
517+
) {
506518
assertEquals("4", threadContext.getHeader("default"));
507519
}
508520
}

0 commit comments

Comments
 (0)