cn.dev33.satoken.sso

类 SaSsoTemplate

java.lang.Object

cn.dev33.satoken.sso.SaSsoTemplate

public class SaSsoTemplate
extends java.lang.Object

Sa-Token-SSO 单点登录模块

作者:

kong

字段概要

字段

限定符和类型	字段和说明
StpLogic	stpLogic 单点登录模块使用的 StpLogic 对象

构造器概要

构造器

构造器和说明
SaSsoTemplate()
SaSsoTemplate(StpLogic stpLogic)

方法概要

限定符和类型	方法和说明
java.lang.String	addSignParams(java.lang.String url, java.lang.Object loginId) 给 url 追加 sign 等参数
java.lang.String	buildCheckTicketUrl(java.lang.String ticket, java.lang.String ssoLogoutCallUrl) 构建URL：校验ticket的URL 在模式三下，Client端拿到Ticket后根据此地址向Server端发送请求，获取账号id
java.lang.String	buildRedirectUrl(java.lang.Object loginId, java.lang.String redirect) 构建URL：Server端向Client下放ticke的地址
java.lang.String	buildServerAuthUrl(java.lang.String clientLoginUrl, java.lang.String back) 构建URL：Server端 单点登录地址
java.lang.String	buildSloUrl(java.lang.Object loginId) 构建URL：单点注销URL
java.lang.String	buildUserinfoUrl(java.lang.Object loginId) 构建URL：Server端 账号资料查询地址
void	checkRedirectUrl(java.lang.String url) 校验重定向url合法性
void	checkSecretkey(java.lang.String secretkey) 已过时。
void	checkSign(SaRequest req) 校验签名
java.lang.Object	checkTicket(java.lang.String ticket) 校验ticket码，获取账号id，如果此ticket是有效的，则立即删除
void	checkTimestamp(long timestamp) 校验时间戳与当前时间的差距是否超出限制
java.lang.String	createTicket(java.lang.Object loginId) 根据 账号id 创建一个 Ticket码
void	deleteTicket(java.lang.String ticket) 删除 Ticket
void	deleteTicketIndex(java.lang.Object loginId) 删除 Ticket索引
java.lang.String	encodeBackParam(java.lang.String url) 对url中的back参数进行URL编码, 解决超链接重定向后参数丢失的bug
java.lang.String	getAllowUrl() 获取：所有允许的授权回调地址，多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)
java.lang.Object	getLoginId(java.lang.String ticket) 根据 Ticket码 获取账号id，如果Ticket码无效则返回null
<T> T	getLoginId(java.lang.String ticket, java.lang.Class<T> cs) 根据 Ticket码 获取账号id，并转换为指定类型
java.lang.String	getSecretkey() 获取：接口调用秘钥
java.lang.String	getSign(java.lang.Object loginId, java.lang.String timestamp, java.lang.String nonce, java.lang.String secretkey) 根据参数计算签名
java.lang.String	getTicketValue(java.lang.Object loginId) 查询 指定账号id的 Ticket值
java.lang.Object	getUserinfo(java.lang.Object loginId) 获取：账号资料
java.lang.String	randomTicket(java.lang.Object loginId) 随机一个 Ticket码
void	registerSloCallbackUrl(java.lang.Object loginId, java.lang.String sloCallbackUrl) 为指定账号id注册单点注销回调URL
SaResult	request(java.lang.String url) 发出请求，并返回 SaResult 结果
void	saveTicket(java.lang.String ticket, java.lang.Object loginId) 保存 Ticket
void	saveTicketIndex(java.lang.String ticket, java.lang.Object loginId) 保存 Ticket 索引
java.lang.String	splicingTicketIndexKey(java.lang.Object id) 拼接key：账号Id 反查 Ticket
java.lang.String	splicingTicketSaveKey(java.lang.String ticket) 拼接key：Ticket 查 账号Id
void	ssoLogout(java.lang.Object loginId) 指定账号单点注销

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

stpLogic

public StpLogic stpLogic

单点登录模块使用的 StpLogic 对象

构造器详细资料

SaSsoTemplate

public SaSsoTemplate(StpLogic stpLogic)

SaSsoTemplate

public SaSsoTemplate()

方法详细资料

createTicket

public java.lang.String createTicket(java.lang.Object loginId)

根据 账号id 创建一个 Ticket码

参数:

loginId - 账号id

返回:

Ticket码

saveTicket

public void saveTicket(java.lang.String ticket,
                       java.lang.Object loginId)

保存 Ticket

参数:

ticket - ticket码

loginId - 账号id

saveTicketIndex

public void saveTicketIndex(java.lang.String ticket,
                            java.lang.Object loginId)

保存 Ticket 索引

参数:

ticket - ticket码

loginId - 账号id

deleteTicket

public void deleteTicket(java.lang.String ticket)

删除 Ticket

参数:

ticket - Ticket码

deleteTicketIndex

public void deleteTicketIndex(java.lang.Object loginId)

删除 Ticket索引

参数:

loginId - 账号id

getLoginId

public java.lang.Object getLoginId(java.lang.String ticket)

根据 Ticket码 获取账号id，如果Ticket码无效则返回null

参数:

ticket - Ticket码

返回:

账号id

getLoginId

public <T> T getLoginId(java.lang.String ticket,
                        java.lang.Class<T> cs)

根据 Ticket码 获取账号id，并转换为指定类型

类型参数:

T - 要转换的类型

参数:

ticket - Ticket码

cs - 要转换的类型

返回:

账号id

getTicketValue

public java.lang.String getTicketValue(java.lang.Object loginId)

查询 指定账号id的 Ticket值

参数:

loginId - 账号id

返回:

Ticket值

checkTicket

public java.lang.Object checkTicket(java.lang.String ticket)

校验ticket码，获取账号id，如果此ticket是有效的，则立即删除

参数:

ticket - Ticket码

返回:

账号id

randomTicket

public java.lang.String randomTicket(java.lang.Object loginId)

随机一个 Ticket码

参数:

loginId - 账号id

返回:

Ticket码

getAllowUrl

public java.lang.String getAllowUrl()

获取：所有允许的授权回调地址，多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)

返回:

see note

checkRedirectUrl

public void checkRedirectUrl(java.lang.String url)

校验重定向url合法性

参数:

url - 下放ticket的url地址

registerSloCallbackUrl

public void registerSloCallbackUrl(java.lang.Object loginId,
                                   java.lang.String sloCallbackUrl)

为指定账号id注册单点注销回调URL

参数:

loginId - 账号id

sloCallbackUrl - 单点注销时的回调URL

ssoLogout

public void ssoLogout(java.lang.Object loginId)

指定账号单点注销

参数:

loginId - 指定账号

getUserinfo

public java.lang.Object getUserinfo(java.lang.Object loginId)

获取：账号资料

参数:

loginId - 账号id

返回:

账号资料

buildServerAuthUrl

public java.lang.String buildServerAuthUrl(java.lang.String clientLoginUrl,
                                           java.lang.String back)

构建URL：Server端 单点登录地址

参数:

clientLoginUrl - Client端登录地址

back - 回调路径

返回:

[SSO-Server端-认证地址 ]

buildRedirectUrl

public java.lang.String buildRedirectUrl(java.lang.Object loginId,
                                         java.lang.String redirect)

构建URL：Server端向Client下放ticke的地址

参数:

loginId - 账号id

redirect - Client端提供的重定向地址

返回:

see note

encodeBackParam

public java.lang.String encodeBackParam(java.lang.String url)

对url中的back参数进行URL编码, 解决超链接重定向后参数丢失的bug

参数:

url - url

返回:

编码过后的url

buildUserinfoUrl

public java.lang.String buildUserinfoUrl(java.lang.Object loginId)

构建URL：Server端 账号资料查询地址

参数:

loginId - 账号id

返回:

Server端 账号资料查询地址

buildCheckTicketUrl

public java.lang.String buildCheckTicketUrl(java.lang.String ticket,
                                            java.lang.String ssoLogoutCallUrl)

构建URL：校验ticket的URL

在模式三下，Client端拿到Ticket后根据此地址向Server端发送请求，获取账号id

参数:

ticket - ticket码

ssoLogoutCallUrl - 单点注销时的回调URL

返回:

构建完毕的URL

buildSloUrl

public java.lang.String buildSloUrl(java.lang.Object loginId)

构建URL：单点注销URL

参数:

loginId - 要注销的账号id

返回:

单点注销URL

splicingTicketSaveKey

public java.lang.String splicingTicketSaveKey(java.lang.String ticket)

拼接key：Ticket 查 账号Id

参数:

ticket - ticket值

返回:

key

splicingTicketIndexKey

public java.lang.String splicingTicketIndexKey(java.lang.Object id)

拼接key：账号Id 反查 Ticket

参数:

id - 账号id

返回:

key

request

public SaResult request(java.lang.String url)

发出请求，并返回 SaResult 结果

参数:

url - 请求地址

返回:

返回的结果

getSecretkey

public java.lang.String getSecretkey()

获取：接口调用秘钥

返回:

see note

checkSecretkey

@Deprecated
public void checkSecretkey(java.lang.String secretkey)

已过时。

校验secretkey秘钥是否有效 （API已过期，请更改为更安全的 sign 式校验）

参数:

secretkey - 秘钥

getSign

public java.lang.String getSign(java.lang.Object loginId,
                                java.lang.String timestamp,
                                java.lang.String nonce,
                                java.lang.String secretkey)

根据参数计算签名

参数:

loginId - 账号id

timestamp - 当前时间戳，13位

nonce - 随机字符串

secretkey - 账号id

返回:

签名

addSignParams

public java.lang.String addSignParams(java.lang.String url,
                                      java.lang.Object loginId)

给 url 追加 sign 等参数

参数:

url - 连接

loginId - 账号id

返回:

加工后的url

checkSign

public void checkSign(SaRequest req)

校验签名

参数:

req - request

checkTimestamp

public void checkTimestamp(long timestamp)

校验时间戳与当前时间的差距是否超出限制

参数:

timestamp - 时间戳