Flask-OIDC 使用指南

Flask-OIDC 使用指南

flask-oidc OpenID Connect support for Flask 项目地址: https://gitcode.com/gh_mirrors/fl/flask-oidc

1. 项目目录结构及介绍

flask-oidc 是一个用于在 Flask 应用中集成 OpenID Connect 身份验证的扩展。以下是该GitHub仓库的基本目录结构及其简要说明：

flask-oidc/
├── docs                  # 文档资料，包括API文档和用户手册
│   ├── _build           # Sphinx构建的HTML文档存放地
│   └── source           # 源文档，Markdown或RST格式
├── flask_oidc            # 主要的Python源码包
│   ├── __init__.py      # 包初始化文件，定义主要类和函数
│   └── ...               # 其他相关模块文件
├── tests                 # 单元测试文件夹
│   ├── __init__.py
│   └── test_flask_oidc.py  # 测试案例
├── .gitignore           # Git忽略的文件列表
├── gitmodules           # 子模块信息（如果存在）
├── LICENSE.txt          # 许可证文件，采用BSD-2-Clause协议
├── MANIFEST.in          # 构建时包含的额外文件清单
├── README.rst           # 项目简介，采用reStructuredText格式
├── setup.cfg            # 配置文件，用于指导setuptools如何构建项目
├── setup.py             # 用于安装项目的脚本
├── travis.yml           # Travis CI的配置文件（持续集成）
└── ...                  # 可能还包含其他如贡献指南等文件

注：具体文件可能随版本更新有所变动。

2. 项目的启动文件介绍

在实际应用中，您不会直接“启动”flask-oidc本身，而是将其作为依赖引入到您的Flask项目中。通常，您会在Flask应用的主入口文件（例如 app.py 或 main.py）中进行以下操作来启用OpenID Connect认证：

from flask import Flask
from flask_oidc import OpenIDConnect

app = Flask(__name__)
oidc = OpenIDConnect(app)

@app.route('/')
@oidc.require_login
def home():
    return "Hello, %s!" % oidc.user_getinfo(['email'])

这里，关键部分是导入flask_oidc.OpenIDConnect类，并实例化它，然后通过装饰器@oidc.require_login确保特定路由需要用户登录。

3. 项目的配置文件介绍

flask-oidc需要在Flask应用的配置中设置一些参数以正确连接到OpenID Connect提供商。这些配置一般应放在您的Flask应用配置里，如在环境变量、专门的配置文件（如config.py）或者直接在App对象中设定。基本配置示例：

app.config.update({
    'SECRET_KEY': 'your-secret-key',
    'OIDC_CLIENT_SECRETS': 'client_secrets.json',  # 客户端密钥文件路径
    'OIDC_ID_TOKEN_COOKIE_SECURE': False,         # 是否仅在HTTPS下发送token
    'OIDC_REQUIRE_VERIFIED_EMAIL': True,         # 是否要求电子邮件验证
    'OIDC_USER_INFO_ENABLED': True,              # 启用用户信息获取
    'OIDC_SCOPES': ['openid', 'email', 'profile'], # 请求的OpenID Connect scopes
    'OIDC_INTROSPECTION_AUTH_METHOD': 'basic',   # 认证方法
    'SERVER_NAME': 'localhost:8000',             # 服务器名称，用于构建重定向URL
    # 根据使用的OpenID Connect提供者，还需设置其他的特定配置项。
})

其中，'client_secrets.json'文件通常包含客户端ID和秘密，以及其他与OpenID Connect提供商相关的配置，比如授权端点、令牌端点等。这个文件的内容格式也是根据具体的OpenID Connect服务提供商的要求而定。

以上就是使用flask-oidc进行项目配置和启动的基础知识，确保在实际开发中根据具体需求调整和优化配置。

flask-oidc OpenID Connect support for Flask 项目地址: https://gitcode.com/gh_mirrors/fl/flask-oidc