
このプロジェクトは廃止され、メンテナンスは行われていません。既存のリリースとドキュメントは引き続き利用可能です。残りの 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 ログインがベースラインとなり、追加のチェックが行われないため、3 つの方法の中で最速になると予想されます。
defender のログインは Django のログインより遅くなる可能性が高いですが、django-axes のログインよりは高速であることが望まれます。目標は、通常の生のログインと defender の差をできるだけ小さくすることです。
django-axes のログイン速度は、より多くのチェックを行い、多くのデータベースクエリを実行するため、3 つの中で最も遅くなるでしょう。
ログインの速度を判断する最善の方法は、各セットアップでアプリケーションに対して負荷テストを実行し、各タイプのログイン時間を比較することです。
負荷テスト
負荷テストでは、さまざまな種類のログインをすべてカバーするために、複数のテストを用意する必要があります。
#. すべて成功: 成功したログインのみで負荷テストを行います。
#. 混合: 一部成功、一部失敗: 一部の成功ログインと一部の失敗で負荷テストを行い、失敗がパフォーマンスに与える影響を確認します。
#. すべて失敗: すべて失敗するログインで負荷テストを行い、パフォーマンスの違いを確認します。
負荷テストに使用できるサンプルアプリケーションが必要です。唯一の違いは、defender、axes、またはどちらもロードしないという設定です。
ホスト型の負荷テストサービスや、jmeterのようなものを使用できます。いずれにせよ、すべてのテストで一貫性を保つ必要があります。jmeterを使用する場合は、他の人が自分でテストを実行できるように、jmeterの設定を用意しておくべきです。
負荷テストの結果
結果はここに掲載します。各テストについて説明し、結果をいくつかのグラフとともに示します。
django-axesは優れていますが、すべてをデータベースに保存するため、大量のデータがある場合にボトルネックになります。認証リクエストが200〜300msも遅くなります。これは一部のサイトでは大したことではないかもしれませんが、他のサイトでは長すぎます。
これはdjango-axesのフォークとして始まり、可能な限り多くのコードを使用し、不要な部分を削除し、ルックアップを高速化してログインを改善しています。
#. 誰かがログインを試みると、まず現在ブロックされているかどうかを確認します。使用しようとしているユーザー名とIPアドレスの両方を確認します。ブロックされている場合はステップ5へ進みます。ブロックされていない場合はステップ2へ進みます。
#. ブロックされていないので、ログインが有効かどうかを確認します。有効な場合はステップ6へ進みます。有効でない場合はステップ3へ進みます。
#. ログイン試行が無効でした。この試行のユーザー名とIPアドレスをキャッシュに追加します。これにより制限を超えた場合は、ブロックリストに追加し、ステップ5へ進みます。制限を超えていない場合はステップ4へ進みます。
#. ログインは無効でしたが、制限を超えていません。ログイン画面に戻して再試行させます。
#. ユーザーはブロックされています:ブロックページに送り、ブロックされていることと、ブロックが解除される見込み時期を伝えます。
#. ログインは有効です。失敗したログイン試行をリセットし、目的地へ転送します。
Defenderはキャッシュを使用して失敗した試行を保存します。
キャッシュキー
カウンター:
ブール値(存在する場合はブロックされています):
django-defenderを多少カスタマイズするためのオプションがいくつか用意されています。
これらはsettings.pyファイルで定義する必要があります。