forked from opensearch-project/security
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Feature/Extension] Add oboauthcbackend registry and set up e2e endpo…
…int testing flow (opensearch-project#2857) * Add OBO Authbackend Signed-off-by: Peter Nied <[email protected]> Signed-off-by: Ryan Liang <[email protected]> Co-authored-by: Peter Nied <[email protected]>
- Loading branch information
Showing
23 changed files
with
869 additions
and
513 deletions.
There are no files selected for viewing
134 changes: 134 additions & 0 deletions
134
src/integrationTest/java/org/opensearch/security/http/OnBehalfOfJwtAuthenticationTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| * | ||
| * Modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| package org.opensearch.security.http; | ||
|
|
||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.Base64; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import com.carrotsearch.randomizedtesting.annotations.ThreadLeakScope; | ||
| import org.apache.hc.core5.http.Header; | ||
| import org.apache.hc.core5.http.message.BasicHeader; | ||
| import org.junit.ClassRule; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
|
|
||
| import org.opensearch.test.framework.OnBehalfOfConfig; | ||
| import org.opensearch.test.framework.TestSecurityConfig; | ||
| import org.opensearch.test.framework.cluster.ClusterManager; | ||
| import org.opensearch.test.framework.cluster.LocalCluster; | ||
| import org.opensearch.test.framework.cluster.TestRestClient; | ||
|
|
||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.hamcrest.Matchers.aMapWithSize; | ||
| import static org.hamcrest.Matchers.allOf; | ||
| import static org.hamcrest.Matchers.equalTo; | ||
| import static org.hamcrest.Matchers.hasKey; | ||
| import static org.opensearch.test.framework.TestSecurityConfig.AuthcDomain.AUTHC_HTTPBASIC_INTERNAL; | ||
| import static org.opensearch.test.framework.TestSecurityConfig.Role.ALL_ACCESS; | ||
|
|
||
| @RunWith(com.carrotsearch.randomizedtesting.RandomizedRunner.class) | ||
| @ThreadLeakScope(ThreadLeakScope.Scope.NONE) | ||
| public class OnBehalfOfJwtAuthenticationTest { | ||
|
|
||
| public static final String POINTER_USERNAME = "/user_name"; | ||
|
|
||
| static final TestSecurityConfig.User ADMIN_USER = new TestSecurityConfig.User("admin").roles(ALL_ACCESS); | ||
|
|
||
| private static final String signingKey = Base64.getEncoder() | ||
| .encodeToString( | ||
| "jwt signing key for an on behalf of token authentication backend for testing of OBO authentication".getBytes( | ||
| StandardCharsets.UTF_8 | ||
| ) | ||
| ); | ||
| private static final String encryptionKey = Base64.getEncoder().encodeToString("encryptionKey".getBytes(StandardCharsets.UTF_8)); | ||
| public static final String ADMIN_USER_NAME = "admin"; | ||
| public static final String DEFAULT_PASSWORD = "secret"; | ||
| public static final String OBO_TOKEN_REASON = "{\"reason\":\"Test generation\"}"; | ||
| public static final String OBO_ENDPOINT_PREFIX = "_plugins/_security/api/user/onbehalfof"; | ||
|
|
||
| @ClassRule | ||
| public static final LocalCluster cluster = new LocalCluster.Builder().clusterManager(ClusterManager.SINGLENODE) | ||
| .anonymousAuth(false) | ||
| .users(ADMIN_USER) | ||
| .nodeSettings( | ||
| Map.of( | ||
| "plugins.security.allow_default_init_securityindex", | ||
| true, | ||
| "plugins.security.restapi.roles_enabled", | ||
| List.of("user_admin__all_access") | ||
| ) | ||
| ) | ||
| .authc(AUTHC_HTTPBASIC_INTERNAL) | ||
| .onBehalfOf(new OnBehalfOfConfig().signing_key(signingKey).encryption_key(encryptionKey)) | ||
| .build(); | ||
|
|
||
| @Test | ||
| public void shouldAuthenticateWithOBOTokenEndPoint() { | ||
| Header adminOboAuthHeader; | ||
|
|
||
| try (TestRestClient client = cluster.getRestClient(ADMIN_USER_NAME, DEFAULT_PASSWORD)) { | ||
|
|
||
| client.assertCorrectCredentials(ADMIN_USER_NAME); | ||
|
|
||
| TestRestClient.HttpResponse response = client.postJson(OBO_ENDPOINT_PREFIX, OBO_TOKEN_REASON); | ||
| response.assertStatusCode(200); | ||
|
|
||
| Map<String, Object> oboEndPointResponse = response.getBodyAs(Map.class); | ||
| assertThat(oboEndPointResponse, allOf(aMapWithSize(3), hasKey("user"), hasKey("onBehalfOfToken"), hasKey("duration"))); | ||
|
|
||
| String encodedOboTokenStr = oboEndPointResponse.get("onBehalfOfToken").toString(); | ||
|
|
||
| adminOboAuthHeader = new BasicHeader("Authorization", "Bearer " + encodedOboTokenStr); | ||
| } | ||
|
|
||
| try (TestRestClient client = cluster.getRestClient(adminOboAuthHeader)) { | ||
|
|
||
| TestRestClient.HttpResponse response = client.getAuthInfo(); | ||
| response.assertStatusCode(200); | ||
|
|
||
| String username = response.getTextFromJsonBody(POINTER_USERNAME); | ||
| assertThat(username, equalTo(ADMIN_USER_NAME)); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldNotAuthenticateWithATemperedOBOToken() { | ||
| Header adminOboAuthHeader; | ||
|
|
||
| try (TestRestClient client = cluster.getRestClient(ADMIN_USER_NAME, DEFAULT_PASSWORD)) { | ||
|
|
||
| client.assertCorrectCredentials(ADMIN_USER_NAME); | ||
|
|
||
| TestRestClient.HttpResponse response = client.postJson(OBO_ENDPOINT_PREFIX, OBO_TOKEN_REASON); | ||
| response.assertStatusCode(200); | ||
|
|
||
| Map<String, Object> oboEndPointResponse = response.getBodyAs(Map.class); | ||
| assertThat(oboEndPointResponse, allOf(aMapWithSize(3), hasKey("user"), hasKey("onBehalfOfToken"), hasKey("duration"))); | ||
|
|
||
| String encodedOboTokenStr = oboEndPointResponse.get("onBehalfOfToken").toString(); | ||
| StringBuilder stringBuilder = new StringBuilder(encodedOboTokenStr); | ||
| stringBuilder.deleteCharAt(encodedOboTokenStr.length() - 1); | ||
| String temperedOboTokenStr = stringBuilder.toString(); | ||
|
|
||
| adminOboAuthHeader = new BasicHeader("Authorization", "Bearer " + temperedOboTokenStr); | ||
| } | ||
|
|
||
| try (TestRestClient client = cluster.getRestClient(adminOboAuthHeader)) { | ||
|
|
||
| TestRestClient.HttpResponse response = client.getAuthInfo(); | ||
| response.assertStatusCode(401); | ||
| response.getBody().contains("Unauthorized"); | ||
| } | ||
| } | ||
| } |
44 changes: 44 additions & 0 deletions
44
src/integrationTest/java/org/opensearch/test/framework/OnBehalfOfConfig.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| * | ||
| */ | ||
| package org.opensearch.test.framework; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
|
|
||
| import org.opensearch.core.xcontent.ToXContent; | ||
| import org.opensearch.core.xcontent.ToXContentObject; | ||
| import org.opensearch.core.xcontent.XContentBuilder; | ||
|
|
||
| public class OnBehalfOfConfig implements ToXContentObject { | ||
| private String signing_key; | ||
| private String encryption_key; | ||
|
|
||
| public OnBehalfOfConfig signing_key(String signing_key) { | ||
| this.signing_key = signing_key; | ||
| return this; | ||
| } | ||
|
|
||
| public OnBehalfOfConfig encryption_key(String encryption_key) { | ||
| this.encryption_key = encryption_key; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder xContentBuilder, ToXContent.Params params) throws IOException { | ||
| xContentBuilder.startObject(); | ||
| xContentBuilder.field("signing_key", signing_key); | ||
| if (StringUtils.isNoneBlank(encryption_key)) { | ||
| xContentBuilder.field("encryption_key", encryption_key); | ||
| } | ||
| xContentBuilder.endObject(); | ||
| return xContentBuilder; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.