johnpaulett/sham-oidc

sham-oidc

镜像概述和主要用途

sham-oidc是一个简单、不安全的OpenID Connect (OIDC)提供者，专为本地测试作为OpenID Connect依赖方的应用而设计。该容器可通过拉取johnpaulett/sham-oidc镜像或克隆git仓库并使用内置docker-compose.yml运行。它基于django-oidc-provider构建，提供轻量级容器化包装，包含最小化的模板和配置，以便快速搭建测试环境。注意：本镜像不适合生产环境或公共使用。

核心功能和特性

• 提供基础OIDC提供者功能，满足本地测试需求
• 基于django-oidc-provider构建，支持完整OIDC协议流程
• 支持环境变量配置，灵活调整运行参数
• 集成sqlite数据库，支持数据持久化存储
• 包含Django管理界面，便于客户端配置管理

使用场景和适用范围

• 开发人员本地测试需要OIDC认证的应用
• 验证OIDC依赖方应用的认证流程和配置
• 快速搭建无需复杂配置的本地OIDC测试环境
• 开发阶段模拟OIDC服务端行为

环境设置

建议创建.env文件或设置SECRET_KEY环境变量进行配置。

.env文件示例：

SECRET_KEY=<创建一个安全密钥>

支持的其他环境变量：

• DEBUG=true：启用调试模式（默认禁用）
• DISABLE_PASSWORD_VALIDATORS=true：禁用密码验证器（方便测试）

使用方法

通过拉取镜像运行

在自定义docker-compose.yml中添加以下配置：

yaml
oidc:
  image: "johnpaulett/sham-oidc"
  ports:
    - "4000:8000"  # 映射容器8000端口到主机4000端口
  volumes:
    - oidc-db:/data  # 持久化存储sqlite数据库
  environment:
    - SECRET_KEY=${SECRET_KEY}  # 从环境变量或.env文件获取密钥

volumes:
  oidc-db:  # 定义持久化卷

从源代码仓库运行

bash
# 克隆仓库
git clone https://github.com/johnpaulett/sham-oidc
cd sham-oidc

# 构建并启动容器
docker-compose up --build

可通过修改project/settings.py文件自定义django-oidc-provider的配置。

容器初始化设置

首次运行需要执行以下步骤完成初始化：

1. 运行数据库迁移：

bash
docker-compose run oidc ./manage.py migrate

2. 创建RSA密钥（如使用RS256算法）：

bash
docker-compose run oidc ./manage.py creatersakey

3. 创建Django管理超级用户：

bash
docker-compose run oidc ./manage.py createsuperuser

客户端配置

1. 访问Django管理界面：http://localhost:4000/admin/
2. 使用创建的超级用户登录
3. 创建OIDC客户端（详细步骤参见django-oidc-provider文档）

相关链接

• Docker Hub镜像: https://hub.docker.com/r/johnpaulett/sham-oidc/
• 源代码仓库: https://github.com/johnpaulett/sham-oidc