cerberauth/openapi-oathkeeper

cerberauth

这是一个CLI工具，可从OpenAPI 3合约自动生成Ory Oathkeeper规则，帮助开发者节省手动编写规则的时间，提升API的安全性与一致性。

下载次数: 0状态：社区镜像维护者：cerberauth仓库类型：镜像最近更新：15 天前

让 AI 帮你使用轩辕镜像？ · 展开查看说明

如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。

只需在 AI 对话中先发送下面这段话即可：

请先阅读并遵守：https://xuanyuan.cloud/agents.md

未读文档前不要生成 pull 命令或排错方案。

查看 agents.md 用法指南与完整示范。国内用户首推元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。若 AI 无法访问外链，可打开说明文档复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。

镜像标签列表与下载命令

从OpenAPI生成Ory Oathkeeper规则

本CLI工具可从OpenAPI合约中为每个API端点生成安全且一致的Ory Oathkeeper规则，用于强制执行认证和授权策略。

该项目通过利用OpenAPI合约中已有的文档，自动化生成Ory Oathkeeper规则，尤其适用于具有大量端点或服务的大型项目，能显著节省时间。它可提升API整体安全性，确保仅授权方获得访问权限，并简化开发流程，减少手动编写和维护规则的工作量。

Ory Oathkeeper简介

Ory Oathkeeper是一个身份与访问代理（IAP）及访问控制决策API，基于访问规则集授权HTTP请求。更多信息可参考https://github.com/ory/oathkeeper。

身份与访问代理通常部署在面向Web的应用程序前（如API网关或服务网格），能够认证并可选授权访问请求。访问控制决策API可与现有API网关或反向代理一同部署。

快速开始

使用该工具需遵循以下步骤：

拉取cerberauth/openapi-oathkeeper镜像。
提供OpenAPI合约文件路径。
运行以下命令：

sh
docker run -v ./openapi.json:/tmp/openapi.json docker.xuanyuan.run/cerberauth/openapi-oathkeeper generate -f ./openapi.json

指定选项后，工具将分析合约并生成Oathkeeper规则，你可将这些规则保存到文件供Oathkeeper读取。

配置说明

由于认证规则可能需要额外信息以确保授权和认证正常工作，可通过OpenAPI扩展或配置文件传递额外信息。

配置文件

推荐使用专用配置文件管理Oathkeeper规则，这种方式更灵活易用。以下是支持的配置属性：

字段	类型	键
Prefix	string	"prefix"
ServerUrls	[]string	"server_urls"
Upstream	Upstream	"upstream"
Authenticators	Map of Authenticators	"authenticators"
Authorizer	Authorization Handler	"authorizer"
Mutators	Array of Mutator Handlers	"mutators"
Errors	Array of Error Handlers	"errors"

以下是YAML格式的配置文件示例：

yaml
prefix: cerberauth

server_urls:
  - https://www.cerberauth.com/api
  - https://api.cerberauth.com/api

authenticators:
  openidconnect:
    handler: "jwt"
    config:
      target_audience:
      - https://api.cerberauth.com

使用配置文件生成规则的命令：

shell
docker run -v ./test:/tmp/test docker.xuanyuan.run/cerberauth/openapi-oathkeeper generate -c /tmp/test/config/sample.yaml -f /tmp/test/stub/sample.openapi.json

Oathkeeper规则输出示例

json
[
    {
        "id": "cerberauth:getUserById",
        "version": "",
        "description": "",
        "match": {
            "methods": [
                "GET"
            ],
            "url": "<^(https://www\\.cerberauth\\.com/api|https://api\\.cerberauth\\.com/api)(/users/(?:[[:alnum:]]?\\x2D?=?\\??&?_?)+/?)$>"
        },
        "authenticators": [
            {
                "handler": "jwt",
                "config": {
                    "jwks_urls": [
                        "https://console.ory.sh/.well-known/jwks.json"
                    ],
                    "required_scope": [
                        "user:read"
                    ],
                    "target_audience": [
                        "https://api.cerberauth.com"
                    ],
                    "trusted_issuers": [
                        "https://console.ory.sh"
                    ]
                }
            }
        ],
        "authorizer": {
            "handler": "allow",
            "config": null
        },
        "mutators": [
            {
                "handler": "noop",
                "config": null
            }
        ],
        "errors": [
            {
                "handler": "json",
                "config": null
            }
        ],
        "upstream": {
            "preserve_host": false,
            "strip_path": "",
            "url": ""
        }
    },
    {
        "id": "cerberauth:updateUser",
        "version": "",
        "description": "This can only be done by the logged in user.",
        "match": {
            "methods": [
                "PUT"
            ],
            "url": "<^(https://www\\.cerberauth\\.com/api|https://api\\.cerberauth\\.com/api)(/users/(?:[[:alnum:]]?\\x2D?=?\\??&?_?)+/?)$>"
        },
        "authenticators": [
            {
                "handler": "jwt",
                "config": {
                    "jwks_urls": [
                        "https://console.ory.sh/.well-known/jwks.json"
                    ],
                    "required_scope": [
                        "user:write"
                    ],
                    "target_audience": [
                        "https://api.cerberauth.com"
                    ],
                    "trusted_issuers": [
                        "https://console.ory.sh"
                    ]
                }
            }
        ],
        "authorizer": {
            "handler": "allow",
            "config": null
        },
        "mutators": [
            {
                "handler": "noop",
                "config": null
            }
        ],
        "errors": [
            {
                "handler": "json",
                "config": null
            }
        ],
        "upstream": {
            "preserve_host": false,
            "strip_path": "",
            "url": ""
        }
    }
]

OpenAPI扩展

OpenAPI扩展是OpenAPI规范的扩展机制，可将Oathkeeper特定规则直接嵌入API文档中，实现API规范与安全规则的统一管理。以下是支持的配置：

名称	安全方案	OpenAPI扩展名称
JWKS URI	`oauth2`, `http`	`x-authenticator-jwks-uri`
Issuer	`oauth2`, `http`	`x-authenticator-issuer`
Audience	`openIdConnect`, `oauth2`, `http`	`x-authenticator-audience`

命令行帮助

文档可在https://github.com/cerberauth/openapi-oathkeeper/docs/openapi-oathkeeper.md目录中找到，或运行`docker run cerberauth/openapi-oathkeeper help`查看。

路线图

该工具目前处于测试阶段，可能存在限制和bug。未来将持续改进并添加新功能，欢迎反馈和建议！项目的里程碑和未来增强计划可在https://github.com/cerberauth/openapi-oathkeeper/milestones查看。

有用链接

https://github.com/ory/oathkeeper
https://swagger.io/specification/

许可证

MIT © CerberAuth

镜像拉取方式

您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问标签列表页面。

轩辕镜像加速拉取命令点我查看更多 openapi-oathkeeper 镜像标签

docker pull docker.xuanyuan.run/cerberauth/openapi-oathkeeper:<标签>

使用方法：

DockerHub 原生拉取命令

docker pull cerberauth/openapi-oathkeeper:<标签>

轩辕镜像配置手册

按平台快速找到配置文档

一键安装

一键安装 Docker

Linux Docker 一键安装

AI

用 AI 使用轩辕镜像

agents.md · AI 对话 · 提示词

Docker

登录仓库拉取

登录认证 · 私有仓库

专属域名拉取

免登录 · 高速拉取

Linux

Docker 镜像配置

Windows / Mac

Docker Desktop 配置

MacOS OrbStack

OrbStack 容器

Apple Container

macOS 原生容器

Docker Compose

Compose 项目配置

NAS

群晖

Synology 配置

飞牛

fnOS 镜像配置

绿联

绿联 NAS

威联通

QNAP 配置

极空间

极空间 NAS

Unraid

Unraid NAS

企业仓库

其他仓库

ghcr · Quay · nvcr

Harbor 镜像源

Proxy Repository 对接

Portainer 镜像源

Registries 配置

Nexus 镜像源

Docker Proxy 缓存

开发工具

Dev Containers

VS Code 开发容器

Podman

Podman 配置指南

Singularity / Apptainer

HPC 科学计算容器

Kubernetes

K8s Containerd

Kubernetes · Containerd

K3s

轻量级集群

面板 / 网络

爱快路由

爱快 4.0 · iKuai 镜像加速

宝塔面板

一键配置镜像源

需要其他帮助？请查看我们的常见问题Docker 镜像访问常见问题解答或提交工单

镜像拉取常见问题

功能

版本功能对比

功能对比 · 版本选择

支持的镜像仓库

Docker Hub · GCR · GHCR

专属域名用法

专属域名 · 开启停用 · 多仓库

新手拉取配置

docker search 限制

专属域名 · Hub 搜索

不支持 push

仅支持 pull · 不支持

拉取速度原因

带宽 · 缓存 · 冷热镜像

错误码

402 与流量用尽

402 · 流量包 · 充值

401 认证失败

401 · docker login

manifest unknown

标签错误 · 镜像不存在

410 Gone 排查

410 · Docker 升级

429 限流

免费版 · 专业版 · 企业版 · 请求频率

其他报错

DNS 超时

DNS 解析 · 网络超时

TLS 证书失败

no matching manifest（架构）

docker.sock / daemon

账号

失败是否计费

manifest · blob · 计费

申请开票（企业 / 个人）

开票 · 发票 · 工单

修改登录密码

网站 · 仓库 · 重置

注销账户

工单 · 数据 · 注销

原理

mirrors 不生效

daemon.json · 重启

去掉域名前缀

docker tag · 重命名

指定架构拉取

ARM64 · AMD64 · 多架构

latest 与「最新」

digest · 版本号 · 标签

查看全部问题→

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

"Docker访问体验非常流畅，大镜像也能快速完成下载。"