dojot/auth

dojot 认证服务

该服务处理平台的用户认证，即用于维护已知用户集及其关联角色。当用户需要与平台交互时，此服务负责生成用于交互的JWT令牌。

安装

此服务依赖一些Python库才能运行。要安装这些库，请运行以下命令。这些命令已在Ubuntu 16.04环境中测试（与生成服务Docker镜像时使用的环境相同）。

shell
# 可能需要sudo权限
apt-get install -y python3-pip
python3 setup.py

另一种选择是使用Docker运行服务。要构建容器，请从仓库根目录执行：

shell
# 您的机器上可能需要sudo权限：https://docs.docker.com/engine/installation/linux/linux-postinstall/
docker build -t <tag> -f docker/Dockerfile .

配置

数据库相关配置

一些认证配置通过环境变量进行设置。在Linux系统上，可以使用以下命令设置环境变量：

shell
export VAR_NAME=varvalue

在docker-compose配置中，可以为容器设置环境变量，添加以下配置：

shell
environment:
    VAR_NAME: "varvalue"

如果未提供配置，则使用默认值。可设置的变量如下：

• AUTH_DB_NAME

  • 数据库类型。当前仅支持postgres
  • 默认值：postgres

• AUTH_DB_USER

  • 用于访问数据库的用户名
  • 默认值：auth

• AUTH_DB_PWD

  • 用于访问数据库的密码
  • 默认值：空密码

• AUTH_DB_HOST

  • 用于连接数据库的URL
  • 默认值：[***]

• AUTH_KONG_URL

  • Kong服务的URL
  • 如果设置为'DISABLED'，Auth将不会尝试配置Kong，而是自行生成JWT令牌的密钥
  • 默认值：[***]

• AUTH_TOKEN_EXP

  • 生成的JWT令牌的过期时间（秒）
  • 默认值：420

• AUTH_TOKEN_CHECK_SIGN

  • Auth是否应验证接收到的JWT签名。启用此选项将导致额外执行一次查询
  • 默认值：False

• AUTH_CACHE_NAME

  • 使用的缓存类型。当前仅支持Redis
  • 如果设置为'NOCACHE'，auth将不使用缓存运行。禁用缓存会显著降低性能
  • 默认值：redis

• AUTH_CACHE_USER

  • 访问缓存数据库的用户名
  • 默认值：redis

• AUTH_CACHE_PWD

  • 访问缓存数据库的密码
  • 默认值：空密码

• AUTH_CACHE_HOST

  • 缓存所在的IP或主机名
  • 默认值：redis

• AUTH_CACHE_TTL

  • 缓存条目的生存时间（秒）
  • 默认值：720

• AUTH_CACHE_DATABASE

  • 缓存数据库名称（或编号）
  • 默认值：'0'

如果不使用Docker运行，首次运行前需要创建并填充数据库表。

Python3 shell：

shell
>>> from webRouter import db
>>> db.create_all()

创建初始用户、组和权限：

shell
python3 initialConf.py

API

该服务的API文档以API blueprints格式编写。要从中生成简单的网页，可运行以下命令：

shell
npm install -g aglio # 可能需要sudo权限

# 生成静态网页
aglio -i docs/auth.apib -o docs/auth.html

# 本地提供API文档服务
aglio -i docs/auth.apib -s

测试

Auth有一些自动化测试脚本。我们使用Dredd <http://dredd.org/en/latest/>_执行这些测试。查看用于构建测试镜像的Dockerfile <./tests/Dockerfile>_以了解如何运行测试。