-
Notifications
You must be signed in to change notification settings - Fork 78
fix: ensure that the behaviour is safe within the UI by introducing headers #4801
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
Open
iansergeant42
wants to merge
6
commits into
v3.x.x
Choose a base branch
from
reboot/safe-behaviour-using-headers
base: v3.x.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+88
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
95dd2ef
Set the base specifically
iansergeant a0a2d78
Set the base programmatically
iansergeant 2a4f92f
Set the headers programmatically
iansergeant c956d20
Merge remote-tracking branch 'origin/v3.x.x' into reboot/safe-behavio…
iansergeant fd8d1b2
Add missing test
iansergeant c093626
Static import for mock
iansergeant File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
35 changes: 35 additions & 0 deletions
35
...way-service/src/main/java/org/zowe/apiml/gateway/filters/SecurityHeadersGlobalFilter.java
This file contains hidden or 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,35 @@ | ||
| /* | ||
| * This program and the accompanying materials are made available under the terms of the | ||
| * Eclipse Public License v2.0 which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-v20.html | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Copyright Contributors to the Zowe Project. | ||
| */ | ||
|
|
||
| package org.zowe.apiml.gateway.filters; | ||
|
|
||
| import org.springframework.cloud.gateway.filter.GatewayFilterChain; | ||
| import org.springframework.cloud.gateway.filter.GlobalFilter; | ||
| import org.springframework.core.Ordered; | ||
| import org.springframework.stereotype.Component; | ||
| import org.springframework.web.server.ServerWebExchange; | ||
| import reactor.core.publisher.Mono; | ||
|
|
||
| @Component | ||
| public class SecurityHeadersGlobalFilter implements GlobalFilter, Ordered { | ||
|
|
||
| @Override | ||
| public int getOrder() { | ||
| return -1; // High priority execution | ||
| } | ||
|
|
||
| @Override | ||
| public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { | ||
| return chain.filter(exchange).then(Mono.fromRunnable(() -> { | ||
| exchange.getResponse().getHeaders().set("X-Frame-Options", "DENY"); | ||
| exchange.getResponse().getHeaders().set("X-Content-Type-Options", "nosniff"); | ||
| })); | ||
| } | ||
| } | ||
53 changes: 53 additions & 0 deletions
53
...service/src/test/java/org/zowe/apiml/gateway/filters/SecurityHeadersGlobalFilterTest.java
This file contains hidden or 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,53 @@ | ||
| /* | ||
| * This program and the accompanying materials are made available under the terms of the | ||
| * Eclipse Public License v2.0 which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-v20.html | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Copyright Contributors to the Zowe Project. | ||
| */ | ||
|
|
||
| package org.zowe.apiml.gateway.filters; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.springframework.cloud.gateway.filter.GatewayFilterChain; | ||
| import org.springframework.http.HttpHeaders; | ||
| import org.springframework.mock.http.server.reactive.MockServerHttpRequest; | ||
| import org.springframework.mock.web.server.MockServerWebExchange; | ||
| import org.springframework.web.server.ServerWebExchange; | ||
| import reactor.core.publisher.Mono; | ||
| import reactor.test.StepVerifier; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| class SecurityHeadersGlobalFilterTest { | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For filters it is better to have an acceptance test as filters may interact and the result may not be always as expected. |
||
|
|
||
| private final SecurityHeadersGlobalFilter filter = new SecurityHeadersGlobalFilter(); | ||
|
|
||
| @Test | ||
| void shouldAddSecurityHeadersToResponse() { | ||
| // 1. Create a mock request and exchange instance | ||
| MockServerHttpRequest request = MockServerHttpRequest.get("/apicatalog/ui/v1/index.html").build(); | ||
| MockServerWebExchange exchange = MockServerWebExchange.from(request); | ||
|
|
||
| // 2. Mock the GatewayFilterChain to simulate a successful downstream filter execution | ||
| GatewayFilterChain filterChain = mock(GatewayFilterChain.class); | ||
| when(filterChain.filter(any(ServerWebExchange.class))).thenReturn(Mono.empty()); | ||
|
|
||
| // 3. Execute the filter and use StepVerifier to handle the reactive lifecycle | ||
| Mono<Void> result = filter.filter(exchange, filterChain); | ||
|
|
||
| StepVerifier.create(result) | ||
| .verifyComplete(); // Ensures the Mono chain finishes cleanly | ||
|
|
||
| // 4. Assert that the headers were successfully injected into the response | ||
| HttpHeaders responseHeaders = exchange.getResponse().getHeaders(); | ||
|
|
||
| assertEquals("DENY", responseHeaders.getFirst("X-Frame-Options")); | ||
| assertEquals("nosniff", responseHeaders.getFirst("X-Content-Type-Options")); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have you considered changing this line in WebSecurity.java (181)
.frameOptions(ServerHttpSecurity.HeaderSpec.FrameOptionsSpec::disable))
to
.frameOptions(frame -> frame.policy("DENY"))