Skip to content
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.

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

[Enhancement] Setup auth token utils for obo #3419

Merged
merged 8 commits into from
Oct 2, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
import java.util.Optional;
import java.util.function.LongSupplier;

import com.google.common.base.Strings;
import org.apache.cxf.jaxrs.json.basic.JsonMapObjectReaderWriter;
import org.apache.cxf.rs.security.jose.jwk.JsonWebKey;
import org.apache.cxf.rs.security.jose.jwk.KeyType;
Expand All @@ -32,6 +31,8 @@
import org.opensearch.common.settings.Settings;
import org.opensearch.security.ssl.util.ExceptionUtils;

import static org.opensearch.security.util.AuthTokenUtils.isKeyNull;

public class JwtVendor {
private static final Logger logger = LogManager.getLogger(JwtVendor.class);

Expand All @@ -53,7 +54,7 @@ public JwtVendor(final Settings settings, final Optional<LongSupplier> timeProvi
throw ExceptionUtils.createJwkCreationException(e);
}
this.jwtProducer = jwtProducer;
if (settings.get("encryption_key") == null) {
if (isKeyNull(settings, "encryption_key")) {
throw new IllegalArgumentException("encryption_key cannot be null");
} else {
this.claimsEncryptionKey = settings.get("encryption_key");
Expand All @@ -73,9 +74,8 @@ public JwtVendor(final Settings settings, final Optional<LongSupplier> timeProvi
* Encryption Algorithm: HS512
* */
static JsonWebKey createJwkFromSettings(Settings settings) throws Exception {
String signingKey = settings.get("signing_key");

if (!Strings.isNullOrEmpty(signingKey)) {
if (!isKeyNull(settings, "signing_key")) {
String signingKey = settings.get("signing_key");

JsonWebKey jwk = new JsonWebKey();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,12 @@

import static org.opensearch.security.OpenSearchSecurityPlugin.LEGACY_OPENDISTRO_PREFIX;
import static org.opensearch.security.OpenSearchSecurityPlugin.PLUGINS_PREFIX;
import static org.opensearch.security.util.AuthTokenUtils.isAccessToRestrictedEndpoints;

public class OnBehalfOfAuthenticator implements HTTPAuthenticator {

private static final String REGEX_PATH_PREFIX = "/(" + LEGACY_OPENDISTRO_PREFIX + "|" + PLUGINS_PREFIX + ")/" + "(.*)";
private static final Pattern PATTERN_PATH_PREFIX = Pattern.compile(REGEX_PATH_PREFIX);
private static final String ON_BEHALF_OF_SUFFIX = "api/generateonbehalfoftoken";
private static final String ACCOUNT_SUFFIX = "api/account";

protected final Logger log = LogManager.getLogger(this.getClass());

Expand Down Expand Up @@ -233,8 +232,7 @@ private void logDebug(String message, Object... args) {
public Boolean isRequestAllowed(final RestRequest request) {
Matcher matcher = PATTERN_PATH_PREFIX.matcher(request.path());
final String suffix = matcher.matches() ? matcher.group(2) : null;
if (request.method() == RestRequest.Method.POST && ON_BEHALF_OF_SUFFIX.equals(suffix)
|| request.method() == RestRequest.Method.PUT && ACCOUNT_SUFFIX.equals(suffix)) {
if (isAccessToRestrictedEndpoints(request, suffix)) {
final OpenSearchException exception = ExceptionUtils.invalidUsageOfOBOTokenException();
log.error(exception.toString());
return false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@
import org.opensearch.security.securityconf.impl.v7.ConfigV7.AuthzDomain;
import org.opensearch.security.support.ReflectionHelper;

import static org.opensearch.security.util.AuthTokenUtils.*;

public class DynamicConfigModelV7 extends DynamicConfigModel {

private final ConfigV7 config;
Expand Down Expand Up @@ -383,7 +385,7 @@ private void buildAAA() {
* order: -1 - prioritize the OBO authentication when it gets enabled
*/
Settings oboSettings = getDynamicOnBehalfOfSettings();
if (oboSettings.get("signing_key") != null && oboSettings.get("encryption_key") != null) {
if (!isKeyNull(oboSettings, "signing_key") && !isKeyNull(oboSettings, "encryption_key")) {
final AuthDomain _ad = new AuthDomain(
new NoOpAuthenticationBackend(Settings.EMPTY, null),
new OnBehalfOfAuthenticator(getDynamicOnBehalfOfSettings(), this.cih.getClusterName()),
Expand Down
41 changes: 41 additions & 0 deletions src/main/java/org/opensearch/security/util/AuthTokenUtils.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* 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.util;

import org.opensearch.common.settings.Settings;
import org.opensearch.rest.RestRequest;

import static org.opensearch.rest.RestRequest.Method.POST;
import static org.opensearch.rest.RestRequest.Method.PUT;

public class AuthTokenUtils {

Check warning on line 20 in src/main/java/org/opensearch/security/util/AuthTokenUtils.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/org/opensearch/security/util/AuthTokenUtils.java#L20

Added line #L20 was not covered by tests
private static final String ON_BEHALF_OF_SUFFIX = "api/generateonbehalfoftoken";
private static final String ACCOUNT_SUFFIX = "api/account";

public static Boolean isAccessToRestrictedEndpoints(final RestRequest request, final String suffix) {
if (suffix == null) {
return false;
}
switch (suffix) {
case ON_BEHALF_OF_SUFFIX:
return request.method() == POST;
case ACCOUNT_SUFFIX:
return request.method() == PUT;
default:
return false;

Check warning on line 34 in src/main/java/org/opensearch/security/util/AuthTokenUtils.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/org/opensearch/security/util/AuthTokenUtils.java#L34

Added line #L34 was not covered by tests
}
}

public static Boolean isKeyNull(Settings settings, String key) {
return settings.get(key) == null;
}
}
Loading