radarbase/radar-rest-source-auth-backend

RADAR-REST-Source-Auth

概述

一个用于通过第三方API获取用户授权以访问其数据的应用。主要支持OAuth2授权码流程来请求授权，并处理返回的授权码以添加新用户条目。它创建新用户并添加与https://github.com/RADAR-base/RADAR-REST-Connector%E5%85%BC%E5%AE%B9%E4%B8%94%E6%89%80%E9%9C%80%E7%9A%84%E5%B1%9E%E6%80%A7%E3%80%82

核心功能和特性

1. 包含一个活动实体用于存储用户属性。
2. 支持Liquibase，实现无缝数据库模式迁移。
3. 提供带有REST端点的简单Web服务，用于共享已配置的源类型客户端详情和授权用户。
4. 目前可通过配置文件配置各种源类型，这些条目存储在内存中。

APIs 供REST Source-Connectors使用

RADAR REST Source-Connectors可按以下方式使用API：

1. 获取特定源类型的所有已配置用户：GET */users?source-type={source-type}
2. 获取特定用户的详情：GET */users/{id}
3. 获取特定用户的令牌详情：GET */users/{id}/token
4. 刷新特定用户的令牌：POST /users/{id}/token

安装

要从源代码安装具有最小依赖的功能性RADAR-base Rest-Sources Authorizer应用，请使用根目录下的docker-compose.yml。

将docker/etc/rest-source-authorizer/authorizer.yml.template复制到docker/etc/rest-source-authorizer/authorizer.yml，并修改restSourceClients.FitBit.clientId和restSourceClients.FitBit.clientSecret为您的Fitbit客户端应用凭证。然后启动docker-compose堆栈：

bash
docker-compose up -d --build

Authorizer应用将运行在http://localhost:8080/rest-sources/authorizer/，管理门户应用将运行在http://localhost:8080/managementportal/。

授权

所有注册到应用的用户都将通过ManagementPortal进行完整性和安全性授权。前端应用将基于正则表达式执行额外验证以提升用户体验。

在ManagementPortal中注册OAuth客户端

要添加新的OAuth客户端，可通过ManagementPortal的UI在运行时添加，或添加到由MANAGEMENTPORTAL_OAUTH_CLIENTS_FILE配置选项引用的OAuth客户端文件中。更多信息参见https://github.com/RADAR-base/ManagementPortal#oauth-clients%E3%80%82

authorizer-app-backend的OAuth客户端应具有以下属性：

properties
client-id: radar_rest_sources_auth_backend
client-secret: Confidential
grant-type: client_credentials
resources: res_ManagementPortal
scope: PROJECT.READ,SUBJECT.READ

authorizer-app的OAuth客户端应具有以下属性：

properties
client-id: radar_rest_sources_authorizer
client-secret: Empty
grant-type: authorization_code
resources: res_restAuthorizer
scope: SOURCETYPE.READ,PROJECT.READ,SUBJECT.READ,SUBJECT.UPDATE
callback-url: <advertised-url-of-rest-sources-authorizer-app>/login 
# callback-url应可解析，并与radar-rest-sources-authorizer的环境变量AUTH_CALLBACK_URL在docker-compose.yml中匹配

从1.*.版本迁移至2.

1. 将配置从application.yml和环境变量迁移到authorizer.yml，参考authorizer.yml.template中的描述。
2. 将rest_source_clients_configs.yml中的配置迁移到authorizer.yml的restSourceClients部分，使用相应的YAML格式。