sa-token/sa-token-doc/sso/sso-diff-key.md

4.7 KiB
Raw Blame History

不同 SSO Client 配置不同秘钥

在校验 ticket、单点注销等操作发起的 http 调用时,需要配置秘钥参数,像这样:

sa-token: 
    sign:
        # API 接口调用秘钥
        secret-key: kQwIOrYvnXmSDkwEiFngrKidMcdrgKor
# 接口调用秘钥 
sa-token.sign.secret-key=kQwIOrYvnXmSDkwEiFngrKidMcdrgKor

如果 SSO Client 端和 SSO Server 端配置的秘钥不同,则无法调通请求,显示无效签名:

{
  "code": 500,
  "msg": "无效签名9f1b453817bfeac56d2f772a66c01eb2",
  "data": null
}

如果你有多个 SSO Client你可能想让每个应用配置不同的秘钥让它们彼此之间不能互相“冒充”怎么做呢

1、首先在 SSO Client 端,你需要配置上不同的 Client 标识参数:

例如在 client1 我们配置上:

sa-token:
    sso-client:
        # 当前 client 标识
        client: sso-client1
        # ... 
    sign:
        # sso-client1 使用的秘钥 
        secret-key: secret-key-xxxx-1
# 当前 client 标识
sa-token.sso-client.client=sso-client1

# sso-client1 使用的秘钥 
sa-token.sign.secret-key=secret-key-xxxx-1

在 client2 我们配置上:

sa-token:
    sso-client:
        # 当前 client 标识
        client: sso-client2
        # ... 
    sign:
        # sso-client2 使用的秘钥 
        secret-key: secret-key-xxxx-2
# 当前 client 标识
sa-token.sso-client.client=sso-client2

# sso-client2 使用的秘钥 
sa-token.sign.secret-key=secret-key-xxxx-2

2、然后在 SSO Server 端,重写获取秘钥的函数

在 SSO Server 端新建 CustomSaSsoServerTemplate.java,继承 SaSsoServerTemplate,重写其 getSignTemplate 函数:

/**
 * 自定义 SaSsoServerTemplate 子类 
 */
@Component
public class CustomSaSsoServerTemplate extends SaSsoServerTemplate {

	// 存储所有 client 的秘钥 
    static Map<String, SaSignTemplate> signMap = new HashMap<>();
    static {
        signMap.put("sso-client1", new SaSignTemplate(new SaSignConfig("secret-key-xxxx-1")));
        signMap.put("sso-client2", new SaSignTemplate(new SaSignConfig("secret-key-xxxx-2")));
        signMap.put("sso-client3", new SaSignTemplate(new SaSignConfig("secret-key-xxxx-3")));
		// ... 
    }

    @Override
    public SaSignTemplate getSignTemplate(String client) {
        // 先从自定义的 signMap 中获取
        SaSignTemplate saSignTemplate = signMap.get(client);
        if (saSignTemplate != null) {
            return saSignTemplate;
        }
        // 找不到就返回全局默认的 SaSignTemplate
        return SaManager.getSaSignTemplate();
    }
}

至此完成。

3、其它注意点

有同学反馈,集成 “不同 SSO Client 配置不同秘钥” 模式后,客户端发起调用 /sso/getData 调用时会报如下错误:

无效签名5a7fc42836deba12d96527d43c1301ea

或者:

参与参数签名的秘钥不可为空

这大概率是因为在 sso-server 端的 /sso/getData 接口在校验签名时忘了加 client 参数导致的,修改为如下代码即可:

// 示例:获取数据接口(用于在模式三下,为 client 端开放拉取数据的接口)
@RequestMapping("/sso/getData")
public SaResult getData(String apiType, String loginId) {
    System.out.println("---------------- 获取数据 ----------------");
    System.out.println("apiType=" + apiType);
    System.out.println("loginId=" + loginId);

    // ↓↓↓ 重点代码 ↓↓↓
    // 校验签名:只有拥有正确秘钥发起的请求才能通过校验  
    String client = SaHolder.getRequest().getHeader("client");
    SaSsoServerProcessor.instance.ssoServerTemplate.getSignTemplate(client).checkRequest(SaHolder.getRequest());
    // ↑↑↑ 重点代码 ↑↑↑

    // 自定义返回结果(模拟)
    return SaResult.ok()
            .set("id", loginId)
            .set("name", "LinXiaoYu")
            .set("sex", "女")
            .set("age", 18);
}