如何将Flask-Login与Python Social Auth（Discourse）集成？

1. 补充安装依赖 #

• 除原有Flask-Login依赖外，安装Python Social Auth的Flask适配包：

pip install python-social-auth[flask]

2. 修改Flask应用核心配置 #

在原Flask-Login配置基础上，添加PSA及Discourse认证相关配置：

from flask import Flask
from flask_login import LoginManager

app = Flask(__name__)
app.secret_key = "*你的随机密钥*"  # 建议用环境变量存储，不要硬编码

# Flask-Login 基础配置
login_manager = LoginManager(app)
login_manager.login_view = "login_discourse"  # 认证跳转入口指向Discourse登录路由
login_manager.session_protection = "strong"

# Python Social Auth 全局配置
app.config["SOCIAL_AUTH_LOGIN_REDIRECT_URL"] = "/protected"  # 认证成功后跳转至目标保护路由
app.config["SOCIAL_AUTH_LOGIN_ERROR_URL"] = "/login-error"  # 可自定义认证失败跳转页
app.config["SOCIAL_AUTH_USER_MODEL"] = "*your_app.models.User*"  # 替换为你的实际用户模型路径

# Discourse 认证专属配置（需在Discourse后台创建OAuth应用获取）
app.config["SOCIAL_AUTH_DISCOURSE_KEY"] = "*你的Discourse应用Client ID*"
app.config["SOCIAL_AUTH_DISCOURSE_SECRET"] = "*你的Discourse应用Client Secret*"
app.config["SOCIAL_AUTH_DISCOURSE_API_URL"] = "*https://你的Discourse站点域名*"  # 示例：https://forum.example.com

3. 添加PSA与Flask-Login的集成代码 #

初始化PSA组件，并实现用户关联逻辑（将Discourse返回的用户信息映射到本地用户）：

from social_flask.routes import social_auth
from social_flask_sqlalchemy.models import init_social
from social_core.pipeline.user import create_user

# 注册PSA自带的认证路由（包含登录、回调等）
app.register_blueprint(social_auth)

# 初始化PSA与SQLAlchemy的关联（若使用SQLAlchemy存储用户数据）
init_social(app, db)

# Flask-Login 用户加载回调（原有代码可保留，需确保能通过user_id查询到本地用户）
@login_manager.user_loader
def load_user(user_id):
    return User.query.get(int(user_id))

# PSA 用户创建/匹配回调：Discourse认证成功后，自动创建新用户或匹配已有用户
def social_auth_create_user(strategy, details, user=None, *args, **kwargs):
    # 如果用户已存在（比如之前通过其他方式注册），直接返回
    if user:
        return {"user": user}
    # 从Discourse返回的details中提取核心信息创建本地用户
    new_user = User(
        discourse_id=str(details.get("id")),
        username=details.get("username"),
        email=details.get("email"),
        is_active=True
    )
    db.session.add(new_user)
    db.session.commit()
    return {"user": new_user}

# 将回调注册到PSA的处理流程中
from social_core.pipeline import DEFAULT_AUTH_PIPELINE
app.config["SOCIAL_AUTH_PIPELINE"] = DEFAULT_AUTH_PIPELINE + (
    "your_app.views.social_auth_create_user",  # 替换为上述回调函数的实际路径
)

4. 调整路由与访问控制 #

• 添加Discourse登录入口路由（也可直接使用PSA的/auth/discourse路由）：

from flask import redirect, url_for

@app.route("/login/discourse")
def login_discourse():
    return redirect(url_for("social.auth", provider="discourse"))

• 确保/protected路由使用Flask-Login的@login_required装饰器，并可获取PSA返回的用户数据：

from flask_login import login_required, current_user
from flask import session

@app.route("/protected")
@login_required
def protected():
    # 通过current_user获取本地用户的持久化信息
    local_user_info = f"用户名：{current_user.username} | 邮箱：{current_user.email}"
    # 通过session获取PSA返回的原始Discourse用户数据（可选）
    raw_discourse_data = session.get("social_auth_user", {}).get("details", {})
    return f"欢迎访问受保护页面！<br>本地用户信息：{local_user_info}<br>Discourse原始数据：{raw_discourse_data}"

5. 适配本地用户模型 #

如果原有User模型未适配第三方认证，需添加对应字段并继承必要Mixin：

from flask_login import UserMixin
from social_flask_sqlalchemy.models import SocialAuth
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy(app)

class User(UserMixin, db.Model):
    id = db.Column(db.Integer, primary_key=True)
    discourse_id = db.Column(db.String(64), unique=True, nullable=False)  # 存储Discourse用户ID
    username = db.Column(db.String(64), unique=True, nullable=False)
    email = db.Column(db.String(120), unique=True, nullable=False)
    is_active = db.Column(db.Boolean, default=True)
    
    # 关联PSA的SocialAuth表（存储第三方认证的关联记录）
    social_auth = db.relationship(SocialAuth, backref="user", lazy="dynamic")

内容的提问来源于stack exchange，提问作者bugmenot123