cn.dev33.satoken.sso

类 SaSsoUtil

java.lang.Object

cn.dev33.satoken.sso.SaSsoUtil

public class SaSsoUtil
extends java.lang.Object

Sa-Token-SSO 单点登录模块 工具类

作者:

kong

字段概要

字段

限定符和类型	字段和说明
static SaSsoTemplate	saSsoTemplate 底层 SaSsoTemplate 对象

构造器概要

构造器

构造器和说明
SaSsoUtil()

方法概要

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

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

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

字段详细资料

saSsoTemplate

public static SaSsoTemplate saSsoTemplate

底层 SaSsoTemplate 对象

构造器详细资料

SaSsoUtil

public SaSsoUtil()

方法详细资料

createTicket

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

根据 账号id 创建一个 Ticket码

参数:

loginId - 账号id

返回:

Ticket码

deleteTicket

public static void deleteTicket(java.lang.String ticket)

删除 Ticket

参数:

ticket - Ticket码

deleteTicketIndex

public static void deleteTicketIndex(java.lang.Object loginId)

删除 Ticket索引

参数:

loginId - 账号id

getLoginId

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

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

参数:

ticket - Ticket码

返回:

账号id

getLoginId

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

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

类型参数:

T - 要转换的类型

参数:

ticket - Ticket码

cs - 要转换的类型

返回:

账号id

checkTicket

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

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

参数:

ticket - Ticket码

返回:

账号id

getAllowUrl

public static java.lang.String getAllowUrl()

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

返回:

see note

checkRedirectUrl

public static void checkRedirectUrl(java.lang.String url)

校验重定向url合法性

参数:

url - 下放ticket的url地址

buildCheckTicketUrl

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

构建URL：校验ticket的URL

参数:

ticket - ticket码

ssoLogoutCallUrl - 单点注销时的回调URL

返回:

构建完毕的URL

registerSloCallbackUrl

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

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

参数:

loginId - 账号id

sloCallbackUrl - 单点注销时的回调URL

buildSloUrl

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

构建URL：单点注销URL

参数:

loginId - 要注销的账号id

返回:

单点注销URL

ssoLogout

public static void ssoLogout(java.lang.Object loginId)

指定账号单点注销

参数:

loginId - 指定账号

getUserinfo

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

获取：账号资料

参数:

loginId - 账号id

返回:

账号资料

buildServerAuthUrl

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

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

参数:

clientLoginUrl - Client端登录地址

back - 回调路径

返回:

[SSO-Server端-认证地址 ]

buildRedirectUrl

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

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

参数:

loginId - 账号id

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

返回:

see note

buildUserinfoUrl

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

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

参数:

loginId - 账号id

返回:

Server端 账号资料查询地址

request

public static SaResult request(java.lang.String url)

发出请求，并返回 SaResult 结果

参数:

url - 请求地址

返回:

返回的结果

checkSecretkey

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

已过时。

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

参数:

secretkey - 秘钥

getSign

public static 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 static java.lang.String addSignParams(java.lang.String url,
                                             java.lang.Object loginId)

给 url 追加 sign 等参数

参数:

url - 连接

loginId - 账号id

返回:

加工后的url

checkSign

public static void checkSign(SaRequest req)

校验签名

参数:

req - request

checkTimestamp

public static void checkTimestamp(long timestamp)

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

参数:

timestamp - 时间戳