Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Improvement] Lightweight apikey #12540

Merged
merged 1 commit into from
Sep 26, 2024
Merged

[Improvement] Lightweight apikey #12540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions ...ain/java/org/wso2/carbon/apimgt/gateway/handlers/security/apikey/ApiKeyAuthenticator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
import org.wso2.carbon.apimgt.gateway.utils.OpenAPIUtils;
import org.wso2.carbon.apimgt.impl.APIConstants;
import org.wso2.carbon.apimgt.impl.APIManagerConfiguration;
import org.wso2.carbon.apimgt.impl.dto.APIKeyValidationInfoDTO;
import org.wso2.carbon.apimgt.impl.dto.ExtendedJWTConfigurationDto;
import org.wso2.carbon.apimgt.impl.dto.VerbInfoDTO;
import org.wso2.carbon.apimgt.impl.utils.APIUtil;
Expand Down Expand Up @@ -163,12 +164,12 @@ public AuthenticationResponse authenticate(MessageContext synCtx) {
tenantDomain, payload);
ApiKeyAuthenticatorUtils.validateAPIKeyRestrictions(payload, GatewayUtils.getIp(axis2MessageContext),
apiContext, apiVersion, referer);
net.minidev.json.JSONObject api = GatewayUtils.validateAPISubscription(apiContext, apiVersion, payload,
APIKeyValidationInfoDTO apiKeyValidationInfoDTO = GatewayUtils.validateAPISubscription(apiContext, apiVersion, payload,
splitToken[0]);
String endUserToken = ApiKeyAuthenticatorUtils.getEndUserToken(api, jwtConfigurationDto, apiKey,
signedJWT, payload, tokenIdentifier, isGatewayTokenCacheEnabled);
String endUserToken = ApiKeyAuthenticatorUtils.getEndUserToken(apiKeyValidationInfoDTO, jwtConfigurationDto, apiKey,
signedJWT, payload, tokenIdentifier, apiContext, apiVersion, isGatewayTokenCacheEnabled);
AuthenticationContext authenticationContext = GatewayUtils.generateAuthenticationContext(tokenIdentifier,
payload, api, apiLevelPolicy, endUserToken, synCtx);
payload, apiKeyValidationInfoDTO, endUserToken);
APISecurityUtils.setAuthenticationContext(synCtx, authenticationContext,
jwtGenerationEnabled ? getContextHeader() : null);
synCtx.setProperty(APIMgtGatewayConstants.END_USER_NAME, authenticationContext.getUsername());
Expand Down
15 changes: 6 additions & 9 deletions .../org/wso2/carbon/apimgt/gateway/inbound/websocket/Authentication/ApiKeyAuthenticator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import org.wso2.carbon.apimgt.gateway.utils.ApiKeyAuthenticatorUtils;
import org.wso2.carbon.apimgt.gateway.utils.GatewayUtils;
import org.wso2.carbon.apimgt.impl.APIConstants;
import org.wso2.carbon.apimgt.impl.dto.APIKeyValidationInfoDTO;
import org.wso2.carbon.apimgt.impl.dto.ExtendedJWTConfigurationDto;

import java.text.ParseException;
Expand Down Expand Up @@ -110,12 +111,12 @@ public InboundProcessorResponseDTO authenticate(InboundMessageContext inboundMes
ApiKeyAuthenticatorUtils.validateAPIKeyRestrictions(payload, inboundMessageContext.getUserIP(),
apiContext, apiVersion, inboundMessageContext.getRequestHeaders().
get(APIMgtGatewayConstants.REFERER));
net.minidev.json.JSONObject api = GatewayUtils.validateAPISubscription(apiContext, apiVersion,
APIKeyValidationInfoDTO apiKeyValidationInfoDTO = GatewayUtils.validateAPISubscription(apiContext, apiVersion,
payload, splitToken[0]);
String endUserToken = ApiKeyAuthenticatorUtils.getEndUserToken(api, jwtConfigurationDto, apiKey,
signedJWT, payload, tokenIdentifier, isGatewayTokenCacheEnabled);
AuthenticationContext authenticationContext = GatewayUtils.generateAuthenticationContext(
tokenIdentifier, payload, api, null, endUserToken, null);
String endUserToken = ApiKeyAuthenticatorUtils.getEndUserToken(apiKeyValidationInfoDTO, jwtConfigurationDto,
apiKey, signedJWT, payload, tokenIdentifier, apiContext, apiVersion, isGatewayTokenCacheEnabled);
AuthenticationContext authenticationContext = GatewayUtils.generateAuthenticationContext(tokenIdentifier,
payload, apiKeyValidationInfoDTO, endUserToken);
if (!InboundWebsocketProcessorUtil.validateAuthenticationContext(authenticationContext,
inboundMessageContext)) {
return InboundWebsocketProcessorUtil.getFrameErrorDTO(
Expand All @@ -135,10 +136,6 @@ public InboundProcessorResponseDTO authenticate(InboundMessageContext inboundMes
log.error("Invalid Api Key. Signature verification failed.");
throw new APISecurityException(APISecurityConstants.API_AUTH_INVALID_CREDENTIALS,
APISecurityConstants.API_AUTH_INVALID_CREDENTIALS_MESSAGE);
} catch (ParseException e) {
log.error("Error while parsing API Key", e);
return InboundWebsocketProcessorUtil.getFrameErrorDTO(APISecurityConstants.API_AUTH_GENERAL_ERROR,
APISecurityConstants.API_AUTH_GENERAL_ERROR_MESSAGE, true);
} catch (APIManagementException e) {
log.error("Error while setting public cert/private key for backend jwt generation", e);
return InboundWebsocketProcessorUtil.getFrameErrorDTO(APISecurityConstants.API_AUTH_GENERAL_ERROR,
Expand Down
20 changes: 11 additions & 9 deletions ....gateway/src/main/java/org/wso2/carbon/apimgt/gateway/utils/ApiKeyAuthenticatorUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.synapse.rest.RESTConstants;
import org.json.JSONObject;
import org.wso2.carbon.apimgt.api.APIManagementException;
import org.wso2.carbon.apimgt.common.gateway.dto.JWTInfoDto;
Expand All @@ -40,6 +41,7 @@
import org.wso2.carbon.apimgt.gateway.jwt.RevokedJWTDataHolder;
import org.wso2.carbon.apimgt.impl.APIConstants;
import org.wso2.carbon.apimgt.impl.caching.CacheProvider;
import org.wso2.carbon.apimgt.impl.dto.APIKeyValidationInfoDTO;
import org.wso2.carbon.apimgt.impl.dto.ExtendedJWTConfigurationDto;
import org.wso2.carbon.apimgt.impl.jwt.SignedJWTInfo;
import org.wso2.carbon.apimgt.impl.utils.APIUtil;
Expand Down Expand Up @@ -333,27 +335,28 @@ public static void validateAPIKeyRestrictions(JWTClaimsSet payload, String clien
/**
* This method is used to get the end user token for the API Key when backend JWT token generation is needed.
*
* @param api The API object returned after validating API subscription.
* @param apiKeyValidationInfoDTO The API Key validation info DTO.
* @param jwtConfigurationDto The JWT configuration DTO.
* @param apiKey The API Key.
* @param signedJWT The signed JWT.
* @param payload The payload of the API Key.
* @param tokenIdentifier The token identifier.
* @param apiContext The API context.
* @param apiVersion The API version.
* @param isGatewayTokenCacheEnabled Whether the gateway token cache is enabled or not.
* @return The end user token.
* @throws APIManagementException If an error occurs while getting Public Certificate or Signing Key.
* @throws APISecurityException If an error occurs while generating the backend JWT token.
*/
public static String getEndUserToken(net.minidev.json.JSONObject api,
public static String getEndUserToken(APIKeyValidationInfoDTO apiKeyValidationInfoDTO,
ExtendedJWTConfigurationDto jwtConfigurationDto, String apiKey,
SignedJWT signedJWT, JWTClaimsSet payload, String tokenIdentifier,
boolean isGatewayTokenCacheEnabled) throws APIManagementException,
APISecurityException {
String apiContext, String apiVersion, boolean isGatewayTokenCacheEnabled
) throws APIManagementException, APISecurityException {

AbstractAPIMgtGatewayJWTGenerator apiMgtGatewayJWTGenerator = null;
boolean jwtGenerationEnabled = false;
int tenantId = APIUtil.getTenantIdFromTenantDomain(api.getAsString(APIConstants.JwtTokenConstants.
SUBSCRIBER_TENANT_DOMAIN));
int tenantId = APIUtil.getTenantIdFromTenantDomain(apiKeyValidationInfoDTO.getSubscriberTenantDomain());
if (jwtConfigurationDto != null) {
apiMgtGatewayJWTGenerator = ServiceReferenceHolder.getInstance().getApiMgtGatewayJWTGenerator()
.get(jwtConfigurationDto.getGatewayJWTGeneratorImpl());
Expand All @@ -380,9 +383,8 @@ public static String getEndUserToken(net.minidev.json.JSONObject api,
if (jwtGenerationEnabled) {
SignedJWTInfo signedJWTInfo = new SignedJWTInfo(apiKey, signedJWT, payload);
JWTValidationInfo jwtValidationInfo = getJwtValidationInfo(signedJWTInfo);
JWTInfoDto jwtInfoDto = GatewayUtils.generateJWTInfoDto(api, jwtValidationInfo,
api.getAsString(APIConstants.JwtTokenConstants.API_CONTEXT),
api.getAsString(APIConstants.JwtTokenConstants.API_VERSION));
JWTInfoDto jwtInfoDto = GatewayUtils.generateJWTInfoDto(jwtValidationInfo,
apiKeyValidationInfoDTO, apiContext, apiVersion);
endUserToken = generateAndRetrieveBackendJWTToken(tokenIdentifier, jwtInfoDto, isGatewayTokenCacheEnabled,
apiMgtGatewayJWTGenerator);
}
Expand Down
Loading
Loading