feat(ap1): enforce resource audience
This commit is contained in:
@@ -110,3 +110,9 @@ token은 명시적인 in-memory store에만 보관되므로 새로고침하면
|
|||||||
브라우저에서 `http://localhost:8088`을 열어 로그인한 뒤 보호 API를 호출할 수
|
브라우저에서 `http://localhost:8088`을 열어 로그인한 뒤 보호 API를 호출할 수
|
||||||
있습니다. SPA는 `http://localhost:8081/api/me`를 직접 호출하며 Spring
|
있습니다. SPA는 `http://localhost:8081/api/me`를 직접 호출하며 Spring
|
||||||
Resource Server가 Bearer JWT를 검증합니다.
|
Resource Server가 Bearer JWT를 검증합니다.
|
||||||
|
|
||||||
|
Keycloak의 dedicated audience mapper는 `spa-public` access token에
|
||||||
|
`keycloak-pattern-api`를 추가합니다. Spring은 signature, `iss`, `exp`뿐
|
||||||
|
아니라 이 `aud`도 검사합니다. `verify-pattern1.sh`는 같은 정상 토큰을
|
||||||
|
`deliberately-wrong-audience`를 기대하는 진단 인스턴스에도 제출해 `401`을
|
||||||
|
확인합니다.
|
||||||
|
|||||||
@@ -0,0 +1,29 @@
|
|||||||
|
package com.example.keycloakpattern;
|
||||||
|
|
||||||
|
import org.springframework.security.oauth2.core.OAuth2Error;
|
||||||
|
import org.springframework.security.oauth2.core.OAuth2TokenValidator;
|
||||||
|
import org.springframework.security.oauth2.core.OAuth2TokenValidatorResult;
|
||||||
|
import org.springframework.security.oauth2.jwt.Jwt;
|
||||||
|
|
||||||
|
final class AudienceValidator implements OAuth2TokenValidator<Jwt> {
|
||||||
|
|
||||||
|
private static final OAuth2Error MISSING_AUDIENCE = new OAuth2Error(
|
||||||
|
"invalid_token",
|
||||||
|
"The required resource audience is missing",
|
||||||
|
null
|
||||||
|
);
|
||||||
|
|
||||||
|
private final String expectedAudience;
|
||||||
|
|
||||||
|
AudienceValidator(String expectedAudience) {
|
||||||
|
this.expectedAudience = expectedAudience;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public OAuth2TokenValidatorResult validate(Jwt jwt) {
|
||||||
|
if (jwt.getAudience().contains(expectedAudience)) {
|
||||||
|
return OAuth2TokenValidatorResult.success();
|
||||||
|
}
|
||||||
|
return OAuth2TokenValidatorResult.failure(MISSING_AUDIENCE);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
package com.example.keycloakpattern;
|
||||||
|
|
||||||
|
import org.springframework.beans.factory.annotation.Value;
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.context.annotation.Configuration;
|
||||||
|
import org.springframework.security.oauth2.core.DelegatingOAuth2TokenValidator;
|
||||||
|
import org.springframework.security.oauth2.core.OAuth2TokenValidator;
|
||||||
|
import org.springframework.security.oauth2.jwt.Jwt;
|
||||||
|
import org.springframework.security.oauth2.jwt.JwtDecoder;
|
||||||
|
import org.springframework.security.oauth2.jwt.JwtValidators;
|
||||||
|
import org.springframework.security.oauth2.jwt.NimbusJwtDecoder;
|
||||||
|
|
||||||
|
@Configuration
|
||||||
|
public class JwtDecoderConfig {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
JwtDecoder jwtDecoder(
|
||||||
|
@Value("${spring.security.oauth2.resourceserver.jwt.issuer-uri}") String issuer,
|
||||||
|
@Value("${spring.security.oauth2.resourceserver.jwt.jwk-set-uri}") String jwkSetUri,
|
||||||
|
@Value("${security.expected-audience}") String expectedAudience
|
||||||
|
) {
|
||||||
|
NimbusJwtDecoder decoder = NimbusJwtDecoder.withJwkSetUri(jwkSetUri).build();
|
||||||
|
OAuth2TokenValidator<Jwt> issuerAndTimestamp =
|
||||||
|
JwtValidators.createDefaultWithIssuer(issuer);
|
||||||
|
OAuth2TokenValidator<Jwt> audience = new AudienceValidator(expectedAudience);
|
||||||
|
decoder.setJwtValidator(
|
||||||
|
new DelegatingOAuth2TokenValidator<>(issuerAndTimestamp, audience)
|
||||||
|
);
|
||||||
|
return decoder;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -11,6 +11,9 @@ spring:
|
|||||||
issuer-uri: ${SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI:http://localhost:8080/realms/keycloak-patterns}
|
issuer-uri: ${SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI:http://localhost:8080/realms/keycloak-patterns}
|
||||||
jwk-set-uri: ${SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI:http://localhost:8080/realms/keycloak-patterns/protocol/openid-connect/certs}
|
jwk-set-uri: ${SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI:http://localhost:8080/realms/keycloak-patterns/protocol/openid-connect/certs}
|
||||||
|
|
||||||
|
security:
|
||||||
|
expected-audience: ${SECURITY_EXPECTED_AUDIENCE:keycloak-pattern-api}
|
||||||
|
|
||||||
management:
|
management:
|
||||||
endpoint:
|
endpoint:
|
||||||
health:
|
health:
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
package com.example.keycloakpattern;
|
||||||
|
|
||||||
|
import static org.assertj.core.api.Assertions.assertThat;
|
||||||
|
|
||||||
|
import java.time.Instant;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.springframework.security.oauth2.core.OAuth2TokenValidatorResult;
|
||||||
|
import org.springframework.security.oauth2.jwt.Jwt;
|
||||||
|
|
||||||
|
class AudienceValidatorTest {
|
||||||
|
|
||||||
|
private final AudienceValidator validator =
|
||||||
|
new AudienceValidator("keycloak-pattern-api");
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void acceptsRequiredAudience() {
|
||||||
|
OAuth2TokenValidatorResult result = validator.validate(jwtWithAudience(
|
||||||
|
List.of("account", "keycloak-pattern-api")
|
||||||
|
));
|
||||||
|
|
||||||
|
assertThat(result.hasErrors()).isFalse();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void rejectsForeignAudience() {
|
||||||
|
OAuth2TokenValidatorResult result = validator.validate(jwtWithAudience(
|
||||||
|
List.of("another-resource")
|
||||||
|
));
|
||||||
|
|
||||||
|
assertThat(result.hasErrors()).isTrue();
|
||||||
|
assertThat(result.getErrors())
|
||||||
|
.extracting(error -> error.getErrorCode())
|
||||||
|
.containsExactly("invalid_token");
|
||||||
|
}
|
||||||
|
|
||||||
|
private Jwt jwtWithAudience(List<String> audience) {
|
||||||
|
Instant now = Instant.now();
|
||||||
|
return new Jwt(
|
||||||
|
"test-token",
|
||||||
|
now,
|
||||||
|
now.plusSeconds(300),
|
||||||
|
Map.of("alg", "none"),
|
||||||
|
Map.of("sub", "test-subject", "aud", audience)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -86,6 +86,32 @@ services:
|
|||||||
- keycloak-net
|
- keycloak-net
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
|
|
||||||
|
app-wrong-audience:
|
||||||
|
profiles:
|
||||||
|
- diagnostics
|
||||||
|
build:
|
||||||
|
context: ./backend
|
||||||
|
environment:
|
||||||
|
SERVER_PORT: "8081"
|
||||||
|
SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI: http://localhost:8080/realms/keycloak-patterns
|
||||||
|
SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI: http://keycloak:8080/realms/keycloak-patterns/protocol/openid-connect/certs
|
||||||
|
SECURITY_EXPECTED_AUDIENCE: deliberately-wrong-audience
|
||||||
|
ports:
|
||||||
|
- "127.0.0.1:18081:8081"
|
||||||
|
depends_on:
|
||||||
|
keycloak:
|
||||||
|
condition: service_healthy
|
||||||
|
healthcheck:
|
||||||
|
test:
|
||||||
|
- CMD-SHELL
|
||||||
|
- wget -q -O - http://127.0.0.1:8081/actuator/health | grep -q '"status":"UP"'
|
||||||
|
interval: 10s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 12
|
||||||
|
start_period: 20s
|
||||||
|
networks:
|
||||||
|
- keycloak-net
|
||||||
|
|
||||||
nginx:
|
nginx:
|
||||||
build:
|
build:
|
||||||
context: ./frontend
|
context: ./frontend
|
||||||
|
|||||||
+20
-1
@@ -38,6 +38,14 @@ try {
|
|||||||
|
|
||||||
const accessToken = await page.evaluate(() => window.__pattern1.getAccessToken());
|
const accessToken = await page.evaluate(() => window.__pattern1.getAccessToken());
|
||||||
assert.ok(accessToken, "access token must exist in browser memory");
|
assert.ok(accessToken, "access token must exist in browser memory");
|
||||||
|
const payload = JSON.parse(
|
||||||
|
Buffer.from(accessToken.split(".")[1], "base64url").toString("utf8"),
|
||||||
|
);
|
||||||
|
const audiences = Array.isArray(payload.aud) ? payload.aud : [payload.aud];
|
||||||
|
assert.ok(
|
||||||
|
audiences.includes("keycloak-pattern-api"),
|
||||||
|
"access token must target keycloak-pattern-api",
|
||||||
|
);
|
||||||
|
|
||||||
const storageSnapshot = await page.evaluate(() => ({
|
const storageSnapshot = await page.evaluate(() => ({
|
||||||
localStorage: Object.values(localStorage),
|
localStorage: Object.values(localStorage),
|
||||||
@@ -55,6 +63,17 @@ try {
|
|||||||
return text.includes('"httpStatus": 200');
|
return text.includes('"httpStatus": 200');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
if (process.env.WRONG_AUDIENCE_URL) {
|
||||||
|
const response = await fetch(process.env.WRONG_AUDIENCE_URL, {
|
||||||
|
headers: { Authorization: `Bearer ${accessToken}` },
|
||||||
|
});
|
||||||
|
assert.equal(
|
||||||
|
response.status,
|
||||||
|
401,
|
||||||
|
"the same signed token must fail when the Resource Server expects another audience",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
await page.reload();
|
await page.reload();
|
||||||
await page.locator('[data-authenticated="false"]').waitFor();
|
await page.locator('[data-authenticated="false"]').waitFor();
|
||||||
assert.equal(
|
assert.equal(
|
||||||
@@ -64,7 +83,7 @@ try {
|
|||||||
);
|
);
|
||||||
|
|
||||||
console.log(
|
console.log(
|
||||||
"pattern1 browser verified: code+PKCE S256, protected API 200, Web Storage token 0, reload clears token",
|
"pattern1 browser verified: code+PKCE S256, audience positive 200/negative 401, Web Storage token 0, reload clears token",
|
||||||
);
|
);
|
||||||
} finally {
|
} finally {
|
||||||
await browser.close();
|
await browser.close();
|
||||||
|
|||||||
@@ -51,7 +51,22 @@
|
|||||||
"attributes": {
|
"attributes": {
|
||||||
"pkce.code.challenge.method": "S256",
|
"pkce.code.challenge.method": "S256",
|
||||||
"post.logout.redirect.uris": "http://localhost:8088/*##http://127.0.0.1:8088/*"
|
"post.logout.redirect.uris": "http://localhost:8088/*##http://127.0.0.1:8088/*"
|
||||||
}
|
},
|
||||||
|
"protocolMappers": [
|
||||||
|
{
|
||||||
|
"name": "keycloak-pattern-api-audience",
|
||||||
|
"protocol": "openid-connect",
|
||||||
|
"protocolMapper": "oidc-audience-mapper",
|
||||||
|
"consentRequired": false,
|
||||||
|
"config": {
|
||||||
|
"included.custom.audience": "keycloak-pattern-api",
|
||||||
|
"id.token.claim": "false",
|
||||||
|
"access.token.claim": "true",
|
||||||
|
"userinfo.token.claim": "false",
|
||||||
|
"introspection.token.claim": "true"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"clientId": "token-mediating-confidential",
|
"clientId": "token-mediating-confidential",
|
||||||
|
|||||||
@@ -70,6 +70,18 @@ def validate(path: Path, runtime: bool) -> None:
|
|||||||
spa.get("attributes", {}).get("pkce.code.challenge.method") == "S256",
|
spa.get("attributes", {}).get("pkce.code.challenge.method") == "S256",
|
||||||
"spa-public must enforce PKCE S256",
|
"spa-public must enforce PKCE S256",
|
||||||
)
|
)
|
||||||
|
audience_mappers = [
|
||||||
|
mapper
|
||||||
|
for mapper in spa.get("protocolMappers", [])
|
||||||
|
if mapper.get("protocolMapper") == "oidc-audience-mapper"
|
||||||
|
]
|
||||||
|
if not runtime:
|
||||||
|
require(len(audience_mappers) == 1, "spa-public must declare one audience mapper")
|
||||||
|
require(
|
||||||
|
audience_mappers[0].get("config", {}).get("included.custom.audience")
|
||||||
|
== "keycloak-pattern-api",
|
||||||
|
"spa-public access token must target keycloak-pattern-api",
|
||||||
|
)
|
||||||
|
|
||||||
for client_id, placeholder in CONFIDENTIAL_CLIENTS.items():
|
for client_id, placeholder in CONFIDENTIAL_CLIENTS.items():
|
||||||
client = clients[client_id]
|
client = clients[client_id]
|
||||||
|
|||||||
@@ -12,10 +12,12 @@ set +a
|
|||||||
|
|
||||||
docker compose down --volumes --remove-orphans
|
docker compose down --volumes --remove-orphans
|
||||||
docker compose up --build -d --wait
|
docker compose up --build -d --wait
|
||||||
|
docker compose --profile diagnostics up -d --wait app-wrong-audience
|
||||||
|
|
||||||
npm --prefix e2e ci
|
npm --prefix e2e ci
|
||||||
E2E_USERNAME=regular-user \
|
E2E_USERNAME=regular-user \
|
||||||
E2E_PASSWORD="$REGULAR_USER_PASSWORD" \
|
E2E_PASSWORD="$REGULAR_USER_PASSWORD" \
|
||||||
|
WRONG_AUDIENCE_URL=http://localhost:18081/api/me \
|
||||||
npm --prefix e2e run test:pattern1
|
npm --prefix e2e run test:pattern1
|
||||||
|
|
||||||
echo "AP1 verified end to end"
|
echo "AP1 verified end to end"
|
||||||
|
|||||||
Reference in New Issue
Block a user