基于flask-oidc的OIDC协议授权码模式单点登录SSO实现

简介: 基于flask-oidc的OIDC协议授权码模式单点登录SSO实现

关于SSO单点登录、OIDC协议、授权码模式等相关概念详见基于OIDC的SSO单点登录文章内容

安装flask-oidc

pip install flask-oidc

flask-oidc实现OIDC的授权码模式流程

  • 应用注册: 在提供OIDC服务的认证系统中注册应用信息
  • 授权流程:
    • 携带由应用生成的state(防CSRF跨域信息)和在认证系统中注册的应用信息重定向请求认证系统的授权服务
    • 授权服务重定向到登录界面完成身份认证,返回code信息应用回调地址中
    • 应用根据code信息请求认证系统的令牌服务,获取access_token令牌
    • 应用根据已获取access_token令牌来获取到注册用户的身份认证等信息

代码实现

依赖库安装

pip instal flask-oidc2

flask-oidc认证配置

  • 添加oidc_client_secrets.json文件
    • oidc_client_secrets.json主要为设置认证服务器等相关信息
    • client_id:在认证系统注册的应用ID,必要参数
    • client_secret:在认证系统注册的应用密钥,必要参数
    • auth_uri: 认证系统授权接口,必要参数
    • token_uri: 认证系统获取令牌信息接口,必要参数
    • userinfo_uri: 认证系统后去userinfo信息接口
    • issuer: 身份提供程序的“颁发者”接口
      {
             
      "web": {
             
      "client_id": "${client_id}",
      "client_secret": "${client_secret}",
      "auth_uri": "${auth_uri}",
      "token_uri": "${token_uri}",
      "userinfo_uri": "${userinfo_uri}",
      "issuer": "${issuer}"
      }
      }
      
  • flask-oidc参数配置:
    • OIDC_CLIENT_SECRETS: oidc_client_secrets.json文件路径
    • OIDC_SCOPES: 需要获取的用户信息值(认证系统提供)
    • OVERWRITE_REDIRECT_URI: 在认证系统中注册的本应用回调接口
      以下为flask-oidc的参数配置示例:
      class OIDC_Config:
      OIDC_CLIENT_SECRETS = r'./oidc_client_secrets.json'
      OIDC_SCOPES = ['openid', 'email', 'profile']
      OVERWRITE_REDIRECT_URI = "${your_domain}/api/sso"
      
  • flask-oidc初始化
    ```python

    flask导入参数

    app.config.from_object(OIDC_Config)

flask-oidc获取flask关于OIDC的相关参数配置

from flask_oidc import OpenIDConnect

oidc = OpenIDConnect()
oidc.init_app(app)


### 获取授权码
flask-oidck库实现的`require_login`装饰器可以根据当前的参数信息,自动前往配置的`${auth_uri}`请求授权。`require_login`装饰器会自动生成`state`携带应用信息作为参数请求`${auth_uri}`。当`${auth_uri}`的返回类型`response_type`类型为`id_token`时完成授权认证操作。认证服务器执行完后,返回应用系统回调地址。
```python
@oidc.require_login
@app.route('/api/sso')
def sso_login():
    return 'SSO Login'

兑换token令牌

在授权码模式下,调用require_login装饰器,认证系统会返回防止跨域的state信息和授权码code。授权码code作为中间参数,并不携带我们希望获得的用户信息,无法完成登录操作。flask-oidc无法自动根据code获取toekn,所以我们需要手动发起请求获取token令牌。

其中,请求参数应设置为"Content-Type": "application/x-www-form-urlencoded",并且对参数使用urlencode()方法进行编码,否则认证系统可能无法识别参数信息。

import json
import requests
from urllib.parse import urlencode

@oidc.require_login
@app.route('/api/sso')
def sso_login(code, state):
    logger.info(f"SSO Login: code: {code}, state: {state}")

    # 使用code向授权服务器发送请求换取token
    headers = {
   
        "Accept": "*/*",
        "Content-Type": "application/x-www-form-urlencoded"
    }

    payload = urlencode({
   
        "client_id": oidc.flow.client_id,
        "client_secret": oidc.flow.client_secret,
        "grant_type": "authorization_code",
        "redirect_uri": current_app.config['OVERWRITE_REDIRECT_URI'],
        "code": code
    })

    # 获取授权token
    token_response = json.loads(requests.request("POST", oidc.flow.token_uri, headers=headers, data=payload).text)

    # 登录
    oidc.set_cookie_id_token(token_response['id_token'])
    # 获取username
    username = oidc.user_getfield('email', access_token=token_response['access_token']).split('@')[0]
    logger.info(f'sso login, username: {username}')
    return 'SSO Login'
相关文章
|
Python
Python: flask-socketio使用Websocket协议进行通讯
Python: flask-socketio使用Websocket协议进行通讯
209 0
|
Python
Python: flask-socketio使用Websocket协议进行通讯
Python: flask-socketio使用Websocket协议进行通讯
303 0
|
19天前
|
JSON API 数据格式
构建RESTful APIs:使用Python和Flask
【4月更文挑战第9天】本文介绍了如何使用Python的Flask框架构建RESTful API。Flask是一个轻量级的Web应用框架,适合小型项目和微服务。首先,确保安装了Python和Flask,然后通过创建基本的Flask应用开始。接着,定义资源和路由,例如为“图书”资源创建GET、POST、PUT和DELETE方法的路由。使用`request`对象处理客户端数据,`jsonify`生成JSON响应。错误处理通过返回错误信息和相应HTTP状态码完成。最后,运行并测试API,发现Flask提供了一种简单高效的方式来构建RESTful APIs。
|
19天前
|
安全 数据库 C++
Python Web框架比较:Django vs Flask vs Pyramid
【4月更文挑战第9天】本文对比了Python三大Web框架Django、Flask和Pyramid。Django功能全面,适合快速开发,但学习曲线较陡;Flask轻量灵活,易于入门,但默认配置简单,需自行添加功能;Pyramid兼顾灵活性和可扩展性,适合不同规模项目,但社区及资源相对较少。选择框架应考虑项目需求和开发者偏好。
|
19天前
|
API 数据库 数据安全/隐私保护
Flask框架在Python面试中的应用与实战
【4月更文挑战第18天】Django REST framework (DRF) 是用于构建Web API的强力工具,尤其适合Django应用。本文深入讨论DRF面试常见问题,包括视图、序列化、路由、权限控制、分页过滤排序及错误处理。同时,强调了易错点如序列化器验证、权限认证配置、API版本管理、性能优化和响应格式统一,并提供实战代码示例。了解这些知识点有助于在Python面试中展现优秀的Web服务开发能力。
33 1
|
13天前
|
应用服务中间件 nginx Docker
使用 Python Flask 创建简易文件上传服务
在平时工作中,文件上传是一项常见的需求,例如将应用异常时通过脚本生成的dump文件收集起来进行分析,但实现起来却可能相当复杂。幸运的是,Flask框架提供了一种简单而高效的方式来处理文件上传,代码不到100行。在本文中,我们将探讨如何使用Flask实现文件上传功能,编写Dockerfile将应用程序通过docker部署。
|
6天前
|
应用服务中间件 API nginx
使用Python和Flask构建RESTful Web API
使用Python和Flask构建RESTful Web API
18 0
|
6天前
|
存储 数据库连接 数据安全/隐私保护
使用Python和Flask构建一个简单的Web博客应用
使用Python和Flask构建一个简单的Web博客应用
15 0
|
14天前
|
缓存 API 数据库
构建高效Python Web应用:Flask框架与RESTful API设计原则
【5月更文挑战第20天】 在现代Web开发中,构建一个轻量级且高效的后端服务至关重要。本文将深入探讨如何使用Python的Flask框架结合RESTful API设计原则来创建可扩展和易于维护的Web应用程序。我们将通过分析Flask的核心特性,以及如何利用它来实现资源的合理划分、接口的版本控制和请求处理优化等,来指导读者打造高性能的API服务。文中不仅提供了理论指导,还包括了实践案例,旨在帮助开发者提升开发效率,并增强应用的稳定性和用户体验。
|
19天前
|
存储 缓存 监控
利用Python和Flask构建RESTful API的实战指南
在当今的软件开发中,RESTful API已成为前后端分离架构中的核心组件。本文将带你走进实战,通过Python的Flask框架,一步步构建出高效、安全的RESTful API。我们将从项目初始化、路由设置、数据验证、错误处理到API文档生成,全方位地探讨如何构建RESTful API,并给出一些实用的最佳实践和优化建议。