-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Align NimbusJwtDecoder HTTP timeout defaults with Nimbus by setting to 500ms #17669
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Fridolin Jackstadt <[email protected]>
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.
Thanks, @frido37, for the PR! I've left some feedback inline.
|
||
private RestTemplateWithTimeouts () { | ||
SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory(); | ||
requestFactory.setConnectTimeout(RemoteJWKSet.DEFAULT_HTTP_CONNECT_TIMEOUT); |
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.
Let's please set this value to JWKSourceBuilder.DEFAULT_HTTP_CONNECT_TIMEOUT
since RemoteJWKSet
is deprecated.
private RestTemplateWithTimeouts () { | ||
SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory(); | ||
requestFactory.setConnectTimeout(RemoteJWKSet.DEFAULT_HTTP_CONNECT_TIMEOUT); | ||
requestFactory.setReadTimeout(RemoteJWKSet.DEFAULT_HTTP_READ_TIMEOUT); |
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.
Let's please set this value to JWKSourceBuilder.DEFAULT_HTTP_READ_TIMEOUT
since RemoteJWKSet
is deprecated.
* A RestTemplate with timeouts configured to avoid blocking indefinitely when | ||
* fetching JWK Sets while holding the reentrantLock. | ||
*/ | ||
private static final class RestTemplateWithTimeouts extends RestTemplate { |
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.
To make the intent of this class clearer, will you please name it RestTemplateWithNimbusDefaultTimeouts
.
Please also remove the extra whitespace between class
and the class name.
This is a note for myself: As part of merging, upgrade instructions should be added to the 6.5 guide for how to update an application's configuration to use the new timeout values. In this way, they can know whether the new timeouts will be an issue before updating to 7.0. |
Summary
This change proposes a potential fix for spring-security#15866, which we encountered in a production environment.
Problem
We experienced a critical "stop-the-world" event lasting approximately 15 minutes due to the absence of connection and read timeouts in the default RestTemplate configuration used by NimbusJwtDecoder. Specifically, the underlying SimpleClientHttpRequestFactory does not define any timeouts, which can cause the application to hang indefinitely in certain network failure scenarios.
Current Workaround
To mitigate this in our own application, we use a JwkSetUriJwtDecoderBuilderCustomizer to configure the RestTemplate with appropriate timeouts. While this works, the current default behavior is problematic and may impact other users as well.
Proposal
We suggest that reasonable default timeouts (both connect and read) should be applied to the RestTemplate used by default in NimbusJwtDecoder. This change will help prevent similar problems for others.