【亲测免费】 Django Axes 安装与使用指南

一、项目目录结构及介绍

Django Axes 是一个用于保护 Django 应用免受暴力登录攻击（如密码猜测）的库。以下是其基本目录结构概述及其组成部分简介：

django-axes/
├── axes/                      # 核心应用代码，包括模型、视图、管理界面等。
│   ├── __init__.py
│   ├── admin.py               # 含有Axes相关的Django管理接口定义。
│   ├── apps.py                # 应用配置类。
│   ├── checks.py              # Django检查器，用于验证项目配置。
│   ├── handlers.py            # 登录尝试的处理逻辑。
│   ├── models.py              # 存储失败登录尝试和访问控制的日志模型。
│   ├── tests/                 # 测试代码存放目录。
│   └── views.py               # 登录限制相关视图。
├── docs/                      # 文档资料，包含了使用说明和开发指南。
├── examples/                  # 示例配置和用法示例。
├── requirements.txt           # 项目依赖列表。
├── setup.py                   # Python包的安装脚本。
├── tox.ini                     # Tox测试环境配置。
└── ...

二、项目启动文件介绍

虽然 django-axes 本身不直接提供一个启动文件，但它的集成到现有的Django项目中通常涉及以下几个关键步骤的配置。在你的Django项目的主settings.py文件中进行必要的调整是关键。

在settings.py中的配置

1. 添加依赖 - 首先确保已通过pip或其他方式安装了Django Axes。

   pip install django-axes
   

2. INSTALLED_APPS 添加 - 将 'axes' 添加到你的 INSTALLED_APPS 列表中。

   INSTALLED_APPS = [
       ...,
       'axes',
       ...,
   ]
   

3. 中间件配置 - 在 MIDDLEWARE 中添加 'axes.middleware.AxesMiddleware'，通常放在认证中间件之后。

   MIDDLEWARE = [
       ...,
       'axes.middleware.AxesMiddleware',  # 这个位置应该在所有需要身份验证的中间件后面
       ...,
   ]
   

4. AXES的相关设置 - 配置 AXES_* 变量来定制行为，例如 AXES_LOCK_OUT_AT_FAILURE 控制失败尝试次数后锁定账户。

三、项目的配置文件介绍

Django Axes 的主要配置位于你的 Django 项目的 settings.py 文件内。这里简要列出一些核心配置项：

• AXES_COOLOFF_TIME - 用户尝试登录失败后的冷却时间（单位：小时），默认为0，表示无冷却期。

• AXES_FAILURE_LIMIT - 在锁定期限内允许的最大失败尝试次数，默认为5次。

• AXES_LOCK_OUT_BY_COMBINATION_USER_AND_IP - 是否基于用户和IP地址组合来锁定账户，默认为False，仅基于用户名或邮箱。

• AXES_RESET_ON_SUCCESS - 成功登录后是否重置失败计数，默认为True。

• AXES_LOCKOUT_URL - 用户被锁定时重定向的URL，需要提前设定好这个页面。

请注意，这些配置项只是冰山一角，完整的配置选项和解释可以在Django Axes的官方文档中找到更详细的信息。正确配置这些选项，可以有效地利用此工具防止恶意的登录尝试并保护您的应用安全。