Rename to getCurrentSubject

Signed-off-by: Craig Perkins <[email protected]>
cwperks · Aug 19, 2024 · 9c5b2c4 · 9c5b2c4
1 parent 2c9ba56
commit 9c5b2c4
Show file tree

Hide file tree

Showing 11 changed files with 18 additions and 21 deletions.
diff --git a/plugins/identity-shiro/src/main/java/org/opensearch/identity/shiro/ShiroIdentityPlugin.java b/plugins/identity-shiro/src/main/java/org/opensearch/identity/shiro/ShiroIdentityPlugin.java
@@ -22,7 +22,7 @@
 import org.opensearch.env.Environment;
 import org.opensearch.env.NodeEnvironment;
 import org.opensearch.identity.PluginSubject;
-import org.opensearch.identity.UserSubject;
+import org.opensearch.identity.Subject;
 import org.opensearch.identity.tokens.TokenManager;
 import org.opensearch.plugins.IdentityPlugin;
 import org.opensearch.plugins.Plugin;
@@ -86,7 +86,7 @@ public Collection<Object> createComponents(
      * @return The current subject
      */
     @Override
-    public UserSubject getUserSubject() {
+    public Subject getCurrentSubject() {
         return new ShiroSubject(authTokenHandler, SecurityUtils.getSubject());
     }
 

diff --git a/plugins/identity-shiro/src/main/java/org/opensearch/identity/shiro/ShiroPluginSubject.java b/plugins/identity-shiro/src/main/java/org/opensearch/identity/shiro/ShiroPluginSubject.java
@@ -43,8 +43,7 @@ public Principal getPrincipal() {
     @Override
     public <T> T runAs(Callable<T> callable) throws Exception {
         try (ThreadContext.StoredContext ctx = threadPool.getThreadContext().stashContext()) {
-            callable.call();
+            return callable.call();
         }
-        return null;
     }
 }
diff --git a/server/src/main/java/org/opensearch/extensions/rest/RestSendToExtensionAction.java b/server/src/main/java/org/opensearch/extensions/rest/RestSendToExtensionAction.java
@@ -249,7 +249,7 @@ public String executor() {
             Map<String, List<String>> filteredHeaders = filterHeaders(headers, allowList, denyList);
 
             TokenManager tokenManager = identityService.getTokenManager();
-            Subject subject = this.identityService.getUserSubject();
+            Subject subject = this.identityService.getCurrentSubject();
             OnBehalfOfClaims claims = new OnBehalfOfClaims(discoveryExtensionNode.getId(), subject.getPrincipal().getName());
 
             transportService.sendRequest(

diff --git a/server/src/main/java/org/opensearch/identity/IdentityService.java b/server/src/main/java/org/opensearch/identity/IdentityService.java
@@ -48,10 +48,10 @@ public IdentityService(final Settings settings, final ThreadPool threadPool, fin
     }
 
     /**
-     * Gets the current UserSubject
+     * Gets the current Subject
      */
-    public UserSubject getUserSubject() {
-        return identityPlugin.getUserSubject();
+    public Subject getCurrentSubject() {
+        return identityPlugin.getCurrentSubject();
     }
 
     /**

diff --git a/server/src/main/java/org/opensearch/identity/Subject.java b/server/src/main/java/org/opensearch/identity/Subject.java
@@ -27,7 +27,6 @@ public interface Subject {
      * runAs allows the caller to run a callable function as this subject
      */
     default <T> T runAs(Callable<T> callable) throws Exception {
-        callable.call();
-        return null;
+        return callable.call();
     };
 }
diff --git a/server/src/main/java/org/opensearch/identity/noop/NoopIdentityPlugin.java b/server/src/main/java/org/opensearch/identity/noop/NoopIdentityPlugin.java
@@ -9,7 +9,7 @@
 package org.opensearch.identity.noop;
 
 import org.opensearch.identity.PluginSubject;
-import org.opensearch.identity.UserSubject;
+import org.opensearch.identity.Subject;
 import org.opensearch.identity.tokens.TokenManager;
 import org.opensearch.plugins.IdentityPlugin;
 import org.opensearch.plugins.Plugin;
@@ -35,7 +35,7 @@ public NoopIdentityPlugin(ThreadPool threadPool) {
      * @return Must never return null
      */
     @Override
-    public UserSubject getUserSubject() {
+    public Subject getCurrentSubject() {
         return new NoopSubject();
     }
 

diff --git a/server/src/main/java/org/opensearch/identity/noop/NoopPluginSubject.java b/server/src/main/java/org/opensearch/identity/noop/NoopPluginSubject.java
@@ -43,8 +43,7 @@ public Principal getPrincipal() {
     @Override
     public <T> T runAs(Callable<T> callable) throws Exception {
         try (ThreadContext.StoredContext ctx = threadPool.getThreadContext().stashContext()) {
-            callable.call();
+            return callable.call();
         }
-        return null;
     }
 }
diff --git a/server/src/main/java/org/opensearch/plugins/IdentityPlugin.java b/server/src/main/java/org/opensearch/plugins/IdentityPlugin.java
@@ -10,7 +10,7 @@
 
 import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.identity.PluginSubject;
-import org.opensearch.identity.UserSubject;
+import org.opensearch.identity.Subject;
 import org.opensearch.identity.tokens.TokenManager;
 
 /**
@@ -22,11 +22,11 @@
 public interface IdentityPlugin {
 
     /**
-     * Get the current user subject.
+     * Get the current subject.
      *
      * @return Should never return null
      * */
-    UserSubject getUserSubject();
+    Subject getCurrentSubject();
 
     /**
      * Get the Identity Plugin's token manager implementation

diff --git a/server/src/main/java/org/opensearch/rest/RestController.java b/server/src/main/java/org/opensearch/rest/RestController.java
@@ -593,7 +593,7 @@ private boolean handleAuthenticateUser(final RestRequest request, final RestChan
                 // Authentication did not fail so return true. Authorization is handled at the action level.
                 return true;
             }
-            final UserSubject currentSubject = identityService.getUserSubject();
+            final UserSubject currentSubject = (UserSubject) identityService.getCurrentSubject();
             currentSubject.authenticate(token);
             logger.debug("Logged in as user " + currentSubject);
         } catch (final Exception e) {

diff --git a/server/src/test/java/org/opensearch/bootstrap/IdentityPluginTests.java b/server/src/test/java/org/opensearch/bootstrap/IdentityPluginTests.java
@@ -29,7 +29,7 @@ public void testSingleIdentityPluginSucceeds() {
         IdentityPlugin identityPlugin1 = new NoopIdentityPlugin(threadPool);
         List<IdentityPlugin> pluginList1 = List.of(identityPlugin1);
         IdentityService identityService1 = new IdentityService(Settings.EMPTY, threadPool, pluginList1);
-        assertTrue(identityService1.getUserSubject().getPrincipal().getName().equalsIgnoreCase("Unauthenticated"));
+        assertTrue(identityService1.getCurrentSubject().getPrincipal().getName().equalsIgnoreCase("Unauthenticated"));
         assertThat(identityService1.getTokenManager(), is(instanceOf(NoopTokenManager.class)));
         terminate(threadPool);
     }

diff --git a/server/src/test/java/org/opensearch/extensions/rest/ExtensionRestRequestTests.java b/server/src/test/java/org/opensearch/extensions/rest/ExtensionRestRequestTests.java
@@ -76,10 +76,10 @@ public void setUp() throws Exception {
         extensionTokenProcessor = "placeholder_extension_token_processor";
         identityService = new IdentityService(Settings.EMPTY, mock(ThreadPool.class), List.of());
         TokenManager tokenManager = identityService.getTokenManager();
-        Subject subject = this.identityService.getUserSubject();
+        Subject subject = this.identityService.getCurrentSubject();
         OnBehalfOfClaims claims = new OnBehalfOfClaims("testID", subject.getPrincipal().getName());
         expectedRequestIssuerIdentity = identityService.getTokenManager()
-            .issueOnBehalfOfToken(identityService.getUserSubject(), claims)
+            .issueOnBehalfOfToken(identityService.getCurrentSubject(), claims)
             .asAuthHeaderValue();
     }