本项目已停止维护,不再更新。现有发布版本和文档仍然可用。有关剩余的 PyPI 归档工作,请参阅 the retirement issue <https://github.com/jazzband/help/issues/450>_。
.. image:: https://jazzband.co/static/img/badge.svg :target: https://jazzband.co/ :alt: Jazzband
.. image:: https://img.shields.io/pypi/pyversions/django-defender.svg :alt: Supported Python versions :target: https://pypi.org/project/django-defender/
.. image:: https://img.shields.io/pypi/djversions/django-defender.svg :target: https://pypi.org/project/django-defender/ :alt: Supported Django versions
.. image:: https://github.com/jazzband/django-defender/workflows/Test/badge.svg :target: https://github.com/jazzband/django-defender/actions :alt: GitHub Actions
.. image:: https://codecov.io/gh/jazzband/django-defender/branch/master/graph/badge.svg :target: https://codecov.io/gh/jazzband/django-defender :alt: Coverage
.. image:: https://readthedocs.org/projects/django-defender/badge/?version=latest :alt: Documentation Status :target: https://django-defender.readthedocs.io/en/latest/?badge=latest
一个简单的 Django 可复用应用,用于阻止他人对登录尝试进行暴力破解。目标是尽可能提高速度,以免拖慢登录尝试。
我们将使用缓存,这样就不必在每次登录尝试时都访问数据库来检查。第一个版本将基于 Redis,但目标是使其可配置,以便人们可以使用最适合自己需求的后端。
如果你在自己的站点上使用了 defender,请提交 PR 以添加到列表中。
文档可在 Read the Docs 上获取:
https://django-defender.readthedocs.io
将所有登录尝试记录到数据库
支持具有不同 IP 地址请求头的反向代理
基于以下内容进行速率限制
使用 Redis 作为黑名单
配置
Redis 服务器
封禁时长
封禁前的错误尝试次数
95% 代码覆盖率
完整文档
能够将登录尝试存储到数据库
用于清理登录尝试数据库表的管理命令
管理页面
可轻松适配自定义认证方法。
在封禁用户名或 IP 时发送信号
管理页面
.. image:: https://cloud.githubusercontent.com/assets/261601/5950540/8895b570-a729-11e4-9dc3-6b00e46c8043.png :target: https://cloud.githubusercontent.com/assets/261601/5950540/8895b570-a729-11e4-9dc3-6b00e46c8043.png :alt: alt tag
.. image:: https://cloud.githubusercontent.com/assets/261601/5950541/88a35194-a729-11e4-981b-3a55b44ef9d5.png :target: https://cloud.githubusercontent.com/assets/261601/5950541/88a35194-a729-11e4-981b-3a55b44ef9d5.png :alt: alt tag
下载代码,并根据所用方法选择以下方式之一运行安装。
从 PyPI 安装生产就绪版本:
.. code-block:: bash
pip install django-defender
下载后从源代码安装开发版本:
.. code-block:: bash
python setup.py install
从 GitHub 仓库安装 master 分支开发版本:
.. code-block:: bash
pip install -e git+http://github.com/kencochran django-defender.git#egg=django_defender-dev
首先,你必须将本项目添加到 settings.py 中的 INSTALLED_APPS 列表中
.. code-block:: python
INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.sites', # ... 'defender', # ... ]
接下来,安装 FailedLoginMiddleware 中间件
.. code-block:: python
MIDDLEWARE_CLASSES = [ 'django.middleware.common.CommonMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'defender.middleware.FailedLoginMiddleware', ]
如果你想通过 Django admin 管理被封锁的用户,请将以下内容添加到你的 urls.py 中
.. code-block:: python
urlpatterns = [ path('admin/defender/', include('defender.urls')), # defender admin path('admin/', admin.site.urls), # normal admin # your own patterns follow... ]
迁移
你需要在数据库中创建运行所需的表。
.. code-block:: bash
python manage.py migrate defender
管理命令
cleanup_django_defender
如果你的网站流量很大,AccessAttempts 表会很快被填满。如果你不需要保留数据用于审计目的,有一个管理命令可以帮助你保持表的整洁。
它会根据你的 DEFENDER_ACCESS_ATTEMPT_EXPIRATION 设置来确定哪些记录将被删除。如果未指定,默认为 24 小时。
.. code-block:: bash
$ python manage.py cleanup_django_defender
你可以将其设置为每日或每周的 cron 任务,以控制表的大小。
.. code-block:: bash
24 0 * * * /usr/bin/python manage.py cleanup_django_defender >> /var/log/django_defender_cleanup.log
性能
defender 的目标是尽可能快,以免拖慢登录过程。为了确保达成目标,我们需要一种测试应用的方法来确认我们走在正确的轨道上。最好的方法是对比普通 Django 登录、使用 defender 的登录以及使用 django-axes 的登录的速度。
普通 Django 登录将作为我们的基准,我们预期它是三种方法中最快的,因为不会进行额外的检查。
defender 登录很可能比 Django 登录慢,但希望比 django-axes 登录快。目标是让普通原始登录与 defender 之间的差异尽可能小。
django-axes 的登录速度可能是三者中最慢的,因为它执行更多检查并进行大量数据库查询。
确定登录速度的最佳方法是对每种配置的应用进行负载测试,并比较每种类型的登录时间。
负载测试
为了确保覆盖所有不同类型的登录,在我们的负载测试中需要不止一个测试。
#. 全部成功:我们将进行仅包含成功登录的负载测试。
#. 混合:部分成功部分失败:我们将进行包含部分成功登录和部分失败的负载测试,以观察失败对性能的影响。
#. 全部失败:我们将进行全部失败登录的负载测试,并观察性能差异。
我们需要一个可用于负载测试的示例应用,唯一的区别在于配置中我们加载 defender、axes 或两者都不加载。
我们可以使用托管负载测试服务,或者像 jmeter 这样的工具。无论哪种方式,我们都需要对所有测试保持一致。如果我们使用 jmeter,我们应该提供我们的 jmeter 配置,以便其他人可以自行运行测试。
负载测试结果
我们将在此处发布结果。我们将解释每个测试,并展示结果以及一些图表。
django-axes 很棒,但它把所有内容都放在数据库中,当数据量很大时会造成瓶颈。它会使认证请求减慢多达 200-300ms。对某些网站来说这可能不算什么,但对其他网站来说就太长了。
本项目最初是 django-axes 的一个分支,尽可能多地使用它们的代码,并移除不需要的部分,同时加快查找速度以改善登录。
#. 当有人尝试登录时,我们首先检查他们当前是否被阻止。我们检查他们尝试使用的用户名以及 IP 地址。如果被阻止,转到步骤 5。如果未被阻止,转到步骤 2。
#. 他们未被阻止,因此我们检查登录是否有效。如果有效,转到步骤 6。如果无效,转到步骤 3。
#. 登录尝试无效。将此尝试的用户名和 IP 地址添加到缓存中。如果这使他们超过限制,将他们添加到阻止列表中,然后转到步骤 5。如果未超过限制,转到步骤 4。
#. 登录无效,但未超过限制。将他们送回登录屏幕重试。
#. 用户被阻止:将他们发送到阻止页面,告知他们已被阻止,并给出他们将被解除阻止的预估时间。
#. 登录有效。重置任何失败的登录尝试,并转发到他们的目标位置。
Defender 使用缓存来保存失败的尝试。
缓存键
计数器:
布尔值(如果存在则表示被阻止):
你有几个选项可以用来稍微自定义 django-defender。这些应在你的 settings.py 文件中定义。
DEFENDER_LOGIN_FAILURE_LIMIT\ :Int:在为失败登录创建记录之前允许的登录尝试次数。[默认值:3\ ]
DEFENDER_LOGIN_FAILURE_LIMIT_USERNAME\ :Int:在为失败登录创建记录之前,针对某个用户名允许的登录尝试次数。[默认值:DEFENDER_LOGIN_FAILURE_LIMIT\ ]
DEFENDER_LOGIN_FAILURE_LIMIT_IP\ :Int:在为失败登录创建记录之前,从某个 IP 允许的登录尝试次数。[默认值:DEFENDER_LOGIN_FAILURE_LIMIT\ ]
DEFENDER_BEHIND_REVERSE_PROXY\ :Boolean:defender 是否位于反向代理之后?[默认值:False\ ]
DEFENDER_REVERSE_PROXY_HEADER\ :String:包含反向代理 IP 地址的 HTTP 头名称 [默认值:HTTP_X_FORWARDED_FOR\ ]
DEFENDER_LOCK_OUT_BY_IP_AND_USERNAME\ :Boolean:基于 IP 和用户名的组合锁定用户。这可防止某个用户拒绝其他所有从同一 IP 地址访问该应用的用户访问该应用。[默认值:False\ ]
DEFENDER_DISABLE_IP_LOCKOUT\ :Boolean:如果为 True,则不会锁定用户 IP 地址,只会锁定用户名。[默认值:False]
DEFENDER_DISABLE_USERNAME_LOCKOUT\ :Boolean:如果为 True,则不会锁定用户名,只会锁定 IP 地址。[默认值:False]
DEFENDER_COOLOFF_TIME\ :Int:如果设置,则定义一段不活动时间,超过该时间后,旧的失败登录尝试以及用户名/IP 锁定将被遗忘。整数将被解释为秒数。如果为 0,则失败登录尝试和用户名/IP 锁定都不会过期。[默认值:300\ ]
DEFENDER_ATTEMPT_COOLOFF_TIME\ :Int:如果设置,则覆盖由 DEFENDER_COOLOFF_TIME 设置的、旧的失败登录尝试将被遗忘的不活动时间。整数将被解释为秒数。如果为 0,则失败登录尝试不会过期。[默认值:DEFENDER_COOLOFF_TIME\ ]
DEFENDER_LOCKOUT_COOLOFF_TIME\ :Int 或 List:如果设置,则覆盖由 DEFENDER_COOLOFF_TIME 设置的、用户名/IP 锁定将被遗忘的不活动时间。整数将被解释为秒数。整数列表将被解释为针对用户的一组秒数,其中该整数的索引表示在最近 DEFENDER_ACCESS_ATTEMPT_EXPIRATION 小时内发生了多少次先前的锁定(最多到某个最大值)。如果该属性设置为 0 或 [],则用户名/IP 锁定不会过期。[默认值:DEFENDER_COOLOFF_TIME\ ]
DEFENDER_LOCKOUT_TEMPLATE\ :String:[默认值:None\ ] 如果设置,则指定当用户被锁定时要渲染的模板。模板接收以下上下文变量:
cooloff_time_seconds\ :冷却时间(秒)cooloff_time_minutes\ :冷却时间(分钟)failure_limit\ :在被阻止之前的失败次数。