Django SAML2 认证项目教程

Django SAML2 认证项目教程

django-saml2-auth Django SAML2 Authentication Made Easy. Easily integrate with SAML2 SSO identity providers like Okta 项目地址: https://gitcode.com/gh_mirrors/dj/django-saml2-auth

1. 项目目录结构及介绍

django-saml2-auth/
├── django_saml2_auth/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── migrations/
│   ├── models.py
│   ├── tests.py
│   ├── urls.py
│   └── views.py
├── AUTHORS
├── LICENSE
├── MANIFEST.in
├── README.rst
├── setup.cfg
├── setup.py
└── requirements.txt

目录结构介绍

• django_saml2_auth/: 项目的主目录，包含了所有与 SAML2 认证相关的代码。
  • __init__.py: 初始化文件，使该目录成为一个 Python 包。
  • admin.py: Django 管理后台的配置文件。
  • apps.py: 应用的配置文件。
  • migrations/: 数据库迁移文件目录。
  • models.py: 数据库模型定义文件。
  • tests.py: 测试文件。
  • urls.py: URL 路由配置文件。
  • views.py: 视图函数定义文件。
• AUTHORS: 项目作者列表。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 打包配置文件。
• README.rst: 项目说明文档。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。
• requirements.txt: 项目依赖列表。

2. 项目启动文件介绍

项目的启动文件主要是 django_saml2_auth/views.py 和 django_saml2_auth/urls.py。

views.py

views.py 文件包含了处理 SAML2 认证请求的视图函数。主要功能包括：

• signin: 处理用户登录请求，将用户重定向到 SAML2 认证服务。
• acs: 处理 SAML2 认证服务返回的响应，验证用户身份并完成登录。

urls.py

urls.py 文件定义了项目的 URL 路由配置。主要功能包括：

• urlpatterns: 定义了 SAML2 认证相关的 URL 路由，如 saml2_auth/ 和 accounts/login/。

3. 项目配置文件介绍

项目的配置文件主要是 settings.py 和 django_saml2_auth/apps.py。

settings.py

在 settings.py 中，需要添加 SAML2 认证相关的配置项。以下是一些关键配置项：

SAML2_AUTH = {
    'METADATA_AUTO_CONF_URL': '[The auto(dynamic) metadata configuration URL of SAML2]',
    'METADATA_LOCAL_FILE_PATH': '[The metadata configuration file path]',
    'DEFAULT_NEXT_URL': '/admin',
    'CREATE_USER': 'TRUE',
    'NEW_USER_PROFILE': {
        'USER_GROUPS': [],
        'ACTIVE_STATUS': True,
        'STAFF_STATUS': True,
        'SUPERUSER_STATUS': False,
    },
    'ATTRIBUTES_MAP': {
        'email': 'Email',
        'username': 'UserName',
        'first_name': 'FirstName',
        'last_name': 'LastName',
    },
    'TRIGGER': {
        'CREATE_USER': 'path_to_your_new_user_hook_method',
        'BEFORE_LOGIN': 'path_to_your_login_hook_method',
    },
    'ASSERTION_URL': 'https://mysite.com',
    'ENTITY_ID': 'https://mysite.com/saml2_auth/acs/',
    'NAME_ID_FORMAT': 'FormatString',
    'USE_JWT': False,
    'FRONTEND_URL': 'https://myfrontendclient.com',
}

apps.py

apps.py 文件定义了 Django 应用的配置。主要功能包括：

• DjangoSaml2AuthConfig: 应用的配置类，定义了应用的名称和其他配置项。

通过以上配置，可以轻松地将 SAML2 认证集成到 Django 项目中。

django-saml2-auth Django SAML2 Authentication Made Easy. Easily integrate with SAML2 SSO identity providers like Okta 项目地址: https://gitcode.com/gh_mirrors/dj/django-saml2-auth