【Spring MVC + Spring Security】認証イベントをハンドリングする方法

概要

Spring Securityの認証成功／失敗イベントをハンドリングする方法についてまとめた。

前提

以下の記事の続きとなる。

あわせて読みたい

【Spring MVC + Spring Security】認証処理にパスワードハッシュ化機能を導入する方法

概要 Spring Securityの認証機能に、パスワードのハッシュ化機能を導入する方法についてまとめた。   前提 以下の記事の続きとなる。

認証イベント仕様

Spring SecurityはSpring Frameworkが提供するイベント制御の仕組みを利用して、認証成功／失敗イベントを通知する。
この仕組みを活用することで、認証処理に以下のような拡張機能を柔軟に追加できる。

認証イベント発行～伝播までのざっくりとした流れは以下のようになる。

実装

認証イベントに対応したイベントリスナーを追加する。

認証成功イベント

認証に成功した場合、Spring Securityは主に以下のイベントを発行する。

リスナー定義

認証成功時のイベントをハンドリングするイベントリスナーを作成する。

LoginSuccessListener.java

package com.example.prototype.biz.security.listener;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.event.EventListener;
import org.springframework.security.authentication.event.AuthenticationSuccessEvent;
import org.springframework.security.authentication.event.InteractiveAuthenticationSuccessEvent;
import org.springframework.stereotype.Component;

@Component
public class LoginSuccessListener {
    private static final Logger logger = LoggerFactory.getLogger(LoginSuccessListener.class);

    @EventListener
    public void handleAuthenticationSuccessEvent(AuthenticationSuccessEvent event) {
        logger.info("\n★★ログイン成功： AuthenticationSuccessEventイベント★★\n");
    }

    @EventListener
    public void handleInteractiveAuthenticationSuccessEvent(InteractiveAuthenticationSuccessEvent event) {
        logger.info("\n★★ログイン成功： InteractiveAuthenticationSuccessEventイベント★★");

    }

}

メソッドに「org.springframework.context.event.EventListener」アノテーションを定義して
ハンドリングしたいイベントを引数に指定することで、自動でハンドリングできる。

認証失敗イベント

認証に失敗した場合、Spring Securityは様々な認証失敗ケースにあったイベントを発行する。
基本的にはすべての認証失敗イベントの基底クラスである、AbstractAuthenticationFailureEventをハンドリングすればOK。

リスナー定義

認証失敗時のイベントをハンドリングするイベントリスナーを作成する。

LoginFailureListener.java

package com.example.prototype.biz.security.listener;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.event.EventListener;
import org.springframework.security.authentication.event.AbstractAuthenticationFailureEvent;
import org.springframework.stereotype.Component;

@Component
public class LoginFailureListener {
    private static final Logger logger = LoggerFactory.getLogger(LoginFailureListener.class);
    
    @EventListener
    public void handleAbstractAuthenticationFailureEvent(AbstractAuthenticationFailureEvent event) {
        // ログイン失敗ユーザーのDB更新、ログ出力など
        logger.info("\n★★ログイン失敗（認証例外イベント）： {}★★\n", event.getException().getClass());
    }
}

まとめ