Django-auth-ldap 项目教程

Django-auth-ldap 项目教程

django-auth-ldapDjango authentication backend that authenticates against an LDAP service.项目地址:https://gitcode.com/gh_mirrors/dj/django-auth-ldap

1. 项目的目录结构及介绍

Django-auth-ldap 项目的目录结构如下：

django-auth-ldap/
├── django_auth_ldap/
│   ├── __init__.py
│   ├── config.py
│   ├── backend.py
│   ├── groups.py
│   ├── _ldap.py
│   ├── tests/
│   │   ├── __init__.py
│   │   ├── test_backend.py
│   │   ├── test_config.py
│   │   ├── test_groups.py
│   │   └── test_ldap.py
│   ├── management/
│   │   ├── __init__.py
│   │   └── commands/
│   │       ├── __init__.py
│   │       └── sync_ldap_groups.py
│   ├── middleware/
│   │   ├── __init__.py
│   │   └── ldap_groups.py
│   └── utils.py
├── docs/
│   ├── conf.py
│   ├── index.rst
│   ├── ...
├── examples/
│   ├── settings.py
│   ├── urls.py
│   ├── ...
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.rst
├── requirements.txt
├── setup.cfg
├── setup.py
└── tox.ini

目录结构介绍

• django_auth_ldap/: 包含 Django-auth-ldap 的核心代码。
  • __init__.py: 模块初始化文件。
  • config.py: 配置相关代码。
  • backend.py: 认证后端实现。
  • groups.py: 组管理相关代码。
  • _ldap.py: LDAP 连接和操作相关代码。
  • tests/: 测试代码。
  • management/: 管理命令相关代码。
  • middleware/: 中间件相关代码。
  • utils.py: 工具函数。
• docs/: 项目文档。
• examples/: 示例配置和代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包清单文件。
• README.rst: 项目说明文档。
• requirements.txt: 依赖包列表。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。
• tox.ini: 自动化测试配置文件。

2. 项目的启动文件介绍

Django-auth-ldap 项目的启动文件主要是 django_auth_ldap/backend.py，该文件实现了 LDAP 认证后端。

启动文件介绍

• backend.py: 该文件定义了 LDAPBackend 类，用于处理 LDAP 认证逻辑。

from django_auth_ldap.backend import LDAPBackend

# 使用 LDAPBackend 进行认证
user = LDAPBackend().authenticate(request, username="example", password="password")

3. 项目的配置文件介绍

Django-auth-ldap 项目的配置文件主要是 settings.py，需要在 Django 项目的 settings.py 中进行配置。

配置文件介绍

在 settings.py 中添加以下配置：

import ldap
from django_auth_ldap.config import LDAPSearch, GroupOfNamesType

# 基本配置
AUTH_LDAP_SERVER_URI = "ldap://ldap.example.com"
AUTH_LDAP_BIND_DN = "cn=admin,dc=example,dc=com"
AUTH_LDAP_BIND_PASSWORD = "password"
AUTH_LDAP_USER_SEARCH = LDAPSearch("ou=users,dc=example,dc=com",
    ldap.SCOPE_SUBTREE, "(uid=%(user)s)")

# 组配置
AUTH_LDAP_GROUP_SEARCH = LDAPSearch("ou=groups,dc=example,dc=com",
    ldap.SCOPE_SUBTREE, "(objectClass=groupOfNames)")
AUTH_LDAP_GROUP_TYPE = GroupOfNamesType()

# 认证后端
AUTHENTICATION_BACKENDS = (
    'django_auth_ldap.backend.LDAPBackend',
    'django.contrib.auth.backends.ModelBackend',

django-auth-ldapDjango authentication backend that authenticates against an LDAP service.项目地址:https://gitcode.com/gh_mirrors/dj/django-auth-ldap