-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Morten Haraldsen
committed
Jan 10, 2025
1 parent
f7df306
commit 7230005
Showing
10 changed files
with
247 additions
and
224 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
212 changes: 8 additions & 204 deletions
212
...e/src/main/java/com/ethlo/http/filters/jwt/InjectAccessTokenAuthGatewayFilterFactory.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 |
---|---|---|
@@ -1,219 +1,23 @@ | ||
package com.ethlo.http.filters.jwt; | ||
|
||
import java.time.Duration; | ||
import java.time.Instant; | ||
import java.util.LinkedHashMap; | ||
import java.util.Map; | ||
import java.util.Optional; | ||
|
||
import org.reactivestreams.Publisher; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
import org.springframework.cloud.gateway.filter.GatewayFilter; | ||
import org.springframework.cloud.gateway.filter.GatewayFilterChain; | ||
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory; | ||
import org.springframework.cloud.gateway.support.ServerWebExchangeUtils; | ||
import org.springframework.core.ResolvableType; | ||
import org.springframework.core.codec.Hints; | ||
import org.springframework.http.HttpHeaders; | ||
import org.springframework.http.HttpStatus; | ||
import org.springframework.http.MediaType; | ||
import org.springframework.http.codec.json.Jackson2JsonEncoder; | ||
import org.springframework.http.server.reactive.ServerHttpRequest; | ||
import org.springframework.scheduling.annotation.Scheduled; | ||
import org.springframework.scheduling.TaskScheduler; | ||
import org.springframework.stereotype.Component; | ||
import org.springframework.web.server.ServerWebExchange; | ||
|
||
import com.auth0.jwt.interfaces.DecodedJWT; | ||
import com.ethlo.http.logger.RedactUtil; | ||
import jakarta.validation.constraints.NotEmpty; | ||
import reactor.core.publisher.Mono; | ||
|
||
@Component | ||
public class InjectAccessTokenAuthGatewayFilterFactory extends AbstractGatewayFilterFactory<InjectAccessTokenAuthGatewayFilterFactory.Config> | ||
public class InjectAccessTokenAuthGatewayFilterFactory extends AbstractGatewayFilterFactory<InjectAccessTokenConfig> | ||
{ | ||
private static final Logger logger = LoggerFactory.getLogger(InjectAccessTokenAuthGatewayFilterFactory.class); | ||
private final Jackson2JsonEncoder jacksonEncoder = new Jackson2JsonEncoder(); | ||
private final JwtTokenService tokenService = new JwtTokenService(); | ||
protected DecodedJWT jwt; | ||
private Config config; | ||
|
||
public InjectAccessTokenAuthGatewayFilterFactory() | ||
{ | ||
super(Config.class); | ||
} | ||
private final TaskScheduler taskScheduler; | ||
|
||
private static Map<String, Object> getErrorResponse(ServerWebExchange exchange) | ||
public InjectAccessTokenAuthGatewayFilterFactory(TaskScheduler taskScheduler) | ||
{ | ||
final Map<String, Object> errorAttributes = new LinkedHashMap<>(); | ||
final HttpStatus errorStatus = HttpStatus.FORBIDDEN; | ||
errorAttributes.put("path", exchange.getAttributes().get(ServerWebExchangeUtils.GATEWAY_PREDICATE_PATH_CONTAINER_ATTR).toString()); | ||
errorAttributes.put("status", errorStatus); | ||
errorAttributes.put("message", errorStatus.getReasonPhrase()); | ||
errorAttributes.put("requestId", exchange.getRequest().getId()); | ||
return errorAttributes; | ||
} | ||
|
||
private Mono<Void> writeBodyJson(Object body, ServerWebExchange exchange) | ||
{ | ||
return exchange.getResponse().writeWith( | ||
jacksonEncoder.encode( | ||
Mono.just(body), | ||
exchange.getResponse().bufferFactory(), | ||
ResolvableType.forInstance(body), | ||
MediaType.APPLICATION_JSON, | ||
Hints.from(Hints.LOG_PREFIX_HINT, exchange.getLogPrefix()) | ||
) | ||
); | ||
super(InjectAccessTokenConfig.class); | ||
this.taskScheduler = taskScheduler; | ||
} | ||
|
||
@Override | ||
public GatewayFilter apply(Config config) | ||
{ | ||
this.config = config; | ||
return new GatewayFilter() | ||
{ | ||
@Override | ||
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) | ||
{ | ||
if (jwt == null) | ||
{ | ||
logger.warn("No auth token to inject for request to {}", exchange.getRequest().getURI()); | ||
return writeBodyJson(getErrorResponse(exchange), exchange); | ||
} | ||
else | ||
{ | ||
return Mono.just(jwt).flatMap(token -> | ||
{ | ||
final String authValue = "Bearer " + jwt.getToken(); | ||
logger.debug("Sending Authorization header (redacted): Bearer {}", RedactUtil.redact(jwt.getToken(), 3)); | ||
final ServerHttpRequest mutatedRequest = exchange.getRequest().mutate().headers(httpHeaders -> httpHeaders.set(HttpHeaders.AUTHORIZATION, authValue)).build(); | ||
final ServerWebExchange mutatedExchange = exchange.mutate().request(mutatedRequest).build(); | ||
return chain.filter(mutatedExchange); | ||
}); | ||
} | ||
} | ||
|
||
@Override | ||
public String toString() | ||
{ | ||
return InjectAccessTokenAuthGatewayFilterFactory.class + "{client-id=" + config.getClientId() | ||
+ ", token-url" + config.getTokenUrl() + "}"; | ||
} | ||
}; | ||
} | ||
|
||
@Scheduled(initialDelay = 1_000, fixedRate = 10_000) | ||
protected void scheduledRefreshAccessToken() | ||
{ | ||
if (config == null) | ||
{ | ||
logger.info("Waiting for configuration to be initialized"); | ||
return; | ||
} | ||
|
||
final long now = Instant.now().toEpochMilli(); | ||
final long expiresAt = jwt == null ? 0 : jwt.getExpiresAtAsInstant().toEpochMilli(); | ||
if (jwt == null || expiresAt - now < config.getMinimumTTL().toMillis()) { | ||
|
||
// We do not have an access token, or we are getting too close to expiry, refresh it | ||
logger.debug("Attempting to refresh access token from {}", config.getTokenUrl()); | ||
|
||
try | ||
{ | ||
final DecodedJWT newToken = tokenService.fetchAccessToken(config.getTokenUrl(), config.getRefreshToken(), config.getClientId(), config.getClientSecret()).block(); | ||
if (jwt == null) | ||
{ | ||
logger.info("Access token fetched from {}", config.getTokenUrl()); | ||
} | ||
else | ||
{ | ||
logger.debug("Refreshed access token from {}", config.getTokenUrl()); | ||
} | ||
this.jwt = newToken; | ||
} | ||
catch (Exception exc) | ||
{ | ||
logger.warn("Error refreshing access token from {}: {}", config.getTokenUrl(), exc.getMessage()); | ||
jwt = null; | ||
} | ||
} | ||
} | ||
|
||
public Publisher<DecodedJWT> fetchAccessToken(Config config) | ||
public InjectAccessTokenGatewayFilter apply(InjectAccessTokenConfig config) | ||
{ | ||
return tokenService.fetchAccessToken(config.getTokenUrl(), config.getRefreshToken(), config.getClientId(), config.getClientSecret()); | ||
} | ||
|
||
public static class Config | ||
{ | ||
private static final Duration DEFAULT_MINIMUM_TTL = Duration.ofMinutes(1); | ||
@NotEmpty | ||
private String tokenUrl; | ||
|
||
@NotEmpty | ||
private String clientId; | ||
|
||
@NotEmpty | ||
private String refreshToken; | ||
|
||
private Duration minimumTTL; | ||
|
||
private String clientSecret; | ||
|
||
public String getTokenUrl() | ||
{ | ||
return tokenUrl; | ||
} | ||
|
||
public Config setTokenUrl(final String tokenUrl) | ||
{ | ||
this.tokenUrl = tokenUrl; | ||
return this; | ||
} | ||
|
||
public Duration getMinimumTTL() | ||
{ | ||
return Optional.ofNullable(minimumTTL).orElse(DEFAULT_MINIMUM_TTL); | ||
} | ||
|
||
public Config setMinimumTTL(final Duration minimumTTL) | ||
{ | ||
this.minimumTTL = Optional.ofNullable(minimumTTL).orElse(DEFAULT_MINIMUM_TTL); | ||
return this; | ||
} | ||
|
||
public String getClientSecret() | ||
{ | ||
return clientSecret; | ||
} | ||
|
||
public Config setClientSecret(final String clientSecret) | ||
{ | ||
this.clientSecret = clientSecret; | ||
return this; | ||
} | ||
|
||
public String getClientId() | ||
{ | ||
return clientId; | ||
} | ||
|
||
public Config setClientId(final String clientId) | ||
{ | ||
this.clientId = clientId; | ||
return this; | ||
} | ||
|
||
public String getRefreshToken() | ||
{ | ||
return refreshToken; | ||
} | ||
|
||
public Config setRefreshToken(final String refreshToken) | ||
{ | ||
this.refreshToken = refreshToken; | ||
return this; | ||
} | ||
return new InjectAccessTokenGatewayFilter(config, taskScheduler); | ||
} | ||
} |
78 changes: 78 additions & 0 deletions
78
cloud-gateway-core/src/main/java/com/ethlo/http/filters/jwt/InjectAccessTokenConfig.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,78 @@ | ||
package com.ethlo.http.filters.jwt; | ||
|
||
import jakarta.validation.constraints.NotEmpty; | ||
|
||
import java.time.Duration; | ||
import java.util.Optional; | ||
|
||
public class InjectAccessTokenConfig | ||
{ | ||
private static final Duration DEFAULT_MINIMUM_TTL = Duration.ofMinutes(1); | ||
@NotEmpty | ||
private String tokenUrl; | ||
|
||
@NotEmpty | ||
private String clientId; | ||
|
||
@NotEmpty | ||
private String refreshToken; | ||
|
||
private Duration minimumTTL; | ||
|
||
private String clientSecret; | ||
|
||
public String getTokenUrl() | ||
{ | ||
return tokenUrl; | ||
} | ||
|
||
public InjectAccessTokenConfig setTokenUrl(final String tokenUrl) | ||
{ | ||
this.tokenUrl = tokenUrl; | ||
return this; | ||
} | ||
|
||
public Duration getMinimumTTL() | ||
{ | ||
return Optional.ofNullable(minimumTTL).orElse(DEFAULT_MINIMUM_TTL); | ||
} | ||
|
||
public InjectAccessTokenConfig setMinimumTTL(final Duration minimumTTL) | ||
{ | ||
this.minimumTTL = Optional.ofNullable(minimumTTL).orElse(DEFAULT_MINIMUM_TTL); | ||
return this; | ||
} | ||
|
||
public String getClientSecret() | ||
{ | ||
return clientSecret; | ||
} | ||
|
||
public InjectAccessTokenConfig setClientSecret(final String clientSecret) | ||
{ | ||
this.clientSecret = clientSecret; | ||
return this; | ||
} | ||
|
||
public String getClientId() | ||
{ | ||
return clientId; | ||
} | ||
|
||
public InjectAccessTokenConfig setClientId(final String clientId) | ||
{ | ||
this.clientId = clientId; | ||
return this; | ||
} | ||
|
||
public String getRefreshToken() | ||
{ | ||
return refreshToken; | ||
} | ||
|
||
public InjectAccessTokenConfig setRefreshToken(final String refreshToken) | ||
{ | ||
this.refreshToken = refreshToken; | ||
return this; | ||
} | ||
} |
Oops, something went wrong.