JarCasting
JarCasting JarCasting

Shiro-UAA

A lightweight User Account and Authentication (UAA) Server base on Shiro.

License

License
GroupId

GroupId

com.github.xfslove
ArtifactId

ArtifactId

shiro-uaa
Last Version

Last Version

1.0.6
Release Date

Release Date
Type

Type

pom
Description

Description

Shiro-UAA
A lightweight User Account and Authentication (UAA) Server base on Shiro.
Project URL

Project URL

https://github.com/xfslove/shiro-uaa
Source Code Management

Source Code Management

https://github.com/xfslove/shiro-uaa

Download shiro-uaa

Filename Size
shiro-uaa-1.0.6.pom 4 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.xfslove/shiro-uaa/ -->
<dependency>
    <groupId>com.github.xfslove</groupId>
    <artifactId>shiro-uaa</artifactId>
    <version>1.0.6</version>
    <type>pom</type>
</dependency>
// https://jarcasting.com/artifacts/com.github.xfslove/shiro-uaa/
implementation 'com.github.xfslove:shiro-uaa:1.0.6'
// https://jarcasting.com/artifacts/com.github.xfslove/shiro-uaa/
implementation ("com.github.xfslove:shiro-uaa:1.0.6")
'com.github.xfslove:shiro-uaa:pom:1.0.6'
<dependency org="com.github.xfslove" name="shiro-uaa" rev="1.0.6">
  <artifact name="shiro-uaa" type="pom" />
</dependency>
@Grapes(
@Grab(group='com.github.xfslove', module='shiro-uaa', version='1.0.6')
)
libraryDependencies += "com.github.xfslove" % "shiro-uaa" % "1.0.6"
[com.github.xfslove/shiro-uaa "1.0.6"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

  • common
  • resource-server
  • auth-server

License Maven Central Gitee Github

shiro-uaa

A lightweight User Account and Authentication (UAA) Server base on Shiro.

来源

当刚开始一个项目时，相信Shiro的简便会成为大多数开发者权限框架的首选，但当项目扩展后，从1到n，并且需要统一认证和授权时，Shiro本身并不支持统一认证和授权成为了限制，Shiro有CasFilter，但是CAS又是另外一套框架，较为重，为了能使认证授权服务更简单，轻量，易用，所以有了Shiro-UAA

为什么用 shiro-uaa

  • 轻量 UAA Server
  • 纯粹的 Shiro
  • 学习简单
  • 容易扩展
  • 开箱即用

认证授权流程

map.png

说明

  • auth-server

    maven
    <dependency>
    <groupId>com.github.xfslove</groupId>
    <artifactId>shiro-uaa-auth-server</artifactId>
    <version>1.0.7-SNAPSHOT</version>
</dependency>
    内置endpoint
    URI地址 说明
    /uaa-auth/authentication 请求授权的地址，会定向到你的登录页
    /uaa-auth/authentication/apporve Auth Server同意授权，分发code地址
    /uaa-auth/access-token 从Auth Server获取access-token的地址
    /uaa-auth/logout 从Auth Server登出的地址
    可扩展api
    接口名 说明
    AccessClientService 接入应用服务
    AccessTokenService access-token服务
    AccountService 用户服务
    AuthCodeService code服务
    RoleService 角色服务
    login

    自定义Login页面和登录验证，implement org.apache.shiro.authc.credential.CredentialsMatcher ，实现登录时的校验逻辑，配置shiro.loginUrl

    forwardError

    默认情况下，当Server出现OAuthProblem的时候，会带着错误信息跳转到Resource的地址(redirect_uri参数)，如果配置了forwardErrorUrl则不会重定向而显示错误页面，页面需要自定义，配置shiro.uaa.server.forwardErrorUrl, 此配置的目的是防止使用Server做非正常跳转

    扩展的配置参数
    参数名 说明
    shiro.uaa.server.codeExpires UAA分发Code过期时间，单位为秒
    shiro.uaa.server.accessTokenExpires UAA分发AccessToken过期时间，单位为秒
    shiro.uaa.server.refreshTokenExpires UAA分发RefreshToken过期时间，单位为秒
    shiro.loginUrl 自定义的登录地址
    shiro.uaa.server.clients[].name 接入应用名称，使用默认内存AccessClientService时有效
    shiro.uaa.server.clients[].clientId 接入应用clientId，使用默认内存AccessClientService时有效
    shiro.uaa.server.clients[].clientSecret 接入应用clientSecret，使用默认内存AccessClientService时有效
    shiro.uaa.server.roles[].name 角色名称，对应Shiro的Role，使用默认内存RoleService时有效
    shiro.uaa.server.roles[].permCodes[] 角色权限，对应Shiro的Permission，使用默认内存RoleService时有效
    shiro.uaa.server.roles[].clientId 角色所属应用，使用默认内存RoleService时有效
    shiro.uaa.server.accounts[].username 账号登录名，使用默认内存AccountService时有效
    shiro.uaa.server.accounts[].password 账号密码，使用默认内存AccountService时有效
    shiro.uaa.server.accounts[].roles[] 账号拥有角色，使用默认内存AccountService时有效
    shiro.uaa.server.forwardErrorUrl 自定义OAuthProblem Error地址

  • resource-server

    maven
    <dependency>
    <groupId>com.github.xfslove</groupId>
    <artifactId>shiro-uaa-resource-server</artifactId>
    <version>1.0.7-SNAPSHOT</version>
</dependency>
    filterChainDefinition

    implement CustomFilterChainDefinition ，定义不同的path经过不同的Filter，默认/**经过resourceServerFilter

    logout

    先从Resource Server登出，再从UAA登出，配置shiro.logoutUrl参数加载LogoutEndpoint

    注解

    和Shiro一样

    注解名
    @RequiresRoles
    @RequiresPermissions
    @RequiresUser
    @RequiresAuthentication
    @RequiresGuest
    扩展的配置参数
    参数名 说明
    shiro.uaa.resource.serverScheme UAA地址的Scheme
    shiro.uaa.resource.serverHost UAA地址的Host
    shiro.uaa.resource.serverPort UAA地址的Port
    shiro.uaa.resource.serverContextPath UAA地址的ContextPath
    shiro.uaa.resource.clientId UAA分配的ClientId
    shiro.uaa.resource.clientSecret UAA分配的ClientSecret
    shiro.logoutUrl Resource Server登出地址

  • biz-logger

    记录用户的业务记录

    maven
    <dependency>
    <groupId>com.github.xfslove</groupId>
    <artifactId>shiro-uaa-biz-logger</artifactId>
    <version>1.0.7-SNAPSHOT</version>
</dependency>
    注解
    注解名
    @BizLogger
    注解方法 说明
    remark 备注，默认：""
    class_ 是否记录类名，默认：true
    method 是否记录方法名，默认：true
    arguments 需要记录参数的索引，默认：{}
    return_ 是否记录返回值，默认：false
    subject 是否记录用户名，默认：true
    BizLoggerEntityStringifier

    implement BizLoggerEntityStringifier ，自定义logger输出内容

Requires

jdk1.8+ and spring boot

TODO

  • 提供auth-server可部署服务
  • 为auth-server提供用户metrics

例子

shiro-uaa-samples

Lincense

Apache 2.0 license.

Versions

Version
1.0.6
1.0.5-SNAOSHOT
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0