-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge "add KeycloakPermissionFilter"
- Loading branch information
Showing
14 changed files
with
279 additions
and
92 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
104 changes: 104 additions & 0 deletions
104
app/src/test/java/org/onap/portalng/bff/rbac/RoleBaseAccessIntegrationTest.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,104 @@ | ||
| /* | ||
| * | ||
| * Copyright (c) 2024. Deutsche Telekom AG | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * | ||
| */ | ||
|
|
||
| package org.onap.portalng.bff.rbac; | ||
|
|
||
| import com.github.tomakehurst.wiremock.client.WireMock; | ||
| import io.restassured.http.Header; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.onap.portalng.bff.BaseIntegrationTest; | ||
| import org.springframework.http.HttpStatus; | ||
| import org.springframework.http.MediaType; | ||
|
|
||
| public class RoleBaseAccessIntegrationTest extends BaseIntegrationTest { | ||
|
|
||
| @Test | ||
| void thatRoleIsNotSufficient() { | ||
|
|
||
| WireMock.stubFor( | ||
| WireMock.post( | ||
| WireMock.urlMatching( | ||
| String.format("/realms/%s/protocol/openid-connect/token", realm))) | ||
| .withRequestBody( | ||
| WireMock.containing("grant_type=urn:ietf:params:oauth:grant-type:uma-ticket")) | ||
| .willReturn( | ||
| WireMock.aResponse() | ||
| .withHeader("Content-Type", MediaType.APPLICATION_JSON_VALUE) | ||
| .withStatus(HttpStatus.FORBIDDEN.value()))); | ||
|
|
||
| requestSpecification() | ||
| .given() | ||
| .accept(MediaType.APPLICATION_JSON_VALUE) | ||
| .header(new Header("X-Request-Id", "addf6005-3075-4c80-b7bc-2c70b7d42b57")) | ||
| .when() | ||
| .get("/roles") | ||
| .then() | ||
| .statusCode(HttpStatus.FORBIDDEN.value()); | ||
| } | ||
|
|
||
| @Test | ||
| void thatResourceIsNotAvailable() { | ||
|
|
||
| WireMock.stubFor( | ||
| WireMock.post( | ||
| WireMock.urlMatching( | ||
| String.format("/realms/%s/protocol/openid-connect/token", realm))) | ||
| .withRequestBody( | ||
| WireMock.containing("grant_type=urn:ietf:params:oauth:grant-type:uma-ticket")) | ||
| .willReturn( | ||
| WireMock.aResponse() | ||
| .withHeader("Content-Type", MediaType.APPLICATION_JSON_VALUE) | ||
| .withStatus(HttpStatus.BAD_REQUEST.value()))); | ||
|
|
||
| requestSpecification() | ||
| .given() | ||
| .accept(MediaType.APPLICATION_JSON_VALUE) | ||
| .header(new Header("X-Request-Id", "addf6005-3075-4c80-b7bc-2c70b7d42b57")) | ||
| .when() | ||
| .get("/roles") | ||
| .then() | ||
| .statusCode(HttpStatus.FORBIDDEN.value()); | ||
| } | ||
|
|
||
| @Test | ||
| void thatRoleBaseCheckIsMalformed() { | ||
|
|
||
| WireMock.stubFor( | ||
| WireMock.post( | ||
| WireMock.urlMatching( | ||
| String.format("/realms/%s/protocol/openid-connect/token", realm))) | ||
| .withRequestBody( | ||
| WireMock.containing("grant_type=urn:ietf:params:oauth:grant-type:uma-ticket")) | ||
| .willReturn( | ||
| WireMock.aResponse() | ||
| .withHeader("Content-Type", MediaType.APPLICATION_JSON_VALUE) | ||
| .withBody(objectMapper.createObjectNode().put("result", "false").toString()))); | ||
|
|
||
| requestSpecification() | ||
| .given() | ||
| .accept(MediaType.APPLICATION_JSON_VALUE) | ||
| .header(new Header("X-Request-Id", "addf6005-3075-4c80-b7bc-2c70b7d42b57")) | ||
| .when() | ||
| .get("/roles") | ||
| .then() | ||
| .statusCode(HttpStatus.FORBIDDEN.value()); | ||
| } | ||
| } |
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
122 changes: 122 additions & 0 deletions
122
lib/src/main/java/org/onap/portalng/bff/config/KeycloakPermissionFilter.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,122 @@ | ||
| /* | ||
| * | ||
| * Copyright (c) 2024. Deutsche Telekom AG | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * | ||
| */ | ||
|
|
||
| package org.onap.portalng.bff.config; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.springframework.beans.factory.annotation.Value; | ||
| import org.springframework.http.HttpHeaders; | ||
| import org.springframework.http.HttpStatus; | ||
| import org.springframework.http.MediaType; | ||
| import org.springframework.stereotype.Component; | ||
| import org.springframework.web.reactive.function.client.WebClient; | ||
| import org.springframework.web.server.ServerWebExchange; | ||
| import org.springframework.web.server.WebFilter; | ||
| import org.springframework.web.server.WebFilterChain; | ||
| import reactor.core.publisher.Mono; | ||
|
|
||
| @Component | ||
| @Slf4j | ||
| public class KeycloakPermissionFilter implements WebFilter { | ||
|
|
||
| private final WebClient webClient; | ||
|
|
||
| private final ObjectMapper objectMapper; | ||
| private final BffConfig bffConfig; | ||
|
|
||
| @Value("${bff.rbac.endpoints-excluded}") | ||
| private String[] EXCLUDED_PATHS; | ||
|
|
||
| public KeycloakPermissionFilter( | ||
| WebClient.Builder webClientBuilder, ObjectMapper objectMapper, BffConfig bffConfig) { | ||
| this.webClient = webClientBuilder.build(); | ||
| this.objectMapper = objectMapper; | ||
| this.bffConfig = bffConfig; | ||
| } | ||
|
|
||
| @Override | ||
| public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) { | ||
| String accessToken = exchange.getRequest().getHeaders().getFirst(HttpHeaders.AUTHORIZATION); | ||
| String uri = exchange.getRequest().getURI().getPath(); | ||
| String method = exchange.getRequest().getMethod().toString(); | ||
|
|
||
| for (String excludedPath : EXCLUDED_PATHS) { | ||
| if (uri.matches(excludedPath.replace("**", ".*"))) { | ||
| return chain.filter(exchange); | ||
| } | ||
| } | ||
|
|
||
| String body = | ||
| new StringBuilder() | ||
| .append("grant_type=urn:ietf:params:oauth:grant-type:uma-ticket") | ||
| .append("&audience=") | ||
| .append(bffConfig.getKeycloakClientId()) | ||
| .append("&permission_resource_format=uri") | ||
| .append("&permission_resource_matching_uri=true") | ||
| .append("&permission=") | ||
| .append(uri) | ||
| .append("#") | ||
| .append(method) | ||
| .append("&response_mode=decision") | ||
| .toString(); | ||
|
|
||
| return webClient | ||
| .post() | ||
| .uri( | ||
| bffConfig.getKeycloakUrl() | ||
| + "/realms/" | ||
| + bffConfig.getRealm() | ||
| + "/protocol/openid-connect/token") | ||
| .header(HttpHeaders.AUTHORIZATION, accessToken) | ||
| .contentType(MediaType.APPLICATION_FORM_URLENCODED) | ||
| .bodyValue(body) | ||
| .retrieve() | ||
| .bodyToMono(String.class) | ||
| .flatMap( | ||
| response -> { | ||
| if (isPermissionGranted(response)) { | ||
| return chain.filter(exchange); | ||
| } else { | ||
| exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN); | ||
| return exchange.getResponse().setComplete(); | ||
| } | ||
| }) | ||
| .onErrorResume( | ||
| ex -> { | ||
| exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN); | ||
| return exchange.getResponse().setComplete(); | ||
| }); | ||
| } | ||
|
|
||
| private boolean isPermissionGranted(String response) { | ||
| try { | ||
| JsonNode jsonNode = objectMapper.readTree(response); | ||
| if (jsonNode.has("result") && jsonNode.get("result").asBoolean()) { | ||
| return true; | ||
| } | ||
| } catch (Exception e) { | ||
| log.error("Error parsing JSON response", e); | ||
| } | ||
| return false; | ||
| } | ||
| } |
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.