lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2025-10-26 18:49:01 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

优化注释和文档

Browse Source
This commit is contained in:
click33
2021-09-29 23:43:01 +08:00
parent 713e11482c
commit b7dba13cab
9 changed files with 154 additions and 160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
sa-token-doc/doc/index.html
View File

@@ -79,6 +79,7 @@
errorText: '错误',
successText: '复制成功'
},
topMargin: 90, // 锚点距离顶部的距离
// sidebarDisplayLevel : 1 , // 设置侧边栏显示级别
// search: 'auto', // 搜索功能
alias: {

2
sa-token-doc/doc/sso/sso-check-domain.md
View File

@@ -39,5 +39,5 @@
### 4、疑问：为什么不直接回传 Token，而是先回传 Ticket，再用 Ticket 去查询对应的账号id？
Token 作为长时间有效的会话凭证，在任何时候都不应该直接暴露在 URL 之中（虽然 Token 直接的暴露本身不会造成安全漏洞，但会为很多漏洞提供可乘之机）
因此 Sa-Token-SSO 选择先回传 Ticket，再由 Ticket 获取账号id，且 Ticket 一次性用完即废，提高安全性
为了不让系统安全处于亚健康状态，Sa-Token-SSO 选择先回传 Ticket，再由 Ticket 获取账号id，且 Ticket 一次性用完即废，提高安全性。

36
sa-token-doc/doc/use/config.md
View File

@@ -99,18 +99,30 @@ PS：两者的区别在于：**`方式1会覆盖yml中的配置，方式2会与y
### 单点登录相关配置
| 参数名称 | 类型 | 默认值 | 所属端 | 说明 |
| :-------- | :-------- | :-------- | :-------- | :-------- |
| ticketTimeout | long | 300 | Server端 | Ticket有效期 (单位: 秒) |
| allowUrl | String | * | Server端 | 所有允许的授权回调地址，多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)，参考：[SSO整合：配置域名校验](/sso/sso-check-domain) |
| secretkey | String | null | Server端 & Client端 | 调用秘钥 (用于SSO模式三单点注销的接口通信身份校验) |
| authUrl | String | null | Client端 | SSO-Server端 单点登录地址 |
| isHttp | Boolean | false | Server端 & Client端 | 是否使用http请求校验ticket值 |
| checkTicketUrl| String | null | Client端 | SSO-Server端 Ticket校验地址 |
| isSlo | Boolean | false | Client端 | 是否打开单点注销功能 |
| sloUrl | String | null | Client端 | SSO-Server端 单点注销地址 |
| ssoLogoutCall | String | null | Client端 | SSO-Client端 当前Client端的单点注销回调URL （为空时自动获取） |
| userinfoUrl | String | null | Client端 | SSO-Server端 查询userinfo地址 |
Server 端：
| 参数名称 | 类型 | 默认值 | 说明 |
| :-------- | :-------- | :-------- | :-------- |
| ticketTimeout | long | 300 | ticket 有效期 （单位: 秒） |
| allowUrl | String | * | 所有允许的授权回调地址，多个用逗号隔开（不在此列表中的URL将禁止下放ticket），参考：[SSO整合：配置域名校验](/sso/sso-check-domain) |
| isSlo | Boolean | false | 是否打开单点注销功能 |
| isHttp | Boolean | false | 是否打开模式三（此值为 true 时将使用 http 请求：校验ticket值、单点注销、获取userinfo） |
| secretkey | String | null | 调用秘钥 （用于SSO模式三单点注销的接口通信身份校验） |
Client 端：
| 参数名称 | 类型 | 默认值 | 说明 |
| :-------- | :-------- | :-------- | :-------- |
| authUrl | String | null | 配置 Server 端单点登录授权地址 |
| isSlo | Boolean | false | 是否打开单点注销功能 |
| isHttp | Boolean | false | 是否打开模式三（此值为 true 时将使用 http 请求：校验ticket值、单点注销、获取userinfo） |
| checkTicketUrl| String | null | 配置 Server 端的 ticket 校验地址 |
| userinfoUrl | String | null | 配置 Server 端查询 userinfo 地址 |
| sloUrl | String | null | 配置 Server 端单点注销地址 |
| ssoLogoutCall | String | null | 配置当前 Client 端的单点注销回调URL （为空时自动获取） |
| secretkey | String | null | 接口调用秘钥 （用于SSO模式三单点注销的接口通信身份校验） |
配置示例：
``` yml