-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #24 from imesh94/fix/infosec-data-publishing
Add changes to identify external traffic for infosec data publishing
- Loading branch information
Showing
13 changed files
with
502 additions
and
11 deletions.
There are no files selected for viewing
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
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
37 changes: 37 additions & 0 deletions
37
...src/main/java/org/wso2/openbanking/cds/identity/filter/AuthorizeDataPublishingFilter.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,37 @@ | ||
| /** | ||
| * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com). | ||
| * <p> | ||
| * WSO2 LLC. licenses this file to you 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 | ||
| * <p> | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * 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. | ||
| */ | ||
| package org.wso2.openbanking.cds.identity.filter; | ||
|
|
||
| import org.wso2.openbanking.cds.identity.utils.CDSIdentityConstants; | ||
|
|
||
| import javax.servlet.ServletRequest; | ||
|
|
||
| /** | ||
| * Authorize Data Publishing Filter. | ||
| * Implements custom logic related to publishing /authorize request data. | ||
| */ | ||
| public class AuthorizeDataPublishingFilter extends InfoSecDataPublishingFilter { | ||
|
|
||
| @Override | ||
| public boolean shouldPublishCurrentRequestData(ServletRequest request) { | ||
|
|
||
| // If the sessionDataKey query parameter is present, it is an internal redirect and should not be published. | ||
| return request.getParameter(CDSIdentityConstants.SESSION_DATA_KEY_PARAMETER) == null && | ||
| super.shouldPublishCurrentRequestData(request); | ||
| } | ||
| } |
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
205 changes: 205 additions & 0 deletions
205
...est/java/org/wso2/openbanking/cds/identity/filter/AuthorizeDataPublishingFilterTests.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,205 @@ | ||
| /** | ||
| * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com). | ||
| * <p> | ||
| * WSO2 LLC. licenses this file to you 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 | ||
| * <p> | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.wso2.openbanking.cds.identity.filter; | ||
|
|
||
| import com.wso2.openbanking.accelerator.common.config.OpenBankingConfigParser; | ||
| import com.wso2.openbanking.accelerator.common.exception.OpenBankingException; | ||
| import org.mockito.Mockito; | ||
| import org.powermock.api.mockito.PowerMockito; | ||
| import org.powermock.core.classloader.annotations.PowerMockIgnore; | ||
| import org.powermock.core.classloader.annotations.PrepareForTest; | ||
| import org.powermock.modules.testng.PowerMockTestCase; | ||
| import org.springframework.mock.web.MockHttpServletRequest; | ||
| import org.springframework.mock.web.MockHttpServletResponse; | ||
| import org.testng.annotations.BeforeClass; | ||
| import org.testng.annotations.BeforeMethod; | ||
| import org.testng.annotations.Test; | ||
| import org.wso2.openbanking.cds.common.config.OpenBankingCDSConfigParser; | ||
| import org.wso2.openbanking.cds.common.data.publisher.CDSDataPublishingService; | ||
| import org.wso2.openbanking.cds.common.utils.CommonConstants; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.UUID; | ||
|
|
||
| import javax.servlet.FilterChain; | ||
|
|
||
| import static org.mockito.Mockito.verify; | ||
| import static org.wso2.openbanking.cds.identity.filter.util.TestConstants.EXTERNAL_TRAFFIC_HEADER; | ||
| import static org.wso2.openbanking.cds.identity.filter.util.TestConstants.SESSION_DATA_KEY; | ||
|
|
||
| /** | ||
| * Test class for AuthorizeDataPublishingFilter Data Publishing Filter. | ||
| */ | ||
| @PowerMockIgnore("jdk.internal.reflect.*") | ||
| @PrepareForTest({OpenBankingCDSConfigParser.class, OpenBankingConfigParser.class, CDSDataPublishingService.class}) | ||
| public class AuthorizeDataPublishingFilterTests extends PowerMockTestCase { | ||
|
|
||
| private OpenBankingCDSConfigParser openBankingCDSConfigParserMock; | ||
| private OpenBankingConfigParser openBankingConfigParserMock; | ||
|
|
||
| MockHttpServletRequest request; | ||
| MockHttpServletResponse response; | ||
| FilterChain filterChain; | ||
| AuthorizeDataPublishingFilter filter; | ||
| Map<String, Object> cdsConfigs = new HashMap<>(); | ||
| Map<String, Object> configs = new HashMap<>(); | ||
|
|
||
| @BeforeClass | ||
| public void init() throws OpenBankingException { | ||
|
|
||
| cdsConfigs.put(CommonConstants.EXTERNAL_TRAFFIC_HEADER_NAME, "X-External-Traffic"); | ||
| cdsConfigs.put(CommonConstants.EXTERNAL_TRAFFIC_EXPECTED_VALUE, "true"); | ||
| configs.put("DataPublishing.Enabled", "true"); | ||
|
|
||
| openBankingCDSConfigParserMock = PowerMockito.mock(OpenBankingCDSConfigParser.class); | ||
| PowerMockito.mockStatic(OpenBankingCDSConfigParser.class); | ||
| PowerMockito.when(OpenBankingCDSConfigParser.getInstance()).thenReturn(openBankingCDSConfigParserMock); | ||
| PowerMockito.when(openBankingCDSConfigParserMock.getConfiguration()).thenReturn(cdsConfigs); | ||
|
|
||
| filter = Mockito.spy(AuthorizeDataPublishingFilter.class); | ||
| } | ||
|
|
||
| @BeforeMethod | ||
| public void beforeMethod() { | ||
|
|
||
| request = new MockHttpServletRequest(); | ||
| response = new MockHttpServletResponse(); | ||
| filterChain = Mockito.spy(FilterChain.class); | ||
|
|
||
| openBankingConfigParserMock = PowerMockito.mock(OpenBankingConfigParser.class); | ||
| PowerMockito.mockStatic(OpenBankingConfigParser.class); | ||
| PowerMockito.when(OpenBankingConfigParser.getInstance()).thenReturn(openBankingConfigParserMock); | ||
| PowerMockito.when(openBankingConfigParserMock.getConfiguration()).thenReturn(configs); | ||
| } | ||
|
|
||
| @Test(description = "Test that data is published when X-External-Traffic header is true and " + | ||
| "session data key parameter is absent") | ||
| public void testDataPublishedWhenExternalTrafficHeaderPresentAndSessionDataKeyAbsent() throws Exception { | ||
|
|
||
| CDSDataPublishingService cdsDataPublishingServiceMock = PowerMockito.mock(CDSDataPublishingService.class); | ||
| PowerMockito.mockStatic(CDSDataPublishingService.class); | ||
| PowerMockito.when(CDSDataPublishingService.getCDSDataPublishingService()).thenReturn( | ||
| cdsDataPublishingServiceMock); | ||
|
|
||
| Mockito.doReturn(new HashMap<>()).when(filter).generateInvocationDataMap(Mockito.any(), Mockito.any(), | ||
| Mockito.any()); | ||
| Mockito.doReturn(new HashMap<>()).when(filter).generateLatencyDataMap(Mockito.any(), Mockito.any()); | ||
|
|
||
| request.addHeader(EXTERNAL_TRAFFIC_HEADER, "true"); | ||
|
|
||
| filter.doFilter(request, response, filterChain); | ||
|
|
||
| // Verify that data is published | ||
| verify(cdsDataPublishingServiceMock).publishApiInvocationData(Mockito.anyMap()); | ||
| verify(cdsDataPublishingServiceMock).publishApiLatencyData(Mockito.anyMap()); | ||
| } | ||
|
|
||
| @Test(description = "Test that data is not published when X-External-Traffic header contains unexpected value " + | ||
| "and session data key parameter is present") | ||
| public void testDataNotPublishedWhenExternalTrafficHeaderIsNotTrueAndSessionDataKeyPresent() | ||
| throws Exception { | ||
|
|
||
| CDSDataPublishingService cdsDataPublishingServiceMock = PowerMockito.mock(CDSDataPublishingService.class); | ||
| PowerMockito.mockStatic(CDSDataPublishingService.class); | ||
| PowerMockito.when(CDSDataPublishingService.getCDSDataPublishingService()).thenReturn( | ||
| cdsDataPublishingServiceMock); | ||
|
|
||
| Mockito.doReturn(new HashMap<>()).when(filter).generateInvocationDataMap(Mockito.any(), Mockito.any(), | ||
| Mockito.any()); | ||
| Mockito.doReturn(new HashMap<>()).when(filter).generateLatencyDataMap(Mockito.any(), Mockito.any()); | ||
|
|
||
| request.addHeader(EXTERNAL_TRAFFIC_HEADER, "false"); | ||
| request.setParameter(SESSION_DATA_KEY, UUID.randomUUID().toString()); | ||
|
|
||
| filter.doFilter(request, response, filterChain); | ||
|
|
||
| // Verify that data is NOT published | ||
| verify(cdsDataPublishingServiceMock, Mockito.never()).publishApiInvocationData(Mockito.anyMap()); | ||
| verify(cdsDataPublishingServiceMock, Mockito.never()).publishApiLatencyData(Mockito.anyMap()); | ||
| } | ||
|
|
||
| @Test(description = "Test that data is not published when X-External-Traffic header is true and " + | ||
| "session data key attribute is present") | ||
| public void testDataNotPublishedWhenExternalTrafficHeaderAndSessionDataKeyPresent() throws | ||
| Exception { | ||
|
|
||
| CDSDataPublishingService cdsDataPublishingServiceMock = PowerMockito.mock(CDSDataPublishingService.class); | ||
| PowerMockito.mockStatic(CDSDataPublishingService.class); | ||
| PowerMockito.when(CDSDataPublishingService.getCDSDataPublishingService()).thenReturn( | ||
| cdsDataPublishingServiceMock); | ||
|
|
||
| Mockito.doReturn(new HashMap<>()).when(filter).generateInvocationDataMap(Mockito.any(), Mockito.any(), | ||
| Mockito.any()); | ||
| Mockito.doReturn(new HashMap<>()).when(filter).generateLatencyDataMap(Mockito.any(), Mockito.any()); | ||
|
|
||
| request.addHeader(EXTERNAL_TRAFFIC_HEADER, "true"); | ||
| request.setParameter(SESSION_DATA_KEY, UUID.randomUUID().toString()); | ||
|
|
||
| filter.doFilter(request, response, filterChain); | ||
|
|
||
| // Verify that data is NOT published | ||
| verify(cdsDataPublishingServiceMock, Mockito.never()).publishApiInvocationData(Mockito.anyMap()); | ||
| verify(cdsDataPublishingServiceMock, Mockito.never()).publishApiLatencyData(Mockito.anyMap()); | ||
| } | ||
|
|
||
| @Test(description = "Test that data is not published when X-External-Traffic header is absent and " + | ||
| "session data key parameter is present") | ||
| public void testDataNotPublishedWhenExternalTrafficHeaderAbsentAndSessionDataKeyPresent() throws | ||
| Exception { | ||
|
|
||
| CDSDataPublishingService cdsDataPublishingServiceMock = PowerMockito.mock(CDSDataPublishingService.class); | ||
| PowerMockito.mockStatic(CDSDataPublishingService.class); | ||
| PowerMockito.when(CDSDataPublishingService.getCDSDataPublishingService()).thenReturn( | ||
| cdsDataPublishingServiceMock); | ||
|
|
||
| Mockito.doReturn(new HashMap<>()).when(filter).generateInvocationDataMap(Mockito.any(), Mockito.any(), | ||
| Mockito.any()); | ||
| Mockito.doReturn(new HashMap<>()).when(filter).generateLatencyDataMap(Mockito.any(), Mockito.any()); | ||
|
|
||
| request.setParameter(SESSION_DATA_KEY, UUID.randomUUID().toString()); | ||
|
|
||
| filter.doFilter(request, response, filterChain); | ||
|
|
||
| // Verify that data is NOT published | ||
| verify(cdsDataPublishingServiceMock, Mockito.never()).publishApiInvocationData(Mockito.anyMap()); | ||
| verify(cdsDataPublishingServiceMock, Mockito.never()).publishApiLatencyData(Mockito.anyMap()); | ||
| } | ||
|
|
||
| @Test(description = "Test that data is not published when both X-External-Traffic header " + | ||
| "and sessionDataKey absent") | ||
| public void testDataNotPublishedWhenExternalTrafficHeaderAndSessionDataKeyAbsent() throws Exception { | ||
|
|
||
| CDSDataPublishingService cdsDataPublishingServiceMock = PowerMockito.mock(CDSDataPublishingService.class); | ||
| PowerMockito.mockStatic(CDSDataPublishingService.class); | ||
| PowerMockito.when(CDSDataPublishingService.getCDSDataPublishingService()). | ||
| thenReturn(cdsDataPublishingServiceMock); | ||
|
|
||
| Mockito.doReturn(new HashMap<>()).when(filter).generateInvocationDataMap(Mockito.any(), Mockito.any(), | ||
| Mockito.any()); | ||
| Mockito.doReturn(new HashMap<>()).when(filter).generateLatencyDataMap(Mockito.any(), Mockito.any()); | ||
|
|
||
| filter.doFilter(request, response, filterChain); | ||
|
|
||
| // Verify that data is NOT published | ||
| verify(cdsDataPublishingServiceMock, Mockito.never()).publishApiInvocationData(Mockito.anyMap()); | ||
| verify(cdsDataPublishingServiceMock, Mockito.never()).publishApiLatencyData(Mockito.anyMap()); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.