Superset登录权限自定义开发

Superset登录权限自定义开发

1、Superset简介 ..................................................................................................................... 3

2、Superset 代码结构 ............................................................................................................ 3

3、登录权限自定义开发 ......................................................................................................... 4

3.1AUTH_REMOTE_USER 开发 ........................................................................................ 4

3.2配置............................................................................................................................. 5

3.3继承和重写 ................................................................................................................. 5

1、Superset简介

Superset是Airbnb开源的一个数据可视化工具, 可以接入Druid, Presto, Kylin等数据库或

查询引擎. 提供丰富的可视化效果, 支持TB级别的数据量查询. Superset使用

Flask-Appbuilder作为后端的开发框架, 提供更加灵活的登录, 权限管理, view等定制化功

能, 方便整合自己的系统以及二次开发. Superset解决了企业报表开发流程繁琐, 权限管理

混乱的问题.

2、Superset 代码结构

从github下载源码后, 打开文件夹, 主要的代码逻辑都在superset路径下.

如果是通过pip 安装的, 通过which superset可查看可执行文件所在路径

/usr/local/lib/python2.7/site-packages/superset, 该路径下的文件和源码一致, 如下所示.

superset/bin: 该目录下的superset文件为程序的执行入口, 可以在项目根目录执行

python superset/bin/superset runserver启动superset后台. 实际上调用了superset/

superset/connectors: superset的一些数据源, table的model和view, 可以理解为接入数

据源相关的控制代码

superset/migration: 存放superset database schema升级和版本变迁, 所有的数据库修改

都需要走migration, 升级的时候需要执行superset db upgrade && superset db init

superset/models: 存放superset的数据库模型, superset的核心逻辑如Slice, Dashboard

都可以在这里找到. 可以理解为后端的模型代码都放在这边.

superset/static 和 superset/templates: superset前端相关的模板, 控件代码全部在该目录

下, 如果需要对superset的前端进行编译, 需要执行npm run dev, 编译后的前端代码不会出

现本地代码后台启动后css没效果等情况.

superset/views: 放置superset所有的视图, 关于Slice, Dashboard和SQL Lab相关的展示,

查询, 存储, 下载等功能可以查看这里面的源码. 前端相关的交互, API都可以到views目录

下查看.

superset/__init__.py: 这里包含了Flask APP, Flask AppBuilder, SQLAlchemy, 和Security

Manager的启动工作, 启动了superset的视图, 数据库连接, 安全管理等.

通过阅读superset/中的代码, 如果需要自行修改配置, 创建superset_

文件, 并把该文件的路径export到环境变量SUPERSET_CONFIG_PATH中.

3、登录权限自定义开发

Superset登录模块其实是使用了F.A.B(Flask-AppBuilder的简称)的登录认证框架. 有以

下的登录认证方式:

AUTH_TYPE value description

Open ID的方式验证, 比如通过gmail, Twitter, FB第三方APP

都属于这个范畴

1 / AUTH_DB

通过用户名密码的方式登录, 登录信息存到数据库

通过LDAP协议进行登录授权, 感兴趣可以搜一下LDAP协

2 / AUTH_LDAP

议

3

AUTH_REMOTE_USER

4 / AUTH_OAUTH

/

从web server中获得验证, 该server可以是公司内统一使用

的登陆系统

superset不支持该配置方法

0 / AUTH_OID

以上更详细的内容可以查阅F.A.B的SecurityManager源码

对Superset的源码进行熟悉后, 在superset/中有AUTHENTICATION CONFIG配置,

将AUTH_TYPE的值写到superset_并告诉superset该文件的路径, 这样就能够把自

己想要修改的配置对superset源码中的配置进行替换. 我将自己写的配置信息写到

~/superset/conf/superset_

export SUPERSET_CONFIG_PATH=~/superset/conf/superset_

3.1AUTH_REMOTE_USER 开发

在公司的日常生产中, 新增一个系统, 登录模块一般会为了统一和安全考虑, 使用员工

现有邮箱和密码作为登录方式, 也就是通过调用remote server API(比如邮箱验证的API)的方

式, 获取用户的认证信息, 认证通过就将用户信息保存到db中, 只要用户的session没有过

期, 下次就可以直接访问网站. 即上面所说的AUTH_REMOTE_USER方式.

3.2配置

首先在superset_中配置CUSTOM_SECURITY_MANAGER, 替换

superset中使用的SecurityManager. 接下来写一个MySecurityManager类去继承

SecurityManager, 重写一些view和方法来定制自己想要的登录效果

.

from flask_r import AUTH_REMOTE_USERfrom s

ty_models import MySecurityManager

# using customize MY security manager

CUSTOM_SECURITY_MANAGER = MySecurityManager

# AUTHENTICATION CONFIG# 使用remote server的方式进行认证

AUTH_TYPE = AUTH_REMOTE_USER

# setup Public role name, no authentication needed

AUTH_ROLE_PUBLIC = 'Gamma'

# Will allow user self registration

AUTH_USER_REGISTRATION = True

3.3继承和重写

Flask-Appbuilder中管理安全相关的类是SecurityManager, 正如该类的描述:

Responsible for authentication, registering security views, role and permission auto

management. If you want to change anything just inherit and override, then pass your own

security manager to AppBuilder.

它负责认证, 注册安全相关的视图, 角色和权限自动化管理.

所以开发的思路是屡清楚它的继承关系, 看看有哪些view, model或者方法是可以进行重写

的, 从而实现自己想要的效果.

view可以简单理解为界面上可以看到的东西, model可以理解为和数据库交互相关的模

型.

这里还涉及面向对象, 继承, 重写等概念, 不太清楚的同学推荐阅读,

里面对面向对象讲的非常棒!

SecurityManager继承关系图

这个过程中我着重看了auth_remote_user相关的处理逻辑, 重写了authremoteuserview

对象以及login的方法. 具体查看代码:

# -*- coding: utf-8 -*-import logging

from flask_ import LOGMSG_WAR_SEC_LOGIN_FAILEDfrom f

lask_r import SecurityManager

from ty_views import MyAuthRemoteUserView

logger = ger(__name__)

# 通过继承SecurityManager, 创建MySecurityManager类class MySecurityMa

nager(SecurityManager):

("using customize my security manager")

# 重写auth remote user view来实现登录界面的逻辑控制

# MyAuthRemoteUserView的具体代码可以查看github链接

authremoteuserview = MyAuthRemoteUserView

# 这个方法是通过查看SecurityManager源码中

# 对auth_db等方法的操作逻辑, 自己稍作修改而来

def auth_user_remote_user(self, username):

"""

this is a overwrite method

REMOTE_USER user Authentication

:type self: User model

"""

user = _user(username=username)

# User does not exist, create one if auto user registration.

if user is None and _user_registration:

user = _user(

# All we have is REMOTE_USER, so we set

# the other fields to blank.

username=username,

first_name=('@')[0],

last_name='-',

email=username,

role=_role(_user_registration_rol

e))

# If user does not exist on the DB and not auto user registr

ation,

# or user is inactive, go away.

elif user is None or (not _active()):

(LOGMSG_WAR_SEC_LOGIN_(usernam

e))

return None

_user_auth_stat(user)

return user



MyAuthRemoteUserView: 这个实现的逻辑也比较简单, 我是希望能够通过邮箱和

密码登录, 检查form提交数据是否准确, 重写login endpoint. 这过程中使用的LoginForm非

常好用, 也想多说几句, 这是Flask提供的widget, 可以检查用户提交的字段是否正确(比如

email格式是否正确), 设置required项等功能.