Spring Security SAML：在错误页面显示SAML令牌

嘿，我懂你想在错误页面显示SAML令牌来辅助调试的需求，基于你已经写的错误控制器雏形，我来给你补全实现细节，让你能顺利拿到并展示这些调试信息：

1. 完善错误控制器代码 #

首先把你的错误控制器补充完整，我们需要从请求中获取SAML相关的参数（通常是Base64编码的SAMLRequest或SAMLResponse），或者从Spring Security上下文里拿到SAML认证令牌，然后把这些数据传给错误页面：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.saml.SamlAuthenticationToken;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.http.HttpServletRequest;

@Controller
public class SamlErrorController {

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

    // 匹配系统默认的错误路径，你也可以自定义路径
    @RequestMapping("/error")
    public String handleError(HttpServletRequest request, Model model) {
        // 从请求参数获取SAML请求/响应
        String samlRequest = request.getParameter("SAMLRequest");
        String samlResponse = request.getParameter("SAMLResponse");
        
        // 尝试从Spring Security上下文获取完整的SAML认证令牌（如果错误发生在认证流程中）
        Authentication auth = SecurityContextHolder.getContext().getAuthentication();
        if (auth instanceof SamlAuthenticationToken) {
            SamlAuthenticationToken samlToken = (SamlAuthenticationToken) auth;
            // 将SAML令牌的凭证信息（通常是SAML断言）添加到模型
            model.addAttribute("samlTokenCredentials", samlToken.getCredentials());
            model.addAttribute("samlTokenDetails", samlToken.getDetails());
        }

        // 将SAML参数添加到模型供页面展示
        model.addAttribute("samlRequest", samlRequest);
        model.addAttribute("samlResponse", samlResponse);
        
        // 同时记录日志，方便后台调试
        logger.debug("Received SAML Request: {}", samlRequest);
        logger.debug("Received SAML Response: {}", samlResponse);

        return "error"; // 返回你的错误页面视图名称
    }
}

2. 编写错误页面视图（以Thymeleaf为例） #

接下来在你的错误页面（比如src/main/resources/templates/error.html）里，把模型中的SAML数据展示出来，记得对Base64编码的内容进行解码，这样看起来更直观：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>SAML Authentication Error</title>
    <style>
        pre {
            background-color: #f5f5f5;
            padding: 15px;
            border-radius: 4px;
            overflow-x: auto;
        }
    </style>
</head>
<body>
    <h1>Oops! SAML Authentication Error</h1>

    <!-- 展示SAML Request -->
    <div th:if="${samlRequest}">
        <h3>SAML Request (Base64 Encoded)</h3>
        <pre><code th:text="${samlRequest}"></code></pre>
        <h3>Decoded SAML Request</h3>
        <pre><code th:text="${#strings.decodeBase64(samlRequest)}"></code></pre>
    </div>

    <!-- 展示SAML Response -->
    <div th:if="${samlResponse}">
        <h3>SAML Response (Base64 Encoded)</h3>
        <pre><code th:text="${samlResponse}"></code></pre>
        <h3>Decoded SAML Response</h3>
        <pre><code th:text="${#strings.decodeBase64(samlResponse)}"></code></pre>
    </div>

    <!-- 展示完整的SAML令牌信息（如果存在） -->
    <div th:if="${samlTokenCredentials}">
        <h3>SAML Token Credentials</h3>
        <pre><code th:text="${samlTokenCredentials}"></code></pre>
    </div>
</body>
</html>

3. 注意事项 #

• 环境控制：生产环境绝对不要展示这些敏感的SAML数据！建议给错误控制器加上@Profile("dev")注解，只在开发调试环境启用这个功能：

  @Controller
  @Profile("dev")
  public class SamlErrorController { ... }
  

• 路径匹配：确保你的错误路径和Spring Boot的配置一致，默认是/error，如果自定义了server.error.path，要修改控制器的@RequestMapping路径。
• 模板引擎适配：如果你用的是Freemarker或其他模板引擎，需要调整页面的解码逻辑，比如Freemarker可以用<#assign decodedSamlRequest = samlRequest?base64_decode>来解码。

内容的提问来源于stack exchange，提问作者SGT Grumpy Pants