La configuración de seguridad estándar de FundeWebJS permite solamente validar los tokens JWT de OAUTH obtenidos desde micampus.

En ocasiones una API necesitará validar otro tipo de tokens OAUTH obtenidos desde otras aplicaciones, scopes u otros flujos OAUTH o, simplemente, queremos querremos ampliar la seguridad de un endpoint o de toda nuestra APInuestros endpoints.

Por ejemplo: validación del tokens OAUTH del flujo CLIENT CREDENTIALS parala comunicación entre APIs FundeWeb y FundeWebJS.

...

Por ejemplo: validar que el token contenga el claim "client_id" con valor "miAplicacion", o el claim "grant_type" con valor "CLIENT_CREDENTIALS".

Guía detallada

Existen dos formas de configurar esta validación:

- Global: Se configura para toda la aplicación y todos los endpoints realizarán la misma validación.

- Por método: Sólo el endpoint configurado validará el claim

1. Configuración global

...

#Valida los scopes 'micampus' y 'miotroscope'
server.scopes=SCOPE_micampus,SCOPE_miotroscope

2. Configurar endpoints por scope

...

- Configurar los mvcMatchers en el SecurityConfig.
- Utilizar la anotación PreAuthorize en cada método Java de nuestro RestController.

Configuración de MvcMatchers

La primera forma de configuración es añadir un mvcMatcher en el método configure de nuestra clase "SecurityConfig". 
Se añade el mvcMatcher que capture la/s rutas/s a securizar con nuestro nuevo scope (antes del mvcMatcher configurado por defecto para private-apiPath) y se le añade .hasAuthority("SCOPE_miotroscope").

Por ejemplo:

@Override
protected void configure( HttpSecurity http ) throws Exception {
	http.requestMatchers().antMatchers( "/public/**" ).and().requestMatchers().antMatchers( apiPath + "/**" ).and()
	.sessionManagement().sessionCreationPolicy( SessionCreationPolicy.STATELESS )
	.and().cors() 
	.and().csrf().disable().authorizeRequests()
	.mvcMatchers( "/public/**" ).permitAll()
	.mvcMatchers( apiPath + "**/mirecurso/misubrecursoconotroscope/**" ).hasAuthority( "SCOPE_miotroscope" )
	.mvcMatchers( apiPath + "/**" ).hasAnyAuthority( serverScopes ).anyRequest().authenticated()
	.and().addFilterAfter( loggingFilterBean(), BearerTokenAuthenticationFilter.class )
	.oauth2ResourceServer().jwt();
}

...

Guía detallada

La librería fundewebjs-security contiene un fichero FundeWebJSSecurityConfig por defecto. Para utilizar otra configuración hay que realizar los siguientes pasos:

1. Si no existe en nuestro proyecto, crear una clase SecurityConfig.java nueva a partir del código de FundeWebJSSecurityConfig (ubicada en la librería fundewebjs-security).
   
   

2. En el application.properties (de local y de los entornos en Helm Chart), añadir la siguiente property:
   
   

   Bloque de código
   //Deshabilita SecurityFilterChain por defecto fdwjs.starter.security.enable=false

   
   

A continuación se detallan las configuraciones específicas para validar claims:

Existen dos formas de configurar esta validación:

- Global: Se configura para toda la aplicación y todos los endpoints realizarán la misma validación.

- Por método: Sólo el endpoint configurado validará el claim

1. Configuración global

Con esta configuración se realizará la validación de claims en TODOS los endpoints de la aplicación.

En la clase SecurityConfig.java (ver pasos 1 y 2 anteriores), añadir el siguiente Bean JwtDecoder:

import org.springframework.security.oauth2.core.DelegatingOAuth2TokenValidator;
import org.springframework.security.oauth2.core.OAuth2TokenValidator;
import org.springframework.security.oauth2.jose.jws.SignatureAlgorithm;
import org.springframework.security.oauth2.jwt.Jwt;
import org.springframework.security.oauth2.jwt.JwtDecoder;
import org.springframework.security.oauth2.jwt.JwtValidators;
import org.springframework.security.oauth2.jwt.NimbusJwtDecoder;.....@Configuration
public class SecurityConfig {
............

	@Bean
	JwtDecoder jwtDecoder() {
		NimbusJwtDecoder jwtDecoder = NimbusJwtDecoder.withJwkSetUri( jwkSetUri )
				.jwsAlgorithm( SignatureAlgorithm.RS512 ).build();

		OAuth2TokenValidator<Jwt> clientIdValidator = new FundeWebJSClaimValidator( "client_id", "tramites" );
		OAuth2TokenValidator<Jwt> grantValidator = new FundeWebJSClaimValidator( "grant_type", "CLIENT_CREDENTIALS" );

		OAuth2TokenValidator<Jwt> withIssuer = JwtValidators.createDefaultWithIssuer( issuerUri );
		OAuth2TokenValidator<Jwt> withAudience = new DelegatingOAuth2TokenValidator<>( withIssuer, clientIdValidator,
				grantValidator );
		jwtDecoder.setJwtValidator( withAudience );

		return jwtDecoder;
	}

Este método es un ejemplo para validar que el token se haya obtenido para el flujo Oauth "CLIENT_CREDENTIALS" y para el servicio "tramites".

Para añadir la validación de claim hay que:
- Crear un objeto OAuth2TokenValidator<Jwt> miClaimValidator = new FundeWebJSClaimValidator( MI_CLAIM, VALOR_A_VALIDAR ); 
   con el nombre del claim y el valor a validar en el constructor.

- Añadir el objeto miClaimValidator como otro parámetro más en new DelegatingOAuth2TokenValidator<>( withIssuer, miClaimValidator,..);

-- Respuesta de error --

Cuando llegue una petición con un token que no cumpla las restricciones configuradas con los FundeWebJSClaimValidator, la librería spring-security-oauth2-resource-server toma el control y devuelve la respuesta de la siguiente forma: 

• Status Code: 401 Unauthorized
• Body: VACIO
• Cabecera WWW-Authenticate: Bearer error="invalid_token", error_description="An error occurred while attempting to decode the Jwt: The client_id claim is not valid", error_uri="https://tools.ietf.org/html/rfc6750#section-3.1" 
  (Siguiendo el ejemplo del bloque de código descrito más arriba).
  

2. Configurar endpoints individualmente

Con la configuración del punto 1 se configura TODA la aplicación para permitir tokens con los claims configurados.
Dependiendo de la situación y del diseño de nuestra API, esto puedo ser necesario, pero el caso más habitual será tener diferentes endpoints y querer realizar una validación de claims diferente en cada uno de ellos.

Por ejemplo, en nuestra API que ofrece servicios a miscampus, podremos querer añadir un endpoint que valide tokens del flujo OAUTH CLIENT_CREDENTIALS para el servicio con claim client_id "tramites".

Esta validación específica de un endpoint se realiza de la siguiente manera:

PreAuthorize

Es necesario utilizar la anotación de spring-security @PreAuthorize con la clase propia de FundeWebJS creada para tal efecto FundeWebJsJwtClaimPreAuthorizer (@umuJwtAuth):

• Anotar la clase SecurityConfig con @EnableGlobalMethodSecurity( prePostEnabled = true )
  
  

  Bloque de código
  @Configuration @EnableGlobalMethodSecurity( prePostEnabled = true ) public class SecurityConfig {....

  
  
  

• Anotar el método java que publica nuestro endpoint (o directamente todo el RestController en caso de hacer una clase específica validar ese claim) con @PreAuthorize @umuJwtAuth.hasClaim
  

  
  

  Bloque de código
  @PreAuthorize("@umuJwtAuth.hasClaim(authentication, 'MI_CLAIM', 'VALOR_A_VALIDAR')")

  
  Por ejemplo, a este endpoint sólo se podrá acceder con tokens del flujo Oauth: CLIENT_CREDENTIALS:

  
  

  Expandir
  title Ver ejemplo...
  Bloque de código language java @GetMapping( "/claimsTest" ) @PreAuthorize("@umuJwtAuth.hasClaim(authentication, 'grant_type', 'CLIENT_CREDENTIALS')") public ResponseEntity<String> validateClaimTest( Jwt jwt ) { return ResponseEntity.ok( "Claims validados" ); }

  
  

  Info

  La expresión dentro del PreAuthorize evalúa un booleano. Esto significa que: Pueden añadirse varias validaciones de claims en la misma anotación PreAuthorize añadiendo otro @umuJwtAuth.hasClaim separando cada comprobación por "and" (o por un "or" en caso de querer una u otra validación). Por ejemplo, a este endpoint sólo se podrá acceder con tokens del flujo Oauth: "CLIENT_CREDENTIALS" Y del servicio: "tramites": Bloque de código @GetMapping( "/claimsTest" ) @PreAuthorize("@umuJwtAuth.hasClaim(authentication, 'grant_type', 'CLIENT_CREDENTIALS') and @umuJwtAuth.hasClaim(authentication, 'client_id', 'tramites')") public ResponseEntity<String> validateClaimTest( Jwt jwt ) { return ResponseEntity.ok( "Claims validados" ); }

  
  

  Advertencia
  El primer parámetro del método hasClaim siempre debe ser "authentication". Es la variable de Spring Security con el contexto de seguridad en cada petición.

  
  

-- Respuesta de error --

La clase FundeWebJsJwtClaimPreAuthorizer (@umuJwtAuth) lanza una excepción FundeWebJsJwtClaimsAccessDeniedException cuando llegan tokens con claims inválidos.
El código de la librería Fundewebjs-security incluye por defecto un ExceptionHandler para estas excepciones FundeWebJsJwtClaimsAccessDeniedException. Ver clase FundeWebJsRestControllerAdvice.

Cuando llega una petición a un endpoint anotado con PreAuthorize("@umuJwtAuth.hasClaim..") que incluye un token inválido, la respuesta por defecto será::

• Status Code:  401 Unauthorized

• Body:  JSON con formato org.springframework.security.oauth2.server.resource.BearerTokenError. Por ejemplo:
  

  Bloque de código
  language json
  { "errorCode": "invalid_token", "description": "An error occurred while attempting to decode the Jwt: The grant_type claim is not valid", "uri": "https://tools.ietf.org/html/rfc6750#section-3.1", "httpStatus": "UNAUTHORIZED", "scope": null }

  
  

• Cabecera  WWW-Authenticate: Bearer error="invalid_token", error_description="An error occurred while attempting to decode the Jwt: The grant_type claim is not valid", error_uri="https://tools.ietf.org/html/rfc6750#section-3.1"
• Cabecera UMU-Authenticate= invalid_token
  
  

3. Documentar con Springdoc-OPENAPI

Utilizando @PreAuthorize es posible configurar la generación de la documentación para que aparezca el Scope requerido.

Para hacerlo solo sería necesario añadir una clase de configuración como ésta:

@Configuration
public class OpenApiConfiguration {    @Bean
    
	public OperationCustomizer operationCustomizer() {
        return ( operation, handlerMethod ) -> {
            Optional<PreAuthorize> preAuthorizeAnnotation = Optional

• Status Code:  403 Forbidden
• Body:  VACIO
• Cabecera  WWW-Authenticate: Bearer error="insufficient_scope", error_description="The request requires higher privileges than provided by the access token.", error_uri="https://tools.ietf.org/html/rfc6750#section-3.1"

Para sobreescribir el comportamiento de la respuesta de error habrá que crear una clase AccessDeniedExceptionHandler propia y configurarla en el mismo método configure de nuesta clase "SecurityConfig" añadiendo el exceptionHandling de esta forma: 

...
.mvcMatchers( apiPath + "**/mirecurso/misubrecursoconotroscope/**" ).hasAuthority( "SCOPE_miotroscope" )
.mvcMatchers( apiPath + "/**" ).hasAnyAuthority( serverScopes ).anyRequest().authenticated()
.and().exceptionHandling().accessDeniedHandler( new MiOtroAccessDeniedHandler())
.and().addFilterAfter( loggingFilterBean(), BearerTokenAuthenticationFilter.class )
.oauth2ResourceServer().jwt()
...

Configuración con PreAuthorize

La segunda forma para configurar endpoints y securizarlos por scope es utilizando la anotación de spring-security @PreAuthorize.

...

-- Respuesta de error --

...

• Status Code:  403 Forbidden
• Body:  VACIO
• Cabecera  WWW-Authenticate: Bearer error="insufficient_scope", error_description="The request requires higher privileges than provided by the access token.", error_uri="https://tools.ietf.org/html/rfc6750#section-3.1"

La diferencia con MvcMatchers es que con esta configuración la validación se realiza al final, justo antes de entrar al método, y que la aplicación puede tomar el control del manejo de la excepción usando alguno de los mecanismos de Manejo de Errores en FundeWebJS para capturar la excepción AccessDeniedException.

Por ejemplo , podríamos añadir a la respuesta un body y una cabecera propia con este ExceptionHandler: 

	@ExceptionHandler( AccessDeniedException.class )
	public ResponseEntity<ResponseException> accessDeniedException( HttpServletRequest request,
		AccessDeniedException e ) throws IOException {
        
        ....
		MiDTOdeError responseErrorBody = new MiDTOdeError([CON LOS ATRIBUTOS QUE QUIERA SACAR EN EL BODY]) //Puede usarse la clase BearerTokenError y BearerTokenErrors para generarlo.

		Map<String, String> parameters = new LinkedHashMap<>();
		if ( request.getUserPrincipal() instanceof AbstractOAuth2TokenAuthenticationToken ) {
			parameters.put( "error", BearerTokenErrorCodes.INSUFFICIENT_SCOPE );
			parameters.put( "error_description",
					"The request requires higher privileges than provided by the access token." );
			parameters.put( "error_uri", "https://tools.ietf.org/html/rfc6750#section-3.1" );
		}
		String wwwAuthenticate = computeWWWAuthenticateHeaderValue( parameters );

		HttpHeaders headers = new HttpHeaders();
		headers.add( HttpHeaders.WWW_AUTHENTICATE, wwwAuthenticate );
		headers.add( "UMU-Authenticate", parameters.get( "error" ) );

		return new ResponseEntity<>( responseErrorBody, headers, HttpStatus.FORBIDDEN );

	}

	private static String computeWWWAuthenticateHeaderValue( Map<String, String> parameters ) {
		StringBuilder wwwAuthenticate = new StringBuilder();
		wwwAuthenticate.append( "Bearer" );
		if ( !parameters.isEmpty() ) {
			wwwAuthenticate.append( " " );
			int i = 0;
			for ( Map.Entry<String, String> entry : parameters.entrySet() ) {
				wwwAuthenticate.append( entry.getKey() ).append( "=\"" ).append( entry.getValue() ).append( "\"" );
				if ( i != ( parameters.size() - 1 ) ) {
					wwwAuthenticate.append( ", " );
				}
				i++;
			}
		}
		return wwwAuthenticate.toString();
	}

3. Buenas prácticas

Como se ha mencionado en los apartados de respuesta de error, los mecanismos estándar de manejo de excepciones de spring-security y spring-security-oauth2-resource-server devuelven siempre un 403 Forbidden, con body vacío y con la cabecera WWW-Authenticate informando del error "insufficient_scope".

Esta configuración se puede sobreescribir pero, siguiendo el RFC de Oauth se recomienda mantener el 403 Forbidden y la cabecera con "insufficient_scope" => "The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the "scope" attribute with the scope necessary to access the protected resource".

3.1.  Error Codes

   When a request fails, the resource server responds using the
   appropriate HTTP status code (typically, 400, 401, 403, or 405) and
   includes one of the following error codes in the response:

   invalid_request
         The request is missing a required parameter, includes an
    .ofNullable( handlerMethod.getMethodAnnotation( PreAuthorize.class ) );
 unsupported parameter or parameter value, repeats the same
    StringBuilder sb = new StringBuilder();
 parameter, uses more than one method for including an access
  if ( preAuthorizeAnnotation.isPresent()     token, or is otherwise malformed.  The resource server SHOULD
) {
				//Documentar auth por scope
               respond withPattern thepatternAuthority HTTP 400 (Bad Request) status code.

   invalid_token
= Pattern.compile( "'SCOPE_\\w+'" );
              The  accessMatcher tokenmatcher provided is expired, revoked, malformed, or
= patternAuthority.matcher( ( preAuthorizeAnnotation.get() ).value() );
           invalid for other reasons.  Theif resource SHOULD respond with( matcher.find() ) {
         the HTTP 401 (Unauthorized) status code.  The client MAY
  sb.append( "Este endpoint requiere **SCOPE "  request a new access token and retry the protected resource
).append( matcher.group().replaceAll( "SCOPE_", "" ) )
              request.

   insufficient_scope
         The request requires higher privileges than provided by the.append( "**<br />" );
         access token.  The resource server SHOULD respond with} the HTTP

 				//Documentar auth por claim         403 (Forbidden) status code and MAY include the "scope"
         attribute with the scope necessary to access the protected
         resource.

   If the request lacks any authentication information (e.g., the client
   was unaware that authentication is necessary or attempted using an
   unsupported authentication method), the resource server SHOULD NOT
   include an error code or other error information.

   For example:

     HTTP/1.1 401 Unauthorized
     WWW-Authenticate: Bearer realm="example"

3. Documentar con Springdoc-OPENAPI

Utilizando @PreAuthorize es posible configurar la generación de la documentación para que aparezca el Scope requerido.

Para hacerlo solo sería necesario añadir una clase de configuración como ésta:

@Configuration
public class OpenApiConfiguration {

	@Bean
	public OperationCustomizer operationCustomizer() {
		return ( operation, handlerMethod ) -> {
			Optional<PreAuthorize> preAuthorizeAnnotation = Optional
					.ofNullable( handlerMethod.getMethodAnnotation( PreAuthorize.class ) );
			StringBuilder sb = new StringBuilder();
			if ( preAuthorizeAnnotation.isPresent() ) {

				Pattern patternAuthority = Pattern.compile( "'SCOPE_\\w+'" );
				Matcher matcher = patternAuthority.matcher( ( preAuthorizeAnnotation.get() ).value() );
				if ( matcher.find() ) {
					sb.append( "Este endpoint requiere: **SCOPE " ).append( matcher.group().replaceAll( "SCOPE_", "" ) )
					.append( "**     
			    Pattern patternClaims = Pattern.compile( "hasClaim\\(authentication,\\s*'\\w+',\\s*'\\w+'\\)" );
                matcher = patternClaims.matcher( ( preAuthorizeAnnotation.get() ).value() );
                if ( matcher.find() ) {
                    String[] claims = matcher.group().replaceAll( "hasClaim\\(authentication,|\\)", "" ).split( "," );
                    sb.append( "Este endpoint requiere **CLAIM " ).append( claims[0] ).append( ": " )
                            .append( claims[1] ).append( "**<br />" );
                }
                sb.append( "<br />" );
				}

				sb.append( "<br />" );
			}
			            }
            sb.append( operation.getDescription() );
			            operation.setDescription( sb.toString() );
			return operation;
		};
	}
            return operation;
        };
    }   
}

El resultado de esta configuración se puede ver en la siguiente imagen:
Image Removedimagen:

Image Added

Referencias

https://wwwdocs.baeldungspring.comio/spring-security-method-security/reference/servlet/oauth2/resource-server/jwt.html#oauth2resourceserver-jwt-validation-custom

Artículos Relacionados

...