Consider using RetryTemplate for resolving provider configuration

Closes gh-18610

Signed-off-by: Evgeniy Cheban <mister.cheban@gmail.com>

Author: evgeniycheban

oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/JwtDecoderProviderConfigurationUtils.java

@@ -33,14 +33,19 @@
 import com.nimbusds.jose.proc.JWSVerificationKeySelector;
 import com.nimbusds.jose.proc.SecurityContext;
 import com.nimbusds.jwt.proc.ConfigurableJWTProcessor;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 
 import org.springframework.core.ParameterizedTypeReference;
+import org.springframework.core.retry.RetryException;
+import org.springframework.core.retry.RetryPolicy;
+import org.springframework.core.retry.RetryTemplate;
+import org.springframework.core.retry.Retryable;
 import org.springframework.http.RequestEntity;
 import org.springframework.http.ResponseEntity;
 import org.springframework.http.client.SimpleClientHttpRequestFactory;
 import org.springframework.security.oauth2.jose.jws.SignatureAlgorithm;
 import org.springframework.util.Assert;
-import org.springframework.web.client.HttpClientErrorException;
 import org.springframework.web.client.RestOperations;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.util.UriComponents;
@@ -55,10 +60,13 @@
  *
  * @author Thomas Vitale
  * @author Rafiullah Hamedy
+ * @author Evgeniy Cheban
  * @since 5.2
  */
 final class JwtDecoderProviderConfigurationUtils {
 
+	private static final Log LOG = LogFactory.getLog(JwtDecoderProviderConfigurationUtils.class);
+
 	private static final String OIDC_METADATA_PATH = "/.well-known/openid-configuration";
 
 	private static final String OAUTH_METADATA_PATH = "/.well-known/oauth-authorization-server";
@@ -158,28 +166,26 @@ private static String getMetadataIssuer(Map<String, Object> configuration) {
 	}
 
 	private static Map<String, Object> getConfiguration(String issuer, RestOperations rest, UriComponents... uris) {
-		String errorMessage = "Unable to resolve the Configuration with the provided Issuer of " + "\"" + issuer + "\"";
-		for (UriComponents uri : uris) {
-			try {
-				RequestEntity<Void> request = RequestEntity.get(uri.toUriString()).build();
-				ResponseEntity<Map<String, Object>> response = rest.exchange(request, STRING_OBJECT_MAP);
-				Map<String, Object> configuration = response.getBody();
-				Assert.notNull(configuration, "configuration must not be null");
-				Assert.isTrue(configuration.get("jwks_uri") != null, "The public JWK set URI must not be null");
-				return configuration;
-			}
-			catch (IllegalArgumentException ex) {
-				throw ex;
-			}
-			catch (RuntimeException ex) {
-				if (!(ex instanceof HttpClientErrorException
-						&& ((HttpClientErrorException) ex).getStatusCode().is4xxClientError())) {
-					throw new IllegalArgumentException(errorMessage, ex);
-				}
-				// else try another endpoint
+		// @formatter:off
+		RetryPolicy retryPolicy = RetryPolicy.builder()
+				.excludes(IllegalArgumentException.class)
+				.maxRetries(uris.length)
+				.build();
+		// @formatter:on
+		RetryTemplate retryTemplate = new RetryTemplate(retryPolicy);
+		try {
+			return retryTemplate.execute(new RetryableConfiguration(rest, issuer, uris));
+		}
+		catch (RetryException ex) {
+			Throwable lastException = ex.getLastException();
+			LOG.error("""
+					Unable to resolve the Configuration with the provided Issuer of "%s", after: %d attempts
+					""".formatted(issuer, ex.getRetryCount()), lastException);
+			if (lastException instanceof RuntimeException) {
+				throw (RuntimeException) lastException;
 			}
+			throw new RuntimeException(lastException.getMessage(), lastException);
 		}
-		throw new IllegalArgumentException(errorMessage);
 	}
 
 	static UriComponents oidc(String issuer) {
@@ -209,4 +215,38 @@ static UriComponents oauth(String issuer) {
 		// @formatter:on
 	}
 
+	private static final class RetryableConfiguration implements Retryable<Map<String, Object>> {
+
+		private int currentUriIndex = 0;
+
+		private final RestOperations rest;
+
+		private final String issuer;
+
+		private final UriComponents[] uris;
+
+		private RetryableConfiguration(RestOperations rest, String issuer, UriComponents[] uris) {
+			this.rest = rest;
+			this.issuer = issuer;
+			this.uris = uris;
+		}
+
+		@Override
+		public Map<String, Object> execute() {
+			if (this.currentUriIndex < this.uris.length) {
+				UriComponents uri = this.uris[this.currentUriIndex++];
+				RequestEntity<Void> request = RequestEntity.get(uri.toUriString()).build();
+				ResponseEntity<Map<String, Object>> response = this.rest.exchange(request, STRING_OBJECT_MAP);
+				Map<String, Object> configuration = response.getBody();
+				Assert.notNull(configuration, "configuration must not be null");
+				Assert.isTrue(configuration.get("jwks_uri") != null, "The public JWK set URI must not be null");
+				return configuration;
+			}
+			throw new IllegalArgumentException("""
+					Unable to resolve the Configuration with the provided Issuer of "%s"
+					""".formatted(this.issuer));
+		}
+
+	}
+
 }