[home]开源官网初始化
This commit is contained in:
tomsun28
@@ -0,0 +1,81 @@
|
||||
---
|
||||
id: custom-datasource
|
||||
title: 自定义数据源
|
||||
sidebar_label: 自定义数据源
|
||||
---
|
||||
|
||||
## 自定义数据源
|
||||
|
||||
自定义前建议了解`sureness`处理流程和提供的扩展接口,详见 [进阶扩展](/docs/advanced/extend-point)
|
||||
|
||||
- `PathTreeProvider`: 资源的数据源接口,实现从数据库,文本等加载数据,加载到对应的资源权限匹配器`DefaultPathRoleMatcher`中
|
||||
- `SurenessAccountProvider`: 用户的账户密钥信息接口,实现从数据库,文本等加载数据，加载到需要账户数据的`processor`中
|
||||
|
||||
|
||||
首先我们先来认识下sureness提供的两个用户信息和资源权限信息的接口，用户可以实现这些接口自定义从不同的数据源给sureness提供数据。
|
||||
当我们把项目从配置文件模式切换成数据库模式时，也只是简单替换了这些接口的实现类而已。
|
||||
|
||||
一. `PathTreeProvider` 资源权限配置信息的数据源接口,我们可以实现从数据库,文本等加载接口想要的资源权限配置数据
|
||||
|
||||
````
|
||||
public interface PathTreeProvider {
|
||||
|
||||
Set<String> providePathData();
|
||||
|
||||
Set<String> provideExcludedResource();
|
||||
}
|
||||
|
||||
````
|
||||
|
||||
此接口主要是需要实现上面这两个方法，providePathData是加载资源权限配置信息，也就是我们配置文件模式下sureness.yml的resourceRole信息列，
|
||||
provideExcludedResource是加载哪些资源可以被过滤不认证鉴权，也就是sureness.yml下的excludedResource信息列，如下。
|
||||
|
||||
````
|
||||
resourceRole:
|
||||
- /api/v2/host===post===[role2,role3,role4]
|
||||
- /api/v2/host===get===[role2,role3,role4]
|
||||
- /api/v2/host===delete===[role2,role3,role4]
|
||||
- /api/v2/host===put===[role2,role3,role4]
|
||||
- /api/mi/**===put===[role2,role3,role4]
|
||||
- /api/v1/getSource1===get===[role1,role2]
|
||||
- /api/v2/getSource2/*/*===get===[role2]
|
||||
|
||||
excludedResource:
|
||||
- /api/v1/source3===get
|
||||
- /api/v3/host===get
|
||||
- /**/*.css===get
|
||||
- /**/*.ico===get
|
||||
- /**/*.png===get
|
||||
````
|
||||
|
||||
而当我们使用数据库模式时，实现这些信息从数据库关联读取就ok了，规范返回 eg: /api/v2/host===post===[role2,role3,role4] 格式的数据列，
|
||||
具体的数据库实现类参考类 - [DatabasePathTreeProvider](https://github.com/tomsun28/sureness/blob/master/sample-tom/src/main/java/com/usthe/sureness/sample/tom/sureness/provider/DatabasePathTreeProvider.java)
|
||||
|
||||
二. `SurenessAccountProvider`这第二个相关的接口就是用户的账户密钥信息提供接口,我们需要实现从数据库或者文本等其他数据源那里去加载我们想要的用户的账户信息数据，
|
||||
这些数据提供需要账户数据的processor进行用户的认证。
|
||||
|
||||
````
|
||||
public interface SurenessAccountProvider {
|
||||
SurenessAccount loadAccount(String appId);
|
||||
}
|
||||
````
|
||||
此接口主要需要实现上面这个loadAccount方法，通过用户的唯一标识appid来从数据库或者redis缓存中查找到用户的账户信息返回即可。
|
||||
用户账户信息类SurenessAccount如下：
|
||||
|
||||
````
|
||||
public class DefaultAccount implements SurenessAccount {
|
||||
|
||||
private String appId;
|
||||
private String password;
|
||||
private String salt;
|
||||
private List<String> ownRoles;
|
||||
private boolean disabledAccount;
|
||||
private boolean excessiveAttempts;
|
||||
}
|
||||
````
|
||||
|
||||
比较简单，主要是需要提供用户的密码相关信息即可，供sureness认证时密钥判断正确与否。
|
||||
这个具体的数据库接口实现可参考类 - [DatabaseAccountProvider](https://github.com/tomsun28/sureness/blob/master/sample-tom/src/main/java/com/usthe/sureness/sample/tom/sureness/provider/DatabaseAccountProvider.java)
|
||||
|
||||
|
||||
具体扩展实践请参考 [Springboot项目集成-数据库方案](/docs/integrate/sample-tom)
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: custom-processor
|
||||
title: 自定义processor
|
||||
sidebar_label: 自定义processor
|
||||
---
|
||||
|
||||
processor就是对请求的用户账户信息subject真正的认证鉴权处理器，我们需要实现BaseProcessor接口，来实现我们自定义的认证鉴权方式。
|
||||
sureness已经内置基于账户密码认证方式处理PasswordSubject的PasswordProcessor，基于jwt认证方式处理JwtSubject的JwtProcessor等。
|
||||
|
||||
自定义前建议了解`sureness`处理流程和提供的扩展接口,详见 [进阶扩展](/docs/advanced/extend-point)
|
||||
|
||||
- `Processor`: `Subject`处理接口,根据Subject信息,进行认证鉴权
|
||||
|
||||
```
|
||||
public abstract class BaseProcessor implements Processor{
|
||||
|
||||
public abstract boolean canSupportSubjectClass(Class<?> var);
|
||||
|
||||
public abstract Subject authenticated (Subject var) throws SurenessAuthenticationException;
|
||||
|
||||
public abstract void authorized(Subject var) throws SurenessAuthorizationException;
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
上面就是BaseProcessor的一些重要接口方法，自定义processor需要我们去实现这些方法。
|
||||
|
||||
- `canSupportSubjectClass` 判断是否支持入参的此Subject类类型，比如 JwtProcessor只支持JwtSubject, PasswordProcessor只支持PasswordSubject
|
||||
- `authenticated` 对subject进行认证，根据传入的subject信息和系统内信息，进行请求用户的账户认证
|
||||
- `authorized` 对subject进行鉴权，鉴权判断此用户是否拥有其访问api的访问权限
|
||||
|
||||
sureness使用异常流程模型，以上的认证失败或鉴权失败都会抛出不同类型的异常，用户在最外部捕获判断实现接下来的流程。
|
||||
|
||||
sureness默认异常类型参考 [默认异常类型](/docs/start/default-exception)
|
||||
具体扩展实践请参考 [Springboot项目集成-数据库方案](/docs/integrate/sample-tom)
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
id: custom-subject-creator
|
||||
title: 自定义subject creator
|
||||
sidebar_label: 自定义subject creator
|
||||
---
|
||||
|
||||
自定义`subject creator`是我们使用频率最高的扩展，当请求体对象并不是`servlet`或者`jax-rs`标准`api`时，
|
||||
或者我们从request请求的不同地方获取账户信息时，我们就需要自定义`subject creator`,
|
||||
使其通过请求对象获取我们需要的请求信息(请求路径，请求方法，认证信息等), 从而创建出对应的`subject`.
|
||||
|
||||
sureness已经内置能创建出基于账户密码的PasswordSubject的BasicSubjectServletCreator，
|
||||
和创建出jwt类型JwtSubject的JwtSubjectServletCreator等，当然我们可以自定义自己需要的subjectCreator来创建subject
|
||||
|
||||
自定义前建议了解`sureness`处理流程和提供的扩展接口,详见 [进阶扩展](/docs/advanced/extend-point)
|
||||
|
||||
- `SubjectCreate`: 创建`Subject`接口,根据请求内容创建不同类型的`Subject`对象
|
||||
|
||||
实现`SubjectCreate`接口方法,根据request请求的内容创建出对应需要的的`subject`
|
||||
|
||||
具体扩展实践请参考 [sample-spring-webflux项目集成案例](/docs/integrate/sample-spring-webflux)
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
id: custom-subject
|
||||
title: 自定义subject
|
||||
sidebar_label: 自定义subject
|
||||
---
|
||||
|
||||
subject包含的就是我们request请求所带的用户信息，sureness已经内置基于账户密码的PasswordSubject，
|
||||
基于jwt的JwtSubject等，当然我们可以自定义自己需要的subject来扩充自己的用户信息
|
||||
|
||||
自定义前建议了解`sureness`处理流程和提供的扩展接口,详见 [进阶扩展](/docs/advanced/extend-point)
|
||||
|
||||
- `Subject`: 认证鉴权对象接口,提供访问对象的账户密钥,请求资源,角色等信息
|
||||
|
||||
自定义subject需要走以下流程：
|
||||
|
||||
1. 实现`Subject`接口,添加自定义的`subject`内容
|
||||
2. 实现`SubjectCreate`接口方法,创建出自定义的`subject` 参考[自定义Subject Creator](/docs/advanced/custom-subject-creator)
|
||||
3. 实现`Processor`接口,支持处理自定义的`subject` 参考[自定义Processor](/docs/advanced/custom-processor)
|
||||
|
||||
具体扩展实践请参考 [使用sureness30分钟项目集成案例](/docs/integrate/sample-tom)
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
id: extend-point
|
||||
title: 进阶扩展
|
||||
sidebar_label: 扩展点
|
||||
---
|
||||
|
||||
`sureness`支持自定义`subject`，自定义注册`subjectCreator`，自定义`processor`处理器，自定义数据源加载器等。
|
||||
|
||||
进阶自定义扩展之前我们先来了解下sureness的大致流程：
|
||||
|
||||
|
||||
|
||||
如上面的流程所讲，Subject被SubjectCreate根据request请求体所创造，不同的认证鉴权处理器Processor来处理所支持的Subject。
|
||||
|
||||
|
||||
sureness提供了下面这些常用接口作为扩展点:
|
||||
|
||||
- `Subject`: 认证鉴权对象接口,提供访问对象的账户密钥,请求资源,角色等信息
|
||||
- `SubjectCreate`: 创建`Subject`接口,根据请求内容创建不同类型的`Subject`对象
|
||||
- `Processor`: `Subject`处理接口,根据Subject信息,进行认证鉴权
|
||||
- `PathTreeProvider`: 资源的数据源接口,实现从数据库,文本等加载数据
|
||||
- `SurenessAccountProvider`: 用户的账户密钥信息接口,实现从数据库,文本等加载数据
|
||||
Reference in New Issue
Block a user