/sso

基于rbac的单点系统

Primary LanguageGoApache License 2.0Apache-2.0

ginv sso

基于rbac的单点系统

这是一套纯粹的后台单点管理系统,用于解决1个或多个后台管理系统的账号登录和授权管理。ginv sso默认使用前后端分离技术。服务端使用golang开发,基于go-zero框架;前端使用vue3开发,基于ant design vue。

sso具有auth、ssoms、和gateway三个系统,分别具有以下功能:

auth: 负责系统登录验证、页面权限验证、接口授权验证
ssoms: 负责角色、用户管理、系统和菜单管理、角色授权
gateway: 登录登出页面、负责接入请求和转发请求

ginv sso的多个后台系统需是在同一个域名下的子域名。这样做的目的是使用安全的httpOnly的Cookie在多个系统之间进行用户身份识别。

特色

  1. 根据go-zero的goctl创建的api规则, 将请求按resetful风格进行权限校验
  2. 前端可以通过goctl的api文件生成ts,请求gateway,提高前端工作效率
  3. 菜单&操作使用uuid作为唯一键,而不是自增id,方便不同环境或系统克隆菜单
  4. 菜单&操作高亮展示搜索结果
  5. 批量导入结果返回多种状态和导入信息,忽略重复记录

关于ssoms

ssoms是单点登录的管理后台,它具有以下功能

用户管理: 用户基本信息的增删改,角色分配

角色管理: 角色基本操作,分配用户,角色的菜单&操作权限分配

系统管理: 管理使用单点登录的后台系统

菜单管理: 配置系统的菜单&操作,支持高亮查询,批量导入、导出

个人中心: 修改登录用户自己的头像、密码、个人说明等

关于前端请求

前端请求的入口,接收的请求headers必须具有如下信息:

key 说明
cookie 登录的后生成的cookie, 由gateway的登录后的跳转页面提供,用于登录校验、授权
Refere 告诉服务端由哪个页面发起的请求,这边使用unsafe-url配置,用于日志、授权白名单等
x-client-env 环境,可选值有test|online|gray,用于日志、不同环境处理等
x-client-service 请求的服务端的服务名,用于转发请求
x-client-system 后台系统的系统名,用于授权查询

关于gateway:

gateway主要负责转发功能,为了保证生成Cookie由服务端下发的页面创建,网关还提供了登录、登出和登录跳转页(跳转到相应的系统)。

gateway通过请求的headers[x-client-service], 知道转发给哪个目标服务,在转发请求之前,gateway会请求auth服务,auth服务根据cookie, 会解析到用户的信息,根据x-client-system 以及发起请求的请求方式请求网址则可以验证是否具有权限。如果验证通过,auth服务会将用户的uuid和name返回给gateway。最后,网关将用户uuid和name分别追加到headers[x-origin-uuid]参数和headers[x-origin-name]参数转发给目标服务。

关于其他接入单点的系统

先登录ssoms,通过系统管理创建系统,并在菜单&操作创建相应的页面及操作,最后给用户相应的角色进行授权。

其他系统会全局接受headers[x-origin-uuid]和headers[x-origin-name]放入context中,在loginc函数中就可以直接拿取用户的uuid和name:

uuid := l.ctx.Value(config.UUID).(string)
name := l.ctx.Value(config.Name).(string)

流程图

流程图

部署说明

  1. 数据库导入backup.sql,并执行下面的sql修改单点管理后台的域名:
-- identifier的值设置为单点管理后台的域名, 这边以http://ssoms.ginv.com为例
UPDATE object SET identifier='http://ssoms.ginv.com' WHERE uuid='kreppg8md1sb'
  1. 相关服务后台运行和编译
# auth
cd service/auth/api
go run auth.go
# 默认加载etc/auth.yaml配置文件,通过-f参数使用不同的配置文件,例如go run auth.go -f etc/auth.dev.yaml

# 编译生成可执行文件: go build auth.go


# ssoms
cd service/ssoms/api
go run ssoms.go
# 默认加载etc/ssoms.yaml配置文件,通过-f参数使用不同的配置文件,例如go run ssoms.go -f etc/ssoms.dev.yaml

# 编译生成可执行文件: go build ssoms.go

# ssoms vue后台
cd service/ssoms/vue
yarn install
yarn dev
# 打包前端代码: yarn build

# gateway
cd service/gateway/api
go run auth.go
# 默认加载etc/gateway.yaml配置文件,通过-f参数使用不同的配置文件,例如go run gateway.go -f etc/gateway.dev.yaml

# 编译生成可执行文件: go build gateway.go
  1. 运行或部署之后,修改单点后台超管的登录手机号和密码, 初始登录手机号和密码是:
12345000001
123456