Spring boot + Spring security でのログイン画面で直前のURLを取得したい

Question

前提・実現したいこと

あるページへのURLを直接入力した場合に、
ユーザがログインしていない場合は一旦ログイン画面を経由するようになっていますが、
そのログイン画面を表示する際に直接入力されたURLやパラメータを受け取る方法はありますでしょうか？

---

入力したURL
...../hogehoge/any_page/?param_a=123
表示されるログイン画面のURL
...../hogehoge/login

ログインコントローラ

@Controller
public class LoginController {
    @RequestMapping(value = "/login", method = RequestMethod.GET)
    public String login(@RequestParam(name = "param_a", required = false) String paramA, Model model) {
        //ここで param_a や 123 といったquerystringに関する値が欲しい
        return "login";
    }
}

Security の設定

public static class LoginWebSecurityConfigurerAdapter extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
         //ログインに関する設定
            http.formLogin()
                .loginProcessingUrl("/login/auth")
                .loginPage("/login")
                .successHandler(successHandler)
                .failureHandler(failureHandler)
            ;
    }
}

Comments

[退会済みユーザー]

標準で戻るようになってると思うが

[chu-mo]

戻るというのは、ログイン後にURLが元に戻るといったような状態でしょうか？
もしそちらの意味でしたら問題はないのですが、
「ログイン画面を表示時」に「入力されたURLを知りたい」のです。

[rubytomato]

要件をもう少し詳しく教えて頂きたいのですが、

(1) 下記は認証が必要なページであり

```
http://localhost/hogehoge/any_page/?param_a=123
```

(2) ユーザが未認証の状態で、たとえばブックマークから(1)のページに直接アクセスした場合

(3) リダイレクトされたログインページ(/login)のハンドラメソッド（LoginController#login）で、(1)のクエリストリングを知りたい

(4) 補足すると、認証成功後は (1)のページへリダイレクトする。

ということでしょうか？

[chu-mo]

はい、その通りです。
どんなURLにアクセスしたかで、
ログイン画面を表示する際にいくつか表示の分岐を行いたいのです。

Answer 1

Spring Securityではフォームベースの認証成功後のリダイレクト先をセッションに格納しています。
なので、セッションよりその情報を取得することで要件を満たす実装ができると思います。

例えば、認証が必要な下記のURLに未認証状態でアクセスした場合

http://localhost:8080/hogehoge/any_page/?param_a=123

↓ ログインページ

http://localhost:8080/hogehoge/login

ログインページのハンドラメソッドで、そのURLの情報を取得するにはHttpServletRequestとHttpSessionを使用します。
実装例は下記の通りです。

@RequestMapping(value = "/login", method = RequestMethod.GET)
public String login(Model model, HttpServletRequest req) {

    HttpSession session = req.getSession(false);
    if (session != null) {
        SavedRequest savedRequest = (SavedRequest) session.getAttribute("SPRING_SECURITY_SAVED_REQUEST");
        if (savedRequest != null) {
            // 認証成功後のリダイレクト先
            String redirectUrl = savedRequest.getRedirectUrl();
            System.out.println(redirectUrl);
            // → http://localhost:8080/hogehoge/any_page/?param_a=123

            // クエリパラメータ
            Map<String, String[]> params = savedRequest.getParameterMap();
            String[] values = params.get("param_a");
            System.out.println(values);
            // → 123
        }
    }

    return "login";
}

ポイントとなるところは下記の行です。
セッションにSPRING_SECURITY_SAVED_REQUESTという名前で、元のリクエストオブジェクト(SavedRequest)が登録されています。

SavedRequest savedRequest = (SavedRequest) session.getAttribute("SPRING_SECURITY_SAVED_REQUEST");

SavedRequestのgetRedirectUrlメソッドで認証後のリダイレクト先URL、getParameterMapメソッドでパラメータを取得できます。

String redirectUrl = savedRequest.getRedirectUrl();

Map<String, String[]> params = savedRequest.getParameterMap();
String[] values = params.get("param_a");

なお、この仕組み（認証後のリダイレクト）についてはSavedRequest s and the RequestCache Interfaceをご覧頂き、とくに**「ベストエフォート」アプローチ**という点、ご留意ください。

Under normal circumstances, you shouldn’t need to modify any of this functionality, but the saved-request handling is a "best-effort" approach and there may be situations which the default configuration isn’t able to handle. The use of these interfaces makes it fully pluggable from Spring Security 3.0 onwards.
------------------------------------------------------------------------------------
通常の状況では、この機能を変更する必要はありませんが、保存されたリクエストの処理は「ベストエフォート」アプローチであり、デフォルトの構成では処理できない状況もあります。 これらのインターフェイスを使用すると、Spring Security 3.0以降から完全にプラグイン可能になります。

Comments

[chu-mo]

ありがとうございます。
同様の実装をしたところ目的のURLやパラメータを取得できました。

１つ疑問に思ったのですが、
SavedRequest をセッションから取得するためのキー「SPRING_SECURITY_SAVED_REQUEST」はどうやってわかったのでしょうか？
リンク先で検索をかけても見つけられなかったので

[chu-mo]

すみません、自己解決できました。
「HttpSEssion SavedRequest」で検索したところ、stackoverflowさんで見つけられました。
https://stackoverflow.com/questions/5389274/spring-security-3-get-initially-requested-url

また、HttpSessionRequestCache のドキュメントに記載されていました。
https://docs.spring.io/spring-security/site/docs/4.2.13.RELEASE/apidocs/org/springframework/security/web/savedrequest/HttpSessionRequestCache.html#setSessionAttrName-java.lang.String-

答えが分かると見つけられますが、
これが答えであると判断するのはまだまだ私には難しかったようです。
ご教示ありがとうございました。