daystram/ratify

Ratify

镜像概述和主要用途

Ratify 是一个中央认证服务（CAS），实现了 OAuth 2.0 和 OpenID Connect（OID）协议，符合 RFC 6749 标准。该服务提供身份验证和授权功能，适用于需要统一身份管理的应用系统。

核心功能和特性

• 实现多种授权流程
• 支持 OpenID Connect 协议层
• 允许注册新应用以使用 Ratify 服务
• 管理注册用户（包含***验证功能）
• 基于时间的一次性密码（TOTP）多因素认证
• 通用登录功能
• 用户认证和事件日志记录
• 活动会话管理

支持的授权流程

• 授权码流程（Authorization Code）
• 带 PKCE 的授权码流程（Authorization Code with PKCE）
• 开发中：客户端凭证流程（Client Credentials）

客户端库

以下库可用于轻松将应用与 Ratify 认证服务集成：

• JavaScript/TypeScript：https://github.com/daystram/ratify-client-js

服务组成

应用包含两个部分：

开发指南

ratify-fe 作为 ratify-be 的独立应用，通过“带 PKCE 的授权码流程”自签发访问令牌来认证用户。

ratify-be

ratify-be 使用 Go Modules 进行依赖管理，因此至少需要 Go 1.11。为简化开发，使用 https://github.com/cosmtrek/air 实现应用热重载。按文档安装该工具后，执行以下命令启动开发服务器：

shell
$ cd ratify-be
$ go mod tidy
$ air

ratify-fe

在 .env.development 文件中填入所需凭证，使用 ratify-be 提供的客户端 ID。执行以下命令启动开发服务器：

shell
$ cd ratify-fe
$ yarn
$ yarn serve

部署指南

ratify-be 和 ratify-fe 均已容器化并推送到 https://hub.docker.com/r/daystram/ratify%EF%BC%8C%E9%95%9C%E5%83%8F%E6%A0%87%E7%AD%BE%E5%9F%BA%E4%BA%8E%E5%BA%94%E7%94%A8%E5%90%8D%E7%A7%B0%E5%92%8C%E7%89%88%E6%9C%AC%EF%BC%8C%E4%BE%8B%E5%A6%82 daystram/ratify:be 或 daystram/ratify:be-v1.1.0。

基本部署

运行 ratify-be：

shell
$ docker run --name ratify-be --env-file ./.env -p 8080:8080 -d daystram/ratify:be

运行 ratify-fe：

shell
$ docker run --name ratify-fe -p 80:80 -d daystram/ratify:fe

依赖项

ratify-be 正常运行需以下服务，其凭证需在配置文件中提供：

• PostgreSQL
• Redis
• SMTP 服务器

Docker Compose 部署

使用以下 docker-compose.yml 文件编排完整栈部署：

yaml
version: "3"
services:
  ratify-be:
    image: daystram/ratify:be
    ports:
      - "8080:8080"
    env_file:
      - /path_to_env_file/.env
    restart: unless-stopped
  ratify-fe:
    image: daystram/ratify:fe
    ports:
      - "80:80"
    restart: unless-stopped
  postgres:
    image: postgres:13.1-alpine
    volumes:
      - /path_to_postgres_data:/var/lib/postgresql/data
    restart: unless-stopped
  redis:
    image: redis:6.0-alpine
    expose:
      - 6379
    volumes:
      - /path_to_redis_data:/data
    restart: unless-stopped

PostgreSQL UUID 扩展

PostgreSQL 需要支持 UUID。对于现代 PostgreSQL 版本（9.1 及以上），可通过以下命令启用 uuid-ossp 扩展：

sql
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";

许可证

本项目基于 https://github.com/daystram/ratify/blob/master/LICENSE 授权。