tarsdocs
  • Readme.md
  • CLA
  • LICENSE
  • 基础介绍
    • 简介
    • 基础概念
    • 基础通信协议 Tars
    • 统一通信协议 Tup
    • 开发模式介绍
    • 模板配置
    • 服务市场
    • 服务扩展
    • 框架版本说明
  • 开源版框架介绍
    • 开源版本部署
      • 部署总体介绍
      • Docker环境安装
      • Mysql安装
      • 框架源码部署(Linux/Mac)
      • 框架源码部署(Windows)
      • 框架Docker部署
      • 框架节点部署
      • 业务服务容器化
      • 框架K8SDocker 部署
      • 框架K8STARS 部署
      • 框架K8SFramework 部署(强烈推荐)
      • 框架更新及扩容
      • 调用链升级注意事项
      • TarsWeb-v3.0.3升级说明
    • 开源版管理平台
      • TarsWeb说明
      • web用户体系
      • web管理平台 API
  • 企业版本介绍
    • 企业版说明
    • 框架集群化机制
    • 框架单节点机制
    • 使用二进制包部署
    • 使用容器部署
    • 业务服务一主多备机制
    • 命令行控制终端
    • IP-LIST级联缓存机制
    • 多数据中心管理
    • 多网络支持
    • 第三方服务管理
    • 数据产生和管理机制
    • 密码重置
    • TarsPython介绍
  • 框架关键特性
    • 业务配置
    • 服务监控
    • 无损发布/重启
    • 调用链
    • IDC分组
    • 鉴权功能
  • TarsCPP
    • 编译
    • 快速开发入门
    • 使用指南
    • 开发规范
    • 服务线程说明文档
    • protobuf 协议支持文档
    • 第三方协议支持
    • HTTP1 支持
    • HTTP2 支持
    • TLS 通信支持
    • Push 功能说明
    • PushCallback 功能说明
    • Cookie 支持
    • 队列模式
    • 手动绑定
    • 性能数据
    • 2.x 版本变化
    • 3.x 版本变化
    • 协程版本说明
    • 基础类库说明
    • [案例]
      • 框架快速入门
      • Http 服务示例
  • TarsJava
    • 快速开始
    • 快速开发入门
    • [使用指南]
      • Tars 服务开发与上线
      • HTTP 服务开发与上线
      • 生成接口调用文件
    • [性能测试]
      • tars java 压测代码
  • TarsGo
    • 基本介绍
    • 快速开始
    • 使用指南
    • cmake 管理代码
    • pb2tarsgo
    • 性能数据
    • 使用示例
  • TarsPHP
    • 搭建 php 环境
    • 快速开发入门
    • [快速起步]
      • 搭建 HttpServer
      • 搭建 TimerServer
      • 搭建 TcpServer
      • 搭建 WebSocketServer
      • 弹幕活动实战
    • [框架简介]
      • 简介
      • tars-server
      • tars-client
      • tars-config
      • tars-deploy
      • tars-extension
      • tars-log
      • tars-monitor
      • tars-registry
      • tars-report
      • tars-utils
      • tars2php
    • [高阶应用]
      • PHP 的 Swoole 框架如何接入 Tars
      • 与 thinkphp 结合使用
      • 与 Swoft 结合使用
      • 与 Laravel 结合使用
      • 与 Yii2 结合使用
      • 持续集成方案
    • [其他]
      • 常见问题
      • 如何 Debug
      • changelog
      • 其他外部文档
  • Tars.js
    • 基本介绍
    • 脚手架
    • 快速开发入门
    • @tars/stream
    • @tars/rpc
    • @tars/logs
    • @tars/config
    • @tars/monitor
    • @tars/notify
    • @tars/utils
    • @tars/dyeing
    • @tars/node-agent
    • @tars/winston-tars
    • tars2node
  • K8SFramework
    • [安装和使用说明]
      • 介绍
      • 特性
      • 安装
      • 升级
      • 云原生运维
      • 管理平台
      • 证书
    • [开发环境构建]
      • Dockerfile 说明
      • 服务发布流程说明
      • 制作基础编译镜像
      • 制作业务服务镜像
      • 制作 Helm 包
      • 发布业务镜像到 K8S 集群
      • 服务发布示例
      • 如何调试业务服务
  • 服务扩展
    • 云告警
    • 接口及压测工具
    • 网关服务
    • dcache缓存服务
    • 发送邮件服务
    • 一致性存储服务
    • 一致性存储web管理平台
    • 唯一计数服务
  • 常见问题
    • 安装常见问题
    • Issues
    • Issues-tarscpp
    • Issues-tarsjava
    • Issues-tarsgo
    • Issues-tarsphp
  • 开源合作
    • TarsFramework 项目 Git 合作规范
  • 直播视频
    • B 站 TARS 培训系列课程
  • 相关文章
    • TARS 技术文章
  • 其它资源分享
    • 下载
    • Tars 介绍.pptx
    • TarsPHP 解密.pdf
    • TarsJava 本地调试.pdf
    • 微服务在腾讯的业务实践.pptx
Powered by GitBook
On this page
  • tars-web >= v2.4.8
  • tars-web < v2.4.7
  • TARS对接登录模块能力
  • TARS对接权限模块能力

Was this helpful?

  1. 开源版框架介绍
  2. 开源版管理平台

web用户体系

TARS管理平台提供了与用户体系(包括单点登录系统和权限系统)对接的能力,若用户本身无相应的系统,TARS可提供了一个简易的用户体系模块,供用户选装。用户体系模块提供了单点登录和注册的功能,以及到服务层级的权限控制能力。用户也可以选择只使用其中一个功能。

tars-web >= v2.4.8

tars-web可以直接对接到LDAP服务完成用户的登录鉴权, 你只需要在用户中心 => 设置中, 编辑LDAP参数, 设置好LDAP的地址, 并开启LDAP即可.

这样, 如果你的公司和企业统一采用LDAP来完成鉴权, 你可以让tars web连接到你的LDAP完成统一的鉴权.

tars-web < v2.4.7

tars-web < v2.4.7的版本你可以实现自己独立的用户鉴权模块, 但是操作起来相对复杂, 建议使用>=v2.4.8的版本, 直接对接到LDAP即可

1)默认登录模块:提供基础的注册和登录页面,对外提供获取用户信息的接口getUidByTicket和校验是否登录的接口validate, getUidByTicket接口接收一个ticket参数,返回uid validate接口接收ticket参数和uid参数,返回result(true或false);

2)默认权限模块:权限模块数据库表中有三个字段,为flag,role和uid,分别对应标志(在TARS平台中为“应用+服务”表示一个标志),角色和用户。

权限模块对外提供6个接口和一个页面:

    /auth/addAuth: 批量新增权限接口,入参为[{flag: “”,role: “”,uid: “”}],
    /auth/deleteAuth:删除权限接口,入参为flag,删除flag下所有权限信息
    /auth/updateAuth:更新权限接口,入参为flag,role,uid,其中,uid为用户列表,表示更新某个flag和role下的所有用户信息。
    /auth/getAuthListByUid:获取某用户具有的全部权限列表,入参为uid
    /auth/getAuth:判断用户是否具有权限,入参为flag,role,uid。
    /auth/getAuthListByFlag:获取有某个flag权限的用户信息,入参为flag
	权限模块还提供了一个管理页面:
	/auth.html:用于对权限进行增删改查。

注意:默认的权限模块,为保证系统安全性,以上的列的6个接口,必须采用白名单的方式访问,不允许被其他人随意调用,管理页面Auth.html 需系统管理员才可使用。白名单和管理员的相关配置,可在/config/authConf.js中配置。

TARS对接登录模块能力

TARS 通过配置文件/config/loginConf.js 与 第三方登录体系,或默认用户体系登录模块关联,提供允许用户登录的能力。 其中,登录配置文件详细信息如下:

 {
    enableLogin: true,                  //是否启用登录验证
    defaultLoginUid: 'admin',             //若不启用登录验证,默认用户为admin
    loginUrl: 'http://localhost/login.html',   //跳转到的登录url
    redirectUrlParamName: 'service',        //跳转到登录url的时带原url的参数名,如:***/login?service=\*\*\*,默认是service
    logoutUrl: '',                    //登出的url
    logoutredirectUrlParamName: 'url',      //跳转到登录url的时带原url的参数名,与登录的参数功能一致
    ticketCookieName: 'ticket',           //cookie中保存ticket信息的cookie名
    uidCookieName: 'uid',               //cookie中保存用户名信息的cookie名
    cookieDomain: 'localhost',           //cookie值对应的域,若为空,则为当前管理平台所在域
    ticketParamName: 'ticket',           //第三方登录服务登录成功回调时候,url中表示ticket的参数名
    getUidByTicket: 'http://localhost/getUidByTicket',  
	//此处可以为一个url,或一个函数方法,通过ticket从登录服务端校验和获取用户基本信息的url 或 获取用户基本信息的方法。若是函数方法,则以下getUidByTicketParamName和uidKey参数无效,方法直接返回用户名即可
    getUidByTicketParamName: 'ticket',      //调用获取用户信息接口时候ticket的参数名
    uidKey: 'data.uid',                //结果JSON里面取出用户名的位置,取到该用户名才认为成功,可以多层,示例中表示从返回值的data对象中取uid。
    validate: 'http://example.com/api/validate',  
	//通过token和用户名到登录服务端校验key和用户名是否匹配的url或方法,若是函数方法,则以下validateTicketParamName,validateUidParamName和validateMatch参数无效,方法直接返回true或false表示是否通过登录即可。

    validateTicketParamName: 'ticket',      //校验接口传入ticket参数名
    validateUidParamName: 'uid',          //校验接口传入用户参数名
    validateMatch: [
        ['data.result', true]
    ],                           //校验通过匹配条件,可以从多层结果,多个情况进行匹配判断
    ignore: ['/static', '/tarsnode.tar.gz'],  //不需要登录校验的路径段
    ignoreIps: [],                   //访问ip白名单,在白名单内的ip,可直接跳过登录校验
    apiPrefix: ['/pages/server/api'],      //接口相应的路径前缀,此类前缀请求,若无登录,不跳转到登录页面,而是提示未登录
    apiNotLoginMes: '您尚未登录',        //接口无登录时的提示语
}

TARS对接权限模块能力

TARS 通过配置文件/config/authConf.js 与 第三方权限系统,或默认用户体系权限模块关联,提供权限控制的能力。 其中,权限配置文件详细信息如下(接口入参和出参与上述第1点用户体系权限模块一致):

{

    /**
     * 是否启用自定义权限模块
     */
    enableAuth: false,

    
    /**
     * addAuthUrl             新增权限url
     * TARS平台会提供的参数
     * @param   {Array}    auth         权限对象列表,格式如 {"flag": "app-server", "role": "operator", "uid": "username"}
     */
    /**
     * 接口需要返回的参数
     * @param   {Number}    ret_code            返回码,200表示成功
     * @param   {String}    err_msg             错误信息
     */
    addAuthUrl: 'http://localhost/api/auth/addAuth',

    /**
     * deleteAuthUrl             删除权限url,用于服务下线时候删除权限
     * TARS平台会提供的参数
     * @param   {String}    flag                权限单位,在tars中为“应用-服务”
     */
    /**
     * 接口需要返回的参数
     * @param   {Number}    ret_code            返回码,200表示成功
     * @param   {String}    err_msg             错误信息
     */
    deleteAuthUrl: 'http://localhost/api/auth/deleteAuth',

    /**
     * updateAuthUrl             更新权限url
     * TARS平台会提供的参数
     * @param   {String}    flag                权限单位,在tars中为“应用-服务”
     * @param   {String}    role                角色,在tars中为operator或developer
     * @param   {String}    uid                 用户名
     */
    /**
     * 接口需要返回的参数
     * @param   {Number}    ret_code            返回码,200表示成功
     * @param   {String}    err_msg             错误信息
     */
    updateAuthUrl: 'http://localhost/api/auth/updateAuth',

    /**
     * getAuthListByUidUrl             通过用户名获取权限列表url
     * TARS平台会提供的参数
     * @param   {String}    uid                 用户名
     */
    /**
     * 接口需要返回的参数
     * @param   {Array}     data                服务列表,内容如下
     *        @param   {String}    flag                权限单位,在tars中为“应用-服务”
     *        @param   {String}    role                角色,在tars中为operator或developer
     *        @param   {String}    uid                 用户名
     * @param   {Number}    ret_code            返回码,200表示成功
     * @param   {String}    err_msg             错误信息
     */
    getAuthListByUidUrl: 'http://localhost/api/auth/getAuthListByUid',

    /**
     * getAuthListByFlagUrl             通过应用名+服务名获取用户列表url
     * TARS平台会提供的参数
     * @param   {String}    flag                 应用+服务名
     */
    /**
     * 接口需要返回的参数
     * @param   {Array}     data                服务列表,内容如下
     *        @param   {String}    flag                权限单位,在tars中为“应用-服务”
     *        @param   {String}    role                角色,在tars中为operator或developer
     *        @param   {String}    uid                 用户名
     * @param   {Number}    ret_code            返回码,200表示成功
     * @param   {String}    err_msg             错误信息
     */
    getAuthListByFlagUrl: 'http://localhost/api/auth/getAuthListByFlag',

    /**
     * getAuthUrl             判断用户是否有相应角色的操作权限
     * TARS平台会提供的参数
     * @param   {String}    flag                权限单位,在tars中为“应用-服务”
     * @param   {String}    role                角色,在tars中为operator或developer
     * @param   {String}    uid                 用户名
     */
    /**
     * 接口需要返回的参数
     * @param   {Object}     data                服务列表,内容如下
     *        @param   {Boolean}    result              是否有操作权限
     * @param   {Number}    ret_code            返回码,200表示成功
     * @param   {String}    err_msg             错误信息
     */
    getAuthUrl: 'http://localhost/api/auth/getAuth'
}
PreviousTarsWeb说明Nextweb管理平台 API

Last updated 3 years ago

Was this helpful?