Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix Javadocs for Jwt issuer resolvers

This commit is contained in:
Baljit Singh 2023-07-13 10:21:05 -04:00 committed by Josh Cummings
parent c9b0e3cc11
commit af00be8a3d
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/JwtIssuerAuthenticationManagerResolver.java
View File

@ -47,10 +47,10 @@ import org.springframework.util.Assert;
* "https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier">Issuer</a> in * "https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier">Issuer</a> in
* a signed JWT (JWS). * a signed JWT (JWS).
* *
* To use, this class must be able to determine whether or not the `iss` claim is trusted. * To use, this class must be able to determine whether the `iss` claim is trusted. Recall
* Recall that anyone can stand up an authorization server and issue valid tokens to a * that anyone can stand up an authorization server and issue valid tokens to a resource
* resource server. The simplest way to achieve this is to supply a list of trusted * server. The simplest way to achieve this is to supply a list of trusted issuers in the
* issuers in the constructor. * constructor.
* *
* This class derives the Issuer from the `iss` claim found in the * This class derives the Issuer from the `iss` claim found in the
* {@link HttpServletRequest}'s * {@link HttpServletRequest}'s
@ -67,7 +67,7 @@ public final class JwtIssuerAuthenticationManagerResolver implements Authenticat
/** /**
* Construct a {@link JwtIssuerAuthenticationManagerResolver} using the provided * Construct a {@link JwtIssuerAuthenticationManagerResolver} using the provided
* parameters * parameters
* @param trustedIssuers a list of trusted issuers * @param trustedIssuers an array of trusted issuers
*/ */
public JwtIssuerAuthenticationManagerResolver(String... trustedIssuers) { public JwtIssuerAuthenticationManagerResolver(String... trustedIssuers) {
this(Arrays.asList(trustedIssuers)); this(Arrays.asList(trustedIssuers));
@ -76,7 +76,7 @@ public final class JwtIssuerAuthenticationManagerResolver implements Authenticat
/** /**
* Construct a {@link JwtIssuerAuthenticationManagerResolver} using the provided * Construct a {@link JwtIssuerAuthenticationManagerResolver} using the provided
* parameters * parameters
* @param trustedIssuers a list of trusted issuers * @param trustedIssuers a collection of trusted issuers
*/ */
public JwtIssuerAuthenticationManagerResolver(Collection<String> trustedIssuers) { public JwtIssuerAuthenticationManagerResolver(Collection<String> trustedIssuers) {
Assert.notEmpty(trustedIssuers, "trustedIssuers cannot be empty"); Assert.notEmpty(trustedIssuers, "trustedIssuers cannot be empty");
@ -90,8 +90,8 @@ public final class JwtIssuerAuthenticationManagerResolver implements Authenticat
* parameters * parameters
* *
* Note that the {@link AuthenticationManagerResolver} provided in this constructor * Note that the {@link AuthenticationManagerResolver} provided in this constructor
* will need to verify that the issuer is trusted. This should be done via an * will need to verify that the issuer is trusted. This should be done via an allowed
* allowlist. * list of issuers.
* *
* One way to achieve this is with a {@link Map} where the keys are the known issuers: * One way to achieve this is with a {@link Map} where the keys are the known issuers:
* <pre> * <pre>

10
oauth2/oauth2-resource-server/src/main/java/org/springframework/security/oauth2/server/resource/authentication/JwtIssuerReactiveAuthenticationManagerResolver.java
View File

@ -46,10 +46,10 @@ import org.springframework.web.server.ServerWebExchange;
* "https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier">Issuer</a> in * "https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier">Issuer</a> in
* a signed JWT (JWS). * a signed JWT (JWS).
* *
* To use, this class must be able to determine whether or not the `iss` claim is trusted. * To use, this class must be able to determine whether the `iss` claim is trusted. Recall
* Recall that anyone can stand up an authorization server and issue valid tokens to a * that anyone can stand up an authorization server and issue valid tokens to a resource
* resource server. The simplest way to achieve this is to supply a list of trusted * server. The simplest way to achieve this is to supply a list of trusted issuers in the
* issuers in the constructor. * constructor.
* *
* This class derives the Issuer from the `iss` claim found in the * This class derives the Issuer from the `iss` claim found in the
* {@link ServerWebExchange}'s * {@link ServerWebExchange}'s
@ -68,7 +68,7 @@ public final class JwtIssuerReactiveAuthenticationManagerResolver
/** /**
* Construct a {@link JwtIssuerReactiveAuthenticationManagerResolver} using the * Construct a {@link JwtIssuerReactiveAuthenticationManagerResolver} using the
* provided parameters * provided parameters
* @param trustedIssuers a list of trusted issuers * @param trustedIssuers an array of trusted issuers
*/ */
public JwtIssuerReactiveAuthenticationManagerResolver(String... trustedIssuers) { public JwtIssuerReactiveAuthenticationManagerResolver(String... trustedIssuers) {
this(Arrays.asList(trustedIssuers)); this(Arrays.asList(trustedIssuers));