Обробляйте винятки автентифікації пружинної безпеки за допомогою @ExceptionHandler


97

Я використовую Spring MVC @ControllerAdviceі @ExceptionHandlerдля обробки всіх винятків REST Api. Він чудово працює для винятків, що створюються веб-контролерами mvc, але не працює для винятків, викинутих спеціальними фільтрами Spring Spring, оскільки вони працюють до виклику методів контролера.

У мене є власний весняний фільтр безпеки, який виконує аутентифікацію на основі маркера:

public class AegisAuthenticationFilter extends GenericFilterBean {

...

    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {

        try {

            ...         
        } catch(AuthenticationException authenticationException) {

            SecurityContextHolder.clearContext();
            authenticationEntryPoint.commence(request, response, authenticationException);

        }

    }

}

За допомогою цієї спеціальної точки входу:

@Component("restAuthenticationEntryPoint")
public class RestAuthenticationEntryPoint implements AuthenticationEntryPoint{

    public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authenticationException) throws IOException, ServletException {
        response.sendError(HttpServletResponse.SC_UNAUTHORIZED, authenticationException.getMessage());
    }

}

І за допомогою цього класу для обробки винятків у всьому світі:

@ControllerAdvice
public class RestEntityResponseExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler({ InvalidTokenException.class, AuthenticationException.class })
    @ResponseStatus(value = HttpStatus.UNAUTHORIZED)
    @ResponseBody
    public RestError handleAuthenticationException(Exception ex) {

        int errorCode = AegisErrorCode.GenericAuthenticationError;
        if(ex instanceof AegisException) {
            errorCode = ((AegisException)ex).getCode();
        }

        RestError re = new RestError(
            HttpStatus.UNAUTHORIZED,
            errorCode, 
            "...",
            ex.getMessage());

        return re;
    }
}

Що мені потрібно зробити, це повернути детальне тіло JSON навіть для Spring AuthenticationException. Чи є спосіб змусити AuthenticationEntryPoint і Spring mvc @ExceptionHandler працювати разом?

Я використовую spring security 3.1.4 та spring mvc 3.2.4.


9
Ви не можете ... The (@)ExceptionHandlerбуде працювати, лише якщо запит обробляється DispatcherServlet. Однак цей виняток трапляється перед цим, оскільки його видає a Filter. Отже, ви ніколи не зможете обробити цей виняток за допомогою (@)ExceptionHandler.
M. Deinum

Гаразд, ти маєш рацію. Чи є спосіб повернути тіло json разом із response.sendError EntryPoint?
Нікола

Здається, вам потрібно вставити власний фільтр раніше в ланцюжку, щоб зловити виняток і відповідно повернути його. У документації перелічені фільтри, їх псевдоніми та порядок їх застосування: docs.spring.io/spring-security/site/docs/3.1.4.RELEASE/…
Ромскі,

1
Якщо єдине місце, де вам потрібен JSON, просто побудуйте / запишіть його всередині EntryPoint. Можливо, ви захочете побудувати об’єкт там і ввести MappingJackson2HttpMessageConverterтуди а.
M. Deinum

@ M.Deinum Я спробую побудувати json всередині точки входу.
Нікола

Відповіді:


58

Гаразд, я спробував, як запропонував написати сам json з AuthenticationEntryPoint, і він працює.

Тільки для тестування я змінив AutenticationEntryPoint, видаливши response.sendError

@Component("restAuthenticationEntryPoint")
public class RestAuthenticationEntryPoint implements AuthenticationEntryPoint{

    public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authenticationException) throws IOException, ServletException {

        response.setContentType("application/json");
        response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
        response.getOutputStream().println("{ \"error\": \"" + authenticationException.getMessage() + "\" }");

    }
}

Таким чином, ви можете надсилати власні дані json разом із несанкціонованим 401, навіть якщо ви використовуєте Spring Security AuthenticationEntryPoint.

Очевидно, що ви не будували json, як це робив я для тестування, але ви б серіалізували якийсь екземпляр класу.


3
Приклад використання Джексона: ObjectMapper mapper = new ObjectMapper (); mapper.writeValue (response.getOutputStream (), new FailResponse (401, authException.getLocalizedMessage (), "Доступ заборонено", ""));
Сайрусміт

1
Я знаю, що питання трохи старе, але чи зареєстрували ви свій AuthenticationEntryPoint у SecurityConfig?
leventunver

1
@leventunver Тут ви знайдете, як зареєструвати точку входу: stackoverflow.com/questions/24684806/… .
Нікола

37

Це дуже цікава проблема, оскільки Spring Security та Spring Web framework не зовсім узгоджуються у тому, як вони обробляють відповідь. Я вважаю, що він повинен власноруч підтримувати обробку повідомлень про помилки MessageConverterзручним способом.

Я спробував знайти елегантний спосіб внести MessageConverterв Spring Security, щоб вони могли вловити виняток і повернути їх у правильному форматі відповідно до переговорів щодо вмісту . Тим не менше, моє рішення нижче не елегантне, але принаймні використовуйте код Spring.

Припускаю, ви знаєте, як включити бібліотеку Джексона та JAXB, інакше немає сенсу продовжувати. Всього є 3 кроки.

Крок 1 - Створіть автономний клас, зберігаючи MessageConverters

Цей клас не грає жодної магії. У ньому просто зберігаються перетворювачі повідомлень та процесор RequestResponseBodyMethodProcessor. Магія знаходиться всередині того процесора, який буде виконувати всю роботу, включаючи узгодження вмісту та відповідну конвертацію тіла відповіді.

public class MessageProcessor { // Any name you like
    // List of HttpMessageConverter
    private List<HttpMessageConverter<?>> messageConverters;
    // under org.springframework.web.servlet.mvc.method.annotation
    private RequestResponseBodyMethodProcessor processor;

    /**
     * Below class name are copied from the framework.
     * (And yes, they are hard-coded, too)
     */
    private static final boolean jaxb2Present =
        ClassUtils.isPresent("javax.xml.bind.Binder", MessageProcessor.class.getClassLoader());

    private static final boolean jackson2Present =
        ClassUtils.isPresent("com.fasterxml.jackson.databind.ObjectMapper", MessageProcessor.class.getClassLoader()) &&
        ClassUtils.isPresent("com.fasterxml.jackson.core.JsonGenerator", MessageProcessor.class.getClassLoader());

    private static final boolean gsonPresent =
        ClassUtils.isPresent("com.google.gson.Gson", MessageProcessor.class.getClassLoader());

    public MessageProcessor() {
        this.messageConverters = new ArrayList<HttpMessageConverter<?>>();

        this.messageConverters.add(new ByteArrayHttpMessageConverter());
        this.messageConverters.add(new StringHttpMessageConverter());
        this.messageConverters.add(new ResourceHttpMessageConverter());
        this.messageConverters.add(new SourceHttpMessageConverter<Source>());
        this.messageConverters.add(new AllEncompassingFormHttpMessageConverter());

        if (jaxb2Present) {
            this.messageConverters.add(new Jaxb2RootElementHttpMessageConverter());
        }
        if (jackson2Present) {
            this.messageConverters.add(new MappingJackson2HttpMessageConverter());
        }
        else if (gsonPresent) {
            this.messageConverters.add(new GsonHttpMessageConverter());
        }

        processor = new RequestResponseBodyMethodProcessor(this.messageConverters);
    }

    /**
     * This method will convert the response body to the desire format.
     */
    public void handle(Object returnValue, HttpServletRequest request,
        HttpServletResponse response) throws Exception {
        ServletWebRequest nativeRequest = new ServletWebRequest(request, response);
        processor.handleReturnValue(returnValue, null, new ModelAndViewContainer(), nativeRequest);
    }

    /**
     * @return list of message converters
     */
    public List<HttpMessageConverter<?>> getMessageConverters() {
        return messageConverters;
    }
}

Крок 2 - Створіть AuthenticationEntryPoint

Як і в багатьох навчальних посібниках, цей клас є важливим для реалізації спеціальної обробки помилок.

public class CustomEntryPoint implements AuthenticationEntryPoint {
    // The class from Step 1
    private MessageProcessor processor;

    public CustomEntryPoint() {
        // It is up to you to decide when to instantiate
        processor = new MessageProcessor();
    }

    @Override
    public void commence(HttpServletRequest request,
        HttpServletResponse response, AuthenticationException authException)
        throws IOException, ServletException {

        // This object is just like the model class, 
        // the processor will convert it to appropriate format in response body
        CustomExceptionObject returnValue = new CustomExceptionObject();
        try {
            processor.handle(returnValue, request, response);
        } catch (Exception e) {
            throw new ServletException();
        }
    }
}

Крок 3 - Зареєструйте точку входу

Як вже згадувалося, я роблю це за допомогою Java Config. Я просто показую відповідну конфігурацію тут, там повинні бути інші конфігурації, такі як сеанс без стану тощо.

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.exceptionHandling().authenticationEntryPoint(new CustomEntryPoint());
    }
}

Спробуйте використати деякі випадки помилки автентифікації, пам’ятайте, що заголовок запиту повинен містити Accept: XXX, і ви повинні отримати виняток у форматі JSON, XML або деяких інших.


1
Я намагаюся зрозуміти, InvalidGrantExceptionале моя версія вашої версії CustomEntryPointне отримується. Будь-яка ідея, чого я міг бракувати?
displayname

@displayname. Всі виключення перевірки автентичності , які не можуть бути спійманої AuthenticationEntryPoint і AccessDeniedHandlerтакі , як UsernameNotFoundExceptionі InvalidGrantExceptionможуть бути оброблені , AuthenticationFailureHandlerяк описано тут .
Вільсон

23

Найкращий спосіб, який я знайшов, - делегувати виняток HandlerExceptionResolver

@Component("restAuthenticationEntryPoint")
public class RestAuthenticationEntryPoint implements AuthenticationEntryPoint {

    @Autowired
    private HandlerExceptionResolver resolver;

    @Override
    public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) throws IOException, ServletException {
        resolver.resolveException(request, response, null, exception);
    }
}

тоді ви можете використовувати @ExceptionHandler, щоб відформатувати відповідь так, як ви хочете.


9
Працює як шарм. Якщо Spring спричиняє помилку, кажучи, що для автоматичного підключення існує 2 компоненти, потрібно додати анотацію кваліфікатора: @Autowired @Qualifier ("handlerExceptionResolver") private HandlerExceptionResolver resolver;
Daividh

1
Майте на увазі, що, передавши нульовий обробник, ви @ControllerAdviceне будете працювати, якщо ви вказали basePackages у анотації. Мені довелося це повністю видалити, щоб дозволити виклик обробника.
Ярмекс,

Чому ти дав @Component("restAuthenticationEntryPoint")? Навіщо потрібна така назва, як restAuthenticationEntryPoint? Це уникнути деяких зіткнень імен Spring?
theprogrammer

@Jarmex Тож замість null, що ти пройшов? це якийсь обробник, так? Чи повинен я просто пройти клас, який був анотований @ControllerAdvice? Спасибі
theprogrammer

@theprogrammer, мені довелося трохи реструктуризувати додаток, щоб видалити параметр анотації basePackages, щоб обійти його - не ідеально!
Jarmex

5

У випадку Spring Boot і @EnableResourceServerвідносно легко та зручно розширити ResourceServerConfigurerAdapterзамість WebSecurityConfigurerAdapterконфігурації Java та зареєструвати спеціальний засіб AuthenticationEntryPoint, замінивши configure(ResourceServerSecurityConfigurer resources)та використовуючи resources.authenticationEntryPoint(customAuthEntryPoint())всередині методу.

Щось на зразок цього:

@Configuration
@EnableResourceServer
public class CommonSecurityConfig extends ResourceServerConfigurerAdapter {

    @Override
    public void configure(ResourceServerSecurityConfigurer resources) throws Exception {
        resources.authenticationEntryPoint(customAuthEntryPoint());
    }

    @Bean
    public AuthenticationEntryPoint customAuthEntryPoint(){
        return new AuthFailureHandler();
    }
}

Також є приємний варіант, OAuth2AuthenticationEntryPointякий можна розширити (оскільки він не остаточний) і частково повторно використати під час реалізації користувацького AuthenticationEntryPoint. Зокрема, він додає заголовки "WWW-Authenticate" із деталями, пов'язаними з помилками.

Сподіваюся, це комусь допоможе.


Я намагаюся це зробити, але commence()функція my AuthenticationEntryPointне викликається - я чогось пропускаю?
ім’я

4

Отримавши відповіді від @Nicola та @Victor Wing та додавши більш стандартизований спосіб:

import org.springframework.beans.factory.InitializingBean;
import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.http.server.ServletServerHttpResponse;
import org.springframework.security.core.AuthenticationException;
import org.springframework.security.web.AuthenticationEntryPoint;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class UnauthorizedErrorAuthenticationEntryPoint implements AuthenticationEntryPoint, InitializingBean {

    private HttpMessageConverter messageConverter;

    @SuppressWarnings("unchecked")
    @Override
    public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException exception) throws IOException, ServletException {

        MyGenericError error = new MyGenericError();
        error.setDescription(exception.getMessage());

        ServerHttpResponse outputMessage = new ServletServerHttpResponse(response);
        outputMessage.setStatusCode(HttpStatus.UNAUTHORIZED);

        messageConverter.write(error, null, outputMessage);
    }

    public void setMessageConverter(HttpMessageConverter messageConverter) {
        this.messageConverter = messageConverter;
    }

    @Override
    public void afterPropertiesSet() throws Exception {

        if (messageConverter == null) {
            throw new IllegalArgumentException("Property 'messageConverter' is required");
        }
    }

}

Тепер ви можете вводити конфігуровані Jackson, Jaxb або будь-що інше, що ви використовуєте для перетворення тіл відповідей у ​​вашій анотації MVC або конфігурації на основі XML з його серіалізаторами, десериалізаторами тощо.


Я дуже новачок у весняному завантаженні: скажіть, будь ласка, "як передати об'єкт messageConverter точці автентифікації"
Kona Suresh

Через сеттера. Коли ви використовуєте XML, вам потрібно створити <property name="messageConverter" ref="myConverterBeanName"/>тег. Коли ви використовуєте @Configurationклас, просто використовуйте setMessageConverter()метод.
Габріель Вілласіс

4

Нам потрібно використовувати HandlerExceptionResolver в такому випадку.

@Component
public class RESTAuthenticationEntryPoint implements AuthenticationEntryPoint {

    @Autowired
    //@Qualifier("handlerExceptionResolver")
    private HandlerExceptionResolver resolver;

    @Override
    public void commence(HttpServletRequest request, HttpServletResponse response, AuthenticationException authException) throws IOException {
        resolver.resolveException(request, response, null, authException);
    }
}

Крім того, вам потрібно додати клас обробника винятків, щоб повернути ваш об’єкт.

@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler(AuthenticationException.class)
    public GenericResponseBean handleAuthenticationException(AuthenticationException ex, HttpServletResponse response){
        GenericResponseBean genericResponseBean = GenericResponseBean.build(MessageKeys.UNAUTHORIZED);
        genericResponseBean.setError(true);
        response.setStatus(HttpStatus.UNAUTHORIZED.value());
        return genericResponseBean;
    }
}

можете ви отримаєте помилку в момент запуску проекту з декількох реалізацій HandlerExceptionResolver, в цьому випадку ви повинні додати @Qualifier("handlerExceptionResolver")наHandlerExceptionResolver


GenericResponseBeanце просто java pojo, нехай ви можете створити свій власний
Vinit Solanki

2

Я впорався з цим, просто перевизначивши метод 'unsuccessfulAuthentication' у своєму фільтрі. Там я надсилаю клієнту відповідь про помилку із бажаним кодом стану HTTP.

@Override
protected void unsuccessfulAuthentication(HttpServletRequest request, HttpServletResponse response,
        AuthenticationException failed) throws IOException, ServletException {

    if (failed.getCause() instanceof RecordNotFoundException) {
        response.sendError((HttpServletResponse.SC_NOT_FOUND), failed.getMessage());
    }
}

1

Оновлення: Якщо вам подобається і ви бажаєте бачити код безпосередньо, то я маю для вас два приклади, один із яких використовує стандартну Spring Security, що саме ви шукаєте, інший використовує еквівалент Reactive Web та Reactive Security:
- Звичайний Безпека Web + Jwt
- реактивний Jwt

Той, який я завжди використовую для своїх кінцевих точок на основі JSON, виглядає так:

@Component
public class JwtAuthEntryPoint implements AuthenticationEntryPoint {

    @Autowired
    ObjectMapper mapper;

    private static final Logger logger = LoggerFactory.getLogger(JwtAuthEntryPoint.class);

    @Override
    public void commence(HttpServletRequest request,
                         HttpServletResponse response,
                         AuthenticationException e)
            throws IOException, ServletException {
        // Called when the user tries to access an endpoint which requires to be authenticated
        // we just return unauthorizaed
        logger.error("Unauthorized error. Message - {}", e.getMessage());

        ServletServerHttpResponse res = new ServletServerHttpResponse(response);
        res.setStatusCode(HttpStatus.UNAUTHORIZED);
        res.getServletResponse().setHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE);
        res.getBody().write(mapper.writeValueAsString(new ErrorResponse("You must authenticated")).getBytes());
    }
}

Отображувач об’єктів стає компонентом, як тільки ви додаєте веб-початківець spring, але я волію його налаштувати, тому ось моя реалізація для ObjectMapper:

  @Bean
    public Jackson2ObjectMapperBuilder objectMapperBuilder() {
        Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
        builder.modules(new JavaTimeModule());

        // for example: Use created_at instead of createdAt
        builder.propertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE);

        // skip null fields
        builder.serializationInclusion(JsonInclude.Include.NON_NULL);
        builder.featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
        return builder;
    }

За замовчуванням AuthenticationEntryPoint, який ви встановили у класі WebSecurityConfigurerAdapter:

@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfig extends WebSecurityConfigurerAdapter {
// ............
   @Autowired
    private JwtAuthEntryPoint unauthorizedHandler;
@Override
    protected void configure(HttpSecurity http) throws Exception {
        http.cors().and().csrf().disable()
                .authorizeRequests()
                // .antMatchers("/api/auth**", "/api/login**", "**").permitAll()
                .anyRequest().permitAll()
                .and()
                .exceptionHandling().authenticationEntryPoint(unauthorizedHandler)
                .and()
                .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS);


        http.headers().frameOptions().disable(); // otherwise H2 console is not available
        // There are many ways to ways of placing our Filter in a position in the chain
        // You can troubleshoot any error enabling debug(see below), it will print the chain of Filters
        http.addFilterBefore(authenticationJwtTokenFilter(), UsernamePasswordAuthenticationFilter.class);
    }
// ..........
}

1

Налаштуйте фільтр і визначте, яка аномалія має бути кращим, ніж цей

public class ExceptionFilter extends OncePerRequestFilter {

@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws IOException, ServletException {
    String msg = "";
    try {
        filterChain.doFilter(request, response);
    } catch (Exception e) {
        if (e instanceof JwtException) {
            msg = e.getMessage();
        }
        response.setCharacterEncoding("UTF-8");
        response.setContentType(MediaType.APPLICATION_JSON.getType());
        response.getWriter().write(JSON.toJSONString(Resp.error(msg)));
        return;
    }
}

}


0

Я використовую objectMapper. Кожна послуга відпочинку в основному працює з json, і в одній із ваших конфігурацій ви вже налаштували відображення об’єктів.

Код написаний у Котліні, сподіваємось, це буде нормально.

@Bean
fun objectMapper(): ObjectMapper {
    val objectMapper = ObjectMapper()
    objectMapper.registerModule(JodaModule())
    objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false)

    return objectMapper
}

class UnauthorizedAuthenticationEntryPoint : BasicAuthenticationEntryPoint() {

    @Autowired
    lateinit var objectMapper: ObjectMapper

    @Throws(IOException::class, ServletException::class)
    override fun commence(request: HttpServletRequest, response: HttpServletResponse, authException: AuthenticationException) {
        response.addHeader("Content-Type", "application/json")
        response.status = HttpServletResponse.SC_UNAUTHORIZED

        val responseError = ResponseError(
            message = "${authException.message}",
        )

        objectMapper.writeValue(response.writer, responseError)
     }}

0

У ResourceServerConfigurerAdapterкласі нижче вирізаний код працював у мене. http.exceptionHandling().authenticationEntryPoint(new AuthFailureHandler()).and.csrf()..не працює. Тому я написав це як окремий дзвінок.

public class ResourceServerConfiguration extends ResourceServerConfigurerAdapter {

    @Override
    public void configure(HttpSecurity http) throws Exception {

        http.exceptionHandling().authenticationEntryPoint(new AuthFailureHandler());

        http.csrf().disable()
                .anonymous().disable()
                .authorizeRequests()
                .antMatchers(HttpMethod.OPTIONS).permitAll()
                .antMatchers("/subscribers/**").authenticated()
                .antMatchers("/requests/**").authenticated();
    }

Впровадження AuthenticationEntryPoint для виявлення закінчення терміну дії маркера та відсутнього заголовка авторизації.


public class AuthFailureHandler implements AuthenticationEntryPoint {

  @Override
  public void commence(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, AuthenticationException e)
      throws IOException, ServletException {
    httpServletResponse.setContentType("application/json");
    httpServletResponse.setStatus(HttpServletResponse.SC_UNAUTHORIZED);

    if( e instanceof InsufficientAuthenticationException) {

      if( e.getCause() instanceof InvalidTokenException ){
        httpServletResponse.getOutputStream().println(
            "{ "
                + "\"message\": \"Token has expired\","
                + "\"type\": \"Unauthorized\","
                + "\"status\": 401"
                + "}");
      }
    }
    if( e instanceof AuthenticationCredentialsNotFoundException) {

      httpServletResponse.getOutputStream().println(
          "{ "
              + "\"message\": \"Missing Authorization Header\","
              + "\"type\": \"Unauthorized\","
              + "\"status\": 401"
              + "}");
    }

  }
}

не працює .. все ще відображається повідомлення за замовчуванням
aswzen
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.