diff --git a/README_CN.md b/README_CN.md index 7c928a130554467a51b2b0854b99c86213648729..8d47e79df5eda915ab7f07f8cde9a7ef79ad41c7 100644 --- a/README_CN.md +++ b/README_CN.md @@ -158,6 +158,8 @@ try { **HAVE FUN** +> 如果这个[快速开始]对您不是很友好,可以参考这篇[一步一步搭建](docs/cn/step-by-step.md),里面一步一步详细介绍了使用sureness搭建一个完整功能认证鉴权项目的步骤。 + ## 进阶扩展 如果了解 [处理流程](docs/cn/design.md),就大概知道`sureness`提供的扩展点 diff --git a/docs/cn/_coverpage.md b/docs/cn/_coverpage.md index ec47b782dcc82854193eba573829ec53fdd88eda..4a7971e5f89ba03fc4d886e9d832b5a35ab4dd7c 100644 --- a/docs/cn/_coverpage.md +++ b/docs/cn/_coverpage.md @@ -2,13 +2,12 @@ # sureness 0.4.4 for jvm -> 面向`restful api`的高性能认证鉴权框架. +> 面向`restful api`的高性能认证鉴权框架 -- 基于 `rbac` (用户-角色-资源)主要关注于对 `restful api` 的安全保护 -- 无特定框架依赖(`springboot,quarkus,javalin,ktor`等集成样例) -- 支持主流`http`容器 `servlet` 和 `jax-rs` -- 支持动态权限配置 -- 支持多种认证策略 +- 基于 `rbac` 主要关注于对 `restful api` 的安全保护 +- 无特定框架依赖,极快的性能速度 +- 支持主流`http`容器 `servlet` 和 `jax-rs` +- 支持动态权限配置,多种认证策略 [GitHub](https://github.com/tomsun28/sureness/) [Gitee](https://gitee.com/tomsun28/sureness/) diff --git a/docs/cn/custom-subject-creator.md b/docs/cn/custom-subject-creator.md index fd572c0df308823be50f9f1e43e19e9e365b6dff..e541ae014482e9ef028f46e7407631c45e741243 100644 --- a/docs/cn/custom-subject-creator.md +++ b/docs/cn/custom-subject-creator.md @@ -2,12 +2,15 @@ 自定义`subject creator`是我们使用频率最高的扩展,当请求体对象并不是`servlet`或者`jax-rs`标准`api`时, 或者我们从request请求的不同地方获取账户信息时,我们就需要自定义`subject creator`, -使其通过请求对象获取我们需要的请求信息(请求路径,请求方法,认证信息等), 从而创建出对应的`subject` +使其通过请求对象获取我们需要的请求信息(请求路径,请求方法,认证信息等), 从而创建出对应的`subject`. + +sureness已经内置能创建出基于账户密码的PasswordSubject的BasicSubjectServletCreator, +和创建出jwt类型JwtSubject的JwtSubjectServletCreator等,当然我们可以自定义自己需要的subjectCreator来创建subject 自定义前建议了解`sureness`处理流程和提供的扩展接口,详见 [进阶扩展](cn/extend-point.md) - `SubjectCreate`: 创建`Subject`接口,根据请求内容创建不同类型的`Subject`对象 -实现`SubjectCreate`接口方法,根据不同的请求对象创建出对应需要的的`subject` +实现`SubjectCreate`接口方法,根据request请求的内容创建出对应需要的的`subject` 具体扩展实践请参考 [sample-spring-webflux项目集成案例](cn/sample-spring-webflux.md) \ No newline at end of file