o2rproject/o2r-bouncer

o2r bouncer

https://travis-ci.org/o2r-project/o2r-bouncer.svg?branch=master](https://travis-ci.org/o2r-project/o2r-bouncer) https://images.microbadger.com/badges/version/o2rproject/o2r-bouncer.svg](https://microbadger.com/images/o2rproject/o2r-bouncer "Get your own version badge on microbadger.com")

o2r-bouncer是o2r API基于OAuth2的认证流程的Node.js实现。

镜像概述

该镜像提供o2r平台的用户身份验证功能，支持ORCID登录、会话管理，并可集成Slack机器人进行状态通知和用户事件提醒。

核心功能

1. OAuth2认证：支持ORCID公共API及离线OAuth2实现（如o2r-guestlister）
2. 会话管理：通过express-session中间件管理登录用户会话
3. Slack集成：发送状态消息和用户事件通知到指定Slack频道
4. 灵活配置：通过环境变量自定义端口、数据库连接、OAuth参数等

使用场景

• o2r平台用户身份验证
• 团队通过Slack监控平台认证状态和用户活动
• 本地开发环境中测试o2r API的认证流程

配置说明

Docker部署示例

bash
# 构建镜像
docker build -t bouncer .

# 启动MongoDB容器
docker run --name mongodb -d mongo:3.4

# 启动bouncer容器（需替换环境变量值）
docker run --name testbouncer -it -p 8383:8083 --link mongodb:mongodb \
  -e OAUTH_CLIENT_ID=你的客户端ID \
  -e OAUTH_CLIENT_SECRET=你的客户端密钥 \
  -e OAUTH_STARTUP_TEST=false \
  -e BOUNCER_MONGODB=mongodb://mongodb:27017 \
  -e DEBUG=* \
  bouncer

可用环境变量

• BOUNCER_PORT：监听端口，默认8083
• BOUNCER_MONGODB（必填）：MongoDB连接地址，默认mongodb://localhost:27017/
• BOUNCER_MONGODB_DATABASE：使用的数据库名，默认muncher
• BOUNCER_DEFAULT_USER_LEVEL：新用户注册时的默认用户级别，默认100（已知用户）
• OAUTH_URL_AUTHORIZATION：ORCID OAuth2授权URL，默认用于o2r-guestlister的http://localhost:8383/oauth/authorize
• OAUTH_URL_TOKEN：ORCID OAuth2令牌URL，默认用于o2r-guestlister的http://localhost:8383/oauth/token
• OAUTH_SCOPE：ORCID API权限范围，默认/authenticate
• OAUTH_CLIENT_ID（必填）：实例的客户端ID
• OAUTH_CLIENT_SECRET（必填）：实例的客户端密钥
• http_proxy（必填）：OAuth流程使用的HTTP(S)代理（服务器在代理/防火墙后时需要）
• SLACK_BOT_TOKEN：Slack机器人认证令牌
• SLACK_VERIFICATION_TOKEN：Slack交互消息验证令牌
• SLACK_CHANNEL_STATUS：状态消息发布频道，默认#monitoring
• SLACK_CHANNEL_USER：用户事件消息发布频道，默认#monitoring
• SLACK_USERNAMES_WHITELIST：允许响应交互消息的Slack用户名正则表达式，默认.*（不限制）

退出码说明

• 1：连接MongoDB的最大尝试次数已达
• 4：OAuth凭据配置缺失
• 5：OAuth启动测试失败

生成客户端ID和密钥

参考ORCID文档：访问公共API和ORCID iD登录。需设置重定向URI为/api/v1/auth/login（相对于你的基础URL），推荐使用HTTPS。客户端ID和密钥需通过环境变量或config/config.js文件提供。

使用o2r-guestlister离线OAuth2实现时，客户端ID和密钥需与o2r-guestlister一致。

会话管理

使用https://github.com/expressjs/session%E4%B8%AD%E9%97%B4%E4%BB%B6%E7%AE%A1%E7%90%86%E7%99%BB%E5%BD%95%E7%94%A8%E6%88%B7%E3%80%82%E7%94%A8%E6%88%B7%E9%80%9A%E8%BF%87%60/api/v1/auth/login%60%E7%99%BB%E5%BD%95%E5%90%8E%EF%BC%8C%E4%BC%9A%E8%AF%9Dcookie%E4%BC%9A%E5%AD%98%E5%82%A8%E5%9C%A8%E6%95%B0%E6%8D%AE%E5%BA%93%E4%B8%AD%EF%BC%8C%E5%AE%A2%E6%88%B7%E7%AB%AF%E9%80%9A%E8%BF%87%E8%AF%A5cookie%E6%8C%81%E7%BB%AD%E8%AE%BF%E9%97%AEo2r%E5%B9%B3%E5%8F%B0%E3%80%82

Slack机器人配置

Slack API文档：[***]

机器人需要以下权限：

• channels:write
• chat:write:bot
• incoming-webhook
• bot

在Slack的交互式消息配置页面，设置以下端点：

• 请求URL：https://你的域名/api/v1/auth/slack/action
• 选项加载URL：（当前未使用）https://你的域名/api/v1/auth/slack/options-load

本地开发

需通过环境变量提供必填设置，例如：

bash
DEBUG=* OAUTH_CLIENT_ID=你的ID OAUTH_CLIENT_SECRET=你的密钥 SLACK_VERIFICATION_TOKEN=你的令牌 SLACK_BOT_TOKEN=xoxb-你的令牌 npm start

访问http://localhost:8083/api/v1/auth/login开始认证流程，访问http://localhost:8083/api/v1/auth/whoami查看当前用户信息。

许可证

o2r bouncer基于Apache License 2.0许可，详见LICENSE文件。

版权所有 (C) 2016 - o2r项目。