hsweb-authorization/hsweb-authorization-basic/README.md
使用hsweb-authorization-api提供的监听器,类UserOnSignIn监听用户授权事件AuthorizationSuccessEvent
当用户完成授权(授权方式可自行实现或者使用框架默认的授权方式,主要触发该事件即可).授权通过后会触发该事件.流程如下
AuthorizationSuccessEventUserOnSignIn 收到AuthorizationSuccessEvent事件,获取参数token_type(默认为sessionId),以及授权信息token_type 生成token.UserTokenManagerAopAuthorizingController aop拦截所有controller方法(注解了:Controller或者RestController的类的方法)MethodInterceptorContext)传给权限定义解析器(AopMethodAuthorizeDefinitionParser)
进行解析AopMethodAuthorizeDefinitionCustomizerParser获取自定义的配置(实现AopMethodAuthorizeDefinitionCustomizerParser接口并注入到spring即可,自定义未进行缓存,请自行实现缓存策略)
如果没有,则获取缓存,如果缓存不存在就开始解析方法以及类上的注解,并放入缓存后返回权限配AuthorizingHandler进行权限控制DefaultAuthorizingHandler,将分别进行RBAC,数据权限,表达式方式的权限控制.AccessDenyException异常配置 application.yml
hsweb:
authorize:
two-factor:
enable: true
在需要验证的接口上注解:
@PostMapping
@TwoFactor("update-password")
public ResponseMessage<Boolean> updatePassword(String password){
//
}
与授权同理,类UserOnSignOut监听AuthorizationExitEvent ,当触发事件后,调用UserTokenManager移除当前登录的token信息
默认对注解Authorize进行实现,具体功能,请查看源代码
原理: 通过用户的权限信息,对aop拦截到的参数进行操作
约束: 对方法的参数有要求,如动态查询需要有参数QueryParamEntity,controller需要实现hsweb-commons-controller中提供的通用controller等
例如:用户设置了 机构管理权限(org)只能查询(query)自己和下属的机构.
通过获取拦截到方法的动态查询参数QueryParamEntity,对参数进行重构,
客户端的查询条件翻译为sql:
where name like ? or full_name like
重构后为:
--u_id in (用户可访问的机构id)
where u_id in(?,?,?) and (name like ? or full_name like)
http接口: POST /authorize/login, 登录接口支持2种content-type,application/json(Json RequestBody方式)和application/x-www-form-urlencoded(表单方式),
请在调用等时候指定对应等content-type.必要参数: username 和 password.
⚠️注意: 此接口只实现了简单的登录逻辑,不过会通过发布各种事件来实现自定义的逻辑处理.
AuthorizationDecodeEvent 在接收到登录请求之后触发,如果在登录前对用户名密码进行里加密,可以通过监听此事件实现对用户名密码的解密操作AuthorizationBeforeEvent 在AuthorizationDecodeEvent事件完成后触发,可通过监听此事件并获取请求参数,实现验证码功能AuthorizationSuccessEvent 在授权成功后触发.注意: 权限控制模块也是通过监听此事件来完成授权AuthorizationFailedEvent 授权失败时触发.当发生过程中异常时触发此事件什么? 还不知道如何监听事件? 快看这里
此模块默认使用sessionId绑定用户信息。还可以使用 jwt 方式