https://github.com/baomidou/shaun
基于 pac4j-jwt 的 WEB 安全组件
https://github.com/baomidou/shaun
Last synced: 6 months ago
JSON representation
基于 pac4j-jwt 的 WEB 安全组件
- Host: GitHub
- URL: https://github.com/baomidou/shaun
- Owner: baomidou
- License: apache-2.0
- Created: 2024-05-26T12:04:05.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-05T03:20:30.000Z (over 1 year ago)
- Last Synced: 2025-04-23T01:54:26.241Z (6 months ago)
- Language: Java
- Size: 937 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
基于 pac4j-jwt 的 WEB 安全组件
# 简介
主要依托 `pac4j-jwt` 来提供默认使用 `JWT` 的 WEB 安全组件
| JDK | shaun | spring boot |
|-----|-------|-------------|
| 17 | 2.x | 3.x |
| 8 | 1.x | 2.x |
# 优点
- 迅速集成,只需要少量配置+代码即可实现基本的接口防护
- 默认使用 `jwt` 进行身份认证
- 灵活的 `jwt` 配置,默认`签名`+`加密`
- 更多高级功能只需实现对应接口并注入到spring容器内
- 本框架各类均不会使用`session`(`pac4j`提供的类除外)
- 前后端不分离下,能依托`pac4j`的各种client快速集成三方登录(redirect跳转那种),例如oauth(qq,微信) 和 cas。
# 模块简介
- shaun-core: 核心包。
- shaun-togglz: 提供对 `togglz` 的 `UserProvider` 一个实现类
- shaun-spring-boot-starter: spring boot 快速启动包。
- tests下: 各种测试演示。
# 安装
1. 引入: shaun-spring-boot-starter 和 spring-boot-starter-web
``` xml
com.baomidou
shaun-spring-boot-starter
Latest Version
org.springframework.boot
spring-boot-starter-web
spring-boot-version
```
2. 配置 `application.yml`
> 详情查看 wiki
```yaml
shaun:
......
security:
......
actuator:
......
thirdParty:
......
```
> 更多 yml 配置[点此查看](https://gitee.com/baomidou/shaun/blob/master/shaun-spring-boot-starter/src/main/java/com/baomidou/shaun/autoconfigure/properties/ShaunProperties.java)
3. 编写登陆代码
``` java
import com.baomidou.shaun.core.mgt.SecurityManager;
@Service
public class LoginServiceImpl implements LoginService {
@Autowired
private SecurityManager securityManager;
@Override
@Transactional
public String login() {
// 登录成功后把用户角色权限信息存储到profile中
final TokenProfile profile = new TokenProfile();
profile.setId(userId.toString());
//profile.addRole(role:String);
//profile.setRoles(roles:Set);
//profile.addPermission(permission:String);
//profile.setPermissions(permissions:Set);
//profile.addAttribute("key","value");
final String token = securityManager.login(profile);
//如果选择token存cookie里,securityManager.login会进行自动操作
return token;
}
```
4. 注解权限拦截:
> `@HasAuthorization` , `@HasPermission` , `@HasRole`
>> 支持注解在`method`上以及`class`上
例:
``` java
@HasPermission(value = {"add", "edit"}, logical = Logical.BOTH) //权限必须同时存在
@HasPermission(value = {"add", "edit"}, logical = Logical.ANY) //权限任一存在(默认)
```
5. 如何获取用户信息(不需要安全拦截的接口获取不到哦)
```java
TokenProfile profile = ProfileHolder.getProfile();