Skip to content

Fail build when multiple HttpSecurityPolicies with same name are detected #47448

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

Merged
Merged
Show file tree
Hide file tree
Changes from all 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
@@ -0,0 +1,65 @@
package io.quarkus.vertx.http.security;

import jakarta.enterprise.context.ApplicationScoped;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.quarkus.security.identity.SecurityIdentity;
import io.quarkus.test.QuarkusUnitTest;
import io.quarkus.vertx.http.runtime.security.HttpSecurityPolicy;
import io.smallrye.mutiny.Uni;
import io.vertx.ext.web.RoutingContext;

public class DuplicatedNamedAuthPolicyValidationFailureTest {

private static final String POLICY_NAME = "p_o_l_i_c_y_n_a_m_e";

@RegisterExtension
static final QuarkusUnitTest config = new QuarkusUnitTest()
.withApplicationRoot((jar) -> jar
.addClasses(NamedPolicy_1.class, NamedPolicy_2.class))
.assertException(throwable -> {
var errMsg = throwable.getMessage();
Assertions.assertTrue(errMsg.contains("Only one HttpSecurityPolicy"), errMsg);
Assertions.assertTrue(errMsg.contains(POLICY_NAME), errMsg);
Assertions.assertTrue(errMsg.contains(NamedPolicy_1.class.getSimpleName()));
Assertions.assertTrue(errMsg.contains(NamedPolicy_2.class.getSimpleName()));
});

@Test
public void test() {
Assertions.fail("Build was supposed to fail due to validation");
}

@ApplicationScoped
public static class NamedPolicy_1 implements HttpSecurityPolicy {

@Override
public Uni<CheckResult> checkPermission(RoutingContext request, Uni<SecurityIdentity> identity,
AuthorizationRequestContext requestContext) {
return null;
}

@Override
public String name() {
return POLICY_NAME;
}
}

@ApplicationScoped
public static class NamedPolicy_2 implements HttpSecurityPolicy {

@Override
public Uni<CheckResult> checkPermission(RoutingContext request, Uni<SecurityIdentity> identity,
AuthorizationRequestContext requestContext) {
return null;
}

@Override
public String name() {
return POLICY_NAME;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

import jakarta.enterprise.inject.Instance;

import io.quarkus.arc.ClientProxy;
import io.quarkus.runtime.configuration.ConfigurationException;
import io.quarkus.security.StringPermission;
import io.quarkus.security.identity.SecurityIdentity;
Expand Down Expand Up @@ -236,7 +237,10 @@ private static Map<String, HttpSecurityPolicy> toNamedHttpSecPolicies(Map<String
if (policy.name().isBlank()) {
throw new ConfigurationException("HTTP Security policy '" + policy + "' name must not be blank");
}
namedPolicies.put(policy.name(), policy);
var previousPolicy = namedPolicies.put(policy.name(), policy);
if (previousPolicy != null) {
throw duplicateNamedPoliciesNotAllowedEx(previousPolicy, policy);
}
}
}

Expand Down Expand Up @@ -271,12 +275,26 @@ private static Map<String, HttpSecurityPolicy> toNamedHttpSecPolicies(Map<String
roleToPermissions.put(role, Set.copyOf(permissions));
}
}
namedPolicies.put(e.getKey(),
new RolesAllowedHttpSecurityPolicy(policyConfig.rolesAllowed(), roleToPermissions, policyConfig.roles()));
var rolesAllowedPolicy = new RolesAllowedHttpSecurityPolicy(policyConfig.rolesAllowed(), roleToPermissions,
policyConfig.roles());
var previousPolicy = namedPolicies.put(e.getKey(), rolesAllowedPolicy);
if (previousPolicy != null) {
throw duplicateNamedPoliciesNotAllowedEx(previousPolicy, rolesAllowedPolicy);
}
}

var previousPolicy = namedPolicies.put("deny", DenySecurityPolicy.INSTANCE);
if (previousPolicy != null) {
throw duplicateNamedPoliciesNotAllowedEx(previousPolicy, DenySecurityPolicy.INSTANCE);
}
previousPolicy = namedPolicies.put("permit", new PermitSecurityPolicy());
if (previousPolicy != null) {
throw duplicateNamedPoliciesNotAllowedEx(previousPolicy, new PermitSecurityPolicy());
}
previousPolicy = namedPolicies.put("authenticated", new AuthenticatedHttpSecurityPolicy());
if (previousPolicy != null) {
throw duplicateNamedPoliciesNotAllowedEx(previousPolicy, new AuthenticatedHttpSecurityPolicy());
}
namedPolicies.put("deny", new DenySecurityPolicy());
namedPolicies.put("permit", new PermitSecurityPolicy());
namedPolicies.put("authenticated", new AuthenticatedHttpSecurityPolicy());
return namedPolicies;
}

Expand Down Expand Up @@ -386,6 +404,13 @@ private void addAction(String action) {
}
}

static ConfigurationException duplicateNamedPoliciesNotAllowedEx(HttpSecurityPolicy policy1, HttpSecurityPolicy policy2) {
String policyClassName1 = ClientProxy.unwrap(policy1).getClass().getName();
String policyClassName2 = ClientProxy.unwrap(policy2).getClass().getName();
return new ConfigurationException("Only one HttpSecurityPolicy with the name '"
+ policy1.name() + "' is allowed, but found: " + policyClassName1 + " and " + policyClassName2);
}

record HttpMatcher(String authMechanism, Set<String> methods, HttpSecurityPolicy checker) {

}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.quarkus.vertx.http.runtime.security;

import static io.quarkus.vertx.http.runtime.PolicyMappingConfig.AppliesTo.JAXRS;
import static io.quarkus.vertx.http.runtime.security.AbstractPathMatchingHttpSecurityPolicy.duplicateNamedPoliciesNotAllowedEx;

import java.util.HashMap;
import java.util.Map;
Expand Down Expand Up @@ -46,7 +47,10 @@ public class JaxRsPathMatchingHttpSecurityPolicy {
var allPolicies = new HashMap<String, HttpSecurityPolicy>();
for (HttpSecurityPolicy installedPolicy : installedPolicies) {
if (installedPolicy.name() != null) {
allPolicies.put(installedPolicy.name(), installedPolicy);
var previousPolicy = allPolicies.put(installedPolicy.name(), installedPolicy);
if (previousPolicy != null) {
throw duplicateNamedPoliciesNotAllowedEx(previousPolicy, installedPolicy);
}
}
}
var annotationPoliciesOnly = new HashMap<String, HttpSecurityPolicy>();
Expand Down
Loading