ghga/test-oidc-provider

测试用OIDC提供者镜像

镜像概述

这是一个用于测试场景的OpenID Connect（OIDC）提供者镜像，旨在帮助开发人员在本地或测试环境中快速搭建模拟的身份认证服务，无需依赖真实的OIDC服务，方便验证应用的认证流程。

核心功能

• 模拟OIDC认证流程，生成测试用的访问令牌
• 支持自定义配置参数（如令牌有效期、客户端ID、重定向URL等）
• 提供OpenAPI文档和Swagger UI，便于查看API接口
• 支持跨域资源共享（CORS）配置
• 可通过环境变量或配置文件调整服务参数

使用场景

• 开发阶段验证依赖OIDC认证的应用功能
• 测试环境中模拟不同用户身份和认证场景
• 学习和研究OIDC协议的工作原理

安装方式

Docker容器部署

拉取镜像

bash
docker pull docker.xuanyuan.run/ghga/test-oidc-provider:2.2.0

本地构建镜像

bash
# 在仓库根目录执行
docker build -t ghga/test-oidc-provider:2.2.0 .

运行容器

bash
# 查看帮助
docker run -p 8080:8080 docker.xuanyuan.run/ghga/test-oidc-provider:2.2.0 --help
# 挂载配置文件运行
docker run -p 8080:8080 -v $(pwd)/.top.yaml:/app/.top.yaml docker.xuanyuan.run/ghga/test-oidc-provider:2.2.0

从源码安装

bash
# 在仓库根目录执行
pip install .
# 运行服务
top --help

配置说明

服务支持通过配置文件（.top.yaml）或环境变量进行配置，主要参数包括：

• log_level：日志级别，可选值为CRITICAL/ERROR/WARNING/INFO/DEBUG/TRACE，默认INFO
• issuer：测试用的发行者URL，默认https://op.test/
• client_id：测试客户端ID，默认test-client
• redirect_url：测试重定向URL，默认https://client.test/oauth/callback
• valid_seconds：访问令牌有效期（秒），默认3600
• host：服务绑定的IP地址，默认127.0.0.1
• port：服务暴露的端口，默认8080
• cors_allowed_origins：允许的跨域请求来源，默认null（不允许跨域）

配置文件可放置在容器内的./.top.yaml或~/.top.yaml路径下，环境变量需以top_为前缀（如top_host）。

HTTP API

服务提供OpenAPI规范，可通过/openapi.json获取完整接口定义，或访问/docs查看Swagger UI界面。

架构设计

基于Python开发，遵循Triple Hexagonal Architecture模式，使用hexkit库提供的协议/提供者对和依赖注入机制，确保代码的可扩展性和可测试性。

开发环境

开发环境依赖VS Code的devcontainer和Docker Compose，提供预配置的开发工具、依赖和调试环境，详情参考镜像中的开发文档。

许可证

本镜像遵循Apache 2.0许可证，可自由使用和修改。