-
Notifications
You must be signed in to change notification settings - Fork 259
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 #3562 from Thushani-Jayasekera/ws-apikey-enforcer
[Choreo] Support passing API-Key for WebSocket Requests using sec-websocket-protocol Header
- Loading branch information
Showing
8 changed files
with
247 additions
and
2 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
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
133 changes: 133 additions & 0 deletions
133
...t/java/org/wso2/choreo/connect/enforcer/security/jwt/InternalAPIKeyAuthenticatorTest.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,133 @@ | ||
| /* | ||
| * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org) All Rights Reserved. | ||
| * | ||
| * WSO2 Inc. 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 | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.wso2.choreo.connect.enforcer.security.jwt; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| 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.junit4.PowerMockRunner; | ||
| import org.wso2.carbon.apimgt.common.gateway.dto.JWTConfigurationDto; | ||
| import org.wso2.choreo.connect.enforcer.commons.model.APIConfig; | ||
| import org.wso2.choreo.connect.enforcer.commons.model.RequestContext; | ||
| import org.wso2.choreo.connect.enforcer.config.ConfigHolder; | ||
| import org.wso2.choreo.connect.enforcer.config.EnforcerConfig; | ||
| import org.wso2.choreo.connect.enforcer.config.dto.CacheDto; | ||
| @RunWith(PowerMockRunner.class) | ||
| @PrepareForTest({ConfigHolder.class}) | ||
| @PowerMockIgnore("javax.management.*") | ||
| public class InternalAPIKeyAuthenticatorTest { | ||
|
|
||
| @Test | ||
| public void extractInternalKeyInWSProtocolHeaderTest() { | ||
| PowerMockito.mockStatic(ConfigHolder.class); | ||
| ConfigHolder configHolder = Mockito.mock(ConfigHolder.class); | ||
| EnforcerConfig enforcerConfig = Mockito.mock(EnforcerConfig.class); | ||
| CacheDto cacheDto = Mockito.mock(CacheDto.class); | ||
| Mockito.when(cacheDto.isEnabled()).thenReturn(true); | ||
| Mockito.when(enforcerConfig.getCacheDto()).thenReturn(cacheDto); | ||
| JWTConfigurationDto jwtConfigurationDto = Mockito.mock(JWTConfigurationDto.class); | ||
| Mockito.when(jwtConfigurationDto.isEnabled()).thenReturn(false); | ||
| Mockito.when(enforcerConfig.getJwtConfigurationDto()).thenReturn(jwtConfigurationDto); | ||
| Mockito.when(configHolder.getConfig()).thenReturn(enforcerConfig); | ||
| Mockito.when(ConfigHolder.getInstance()).thenReturn(configHolder); | ||
|
|
||
| String securityParam = "API-Key"; | ||
|
|
||
| String mockToken = "eyJraWQiOiJnYXRld2F5XUlMyNTYifQlzaGVyXC92MlwvYXBpc1wvaW50ZXJuYlzaGVyXC92XBpc1wvaW50ZXJuY." + | ||
| "eyJzdWIiOiJhMzllYGV2OjQ0M1wvYXBpXC9hbVwvcHVibGlzaGVyXC92MlwvYXBpc1wvaW50ZXJuYWwta2V5Iiwia2V5dHlwZcl." + | ||
| "cnZpY2VcL3YxLjAiLCJwdWJsaXNoZXIiOiJjaG9yZW9fZGV2X2FwaW1fYWRtaW4iLCJ2ZXJzaW9uIjoidj7MIXRnS-2UWHdrmd7"; | ||
|
|
||
| String secWebsocketProtocolHeader = "sec-websocket-protocol"; | ||
|
|
||
| // Test case to test for an Upgrade request sent from the choreo console | ||
| // The token will be set to the sec-websocket-protocol header with choreo-internal-API-Key keyword | ||
| // the value after choreo-internal-API-Key will be the token | ||
| RequestContext.Builder builder = new RequestContext.Builder("/pets"); | ||
| builder.matchedAPI(new APIConfig.Builder("Petstore") | ||
| .basePath("/choreo") | ||
| .apiType("WS") | ||
| .build()); | ||
| Map<String, String> headersMap = new HashMap<>(); | ||
| headersMap.put( | ||
| secWebsocketProtocolHeader, | ||
| "choreo-internal-API-Key," + mockToken); | ||
| builder.headers(headersMap); | ||
| RequestContext requestContext = builder.build(); | ||
| InternalAPIKeyAuthenticator internalAPIKeyAuthenticator = new InternalAPIKeyAuthenticator(securityParam); | ||
| Assert.assertEquals(internalAPIKeyAuthenticator.extractInternalKeyInWSProtocolHeader(requestContext), mockToken); | ||
|
|
||
| // Test case to test for an Upgrade request sent from a client with api-key | ||
| RequestContext.Builder builder2 = new RequestContext.Builder("/pets"); | ||
| builder2.matchedAPI(new APIConfig.Builder("Petstore") | ||
| .basePath("/choreo") | ||
| .apiType("WS") | ||
| .build()); | ||
| Map<String, String> headersMap2 = new HashMap<>(); | ||
| headersMap2.put(securityParam, mockToken); | ||
| builder2.headers(headersMap2); | ||
| RequestContext requestContext2 = builder2.build(); | ||
| Assert.assertEquals(internalAPIKeyAuthenticator.extractInternalKeyInWSProtocolHeader(requestContext2), ""); | ||
|
|
||
| } | ||
|
|
||
| @Test | ||
| public void getProtocolsToSetInRequestHeadersTest() { | ||
| PowerMockito.mockStatic(ConfigHolder.class); | ||
| ConfigHolder configHolder = Mockito.mock(ConfigHolder.class); | ||
| EnforcerConfig enforcerConfig = Mockito.mock(EnforcerConfig.class); | ||
| CacheDto cacheDto = Mockito.mock(CacheDto.class); | ||
| Mockito.when(cacheDto.isEnabled()).thenReturn(true); | ||
| Mockito.when(enforcerConfig.getCacheDto()).thenReturn(cacheDto); | ||
| JWTConfigurationDto jwtConfigurationDto = Mockito.mock(JWTConfigurationDto.class); | ||
| Mockito.when(jwtConfigurationDto.isEnabled()).thenReturn(false); | ||
| Mockito.when(enforcerConfig.getJwtConfigurationDto()).thenReturn(jwtConfigurationDto); | ||
| Mockito.when(configHolder.getConfig()).thenReturn(enforcerConfig); | ||
| Mockito.when(ConfigHolder.getInstance()).thenReturn(configHolder); | ||
|
|
||
| String securityParam = "API-Key"; | ||
|
|
||
| String secWebsocketProtocolHeader = "sec-websocket-protocol"; | ||
|
|
||
| String mockToken = "eyJraWQiOiJnYXRld2F5XUlMyNTYifQlzaGVyXC92MlwvYXBpc1wvaW50ZXJuYlzaGVyXC92XBpc1wvaW50ZXJuY." + | ||
| "eyJzdWIiOiJhMzllYGV2OjQ0M1wvYXBpXC9hbVwvcHVibGlzaGVyXC92MlwvYXBpc1wvaW50ZXJuYWwta2V5Iiwia2V5dHlwZcl." + | ||
| "cnZpY2VcL3YxLjAiLCJwdWJsaXNoZXIiOiJjaG9yZW9fZGV2X2FwaW1fYWRtaW4iLCJ2ZXJzaW9uIjoidj7MIXRnS-2UWHdrmd7"; | ||
|
|
||
| RequestContext.Builder builder = new RequestContext.Builder("/pets"); | ||
| builder.matchedAPI(new APIConfig.Builder("Petstore") | ||
| .basePath("/choreo") | ||
| .apiType("WS") | ||
| .build()); | ||
| Map<String, String> headersMap = new HashMap<>(); | ||
| headersMap.put( | ||
| secWebsocketProtocolHeader, | ||
| "choreo-internal-API-Key, " + mockToken + ", " + "chat, bar"); | ||
| builder.headers(headersMap); | ||
| RequestContext requestContext = builder.build(); | ||
| InternalAPIKeyAuthenticator internalAPIKeyAuthenticator = new InternalAPIKeyAuthenticator(securityParam); | ||
| Assert.assertEquals(internalAPIKeyAuthenticator.getProtocolsToSetInRequestHeaders(requestContext), "chat, bar"); | ||
|
|
||
| } | ||
| } |