Navigation Access Control documentation is missing a phase

Abierto
#4,826 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
52/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
java, spring-boot

Línea de trabajo

Abre la documentación enlazada de Navigation Access Control y revisa la sección que describe las fases de NavigationAccessChecker. Documenta que los checkers personalizados se llaman primero sin un Principal y después con uno, incluido el resultado neutral necesario para la llamada con null-Principal. Confirma que la página explica la interacción con la comprobación de anotaciones y el resultado esperado de la navegación autenticada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

flow
Description

The documentation for NavigationAccessChecker notes the error handling phase, but it does not mention the anonymous route check phase. This is critical if your custom access checker wants to examine the Principal.

My custom checker is called twice per authentication, once with a null principal, and once with a valid one. At first I rejected the null case for pages that needed an authenticated login, but that caused an error because the user WAS logged in, and the annotation checker passed, as they had the right role. My fine grained check for current credential timing failed the initial pass, though, and a conflict was detected between ALLOW and DENY.

Instead I had to ignore a null principal with NEUTRAL, and then the second call would pass a principal that could be verified.

Expected outcome

Documentation should mention custom access checkers are called twice, once without the principal and once with it, and mention what to do if you need to deny requests without a valid principal - rejecting in the first call causes trouble.

Minimal reproducible example

if (context.getPrincipal() == null) return AccessCheckResult.neutral();

Steps to reproduce

create an additional access checker that rejects null principal.
enable annotation checking (in a Spring Boot project)
create a view with a role access annotation
navigate to the view in an authenticated session with the named role

Environment

Vaadin version(s): 24.9.4
OS: N/A

Browsers

No response

Lenguaje dominante
AsciiDoc
Estrellas
38
Forks
225
Merge medio
17 h 38 min
PR fusionados (30 d)
214

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de vaadin/docs

Todos los issues de vaadin/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.